| File: | include/llvm/Support/Error.h |
| Warning: | line 201, column 5 Potential leak of memory pointed to by 'Payload._M_t._M_head_impl' |
Press '?' to see keyboard shortcuts
Keyboard shortcuts:
| 1 | //===- lib/Driver/DarwinLdDriver.cpp --------------------------------------===// | |||
| 2 | // | |||
| 3 | // The LLVM Linker | |||
| 4 | // | |||
| 5 | // This file is distributed under the University of Illinois Open Source | |||
| 6 | // License. See LICENSE.TXT for details. | |||
| 7 | // | |||
| 8 | //===----------------------------------------------------------------------===// | |||
| 9 | /// | |||
| 10 | /// \file | |||
| 11 | /// | |||
| 12 | /// Concrete instance of the Driver for darwin's ld. | |||
| 13 | /// | |||
| 14 | //===----------------------------------------------------------------------===// | |||
| 15 | ||||
| 16 | #include "lld/Common/Args.h" | |||
| 17 | #include "lld/Common/ErrorHandler.h" | |||
| 18 | #include "lld/Common/LLVM.h" | |||
| 19 | #include "lld/Core/ArchiveLibraryFile.h" | |||
| 20 | #include "lld/Core/Error.h" | |||
| 21 | #include "lld/Core/File.h" | |||
| 22 | #include "lld/Core/Instrumentation.h" | |||
| 23 | #include "lld/Core/LinkingContext.h" | |||
| 24 | #include "lld/Core/Node.h" | |||
| 25 | #include "lld/Core/PassManager.h" | |||
| 26 | #include "lld/Core/Resolver.h" | |||
| 27 | #include "lld/Core/SharedLibraryFile.h" | |||
| 28 | #include "lld/Core/Simple.h" | |||
| 29 | #include "lld/ReaderWriter/MachOLinkingContext.h" | |||
| 30 | #include "llvm/ADT/ArrayRef.h" | |||
| 31 | #include "llvm/ADT/Optional.h" | |||
| 32 | #include "llvm/ADT/STLExtras.h" | |||
| 33 | #include "llvm/ADT/SmallString.h" | |||
| 34 | #include "llvm/ADT/StringExtras.h" | |||
| 35 | #include "llvm/ADT/StringRef.h" | |||
| 36 | #include "llvm/ADT/Twine.h" | |||
| 37 | #include "llvm/BinaryFormat/MachO.h" | |||
| 38 | #include "llvm/Option/Arg.h" | |||
| 39 | #include "llvm/Option/ArgList.h" | |||
| 40 | #include "llvm/Option/OptTable.h" | |||
| 41 | #include "llvm/Option/Option.h" | |||
| 42 | #include "llvm/Support/Casting.h" | |||
| 43 | #include "llvm/Support/CommandLine.h" | |||
| 44 | #include "llvm/Support/Error.h" | |||
| 45 | #include "llvm/Support/ErrorOr.h" | |||
| 46 | #include "llvm/Support/Format.h" | |||
| 47 | #include "llvm/Support/MathExtras.h" | |||
| 48 | #include "llvm/Support/MemoryBuffer.h" | |||
| 49 | #include "llvm/Support/Path.h" | |||
| 50 | #include "llvm/Support/raw_ostream.h" | |||
| 51 | #include <algorithm> | |||
| 52 | #include <cstdint> | |||
| 53 | #include <memory> | |||
| 54 | #include <string> | |||
| 55 | #include <system_error> | |||
| 56 | #include <utility> | |||
| 57 | #include <vector> | |||
| 58 | ||||
| 59 | using namespace lld; | |||
| 60 | ||||
| 61 | namespace { | |||
| 62 | ||||
| 63 | // Create enum with OPT_xxx values for each option in DarwinLdOptions.td | |||
| 64 | enum { | |||
| 65 | OPT_INVALID = 0, | |||
| 66 | #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ | |||
| 67 | HELP, META, VALUES) \ | |||
| 68 | OPT_##ID, | |||
| 69 | #include "DarwinLdOptions.inc" | |||
| 70 | #undef OPTION | |||
| 71 | }; | |||
| 72 | ||||
| 73 | // Create prefix string literals used in DarwinLdOptions.td | |||
| 74 | #define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE; | |||
| 75 | #include "DarwinLdOptions.inc" | |||
| 76 | #undef PREFIX | |||
| 77 | ||||
| 78 | // Create table mapping all options defined in DarwinLdOptions.td | |||
| 79 | static const llvm::opt::OptTable::Info InfoTable[] = { | |||
| 80 | #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \ | |||
| 81 | HELPTEXT, METAVAR, VALUES) \ | |||
| 82 | {PREFIX, NAME, HELPTEXT, \ | |||
| 83 | METAVAR, OPT_##ID, llvm::opt::Option::KIND##Class, \ | |||
| 84 | PARAM, FLAGS, OPT_##GROUP, \ | |||
| 85 | OPT_##ALIAS, ALIASARGS, VALUES}, | |||
| 86 | #include "DarwinLdOptions.inc" | |||
| 87 | #undef OPTION | |||
| 88 | }; | |||
| 89 | ||||
| 90 | // Create OptTable class for parsing actual command line arguments | |||
| 91 | class DarwinLdOptTable : public llvm::opt::OptTable { | |||
| 92 | public: | |||
| 93 | DarwinLdOptTable() : OptTable(InfoTable) {} | |||
| 94 | }; | |||
| 95 | ||||
| 96 | static std::vector<std::unique_ptr<File>> | |||
| 97 | makeErrorFile(StringRef path, std::error_code ec) { | |||
| 98 | std::vector<std::unique_ptr<File>> result; | |||
| 99 | result.push_back(llvm::make_unique<ErrorFile>(path, ec)); | |||
| 100 | return result; | |||
| 101 | } | |||
| 102 | ||||
| 103 | static std::vector<std::unique_ptr<File>> | |||
| 104 | parseMemberFiles(std::unique_ptr<File> file) { | |||
| 105 | std::vector<std::unique_ptr<File>> members; | |||
| 106 | if (auto *archive = dyn_cast<ArchiveLibraryFile>(file.get())) { | |||
| 107 | if (std::error_code ec = archive->parseAllMembers(members)) | |||
| 108 | return makeErrorFile(file->path(), ec); | |||
| 109 | } else { | |||
| 110 | members.push_back(std::move(file)); | |||
| 111 | } | |||
| 112 | return members; | |||
| 113 | } | |||
| 114 | ||||
| 115 | std::vector<std::unique_ptr<File>> loadFile(MachOLinkingContext &ctx, | |||
| 116 | StringRef path, bool wholeArchive, | |||
| 117 | bool upwardDylib) { | |||
| 118 | if (ctx.logInputFiles()) | |||
| 119 | message(path); | |||
| 120 | ||||
| 121 | ErrorOr<std::unique_ptr<MemoryBuffer>> mbOrErr = ctx.getMemoryBuffer(path); | |||
| 122 | if (std::error_code ec = mbOrErr.getError()) | |||
| 123 | return makeErrorFile(path, ec); | |||
| 124 | ErrorOr<std::unique_ptr<File>> fileOrErr = | |||
| 125 | ctx.registry().loadFile(std::move(mbOrErr.get())); | |||
| 126 | if (std::error_code ec = fileOrErr.getError()) | |||
| 127 | return makeErrorFile(path, ec); | |||
| 128 | std::unique_ptr<File> &file = fileOrErr.get(); | |||
| 129 | ||||
| 130 | // If file is a dylib, inform LinkingContext about it. | |||
| 131 | if (SharedLibraryFile *shl = dyn_cast<SharedLibraryFile>(file.get())) { | |||
| 132 | if (std::error_code ec = shl->parse()) | |||
| 133 | return makeErrorFile(path, ec); | |||
| 134 | ctx.registerDylib(reinterpret_cast<mach_o::MachODylibFile *>(shl), | |||
| 135 | upwardDylib); | |||
| 136 | } | |||
| 137 | if (wholeArchive) | |||
| 138 | return parseMemberFiles(std::move(file)); | |||
| 139 | std::vector<std::unique_ptr<File>> files; | |||
| 140 | files.push_back(std::move(file)); | |||
| 141 | return files; | |||
| 142 | } | |||
| 143 | ||||
| 144 | } // end anonymous namespace | |||
| 145 | ||||
| 146 | // Test may be running on Windows. Canonicalize the path | |||
| 147 | // separator to '/' to get consistent outputs for tests. | |||
| 148 | static std::string canonicalizePath(StringRef path) { | |||
| 149 | char sep = llvm::sys::path::get_separator().front(); | |||
| 150 | if (sep != '/') { | |||
| 151 | std::string fixedPath = path; | |||
| 152 | std::replace(fixedPath.begin(), fixedPath.end(), sep, '/'); | |||
| 153 | return fixedPath; | |||
| 154 | } else { | |||
| 155 | return path; | |||
| 156 | } | |||
| 157 | } | |||
| 158 | ||||
| 159 | static void addFile(StringRef path, MachOLinkingContext &ctx, | |||
| 160 | bool loadWholeArchive, bool upwardDylib) { | |||
| 161 | std::vector<std::unique_ptr<File>> files = | |||
| 162 | loadFile(ctx, path, loadWholeArchive, upwardDylib); | |||
| 163 | for (std::unique_ptr<File> &file : files) | |||
| 164 | ctx.getNodes().push_back(llvm::make_unique<FileNode>(std::move(file))); | |||
| 165 | } | |||
| 166 | ||||
| 167 | // Export lists are one symbol per line. Blank lines are ignored. | |||
| 168 | // Trailing comments start with #. | |||
| 169 | static std::error_code parseExportsList(StringRef exportFilePath, | |||
| 170 | MachOLinkingContext &ctx) { | |||
| 171 | // Map in export list file. | |||
| 172 | ErrorOr<std::unique_ptr<MemoryBuffer>> mb = | |||
| 173 | MemoryBuffer::getFileOrSTDIN(exportFilePath); | |||
| 174 | if (std::error_code ec = mb.getError()) | |||
| 175 | return ec; | |||
| 176 | ctx.addInputFileDependency(exportFilePath); | |||
| 177 | StringRef buffer = mb->get()->getBuffer(); | |||
| 178 | while (!buffer.empty()) { | |||
| 179 | // Split off each line in the file. | |||
| 180 | std::pair<StringRef, StringRef> lineAndRest = buffer.split('\n'); | |||
| 181 | StringRef line = lineAndRest.first; | |||
| 182 | // Ignore trailing # comments. | |||
| 183 | std::pair<StringRef, StringRef> symAndComment = line.split('#'); | |||
| 184 | StringRef sym = symAndComment.first.trim(); | |||
| 185 | if (!sym.empty()) | |||
| 186 | ctx.addExportSymbol(sym); | |||
| 187 | buffer = lineAndRest.second; | |||
| 188 | } | |||
| 189 | return std::error_code(); | |||
| 190 | } | |||
| 191 | ||||
| 192 | /// Order files are one symbol per line. Blank lines are ignored. | |||
| 193 | /// Trailing comments start with #. Symbol names can be prefixed with an | |||
| 194 | /// architecture name and/or .o leaf name. Examples: | |||
| 195 | /// _foo | |||
| 196 | /// bar.o:_bar | |||
| 197 | /// libfrob.a(bar.o):_bar | |||
| 198 | /// x86_64:_foo64 | |||
| 199 | static std::error_code parseOrderFile(StringRef orderFilePath, | |||
| 200 | MachOLinkingContext &ctx) { | |||
| 201 | // Map in order file. | |||
| 202 | ErrorOr<std::unique_ptr<MemoryBuffer>> mb = | |||
| 203 | MemoryBuffer::getFileOrSTDIN(orderFilePath); | |||
| 204 | if (std::error_code ec = mb.getError()) | |||
| 205 | return ec; | |||
| 206 | ctx.addInputFileDependency(orderFilePath); | |||
| 207 | StringRef buffer = mb->get()->getBuffer(); | |||
| 208 | while (!buffer.empty()) { | |||
| 209 | // Split off each line in the file. | |||
| 210 | std::pair<StringRef, StringRef> lineAndRest = buffer.split('\n'); | |||
| 211 | StringRef line = lineAndRest.first; | |||
| 212 | buffer = lineAndRest.second; | |||
| 213 | // Ignore trailing # comments. | |||
| 214 | std::pair<StringRef, StringRef> symAndComment = line.split('#'); | |||
| 215 | if (symAndComment.first.empty()) | |||
| 216 | continue; | |||
| 217 | StringRef sym = symAndComment.first.trim(); | |||
| 218 | if (sym.empty()) | |||
| 219 | continue; | |||
| 220 | // Check for prefix. | |||
| 221 | StringRef prefix; | |||
| 222 | std::pair<StringRef, StringRef> prefixAndSym = sym.split(':'); | |||
| 223 | if (!prefixAndSym.second.empty()) { | |||
| 224 | sym = prefixAndSym.second; | |||
| 225 | prefix = prefixAndSym.first; | |||
| 226 | if (!prefix.endswith(".o") && !prefix.endswith(".o)")) { | |||
| 227 | // If arch name prefix does not match arch being linked, ignore symbol. | |||
| 228 | if (!ctx.archName().equals(prefix)) | |||
| 229 | continue; | |||
| 230 | prefix = ""; | |||
| 231 | } | |||
| 232 | } else | |||
| 233 | sym = prefixAndSym.first; | |||
| 234 | if (!sym.empty()) { | |||
| 235 | ctx.appendOrderedSymbol(sym, prefix); | |||
| 236 | //llvm::errs() << sym << ", prefix=" << prefix << "\n"; | |||
| 237 | } | |||
| 238 | } | |||
| 239 | return std::error_code(); | |||
| 240 | } | |||
| 241 | ||||
| 242 | // | |||
| 243 | // There are two variants of the -filelist option: | |||
| 244 | // | |||
| 245 | // -filelist <path> | |||
| 246 | // In this variant, the path is to a text file which contains one file path | |||
| 247 | // per line. There are no comments or trimming of whitespace. | |||
| 248 | // | |||
| 249 | // -fileList <path>,<dir> | |||
| 250 | // In this variant, the path is to a text file which contains a partial path | |||
| 251 | // per line. The <dir> prefix is prepended to each partial path. | |||
| 252 | // | |||
| 253 | static llvm::Error loadFileList(StringRef fileListPath, | |||
| 254 | MachOLinkingContext &ctx, bool forceLoad) { | |||
| 255 | // If there is a comma, split off <dir>. | |||
| 256 | std::pair<StringRef, StringRef> opt = fileListPath.split(','); | |||
| 257 | StringRef filePath = opt.first; | |||
| 258 | StringRef dirName = opt.second; | |||
| 259 | ctx.addInputFileDependency(filePath); | |||
| 260 | // Map in file list file. | |||
| 261 | ErrorOr<std::unique_ptr<MemoryBuffer>> mb = | |||
| 262 | MemoryBuffer::getFileOrSTDIN(filePath); | |||
| 263 | if (std::error_code ec = mb.getError()) | |||
| 264 | return llvm::errorCodeToError(ec); | |||
| 265 | StringRef buffer = mb->get()->getBuffer(); | |||
| 266 | while (!buffer.empty()) { | |||
| 267 | // Split off each line in the file. | |||
| 268 | std::pair<StringRef, StringRef> lineAndRest = buffer.split('\n'); | |||
| 269 | StringRef line = lineAndRest.first; | |||
| 270 | StringRef path; | |||
| 271 | if (!dirName.empty()) { | |||
| 272 | // If there is a <dir> then prepend dir to each line. | |||
| 273 | SmallString<256> fullPath; | |||
| 274 | fullPath.assign(dirName); | |||
| 275 | llvm::sys::path::append(fullPath, Twine(line)); | |||
| 276 | path = ctx.copy(fullPath.str()); | |||
| 277 | } else { | |||
| 278 | // No <dir> use whole line as input file path. | |||
| 279 | path = ctx.copy(line); | |||
| 280 | } | |||
| 281 | if (!ctx.pathExists(path)) { | |||
| 282 | return llvm::make_error<GenericError>(Twine("File not found '") | |||
| 283 | + path | |||
| 284 | + "'"); | |||
| 285 | } | |||
| 286 | if (ctx.testingFileUsage()) { | |||
| 287 | message("Found filelist entry " + canonicalizePath(path)); | |||
| 288 | } | |||
| 289 | addFile(path, ctx, forceLoad, false); | |||
| 290 | buffer = lineAndRest.second; | |||
| 291 | } | |||
| 292 | return llvm::Error::success(); | |||
| 293 | } | |||
| 294 | ||||
| 295 | /// Parse number assuming it is base 16, but allow 0x prefix. | |||
| 296 | static bool parseNumberBase16(StringRef numStr, uint64_t &baseAddress) { | |||
| 297 | if (numStr.startswith_lower("0x")) | |||
| 298 | numStr = numStr.drop_front(2); | |||
| 299 | return numStr.getAsInteger(16, baseAddress); | |||
| 300 | } | |||
| 301 | ||||
| 302 | static void parseLLVMOptions(const LinkingContext &ctx) { | |||
| 303 | // Honor -mllvm | |||
| 304 | if (!ctx.llvmOptions().empty()) { | |||
| 305 | unsigned numArgs = ctx.llvmOptions().size(); | |||
| 306 | auto **args = new const char *[numArgs + 2]; | |||
| 307 | args[0] = "lld (LLVM option parsing)"; | |||
| 308 | for (unsigned i = 0; i != numArgs; ++i) | |||
| 309 | args[i + 1] = ctx.llvmOptions()[i]; | |||
| 310 | args[numArgs + 1] = nullptr; | |||
| 311 | llvm::cl::ParseCommandLineOptions(numArgs + 1, args); | |||
| 312 | } | |||
| 313 | } | |||
| 314 | ||||
| 315 | namespace lld { | |||
| 316 | namespace mach_o { | |||
| 317 | ||||
| 318 | bool parse(llvm::ArrayRef<const char *> args, MachOLinkingContext &ctx) { | |||
| 319 | // Parse command line options using DarwinLdOptions.td | |||
| 320 | DarwinLdOptTable table; | |||
| 321 | unsigned missingIndex; | |||
| 322 | unsigned missingCount; | |||
| 323 | llvm::opt::InputArgList parsedArgs = | |||
| 324 | table.ParseArgs(args.slice(1), missingIndex, missingCount); | |||
| 325 | if (missingCount) { | |||
| ||||
| 326 | error("missing arg value for '" + | |||
| 327 | Twine(parsedArgs.getArgString(missingIndex)) + "' expected " + | |||
| 328 | Twine(missingCount) + " argument(s)."); | |||
| 329 | return false; | |||
| 330 | } | |||
| 331 | ||||
| 332 | for (auto unknownArg : parsedArgs.filtered(OPT_UNKNOWN)) { | |||
| 333 | warn("ignoring unknown argument: " + | |||
| 334 | Twine(unknownArg->getAsString(parsedArgs))); | |||
| 335 | } | |||
| 336 | ||||
| 337 | errorHandler().Verbose = parsedArgs.hasArg(OPT_v); | |||
| 338 | errorHandler().ErrorLimit = args::getInteger(parsedArgs, OPT_error_limit, 20); | |||
| 339 | ||||
| 340 | // Figure out output kind ( -dylib, -r, -bundle, -preload, or -static ) | |||
| 341 | llvm::MachO::HeaderFileType fileType = llvm::MachO::MH_EXECUTE; | |||
| 342 | bool isStaticExecutable = false; | |||
| 343 | if (llvm::opt::Arg *kind = parsedArgs.getLastArg( | |||
| 344 | OPT_dylib, OPT_relocatable, OPT_bundle, OPT_static, OPT_preload)) { | |||
| 345 | switch (kind->getOption().getID()) { | |||
| 346 | case OPT_dylib: | |||
| 347 | fileType = llvm::MachO::MH_DYLIB; | |||
| 348 | break; | |||
| 349 | case OPT_relocatable: | |||
| 350 | fileType = llvm::MachO::MH_OBJECT; | |||
| 351 | break; | |||
| 352 | case OPT_bundle: | |||
| 353 | fileType = llvm::MachO::MH_BUNDLE; | |||
| 354 | break; | |||
| 355 | case OPT_static: | |||
| 356 | fileType = llvm::MachO::MH_EXECUTE; | |||
| 357 | isStaticExecutable = true; | |||
| 358 | break; | |||
| 359 | case OPT_preload: | |||
| 360 | fileType = llvm::MachO::MH_PRELOAD; | |||
| 361 | break; | |||
| 362 | } | |||
| 363 | } | |||
| 364 | ||||
| 365 | // Handle -arch xxx | |||
| 366 | MachOLinkingContext::Arch arch = MachOLinkingContext::arch_unknown; | |||
| 367 | if (llvm::opt::Arg *archStr = parsedArgs.getLastArg(OPT_arch)) { | |||
| 368 | arch = MachOLinkingContext::archFromName(archStr->getValue()); | |||
| 369 | if (arch == MachOLinkingContext::arch_unknown) { | |||
| 370 | error("unknown arch named '" + Twine(archStr->getValue()) + "'"); | |||
| 371 | return false; | |||
| 372 | } | |||
| 373 | } | |||
| 374 | // If no -arch specified, scan input files to find first non-fat .o file. | |||
| 375 | if (arch == MachOLinkingContext::arch_unknown) { | |||
| 376 | for (auto &inFile : parsedArgs.filtered(OPT_INPUT)) { | |||
| 377 | // This is expensive because it opens and maps the file. But that is | |||
| 378 | // ok because no -arch is rare. | |||
| 379 | if (MachOLinkingContext::isThinObjectFile(inFile->getValue(), arch)) | |||
| 380 | break; | |||
| 381 | } | |||
| 382 | if (arch == MachOLinkingContext::arch_unknown && | |||
| 383 | !parsedArgs.getLastArg(OPT_test_file_usage)) { | |||
| 384 | // If no -arch and no options at all, print usage message. | |||
| 385 | if (parsedArgs.size() == 0) { | |||
| 386 | table.PrintHelp(llvm::outs(), | |||
| 387 | (std::string(args[0]) + " [options] file...").c_str(), | |||
| 388 | "LLVM Linker", false); | |||
| 389 | } else { | |||
| 390 | error("-arch not specified and could not be inferred"); | |||
| 391 | } | |||
| 392 | return false; | |||
| 393 | } | |||
| 394 | } | |||
| 395 | ||||
| 396 | // Handle -macosx_version_min or -ios_version_min | |||
| 397 | MachOLinkingContext::OS os = MachOLinkingContext::OS::unknown; | |||
| 398 | uint32_t minOSVersion = 0; | |||
| 399 | if (llvm::opt::Arg *minOS = | |||
| 400 | parsedArgs.getLastArg(OPT_macosx_version_min, OPT_ios_version_min, | |||
| 401 | OPT_ios_simulator_version_min)) { | |||
| 402 | switch (minOS->getOption().getID()) { | |||
| 403 | case OPT_macosx_version_min: | |||
| 404 | os = MachOLinkingContext::OS::macOSX; | |||
| 405 | if (MachOLinkingContext::parsePackedVersion(minOS->getValue(), | |||
| 406 | minOSVersion)) { | |||
| 407 | error("malformed macosx_version_min value"); | |||
| 408 | return false; | |||
| 409 | } | |||
| 410 | break; | |||
| 411 | case OPT_ios_version_min: | |||
| 412 | os = MachOLinkingContext::OS::iOS; | |||
| 413 | if (MachOLinkingContext::parsePackedVersion(minOS->getValue(), | |||
| 414 | minOSVersion)) { | |||
| 415 | error("malformed ios_version_min value"); | |||
| 416 | return false; | |||
| 417 | } | |||
| 418 | break; | |||
| 419 | case OPT_ios_simulator_version_min: | |||
| 420 | os = MachOLinkingContext::OS::iOS_simulator; | |||
| 421 | if (MachOLinkingContext::parsePackedVersion(minOS->getValue(), | |||
| 422 | minOSVersion)) { | |||
| 423 | error("malformed ios_simulator_version_min value"); | |||
| 424 | return false; | |||
| 425 | } | |||
| 426 | break; | |||
| 427 | } | |||
| 428 | } else { | |||
| 429 | // No min-os version on command line, check environment variables | |||
| 430 | } | |||
| 431 | ||||
| 432 | // Handle export_dynamic | |||
| 433 | // FIXME: Should we warn when this applies to something other than a static | |||
| 434 | // executable or dylib? Those are the only cases where this has an effect. | |||
| 435 | // Note, this has to come before ctx.configure() so that we get the correct | |||
| 436 | // value for _globalsAreDeadStripRoots. | |||
| 437 | bool exportDynamicSymbols = parsedArgs.hasArg(OPT_export_dynamic); | |||
| 438 | ||||
| 439 | // Now that there's enough information parsed in, let the linking context | |||
| 440 | // set up default values. | |||
| 441 | ctx.configure(fileType, arch, os, minOSVersion, exportDynamicSymbols); | |||
| 442 | ||||
| 443 | // Handle -e xxx | |||
| 444 | if (llvm::opt::Arg *entry = parsedArgs.getLastArg(OPT_entry)) | |||
| 445 | ctx.setEntrySymbolName(entry->getValue()); | |||
| 446 | ||||
| 447 | // Handle -o xxx | |||
| 448 | if (llvm::opt::Arg *outpath = parsedArgs.getLastArg(OPT_output)) | |||
| 449 | ctx.setOutputPath(outpath->getValue()); | |||
| 450 | else | |||
| 451 | ctx.setOutputPath("a.out"); | |||
| 452 | ||||
| 453 | // Handle -image_base XXX and -seg1addr XXXX | |||
| 454 | if (llvm::opt::Arg *imageBase = parsedArgs.getLastArg(OPT_image_base)) { | |||
| 455 | uint64_t baseAddress; | |||
| 456 | if (parseNumberBase16(imageBase->getValue(), baseAddress)) { | |||
| 457 | error("image_base expects a hex number"); | |||
| 458 | return false; | |||
| 459 | } else if (baseAddress < ctx.pageZeroSize()) { | |||
| 460 | error("image_base overlaps with __PAGEZERO"); | |||
| 461 | return false; | |||
| 462 | } else if (baseAddress % ctx.pageSize()) { | |||
| 463 | error("image_base must be a multiple of page size (0x" + | |||
| 464 | llvm::utohexstr(ctx.pageSize()) + ")"); | |||
| 465 | return false; | |||
| 466 | } | |||
| 467 | ||||
| 468 | ctx.setBaseAddress(baseAddress); | |||
| 469 | } | |||
| 470 | ||||
| 471 | // Handle -dead_strip | |||
| 472 | if (parsedArgs.getLastArg(OPT_dead_strip)) | |||
| 473 | ctx.setDeadStripping(true); | |||
| 474 | ||||
| 475 | bool globalWholeArchive = false; | |||
| 476 | // Handle -all_load | |||
| 477 | if (parsedArgs.getLastArg(OPT_all_load)) | |||
| 478 | globalWholeArchive = true; | |||
| 479 | ||||
| 480 | // Handle -install_name | |||
| 481 | if (llvm::opt::Arg *installName = parsedArgs.getLastArg(OPT_install_name)) | |||
| 482 | ctx.setInstallName(installName->getValue()); | |||
| 483 | else | |||
| 484 | ctx.setInstallName(ctx.outputPath()); | |||
| 485 | ||||
| 486 | // Handle -mark_dead_strippable_dylib | |||
| 487 | if (parsedArgs.getLastArg(OPT_mark_dead_strippable_dylib)) | |||
| 488 | ctx.setDeadStrippableDylib(true); | |||
| 489 | ||||
| 490 | // Handle -compatibility_version and -current_version | |||
| 491 | if (llvm::opt::Arg *vers = parsedArgs.getLastArg(OPT_compatibility_version)) { | |||
| 492 | if (ctx.outputMachOType() != llvm::MachO::MH_DYLIB) { | |||
| 493 | error("-compatibility_version can only be used with -dylib"); | |||
| 494 | return false; | |||
| 495 | } | |||
| 496 | uint32_t parsedVers; | |||
| 497 | if (MachOLinkingContext::parsePackedVersion(vers->getValue(), parsedVers)) { | |||
| 498 | error("-compatibility_version value is malformed"); | |||
| 499 | return false; | |||
| 500 | } | |||
| 501 | ctx.setCompatibilityVersion(parsedVers); | |||
| 502 | } | |||
| 503 | ||||
| 504 | if (llvm::opt::Arg *vers = parsedArgs.getLastArg(OPT_current_version)) { | |||
| 505 | if (ctx.outputMachOType() != llvm::MachO::MH_DYLIB) { | |||
| 506 | error("-current_version can only be used with -dylib"); | |||
| 507 | return false; | |||
| 508 | } | |||
| 509 | uint32_t parsedVers; | |||
| 510 | if (MachOLinkingContext::parsePackedVersion(vers->getValue(), parsedVers)) { | |||
| 511 | error("-current_version value is malformed"); | |||
| 512 | return false; | |||
| 513 | } | |||
| 514 | ctx.setCurrentVersion(parsedVers); | |||
| 515 | } | |||
| 516 | ||||
| 517 | // Handle -bundle_loader | |||
| 518 | if (llvm::opt::Arg *loader = parsedArgs.getLastArg(OPT_bundle_loader)) | |||
| 519 | ctx.setBundleLoader(loader->getValue()); | |||
| 520 | ||||
| 521 | // Handle -sectalign segname sectname align | |||
| 522 | for (auto &alignArg : parsedArgs.filtered(OPT_sectalign)) { | |||
| 523 | const char* segName = alignArg->getValue(0); | |||
| 524 | const char* sectName = alignArg->getValue(1); | |||
| 525 | const char* alignStr = alignArg->getValue(2); | |||
| 526 | if ((alignStr[0] == '0') && (alignStr[1] == 'x')) | |||
| 527 | alignStr += 2; | |||
| 528 | unsigned long long alignValue; | |||
| 529 | if (llvm::getAsUnsignedInteger(alignStr, 16, alignValue)) { | |||
| 530 | error("-sectalign alignment value '" + Twine(alignStr) + | |||
| 531 | "' not a valid number"); | |||
| 532 | return false; | |||
| 533 | } | |||
| 534 | uint16_t align = 1 << llvm::countTrailingZeros(alignValue); | |||
| 535 | if (!llvm::isPowerOf2_64(alignValue)) { | |||
| 536 | std::string Msg; | |||
| 537 | llvm::raw_string_ostream OS(Msg); | |||
| 538 | OS << "alignment for '-sectalign " << segName << " " << sectName | |||
| 539 | << llvm::format(" 0x%llX", alignValue) | |||
| 540 | << "' is not a power of two, using " << llvm::format("0x%08X", align); | |||
| 541 | OS.flush(); | |||
| 542 | warn(Msg); | |||
| 543 | } | |||
| 544 | ctx.addSectionAlignment(segName, sectName, align); | |||
| 545 | } | |||
| 546 | ||||
| 547 | // Handle -mllvm | |||
| 548 | for (auto &llvmArg : parsedArgs.filtered(OPT_mllvm)) { | |||
| 549 | ctx.appendLLVMOption(llvmArg->getValue()); | |||
| 550 | } | |||
| 551 | ||||
| 552 | // Handle -print_atoms | |||
| 553 | if (parsedArgs.getLastArg(OPT_print_atoms)) | |||
| 554 | ctx.setPrintAtoms(); | |||
| 555 | ||||
| 556 | // Handle -t (trace) option. | |||
| 557 | if (parsedArgs.getLastArg(OPT_t)) | |||
| 558 | ctx.setLogInputFiles(true); | |||
| 559 | ||||
| 560 | // Handle -demangle option. | |||
| 561 | if (parsedArgs.getLastArg(OPT_demangle)) | |||
| 562 | ctx.setDemangleSymbols(true); | |||
| 563 | ||||
| 564 | // Handle -keep_private_externs | |||
| 565 | if (parsedArgs.getLastArg(OPT_keep_private_externs)) { | |||
| 566 | ctx.setKeepPrivateExterns(true); | |||
| 567 | if (ctx.outputMachOType() != llvm::MachO::MH_OBJECT) | |||
| 568 | warn("-keep_private_externs only used in -r mode"); | |||
| 569 | } | |||
| 570 | ||||
| 571 | // Handle -dependency_info <path> used by Xcode. | |||
| 572 | if (llvm::opt::Arg *depInfo = parsedArgs.getLastArg(OPT_dependency_info)) | |||
| 573 | if (std::error_code ec = ctx.createDependencyFile(depInfo->getValue())) | |||
| 574 | warn(ec.message() + ", processing '-dependency_info " + | |||
| 575 | depInfo->getValue()); | |||
| 576 | ||||
| 577 | // In -test_file_usage mode, we'll be given an explicit list of paths that | |||
| 578 | // exist. We'll also be expected to print out information about how we located | |||
| 579 | // libraries and so on that the user specified, but not to actually do any | |||
| 580 | // linking. | |||
| 581 | if (parsedArgs.getLastArg(OPT_test_file_usage)) { | |||
| 582 | ctx.setTestingFileUsage(); | |||
| 583 | ||||
| 584 | // With paths existing by fiat, linking is not going to end well. | |||
| 585 | ctx.setDoNothing(true); | |||
| 586 | ||||
| 587 | // Only bother looking for an existence override if we're going to use it. | |||
| 588 | for (auto existingPath : parsedArgs.filtered(OPT_path_exists)) { | |||
| 589 | ctx.addExistingPathForDebug(existingPath->getValue()); | |||
| 590 | } | |||
| 591 | } | |||
| 592 | ||||
| 593 | // Register possible input file parsers. | |||
| 594 | if (!ctx.doNothing()) { | |||
| 595 | ctx.registry().addSupportMachOObjects(ctx); | |||
| 596 | ctx.registry().addSupportArchives(ctx.logInputFiles()); | |||
| 597 | ctx.registry().addSupportYamlFiles(); | |||
| 598 | } | |||
| 599 | ||||
| 600 | // Now construct the set of library search directories, following ld64's | |||
| 601 | // baroque set of accumulated hacks. Mostly, the algorithm constructs | |||
| 602 | // { syslibroots } x { libpaths } | |||
| 603 | // | |||
| 604 | // Unfortunately, there are numerous exceptions: | |||
| 605 | // 1. Only absolute paths get modified by syslibroot options. | |||
| 606 | // 2. If there is just 1 -syslibroot, system paths not found in it are | |||
| 607 | // skipped. | |||
| 608 | // 3. If the last -syslibroot is "/", all of them are ignored entirely. | |||
| 609 | // 4. If { syslibroots } x path == {}, the original path is kept. | |||
| 610 | std::vector<StringRef> sysLibRoots; | |||
| 611 | for (auto syslibRoot : parsedArgs.filtered(OPT_syslibroot)) { | |||
| 612 | sysLibRoots.push_back(syslibRoot->getValue()); | |||
| 613 | } | |||
| 614 | if (!sysLibRoots.empty()) { | |||
| 615 | // Ignore all if last -syslibroot is "/". | |||
| 616 | if (sysLibRoots.back() != "/") | |||
| 617 | ctx.setSysLibRoots(sysLibRoots); | |||
| 618 | } | |||
| 619 | ||||
| 620 | // Paths specified with -L come first, and are not considered system paths for | |||
| 621 | // the case where there is precisely 1 -syslibroot. | |||
| 622 | for (auto libPath : parsedArgs.filtered(OPT_L)) { | |||
| 623 | ctx.addModifiedSearchDir(libPath->getValue()); | |||
| 624 | } | |||
| 625 | ||||
| 626 | // Process -F directories (where to look for frameworks). | |||
| 627 | for (auto fwPath : parsedArgs.filtered(OPT_F)) { | |||
| 628 | ctx.addFrameworkSearchDir(fwPath->getValue()); | |||
| 629 | } | |||
| 630 | ||||
| 631 | // -Z suppresses the standard search paths. | |||
| 632 | if (!parsedArgs.hasArg(OPT_Z)) { | |||
| 633 | ctx.addModifiedSearchDir("/usr/lib", true); | |||
| 634 | ctx.addModifiedSearchDir("/usr/local/lib", true); | |||
| 635 | ctx.addFrameworkSearchDir("/Library/Frameworks", true); | |||
| 636 | ctx.addFrameworkSearchDir("/System/Library/Frameworks", true); | |||
| 637 | } | |||
| 638 | ||||
| 639 | // Now that we've constructed the final set of search paths, print out those | |||
| 640 | // search paths in verbose mode. | |||
| 641 | if (errorHandler().Verbose) { | |||
| 642 | message("Library search paths:"); | |||
| 643 | for (auto path : ctx.searchDirs()) { | |||
| 644 | message(" " + path); | |||
| 645 | } | |||
| 646 | message("Framework search paths:"); | |||
| 647 | for (auto path : ctx.frameworkDirs()) { | |||
| 648 | message(" " + path); | |||
| 649 | } | |||
| 650 | } | |||
| 651 | ||||
| 652 | // Handle -exported_symbols_list <file> | |||
| 653 | for (auto expFile : parsedArgs.filtered(OPT_exported_symbols_list)) { | |||
| 654 | if (ctx.exportMode() == MachOLinkingContext::ExportMode::blackList) { | |||
| 655 | error("-exported_symbols_list cannot be combined with " | |||
| 656 | "-unexported_symbol[s_list]"); | |||
| 657 | return false; | |||
| 658 | } | |||
| 659 | ctx.setExportMode(MachOLinkingContext::ExportMode::whiteList); | |||
| 660 | if (std::error_code ec = parseExportsList(expFile->getValue(), ctx)) { | |||
| 661 | error(ec.message() + ", processing '-exported_symbols_list " + | |||
| 662 | expFile->getValue()); | |||
| 663 | return false; | |||
| 664 | } | |||
| 665 | } | |||
| 666 | ||||
| 667 | // Handle -exported_symbol <symbol> | |||
| 668 | for (auto symbol : parsedArgs.filtered(OPT_exported_symbol)) { | |||
| 669 | if (ctx.exportMode() == MachOLinkingContext::ExportMode::blackList) { | |||
| 670 | error("-exported_symbol cannot be combined with " | |||
| 671 | "-unexported_symbol[s_list]"); | |||
| 672 | return false; | |||
| 673 | } | |||
| 674 | ctx.setExportMode(MachOLinkingContext::ExportMode::whiteList); | |||
| 675 | ctx.addExportSymbol(symbol->getValue()); | |||
| 676 | } | |||
| 677 | ||||
| 678 | // Handle -unexported_symbols_list <file> | |||
| 679 | for (auto expFile : parsedArgs.filtered(OPT_unexported_symbols_list)) { | |||
| 680 | if (ctx.exportMode() == MachOLinkingContext::ExportMode::whiteList) { | |||
| 681 | error("-unexported_symbols_list cannot be combined with " | |||
| 682 | "-exported_symbol[s_list]"); | |||
| 683 | return false; | |||
| 684 | } | |||
| 685 | ctx.setExportMode(MachOLinkingContext::ExportMode::blackList); | |||
| 686 | if (std::error_code ec = parseExportsList(expFile->getValue(), ctx)) { | |||
| 687 | error(ec.message() + ", processing '-unexported_symbols_list " + | |||
| 688 | expFile->getValue()); | |||
| 689 | return false; | |||
| 690 | } | |||
| 691 | } | |||
| 692 | ||||
| 693 | // Handle -unexported_symbol <symbol> | |||
| 694 | for (auto symbol : parsedArgs.filtered(OPT_unexported_symbol)) { | |||
| 695 | if (ctx.exportMode() == MachOLinkingContext::ExportMode::whiteList) { | |||
| 696 | error("-unexported_symbol cannot be combined with " | |||
| 697 | "-exported_symbol[s_list]"); | |||
| 698 | return false; | |||
| 699 | } | |||
| 700 | ctx.setExportMode(MachOLinkingContext::ExportMode::blackList); | |||
| 701 | ctx.addExportSymbol(symbol->getValue()); | |||
| 702 | } | |||
| 703 | ||||
| 704 | // Handle obosolete -multi_module and -single_module | |||
| 705 | if (llvm::opt::Arg *mod = | |||
| 706 | parsedArgs.getLastArg(OPT_multi_module, OPT_single_module)) { | |||
| 707 | if (mod->getOption().getID() == OPT_multi_module) | |||
| 708 | warn("-multi_module is obsolete and being ignored"); | |||
| 709 | else if (ctx.outputMachOType() != llvm::MachO::MH_DYLIB) | |||
| 710 | warn("-single_module being ignored. It is only for use when producing a " | |||
| 711 | "dylib"); | |||
| 712 | } | |||
| 713 | ||||
| 714 | // Handle obsolete ObjC options: -objc_gc_compaction, -objc_gc, -objc_gc_only | |||
| 715 | if (parsedArgs.getLastArg(OPT_objc_gc_compaction)) { | |||
| 716 | error("-objc_gc_compaction is not supported"); | |||
| 717 | return false; | |||
| 718 | } | |||
| 719 | ||||
| 720 | if (parsedArgs.getLastArg(OPT_objc_gc)) { | |||
| 721 | error("-objc_gc is not supported"); | |||
| 722 | return false; | |||
| 723 | } | |||
| 724 | ||||
| 725 | if (parsedArgs.getLastArg(OPT_objc_gc_only)) { | |||
| 726 | error("-objc_gc_only is not supported"); | |||
| 727 | return false; | |||
| 728 | } | |||
| 729 | ||||
| 730 | // Handle -pie or -no_pie | |||
| 731 | if (llvm::opt::Arg *pie = parsedArgs.getLastArg(OPT_pie, OPT_no_pie)) { | |||
| 732 | switch (ctx.outputMachOType()) { | |||
| 733 | case llvm::MachO::MH_EXECUTE: | |||
| 734 | switch (ctx.os()) { | |||
| 735 | case MachOLinkingContext::OS::macOSX: | |||
| 736 | if ((minOSVersion < 0x000A0500) && | |||
| 737 | (pie->getOption().getID() == OPT_pie)) { | |||
| 738 | error("-pie can only be used when targeting Mac OS X 10.5 or later"); | |||
| 739 | return false; | |||
| 740 | } | |||
| 741 | break; | |||
| 742 | case MachOLinkingContext::OS::iOS: | |||
| 743 | if ((minOSVersion < 0x00040200) && | |||
| 744 | (pie->getOption().getID() == OPT_pie)) { | |||
| 745 | error("-pie can only be used when targeting iOS 4.2 or later"); | |||
| 746 | return false; | |||
| 747 | } | |||
| 748 | break; | |||
| 749 | case MachOLinkingContext::OS::iOS_simulator: | |||
| 750 | if (pie->getOption().getID() == OPT_no_pie) { | |||
| 751 | error("iOS simulator programs must be built PIE"); | |||
| 752 | return false; | |||
| 753 | } | |||
| 754 | break; | |||
| 755 | case MachOLinkingContext::OS::unknown: | |||
| 756 | break; | |||
| 757 | } | |||
| 758 | ctx.setPIE(pie->getOption().getID() == OPT_pie); | |||
| 759 | break; | |||
| 760 | case llvm::MachO::MH_PRELOAD: | |||
| 761 | break; | |||
| 762 | case llvm::MachO::MH_DYLIB: | |||
| 763 | case llvm::MachO::MH_BUNDLE: | |||
| 764 | warn(pie->getSpelling() + | |||
| 765 | " being ignored. It is only used when linking main executables"); | |||
| 766 | break; | |||
| 767 | default: | |||
| 768 | error(pie->getSpelling() + | |||
| 769 | " can only used when linking main executables"); | |||
| 770 | return false; | |||
| 771 | } | |||
| 772 | } | |||
| 773 | ||||
| 774 | // Handle -version_load_command or -no_version_load_command | |||
| 775 | { | |||
| 776 | bool flagOn = false; | |||
| 777 | bool flagOff = false; | |||
| 778 | if (auto *arg = parsedArgs.getLastArg(OPT_version_load_command, | |||
| 779 | OPT_no_version_load_command)) { | |||
| 780 | flagOn = arg->getOption().getID() == OPT_version_load_command; | |||
| 781 | flagOff = arg->getOption().getID() == OPT_no_version_load_command; | |||
| 782 | } | |||
| 783 | ||||
| 784 | // default to adding version load command for dynamic code, | |||
| 785 | // static code must opt-in | |||
| 786 | switch (ctx.outputMachOType()) { | |||
| 787 | case llvm::MachO::MH_OBJECT: | |||
| 788 | ctx.setGenerateVersionLoadCommand(false); | |||
| 789 | break; | |||
| 790 | case llvm::MachO::MH_EXECUTE: | |||
| 791 | // dynamic executables default to generating a version load command, | |||
| 792 | // while static exectuables only generate it if required. | |||
| 793 | if (isStaticExecutable) { | |||
| 794 | if (flagOn) | |||
| 795 | ctx.setGenerateVersionLoadCommand(true); | |||
| 796 | } else { | |||
| 797 | if (!flagOff) | |||
| 798 | ctx.setGenerateVersionLoadCommand(true); | |||
| 799 | } | |||
| 800 | break; | |||
| 801 | case llvm::MachO::MH_PRELOAD: | |||
| 802 | case llvm::MachO::MH_KEXT_BUNDLE: | |||
| 803 | if (flagOn) | |||
| 804 | ctx.setGenerateVersionLoadCommand(true); | |||
| 805 | break; | |||
| 806 | case llvm::MachO::MH_DYLINKER: | |||
| 807 | case llvm::MachO::MH_DYLIB: | |||
| 808 | case llvm::MachO::MH_BUNDLE: | |||
| 809 | if (!flagOff) | |||
| 810 | ctx.setGenerateVersionLoadCommand(true); | |||
| 811 | break; | |||
| 812 | case llvm::MachO::MH_FVMLIB: | |||
| 813 | case llvm::MachO::MH_DYLDLINK: | |||
| 814 | case llvm::MachO::MH_DYLIB_STUB: | |||
| 815 | case llvm::MachO::MH_DSYM: | |||
| 816 | // We don't generate load commands for these file types, even if | |||
| 817 | // forced on. | |||
| 818 | break; | |||
| 819 | } | |||
| 820 | } | |||
| 821 | ||||
| 822 | // Handle -function_starts or -no_function_starts | |||
| 823 | { | |||
| 824 | bool flagOn = false; | |||
| 825 | bool flagOff = false; | |||
| 826 | if (auto *arg = parsedArgs.getLastArg(OPT_function_starts, | |||
| 827 | OPT_no_function_starts)) { | |||
| 828 | flagOn = arg->getOption().getID() == OPT_function_starts; | |||
| 829 | flagOff = arg->getOption().getID() == OPT_no_function_starts; | |||
| 830 | } | |||
| 831 | ||||
| 832 | // default to adding functions start for dynamic code, static code must | |||
| 833 | // opt-in | |||
| 834 | switch (ctx.outputMachOType()) { | |||
| 835 | case llvm::MachO::MH_OBJECT: | |||
| 836 | ctx.setGenerateFunctionStartsLoadCommand(false); | |||
| 837 | break; | |||
| 838 | case llvm::MachO::MH_EXECUTE: | |||
| 839 | // dynamic executables default to generating a version load command, | |||
| 840 | // while static exectuables only generate it if required. | |||
| 841 | if (isStaticExecutable) { | |||
| 842 | if (flagOn) | |||
| 843 | ctx.setGenerateFunctionStartsLoadCommand(true); | |||
| 844 | } else { | |||
| 845 | if (!flagOff) | |||
| 846 | ctx.setGenerateFunctionStartsLoadCommand(true); | |||
| 847 | } | |||
| 848 | break; | |||
| 849 | case llvm::MachO::MH_PRELOAD: | |||
| 850 | case llvm::MachO::MH_KEXT_BUNDLE: | |||
| 851 | if (flagOn) | |||
| 852 | ctx.setGenerateFunctionStartsLoadCommand(true); | |||
| 853 | break; | |||
| 854 | case llvm::MachO::MH_DYLINKER: | |||
| 855 | case llvm::MachO::MH_DYLIB: | |||
| 856 | case llvm::MachO::MH_BUNDLE: | |||
| 857 | if (!flagOff) | |||
| 858 | ctx.setGenerateFunctionStartsLoadCommand(true); | |||
| 859 | break; | |||
| 860 | case llvm::MachO::MH_FVMLIB: | |||
| 861 | case llvm::MachO::MH_DYLDLINK: | |||
| 862 | case llvm::MachO::MH_DYLIB_STUB: | |||
| 863 | case llvm::MachO::MH_DSYM: | |||
| 864 | // We don't generate load commands for these file types, even if | |||
| 865 | // forced on. | |||
| 866 | break; | |||
| 867 | } | |||
| 868 | } | |||
| 869 | ||||
| 870 | // Handle -data_in_code_info or -no_data_in_code_info | |||
| 871 | { | |||
| 872 | bool flagOn = false; | |||
| 873 | bool flagOff = false; | |||
| 874 | if (auto *arg = parsedArgs.getLastArg(OPT_data_in_code_info, | |||
| 875 | OPT_no_data_in_code_info)) { | |||
| 876 | flagOn = arg->getOption().getID() == OPT_data_in_code_info; | |||
| 877 | flagOff = arg->getOption().getID() == OPT_no_data_in_code_info; | |||
| 878 | } | |||
| 879 | ||||
| 880 | // default to adding data in code for dynamic code, static code must | |||
| 881 | // opt-in | |||
| 882 | switch (ctx.outputMachOType()) { | |||
| 883 | case llvm::MachO::MH_OBJECT: | |||
| 884 | if (!flagOff) | |||
| 885 | ctx.setGenerateDataInCodeLoadCommand(true); | |||
| 886 | break; | |||
| 887 | case llvm::MachO::MH_EXECUTE: | |||
| 888 | // dynamic executables default to generating a version load command, | |||
| 889 | // while static exectuables only generate it if required. | |||
| 890 | if (isStaticExecutable) { | |||
| 891 | if (flagOn) | |||
| 892 | ctx.setGenerateDataInCodeLoadCommand(true); | |||
| 893 | } else { | |||
| 894 | if (!flagOff) | |||
| 895 | ctx.setGenerateDataInCodeLoadCommand(true); | |||
| 896 | } | |||
| 897 | break; | |||
| 898 | case llvm::MachO::MH_PRELOAD: | |||
| 899 | case llvm::MachO::MH_KEXT_BUNDLE: | |||
| 900 | if (flagOn) | |||
| 901 | ctx.setGenerateDataInCodeLoadCommand(true); | |||
| 902 | break; | |||
| 903 | case llvm::MachO::MH_DYLINKER: | |||
| 904 | case llvm::MachO::MH_DYLIB: | |||
| 905 | case llvm::MachO::MH_BUNDLE: | |||
| 906 | if (!flagOff) | |||
| 907 | ctx.setGenerateDataInCodeLoadCommand(true); | |||
| 908 | break; | |||
| 909 | case llvm::MachO::MH_FVMLIB: | |||
| 910 | case llvm::MachO::MH_DYLDLINK: | |||
| 911 | case llvm::MachO::MH_DYLIB_STUB: | |||
| 912 | case llvm::MachO::MH_DSYM: | |||
| 913 | // We don't generate load commands for these file types, even if | |||
| 914 | // forced on. | |||
| 915 | break; | |||
| 916 | } | |||
| 917 | } | |||
| 918 | ||||
| 919 | // Handle sdk_version | |||
| 920 | if (llvm::opt::Arg *arg = parsedArgs.getLastArg(OPT_sdk_version)) { | |||
| 921 | uint32_t sdkVersion = 0; | |||
| 922 | if (MachOLinkingContext::parsePackedVersion(arg->getValue(), | |||
| 923 | sdkVersion)) { | |||
| 924 | error("malformed sdkVersion value"); | |||
| 925 | return false; | |||
| 926 | } | |||
| 927 | ctx.setSdkVersion(sdkVersion); | |||
| 928 | } else if (ctx.generateVersionLoadCommand()) { | |||
| 929 | // If we don't have an sdk version, but were going to emit a load command | |||
| 930 | // with min_version, then we need to give an warning as we have no sdk | |||
| 931 | // version to put in that command. | |||
| 932 | // FIXME: We need to decide whether to make this an error. | |||
| 933 | warn("-sdk_version is required when emitting min version load command. " | |||
| 934 | "Setting sdk version to match provided min version"); | |||
| 935 | ctx.setSdkVersion(ctx.osMinVersion()); | |||
| 936 | } | |||
| 937 | ||||
| 938 | // Handle source_version | |||
| 939 | if (llvm::opt::Arg *arg = parsedArgs.getLastArg(OPT_source_version)) { | |||
| 940 | uint64_t version = 0; | |||
| 941 | if (MachOLinkingContext::parsePackedVersion(arg->getValue(), | |||
| 942 | version)) { | |||
| 943 | error("malformed source_version value"); | |||
| 944 | return false; | |||
| 945 | } | |||
| 946 | ctx.setSourceVersion(version); | |||
| 947 | } | |||
| 948 | ||||
| 949 | // Handle stack_size | |||
| 950 | if (llvm::opt::Arg *stackSize = parsedArgs.getLastArg(OPT_stack_size)) { | |||
| 951 | uint64_t stackSizeVal; | |||
| 952 | if (parseNumberBase16(stackSize->getValue(), stackSizeVal)) { | |||
| 953 | error("stack_size expects a hex number"); | |||
| 954 | return false; | |||
| 955 | } | |||
| 956 | if ((stackSizeVal % ctx.pageSize()) != 0) { | |||
| 957 | error("stack_size must be a multiple of page size (0x" + | |||
| 958 | llvm::utohexstr(ctx.pageSize()) + ")"); | |||
| 959 | return false; | |||
| 960 | } | |||
| 961 | ||||
| 962 | ctx.setStackSize(stackSizeVal); | |||
| 963 | } | |||
| 964 | ||||
| 965 | // Handle debug info handling options: -S | |||
| 966 | if (parsedArgs.hasArg(OPT_S)) | |||
| 967 | ctx.setDebugInfoMode(MachOLinkingContext::DebugInfoMode::noDebugMap); | |||
| 968 | ||||
| 969 | // Handle -order_file <file> | |||
| 970 | for (auto orderFile : parsedArgs.filtered(OPT_order_file)) { | |||
| 971 | if (std::error_code ec = parseOrderFile(orderFile->getValue(), ctx)) { | |||
| 972 | error(ec.message() + ", processing '-order_file " + orderFile->getValue() | |||
| 973 | + "'"); | |||
| 974 | return false; | |||
| 975 | } | |||
| 976 | } | |||
| 977 | ||||
| 978 | // Handle -flat_namespace. | |||
| 979 | if (llvm::opt::Arg *ns = | |||
| 980 | parsedArgs.getLastArg(OPT_flat_namespace, OPT_twolevel_namespace)) { | |||
| 981 | if (ns->getOption().getID() == OPT_flat_namespace) | |||
| 982 | ctx.setUseFlatNamespace(true); | |||
| 983 | } | |||
| 984 | ||||
| 985 | // Handle -undefined | |||
| 986 | if (llvm::opt::Arg *undef = parsedArgs.getLastArg(OPT_undefined)) { | |||
| 987 | MachOLinkingContext::UndefinedMode UndefMode; | |||
| 988 | if (StringRef(undef->getValue()).equals("error")) | |||
| 989 | UndefMode = MachOLinkingContext::UndefinedMode::error; | |||
| 990 | else if (StringRef(undef->getValue()).equals("warning")) | |||
| 991 | UndefMode = MachOLinkingContext::UndefinedMode::warning; | |||
| 992 | else if (StringRef(undef->getValue()).equals("suppress")) | |||
| 993 | UndefMode = MachOLinkingContext::UndefinedMode::suppress; | |||
| 994 | else if (StringRef(undef->getValue()).equals("dynamic_lookup")) | |||
| 995 | UndefMode = MachOLinkingContext::UndefinedMode::dynamicLookup; | |||
| 996 | else { | |||
| 997 | error("invalid option to -undefined [ warning | error | suppress | " | |||
| 998 | "dynamic_lookup ]"); | |||
| 999 | return false; | |||
| 1000 | } | |||
| 1001 | ||||
| 1002 | if (ctx.useFlatNamespace()) { | |||
| 1003 | // If we're using -flat_namespace then 'warning', 'suppress' and | |||
| 1004 | // 'dynamic_lookup' are all equivalent, so map them to 'suppress'. | |||
| 1005 | if (UndefMode != MachOLinkingContext::UndefinedMode::error) | |||
| 1006 | UndefMode = MachOLinkingContext::UndefinedMode::suppress; | |||
| 1007 | } else { | |||
| 1008 | // If we're using -twolevel_namespace then 'warning' and 'suppress' are | |||
| 1009 | // illegal. Emit a diagnostic if they've been (mis)used. | |||
| 1010 | if (UndefMode == MachOLinkingContext::UndefinedMode::warning || | |||
| 1011 | UndefMode == MachOLinkingContext::UndefinedMode::suppress) { | |||
| 1012 | error("can't use -undefined warning or suppress with " | |||
| 1013 | "-twolevel_namespace"); | |||
| 1014 | return false; | |||
| 1015 | } | |||
| 1016 | } | |||
| 1017 | ||||
| 1018 | ctx.setUndefinedMode(UndefMode); | |||
| 1019 | } | |||
| 1020 | ||||
| 1021 | // Handle -no_objc_category_merging. | |||
| 1022 | if (parsedArgs.getLastArg(OPT_no_objc_category_merging)) | |||
| 1023 | ctx.setMergeObjCCategories(false); | |||
| 1024 | ||||
| 1025 | // Handle -rpath <path> | |||
| 1026 | if (parsedArgs.hasArg(OPT_rpath)) { | |||
| 1027 | switch (ctx.outputMachOType()) { | |||
| 1028 | case llvm::MachO::MH_EXECUTE: | |||
| 1029 | case llvm::MachO::MH_DYLIB: | |||
| 1030 | case llvm::MachO::MH_BUNDLE: | |||
| 1031 | if (!ctx.minOS("10.5", "2.0")) { | |||
| 1032 | if (ctx.os() == MachOLinkingContext::OS::macOSX) | |||
| 1033 | error("-rpath can only be used when targeting OS X 10.5 or later"); | |||
| 1034 | else | |||
| 1035 | error("-rpath can only be used when targeting iOS 2.0 or later"); | |||
| 1036 | return false; | |||
| 1037 | } | |||
| 1038 | break; | |||
| 1039 | default: | |||
| 1040 | error("-rpath can only be used when creating a dynamic final linked " | |||
| 1041 | "image"); | |||
| 1042 | return false; | |||
| 1043 | } | |||
| 1044 | ||||
| 1045 | for (auto rPath : parsedArgs.filtered(OPT_rpath)) { | |||
| 1046 | ctx.addRpath(rPath->getValue()); | |||
| 1047 | } | |||
| 1048 | } | |||
| 1049 | ||||
| 1050 | // Parse the LLVM options before we process files in case the file handling | |||
| 1051 | // makes use of things like LLVM_DEBUG(). | |||
| 1052 | parseLLVMOptions(ctx); | |||
| 1053 | ||||
| 1054 | // Handle input files and sectcreate. | |||
| 1055 | for (auto &arg : parsedArgs) { | |||
| 1056 | bool upward; | |||
| 1057 | llvm::Optional<StringRef> resolvedPath; | |||
| 1058 | switch (arg->getOption().getID()) { | |||
| 1059 | default: | |||
| 1060 | continue; | |||
| 1061 | case OPT_INPUT: | |||
| 1062 | addFile(arg->getValue(), ctx, globalWholeArchive, false); | |||
| 1063 | break; | |||
| 1064 | case OPT_upward_library: | |||
| 1065 | addFile(arg->getValue(), ctx, false, true); | |||
| 1066 | break; | |||
| 1067 | case OPT_force_load: | |||
| 1068 | addFile(arg->getValue(), ctx, true, false); | |||
| 1069 | break; | |||
| 1070 | case OPT_l: | |||
| 1071 | case OPT_upward_l: | |||
| 1072 | upward = (arg->getOption().getID() == OPT_upward_l); | |||
| 1073 | resolvedPath = ctx.searchLibrary(arg->getValue()); | |||
| 1074 | if (!resolvedPath) { | |||
| 1075 | error("Unable to find library for " + arg->getSpelling() + | |||
| 1076 | arg->getValue()); | |||
| 1077 | return false; | |||
| 1078 | } else if (ctx.testingFileUsage()) { | |||
| 1079 | message(Twine("Found ") + (upward ? "upward " : " ") + "library " + | |||
| 1080 | canonicalizePath(resolvedPath.getValue())); | |||
| 1081 | } | |||
| 1082 | addFile(resolvedPath.getValue(), ctx, globalWholeArchive, upward); | |||
| 1083 | break; | |||
| 1084 | case OPT_framework: | |||
| 1085 | case OPT_upward_framework: | |||
| 1086 | upward = (arg->getOption().getID() == OPT_upward_framework); | |||
| 1087 | resolvedPath = ctx.findPathForFramework(arg->getValue()); | |||
| 1088 | if (!resolvedPath) { | |||
| 1089 | error("Unable to find framework for " + arg->getSpelling() + " " + | |||
| 1090 | arg->getValue()); | |||
| 1091 | return false; | |||
| 1092 | } else if (ctx.testingFileUsage()) { | |||
| 1093 | message(Twine("Found ") + (upward ? "upward " : " ") + "framework " + | |||
| 1094 | canonicalizePath(resolvedPath.getValue())); | |||
| 1095 | } | |||
| 1096 | addFile(resolvedPath.getValue(), ctx, globalWholeArchive, upward); | |||
| 1097 | break; | |||
| 1098 | case OPT_filelist: | |||
| 1099 | if (auto ec = loadFileList(arg->getValue(), ctx, globalWholeArchive)) { | |||
| 1100 | handleAllErrors(std::move(ec), [&](const llvm::ErrorInfoBase &EI) { | |||
| 1101 | error(EI.message() + ", processing '-filelist " + arg->getValue()); | |||
| 1102 | }); | |||
| 1103 | return false; | |||
| 1104 | } | |||
| 1105 | break; | |||
| 1106 | case OPT_sectcreate: { | |||
| 1107 | const char* seg = arg->getValue(0); | |||
| 1108 | const char* sect = arg->getValue(1); | |||
| 1109 | const char* fileName = arg->getValue(2); | |||
| 1110 | ||||
| 1111 | ErrorOr<std::unique_ptr<MemoryBuffer>> contentOrErr = | |||
| 1112 | MemoryBuffer::getFile(fileName); | |||
| 1113 | ||||
| 1114 | if (!contentOrErr) { | |||
| 1115 | error("can't open -sectcreate file " + Twine(fileName)); | |||
| 1116 | return false; | |||
| 1117 | } | |||
| 1118 | ||||
| 1119 | ctx.addSectCreateSection(seg, sect, std::move(*contentOrErr)); | |||
| 1120 | } | |||
| 1121 | break; | |||
| 1122 | } | |||
| 1123 | } | |||
| 1124 | ||||
| 1125 | if (ctx.getNodes().empty()) { | |||
| 1126 | error("No input files"); | |||
| 1127 | return false; | |||
| 1128 | } | |||
| 1129 | ||||
| 1130 | // Validate the combination of options used. | |||
| 1131 | return ctx.validate(); | |||
| 1132 | } | |||
| 1133 | ||||
| 1134 | static void createFiles(MachOLinkingContext &ctx, bool Implicit) { | |||
| 1135 | std::vector<std::unique_ptr<File>> Files; | |||
| 1136 | if (Implicit) | |||
| 1137 | ctx.createImplicitFiles(Files); | |||
| 1138 | else | |||
| 1139 | ctx.createInternalFiles(Files); | |||
| 1140 | for (auto i = Files.rbegin(), e = Files.rend(); i != e; ++i) { | |||
| 1141 | auto &members = ctx.getNodes(); | |||
| 1142 | members.insert(members.begin(), llvm::make_unique<FileNode>(std::move(*i))); | |||
| 1143 | } | |||
| 1144 | } | |||
| 1145 | ||||
| 1146 | /// This is where the link is actually performed. | |||
| 1147 | bool link(llvm::ArrayRef<const char *> args, bool CanExitEarly, | |||
| 1148 | raw_ostream &Error) { | |||
| 1149 | errorHandler().LogName = args::getFilenameWithoutExe(args[0]); | |||
| 1150 | errorHandler().ErrorLimitExceededMsg = | |||
| 1151 | "too many errors emitted, stopping now (use " | |||
| 1152 | "'-error-limit 0' to see all errors)"; | |||
| 1153 | errorHandler().ErrorOS = &Error; | |||
| 1154 | errorHandler().ExitEarly = CanExitEarly; | |||
| 1155 | errorHandler().ColorDiagnostics = Error.has_colors(); | |||
| 1156 | ||||
| 1157 | MachOLinkingContext ctx; | |||
| 1158 | if (!parse(args, ctx)) | |||
| 1159 | return false; | |||
| 1160 | if (ctx.doNothing()) | |||
| 1161 | return true; | |||
| 1162 | if (ctx.getNodes().empty()) | |||
| 1163 | return false; | |||
| 1164 | ||||
| 1165 | for (std::unique_ptr<Node> &ie : ctx.getNodes()) | |||
| 1166 | if (FileNode *node = dyn_cast<FileNode>(ie.get())) | |||
| 1167 | node->getFile()->parse(); | |||
| 1168 | ||||
| 1169 | createFiles(ctx, false /* Implicit */); | |||
| 1170 | ||||
| 1171 | // Give target a chance to add files | |||
| 1172 | createFiles(ctx, true /* Implicit */); | |||
| 1173 | ||||
| 1174 | // Give target a chance to postprocess input files. | |||
| 1175 | // Mach-O uses this chance to move all object files before library files. | |||
| 1176 | ctx.finalizeInputFiles(); | |||
| 1177 | ||||
| 1178 | // Do core linking. | |||
| 1179 | ScopedTask resolveTask(getDefaultDomain(), "Resolve"); | |||
| 1180 | Resolver resolver(ctx); | |||
| 1181 | if (!resolver.resolve()) | |||
| 1182 | return false; | |||
| 1183 | SimpleFile *merged = nullptr; | |||
| 1184 | { | |||
| 1185 | std::unique_ptr<SimpleFile> mergedFile = resolver.resultFile(); | |||
| 1186 | merged = mergedFile.get(); | |||
| 1187 | auto &members = ctx.getNodes(); | |||
| 1188 | members.insert(members.begin(), | |||
| 1189 | llvm::make_unique<FileNode>(std::move(mergedFile))); | |||
| 1190 | } | |||
| 1191 | resolveTask.end(); | |||
| 1192 | ||||
| 1193 | // Run passes on linked atoms. | |||
| 1194 | ScopedTask passTask(getDefaultDomain(), "Passes"); | |||
| 1195 | PassManager pm; | |||
| 1196 | ctx.addPasses(pm); | |||
| 1197 | if (auto ec = pm.runOnFile(*merged)) { | |||
| 1198 | // FIXME: This should be passed to logAllUnhandledErrors but it needs | |||
| 1199 | // to be passed a Twine instead of a string. | |||
| 1200 | *errorHandler().ErrorOS << "Failed to run passes on file '" | |||
| 1201 | << ctx.outputPath() << "': "; | |||
| 1202 | logAllUnhandledErrors(std::move(ec), *errorHandler().ErrorOS, | |||
| 1203 | std::string()); | |||
| 1204 | return false; | |||
| 1205 | } | |||
| 1206 | ||||
| 1207 | passTask.end(); | |||
| 1208 | ||||
| 1209 | // Give linked atoms to Writer to generate output file. | |||
| 1210 | ScopedTask writeTask(getDefaultDomain(), "Write"); | |||
| 1211 | if (auto ec = ctx.writeFile(*merged)) { | |||
| 1212 | // FIXME: This should be passed to logAllUnhandledErrors but it needs | |||
| 1213 | // to be passed a Twine instead of a string. | |||
| 1214 | *errorHandler().ErrorOS << "Failed to write file '" << ctx.outputPath() | |||
| 1215 | << "': "; | |||
| 1216 | logAllUnhandledErrors(std::move(ec), *errorHandler().ErrorOS, | |||
| 1217 | std::string()); | |||
| 1218 | return false; | |||
| 1219 | } | |||
| 1220 | ||||
| 1221 | // Call exit() if we can to avoid calling destructors. | |||
| 1222 | if (CanExitEarly) | |||
| 1223 | exitLld(errorCount() ? 1 : 0); | |||
| 1224 | ||||
| 1225 | ||||
| 1226 | return true; | |||
| 1227 | } | |||
| 1228 | ||||
| 1229 | } // end namespace mach_o | |||
| 1230 | } // end namespace lld |
| 1 | //===- llvm/Support/Error.h - Recoverable error handling --------*- C++ -*-===// | |||
| 2 | // | |||
| 3 | // The LLVM Compiler Infrastructure | |||
| 4 | // | |||
| 5 | // This file is distributed under the University of Illinois Open Source | |||
| 6 | // License. See LICENSE.TXT for details. | |||
| 7 | // | |||
| 8 | //===----------------------------------------------------------------------===// | |||
| 9 | // | |||
| 10 | // This file defines an API used to report recoverable errors. | |||
| 11 | // | |||
| 12 | //===----------------------------------------------------------------------===// | |||
| 13 | ||||
| 14 | #ifndef LLVM_SUPPORT_ERROR_H | |||
| 15 | #define LLVM_SUPPORT_ERROR_H | |||
| 16 | ||||
| 17 | #include "llvm-c/Error.h" | |||
| 18 | #include "llvm/ADT/STLExtras.h" | |||
| 19 | #include "llvm/ADT/SmallVector.h" | |||
| 20 | #include "llvm/ADT/StringExtras.h" | |||
| 21 | #include "llvm/ADT/Twine.h" | |||
| 22 | #include "llvm/Config/abi-breaking.h" | |||
| 23 | #include "llvm/Support/AlignOf.h" | |||
| 24 | #include "llvm/Support/Compiler.h" | |||
| 25 | #include "llvm/Support/Debug.h" | |||
| 26 | #include "llvm/Support/ErrorHandling.h" | |||
| 27 | #include "llvm/Support/ErrorOr.h" | |||
| 28 | #include "llvm/Support/Format.h" | |||
| 29 | #include "llvm/Support/raw_ostream.h" | |||
| 30 | #include <algorithm> | |||
| 31 | #include <cassert> | |||
| 32 | #include <cstdint> | |||
| 33 | #include <cstdlib> | |||
| 34 | #include <functional> | |||
| 35 | #include <memory> | |||
| 36 | #include <new> | |||
| 37 | #include <string> | |||
| 38 | #include <system_error> | |||
| 39 | #include <type_traits> | |||
| 40 | #include <utility> | |||
| 41 | #include <vector> | |||
| 42 | ||||
| 43 | namespace llvm { | |||
| 44 | ||||
| 45 | class ErrorSuccess; | |||
| 46 | ||||
| 47 | /// Base class for error info classes. Do not extend this directly: Extend | |||
| 48 | /// the ErrorInfo template subclass instead. | |||
| 49 | class ErrorInfoBase { | |||
| 50 | public: | |||
| 51 | virtual ~ErrorInfoBase() = default; | |||
| 52 | ||||
| 53 | /// Print an error message to an output stream. | |||
| 54 | virtual void log(raw_ostream &OS) const = 0; | |||
| 55 | ||||
| 56 | /// Return the error message as a string. | |||
| 57 | virtual std::string message() const { | |||
| 58 | std::string Msg; | |||
| 59 | raw_string_ostream OS(Msg); | |||
| 60 | log(OS); | |||
| 61 | return OS.str(); | |||
| 62 | } | |||
| 63 | ||||
| 64 | /// Convert this error to a std::error_code. | |||
| 65 | /// | |||
| 66 | /// This is a temporary crutch to enable interaction with code still | |||
| 67 | /// using std::error_code. It will be removed in the future. | |||
| 68 | virtual std::error_code convertToErrorCode() const = 0; | |||
| 69 | ||||
| 70 | // Returns the class ID for this type. | |||
| 71 | static const void *classID() { return &ID; } | |||
| 72 | ||||
| 73 | // Returns the class ID for the dynamic type of this ErrorInfoBase instance. | |||
| 74 | virtual const void *dynamicClassID() const = 0; | |||
| 75 | ||||
| 76 | // Check whether this instance is a subclass of the class identified by | |||
| 77 | // ClassID. | |||
| 78 | virtual bool isA(const void *const ClassID) const { | |||
| 79 | return ClassID == classID(); | |||
| 80 | } | |||
| 81 | ||||
| 82 | // Check whether this instance is a subclass of ErrorInfoT. | |||
| 83 | template <typename ErrorInfoT> bool isA() const { | |||
| 84 | return isA(ErrorInfoT::classID()); | |||
| 85 | } | |||
| 86 | ||||
| 87 | private: | |||
| 88 | virtual void anchor(); | |||
| 89 | ||||
| 90 | static char ID; | |||
| 91 | }; | |||
| 92 | ||||
| 93 | /// Lightweight error class with error context and mandatory checking. | |||
| 94 | /// | |||
| 95 | /// Instances of this class wrap a ErrorInfoBase pointer. Failure states | |||
| 96 | /// are represented by setting the pointer to a ErrorInfoBase subclass | |||
| 97 | /// instance containing information describing the failure. Success is | |||
| 98 | /// represented by a null pointer value. | |||
| 99 | /// | |||
| 100 | /// Instances of Error also contains a 'Checked' flag, which must be set | |||
| 101 | /// before the destructor is called, otherwise the destructor will trigger a | |||
| 102 | /// runtime error. This enforces at runtime the requirement that all Error | |||
| 103 | /// instances be checked or returned to the caller. | |||
| 104 | /// | |||
| 105 | /// There are two ways to set the checked flag, depending on what state the | |||
| 106 | /// Error instance is in. For Error instances indicating success, it | |||
| 107 | /// is sufficient to invoke the boolean conversion operator. E.g.: | |||
| 108 | /// | |||
| 109 | /// @code{.cpp} | |||
| 110 | /// Error foo(<...>); | |||
| 111 | /// | |||
| 112 | /// if (auto E = foo(<...>)) | |||
| 113 | /// return E; // <- Return E if it is in the error state. | |||
| 114 | /// // We have verified that E was in the success state. It can now be safely | |||
| 115 | /// // destroyed. | |||
| 116 | /// @endcode | |||
| 117 | /// | |||
| 118 | /// A success value *can not* be dropped. For example, just calling 'foo(<...>)' | |||
| 119 | /// without testing the return value will raise a runtime error, even if foo | |||
| 120 | /// returns success. | |||
| 121 | /// | |||
| 122 | /// For Error instances representing failure, you must use either the | |||
| 123 | /// handleErrors or handleAllErrors function with a typed handler. E.g.: | |||
| 124 | /// | |||
| 125 | /// @code{.cpp} | |||
| 126 | /// class MyErrorInfo : public ErrorInfo<MyErrorInfo> { | |||
| 127 | /// // Custom error info. | |||
| 128 | /// }; | |||
| 129 | /// | |||
| 130 | /// Error foo(<...>) { return make_error<MyErrorInfo>(...); } | |||
| 131 | /// | |||
| 132 | /// auto E = foo(<...>); // <- foo returns failure with MyErrorInfo. | |||
| 133 | /// auto NewE = | |||
| 134 | /// handleErrors(E, | |||
| 135 | /// [](const MyErrorInfo &M) { | |||
| 136 | /// // Deal with the error. | |||
| 137 | /// }, | |||
| 138 | /// [](std::unique_ptr<OtherError> M) -> Error { | |||
| 139 | /// if (canHandle(*M)) { | |||
| 140 | /// // handle error. | |||
| 141 | /// return Error::success(); | |||
| 142 | /// } | |||
| 143 | /// // Couldn't handle this error instance. Pass it up the stack. | |||
| 144 | /// return Error(std::move(M)); | |||
| 145 | /// ); | |||
| 146 | /// // Note - we must check or return NewE in case any of the handlers | |||
| 147 | /// // returned a new error. | |||
| 148 | /// @endcode | |||
| 149 | /// | |||
| 150 | /// The handleAllErrors function is identical to handleErrors, except | |||
| 151 | /// that it has a void return type, and requires all errors to be handled and | |||
| 152 | /// no new errors be returned. It prevents errors (assuming they can all be | |||
| 153 | /// handled) from having to be bubbled all the way to the top-level. | |||
| 154 | /// | |||
| 155 | /// *All* Error instances must be checked before destruction, even if | |||
| 156 | /// they're moved-assigned or constructed from Success values that have already | |||
| 157 | /// been checked. This enforces checking through all levels of the call stack. | |||
| 158 | class LLVM_NODISCARD[[clang::warn_unused_result]] Error { | |||
| 159 | // Both ErrorList and FileError need to be able to yank ErrorInfoBase | |||
| 160 | // pointers out of this class to add to the error list. | |||
| 161 | friend class ErrorList; | |||
| 162 | friend class FileError; | |||
| 163 | ||||
| 164 | // handleErrors needs to be able to set the Checked flag. | |||
| 165 | template <typename... HandlerTs> | |||
| 166 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
| 167 | ||||
| 168 | // Expected<T> needs to be able to steal the payload when constructed from an | |||
| 169 | // error. | |||
| 170 | template <typename T> friend class Expected; | |||
| 171 | ||||
| 172 | // wrap needs to be able to steal the payload. | |||
| 173 | friend LLVMErrorRef wrap(Error); | |||
| 174 | ||||
| 175 | protected: | |||
| 176 | /// Create a success value. Prefer using 'Error::success()' for readability | |||
| 177 | Error() { | |||
| 178 | setPtr(nullptr); | |||
| 179 | setChecked(false); | |||
| 180 | } | |||
| 181 | ||||
| 182 | public: | |||
| 183 | /// Create a success value. | |||
| 184 | static ErrorSuccess success(); | |||
| 185 | ||||
| 186 | // Errors are not copy-constructable. | |||
| 187 | Error(const Error &Other) = delete; | |||
| 188 | ||||
| 189 | /// Move-construct an error value. The newly constructed error is considered | |||
| 190 | /// unchecked, even if the source error had been checked. The original error | |||
| 191 | /// becomes a checked Success value, regardless of its original state. | |||
| 192 | Error(Error &&Other) { | |||
| 193 | setChecked(true); | |||
| 194 | *this = std::move(Other); | |||
| 195 | } | |||
| 196 | ||||
| 197 | /// Create an error value. Prefer using the 'make_error' function, but | |||
| 198 | /// this constructor can be useful when "re-throwing" errors from handlers. | |||
| 199 | Error(std::unique_ptr<ErrorInfoBase> Payload) { | |||
| 200 | setPtr(Payload.release()); | |||
| 201 | setChecked(false); | |||
| ||||
| 202 | } | |||
| 203 | ||||
| 204 | // Errors are not copy-assignable. | |||
| 205 | Error &operator=(const Error &Other) = delete; | |||
| 206 | ||||
| 207 | /// Move-assign an error value. The current error must represent success, you | |||
| 208 | /// you cannot overwrite an unhandled error. The current error is then | |||
| 209 | /// considered unchecked. The source error becomes a checked success value, | |||
| 210 | /// regardless of its original state. | |||
| 211 | Error &operator=(Error &&Other) { | |||
| 212 | // Don't allow overwriting of unchecked values. | |||
| 213 | assertIsChecked(); | |||
| 214 | setPtr(Other.getPtr()); | |||
| 215 | ||||
| 216 | // This Error is unchecked, even if the source error was checked. | |||
| 217 | setChecked(false); | |||
| 218 | ||||
| 219 | // Null out Other's payload and set its checked bit. | |||
| 220 | Other.setPtr(nullptr); | |||
| 221 | Other.setChecked(true); | |||
| 222 | ||||
| 223 | return *this; | |||
| 224 | } | |||
| 225 | ||||
| 226 | /// Destroy a Error. Fails with a call to abort() if the error is | |||
| 227 | /// unchecked. | |||
| 228 | ~Error() { | |||
| 229 | assertIsChecked(); | |||
| 230 | delete getPtr(); | |||
| 231 | } | |||
| 232 | ||||
| 233 | /// Bool conversion. Returns true if this Error is in a failure state, | |||
| 234 | /// and false if it is in an accept state. If the error is in a Success state | |||
| 235 | /// it will be considered checked. | |||
| 236 | explicit operator bool() { | |||
| 237 | setChecked(getPtr() == nullptr); | |||
| 238 | return getPtr() != nullptr; | |||
| 239 | } | |||
| 240 | ||||
| 241 | /// Check whether one error is a subclass of another. | |||
| 242 | template <typename ErrT> bool isA() const { | |||
| 243 | return getPtr() && getPtr()->isA(ErrT::classID()); | |||
| 244 | } | |||
| 245 | ||||
| 246 | /// Returns the dynamic class id of this error, or null if this is a success | |||
| 247 | /// value. | |||
| 248 | const void* dynamicClassID() const { | |||
| 249 | if (!getPtr()) | |||
| 250 | return nullptr; | |||
| 251 | return getPtr()->dynamicClassID(); | |||
| 252 | } | |||
| 253 | ||||
| 254 | private: | |||
| 255 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 256 | // assertIsChecked() happens very frequently, but under normal circumstances | |||
| 257 | // is supposed to be a no-op. So we want it to be inlined, but having a bunch | |||
| 258 | // of debug prints can cause the function to be too large for inlining. So | |||
| 259 | // it's important that we define this function out of line so that it can't be | |||
| 260 | // inlined. | |||
| 261 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
| 262 | void fatalUncheckedError() const; | |||
| 263 | #endif | |||
| 264 | ||||
| 265 | void assertIsChecked() { | |||
| 266 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 267 | if (LLVM_UNLIKELY(!getChecked() || getPtr())__builtin_expect((bool)(!getChecked() || getPtr()), false)) | |||
| 268 | fatalUncheckedError(); | |||
| 269 | #endif | |||
| 270 | } | |||
| 271 | ||||
| 272 | ErrorInfoBase *getPtr() const { | |||
| 273 | return reinterpret_cast<ErrorInfoBase*>( | |||
| 274 | reinterpret_cast<uintptr_t>(Payload) & | |||
| 275 | ~static_cast<uintptr_t>(0x1)); | |||
| 276 | } | |||
| 277 | ||||
| 278 | void setPtr(ErrorInfoBase *EI) { | |||
| 279 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 280 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
| 281 | (reinterpret_cast<uintptr_t>(EI) & | |||
| 282 | ~static_cast<uintptr_t>(0x1)) | | |||
| 283 | (reinterpret_cast<uintptr_t>(Payload) & 0x1)); | |||
| 284 | #else | |||
| 285 | Payload = EI; | |||
| 286 | #endif | |||
| 287 | } | |||
| 288 | ||||
| 289 | bool getChecked() const { | |||
| 290 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 291 | return (reinterpret_cast<uintptr_t>(Payload) & 0x1) == 0; | |||
| 292 | #else | |||
| 293 | return true; | |||
| 294 | #endif | |||
| 295 | } | |||
| 296 | ||||
| 297 | void setChecked(bool V) { | |||
| 298 | Payload = reinterpret_cast<ErrorInfoBase*>( | |||
| 299 | (reinterpret_cast<uintptr_t>(Payload) & | |||
| 300 | ~static_cast<uintptr_t>(0x1)) | | |||
| 301 | (V ? 0 : 1)); | |||
| 302 | } | |||
| 303 | ||||
| 304 | std::unique_ptr<ErrorInfoBase> takePayload() { | |||
| 305 | std::unique_ptr<ErrorInfoBase> Tmp(getPtr()); | |||
| 306 | setPtr(nullptr); | |||
| 307 | setChecked(true); | |||
| 308 | return Tmp; | |||
| 309 | } | |||
| 310 | ||||
| 311 | friend raw_ostream &operator<<(raw_ostream &OS, const Error &E) { | |||
| 312 | if (auto P = E.getPtr()) | |||
| 313 | P->log(OS); | |||
| 314 | else | |||
| 315 | OS << "success"; | |||
| 316 | return OS; | |||
| 317 | } | |||
| 318 | ||||
| 319 | ErrorInfoBase *Payload = nullptr; | |||
| 320 | }; | |||
| 321 | ||||
| 322 | /// Subclass of Error for the sole purpose of identifying the success path in | |||
| 323 | /// the type system. This allows to catch invalid conversion to Expected<T> at | |||
| 324 | /// compile time. | |||
| 325 | class ErrorSuccess final : public Error {}; | |||
| 326 | ||||
| 327 | inline ErrorSuccess Error::success() { return ErrorSuccess(); } | |||
| 328 | ||||
| 329 | /// Make a Error instance representing failure using the given error info | |||
| 330 | /// type. | |||
| 331 | template <typename ErrT, typename... ArgTs> Error make_error(ArgTs &&... Args) { | |||
| 332 | return Error(llvm::make_unique<ErrT>(std::forward<ArgTs>(Args)...)); | |||
| 333 | } | |||
| 334 | ||||
| 335 | /// Base class for user error types. Users should declare their error types | |||
| 336 | /// like: | |||
| 337 | /// | |||
| 338 | /// class MyError : public ErrorInfo<MyError> { | |||
| 339 | /// .... | |||
| 340 | /// }; | |||
| 341 | /// | |||
| 342 | /// This class provides an implementation of the ErrorInfoBase::kind | |||
| 343 | /// method, which is used by the Error RTTI system. | |||
| 344 | template <typename ThisErrT, typename ParentErrT = ErrorInfoBase> | |||
| 345 | class ErrorInfo : public ParentErrT { | |||
| 346 | public: | |||
| 347 | using ParentErrT::ParentErrT; // inherit constructors | |||
| 348 | ||||
| 349 | static const void *classID() { return &ThisErrT::ID; } | |||
| 350 | ||||
| 351 | const void *dynamicClassID() const override { return &ThisErrT::ID; } | |||
| 352 | ||||
| 353 | bool isA(const void *const ClassID) const override { | |||
| 354 | return ClassID == classID() || ParentErrT::isA(ClassID); | |||
| 355 | } | |||
| 356 | }; | |||
| 357 | ||||
| 358 | /// Special ErrorInfo subclass representing a list of ErrorInfos. | |||
| 359 | /// Instances of this class are constructed by joinError. | |||
| 360 | class ErrorList final : public ErrorInfo<ErrorList> { | |||
| 361 | // handleErrors needs to be able to iterate the payload list of an | |||
| 362 | // ErrorList. | |||
| 363 | template <typename... HandlerTs> | |||
| 364 | friend Error handleErrors(Error E, HandlerTs &&... Handlers); | |||
| 365 | ||||
| 366 | // joinErrors is implemented in terms of join. | |||
| 367 | friend Error joinErrors(Error, Error); | |||
| 368 | ||||
| 369 | public: | |||
| 370 | void log(raw_ostream &OS) const override { | |||
| 371 | OS << "Multiple errors:\n"; | |||
| 372 | for (auto &ErrPayload : Payloads) { | |||
| 373 | ErrPayload->log(OS); | |||
| 374 | OS << "\n"; | |||
| 375 | } | |||
| 376 | } | |||
| 377 | ||||
| 378 | std::error_code convertToErrorCode() const override; | |||
| 379 | ||||
| 380 | // Used by ErrorInfo::classID. | |||
| 381 | static char ID; | |||
| 382 | ||||
| 383 | private: | |||
| 384 | ErrorList(std::unique_ptr<ErrorInfoBase> Payload1, | |||
| 385 | std::unique_ptr<ErrorInfoBase> Payload2) { | |||
| 386 | assert(!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() &&((!Payload1->isA<ErrorList>() && !Payload2-> isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors" ) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 387, __PRETTY_FUNCTION__)) | |||
| 387 | "ErrorList constructor payloads should be singleton errors")((!Payload1->isA<ErrorList>() && !Payload2-> isA<ErrorList>() && "ErrorList constructor payloads should be singleton errors" ) ? static_cast<void> (0) : __assert_fail ("!Payload1->isA<ErrorList>() && !Payload2->isA<ErrorList>() && \"ErrorList constructor payloads should be singleton errors\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 387, __PRETTY_FUNCTION__)); | |||
| 388 | Payloads.push_back(std::move(Payload1)); | |||
| 389 | Payloads.push_back(std::move(Payload2)); | |||
| 390 | } | |||
| 391 | ||||
| 392 | static Error join(Error E1, Error E2) { | |||
| 393 | if (!E1) | |||
| 394 | return E2; | |||
| 395 | if (!E2) | |||
| 396 | return E1; | |||
| 397 | if (E1.isA<ErrorList>()) { | |||
| 398 | auto &E1List = static_cast<ErrorList &>(*E1.getPtr()); | |||
| 399 | if (E2.isA<ErrorList>()) { | |||
| 400 | auto E2Payload = E2.takePayload(); | |||
| 401 | auto &E2List = static_cast<ErrorList &>(*E2Payload); | |||
| 402 | for (auto &Payload : E2List.Payloads) | |||
| 403 | E1List.Payloads.push_back(std::move(Payload)); | |||
| 404 | } else | |||
| 405 | E1List.Payloads.push_back(E2.takePayload()); | |||
| 406 | ||||
| 407 | return E1; | |||
| 408 | } | |||
| 409 | if (E2.isA<ErrorList>()) { | |||
| 410 | auto &E2List = static_cast<ErrorList &>(*E2.getPtr()); | |||
| 411 | E2List.Payloads.insert(E2List.Payloads.begin(), E1.takePayload()); | |||
| 412 | return E2; | |||
| 413 | } | |||
| 414 | return Error(std::unique_ptr<ErrorList>( | |||
| 415 | new ErrorList(E1.takePayload(), E2.takePayload()))); | |||
| 416 | } | |||
| 417 | ||||
| 418 | std::vector<std::unique_ptr<ErrorInfoBase>> Payloads; | |||
| 419 | }; | |||
| 420 | ||||
| 421 | /// Concatenate errors. The resulting Error is unchecked, and contains the | |||
| 422 | /// ErrorInfo(s), if any, contained in E1, followed by the | |||
| 423 | /// ErrorInfo(s), if any, contained in E2. | |||
| 424 | inline Error joinErrors(Error E1, Error E2) { | |||
| 425 | return ErrorList::join(std::move(E1), std::move(E2)); | |||
| 426 | } | |||
| 427 | ||||
| 428 | /// Tagged union holding either a T or a Error. | |||
| 429 | /// | |||
| 430 | /// This class parallels ErrorOr, but replaces error_code with Error. Since | |||
| 431 | /// Error cannot be copied, this class replaces getError() with | |||
| 432 | /// takeError(). It also adds an bool errorIsA<ErrT>() method for testing the | |||
| 433 | /// error class type. | |||
| 434 | template <class T> class LLVM_NODISCARD[[clang::warn_unused_result]] Expected { | |||
| 435 | template <class T1> friend class ExpectedAsOutParameter; | |||
| 436 | template <class OtherT> friend class Expected; | |||
| 437 | ||||
| 438 | static const bool isRef = std::is_reference<T>::value; | |||
| 439 | ||||
| 440 | using wrap = std::reference_wrapper<typename std::remove_reference<T>::type>; | |||
| 441 | ||||
| 442 | using error_type = std::unique_ptr<ErrorInfoBase>; | |||
| 443 | ||||
| 444 | public: | |||
| 445 | using storage_type = typename std::conditional<isRef, wrap, T>::type; | |||
| 446 | using value_type = T; | |||
| 447 | ||||
| 448 | private: | |||
| 449 | using reference = typename std::remove_reference<T>::type &; | |||
| 450 | using const_reference = const typename std::remove_reference<T>::type &; | |||
| 451 | using pointer = typename std::remove_reference<T>::type *; | |||
| 452 | using const_pointer = const typename std::remove_reference<T>::type *; | |||
| 453 | ||||
| 454 | public: | |||
| 455 | /// Create an Expected<T> error value from the given Error. | |||
| 456 | Expected(Error Err) | |||
| 457 | : HasError(true) | |||
| 458 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 459 | // Expected is unchecked upon construction in Debug builds. | |||
| 460 | , Unchecked(true) | |||
| 461 | #endif | |||
| 462 | { | |||
| 463 | assert(Err && "Cannot create Expected<T> from Error success value.")((Err && "Cannot create Expected<T> from Error success value." ) ? static_cast<void> (0) : __assert_fail ("Err && \"Cannot create Expected<T> from Error success value.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 463, __PRETTY_FUNCTION__)); | |||
| 464 | new (getErrorStorage()) error_type(Err.takePayload()); | |||
| 465 | } | |||
| 466 | ||||
| 467 | /// Forbid to convert from Error::success() implicitly, this avoids having | |||
| 468 | /// Expected<T> foo() { return Error::success(); } which compiles otherwise | |||
| 469 | /// but triggers the assertion above. | |||
| 470 | Expected(ErrorSuccess) = delete; | |||
| 471 | ||||
| 472 | /// Create an Expected<T> success value from the given OtherT value, which | |||
| 473 | /// must be convertible to T. | |||
| 474 | template <typename OtherT> | |||
| 475 | Expected(OtherT &&Val, | |||
| 476 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
| 477 | * = nullptr) | |||
| 478 | : HasError(false) | |||
| 479 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 480 | // Expected is unchecked upon construction in Debug builds. | |||
| 481 | , Unchecked(true) | |||
| 482 | #endif | |||
| 483 | { | |||
| 484 | new (getStorage()) storage_type(std::forward<OtherT>(Val)); | |||
| 485 | } | |||
| 486 | ||||
| 487 | /// Move construct an Expected<T> value. | |||
| 488 | Expected(Expected &&Other) { moveConstruct(std::move(Other)); } | |||
| 489 | ||||
| 490 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
| 491 | /// must be convertible to T. | |||
| 492 | template <class OtherT> | |||
| 493 | Expected(Expected<OtherT> &&Other, | |||
| 494 | typename std::enable_if<std::is_convertible<OtherT, T>::value>::type | |||
| 495 | * = nullptr) { | |||
| 496 | moveConstruct(std::move(Other)); | |||
| 497 | } | |||
| 498 | ||||
| 499 | /// Move construct an Expected<T> value from an Expected<OtherT>, where OtherT | |||
| 500 | /// isn't convertible to T. | |||
| 501 | template <class OtherT> | |||
| 502 | explicit Expected( | |||
| 503 | Expected<OtherT> &&Other, | |||
| 504 | typename std::enable_if<!std::is_convertible<OtherT, T>::value>::type * = | |||
| 505 | nullptr) { | |||
| 506 | moveConstruct(std::move(Other)); | |||
| 507 | } | |||
| 508 | ||||
| 509 | /// Move-assign from another Expected<T>. | |||
| 510 | Expected &operator=(Expected &&Other) { | |||
| 511 | moveAssign(std::move(Other)); | |||
| 512 | return *this; | |||
| 513 | } | |||
| 514 | ||||
| 515 | /// Destroy an Expected<T>. | |||
| 516 | ~Expected() { | |||
| 517 | assertIsChecked(); | |||
| 518 | if (!HasError) | |||
| 519 | getStorage()->~storage_type(); | |||
| 520 | else | |||
| 521 | getErrorStorage()->~error_type(); | |||
| 522 | } | |||
| 523 | ||||
| 524 | /// Return false if there is an error. | |||
| 525 | explicit operator bool() { | |||
| 526 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 527 | Unchecked = HasError; | |||
| 528 | #endif | |||
| 529 | return !HasError; | |||
| 530 | } | |||
| 531 | ||||
| 532 | /// Returns a reference to the stored T value. | |||
| 533 | reference get() { | |||
| 534 | assertIsChecked(); | |||
| 535 | return *getStorage(); | |||
| 536 | } | |||
| 537 | ||||
| 538 | /// Returns a const reference to the stored T value. | |||
| 539 | const_reference get() const { | |||
| 540 | assertIsChecked(); | |||
| 541 | return const_cast<Expected<T> *>(this)->get(); | |||
| 542 | } | |||
| 543 | ||||
| 544 | /// Check that this Expected<T> is an error of type ErrT. | |||
| 545 | template <typename ErrT> bool errorIsA() const { | |||
| 546 | return HasError && (*getErrorStorage())->template isA<ErrT>(); | |||
| 547 | } | |||
| 548 | ||||
| 549 | /// Take ownership of the stored error. | |||
| 550 | /// After calling this the Expected<T> is in an indeterminate state that can | |||
| 551 | /// only be safely destructed. No further calls (beside the destructor) should | |||
| 552 | /// be made on the Expected<T> vaule. | |||
| 553 | Error takeError() { | |||
| 554 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 555 | Unchecked = false; | |||
| 556 | #endif | |||
| 557 | return HasError ? Error(std::move(*getErrorStorage())) : Error::success(); | |||
| 558 | } | |||
| 559 | ||||
| 560 | /// Returns a pointer to the stored T value. | |||
| 561 | pointer operator->() { | |||
| 562 | assertIsChecked(); | |||
| 563 | return toPointer(getStorage()); | |||
| 564 | } | |||
| 565 | ||||
| 566 | /// Returns a const pointer to the stored T value. | |||
| 567 | const_pointer operator->() const { | |||
| 568 | assertIsChecked(); | |||
| 569 | return toPointer(getStorage()); | |||
| 570 | } | |||
| 571 | ||||
| 572 | /// Returns a reference to the stored T value. | |||
| 573 | reference operator*() { | |||
| 574 | assertIsChecked(); | |||
| 575 | return *getStorage(); | |||
| 576 | } | |||
| 577 | ||||
| 578 | /// Returns a const reference to the stored T value. | |||
| 579 | const_reference operator*() const { | |||
| 580 | assertIsChecked(); | |||
| 581 | return *getStorage(); | |||
| 582 | } | |||
| 583 | ||||
| 584 | private: | |||
| 585 | template <class T1> | |||
| 586 | static bool compareThisIfSameType(const T1 &a, const T1 &b) { | |||
| 587 | return &a == &b; | |||
| 588 | } | |||
| 589 | ||||
| 590 | template <class T1, class T2> | |||
| 591 | static bool compareThisIfSameType(const T1 &a, const T2 &b) { | |||
| 592 | return false; | |||
| 593 | } | |||
| 594 | ||||
| 595 | template <class OtherT> void moveConstruct(Expected<OtherT> &&Other) { | |||
| 596 | HasError = Other.HasError; | |||
| 597 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 598 | Unchecked = true; | |||
| 599 | Other.Unchecked = false; | |||
| 600 | #endif | |||
| 601 | ||||
| 602 | if (!HasError) | |||
| 603 | new (getStorage()) storage_type(std::move(*Other.getStorage())); | |||
| 604 | else | |||
| 605 | new (getErrorStorage()) error_type(std::move(*Other.getErrorStorage())); | |||
| 606 | } | |||
| 607 | ||||
| 608 | template <class OtherT> void moveAssign(Expected<OtherT> &&Other) { | |||
| 609 | assertIsChecked(); | |||
| 610 | ||||
| 611 | if (compareThisIfSameType(*this, Other)) | |||
| 612 | return; | |||
| 613 | ||||
| 614 | this->~Expected(); | |||
| 615 | new (this) Expected(std::move(Other)); | |||
| 616 | } | |||
| 617 | ||||
| 618 | pointer toPointer(pointer Val) { return Val; } | |||
| 619 | ||||
| 620 | const_pointer toPointer(const_pointer Val) const { return Val; } | |||
| 621 | ||||
| 622 | pointer toPointer(wrap *Val) { return &Val->get(); } | |||
| 623 | ||||
| 624 | const_pointer toPointer(const wrap *Val) const { return &Val->get(); } | |||
| 625 | ||||
| 626 | storage_type *getStorage() { | |||
| 627 | assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!" ) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 627, __PRETTY_FUNCTION__)); | |||
| 628 | return reinterpret_cast<storage_type *>(TStorage.buffer); | |||
| 629 | } | |||
| 630 | ||||
| 631 | const storage_type *getStorage() const { | |||
| 632 | assert(!HasError && "Cannot get value when an error exists!")((!HasError && "Cannot get value when an error exists!" ) ? static_cast<void> (0) : __assert_fail ("!HasError && \"Cannot get value when an error exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 632, __PRETTY_FUNCTION__)); | |||
| 633 | return reinterpret_cast<const storage_type *>(TStorage.buffer); | |||
| 634 | } | |||
| 635 | ||||
| 636 | error_type *getErrorStorage() { | |||
| 637 | assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!" ) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 637, __PRETTY_FUNCTION__)); | |||
| 638 | return reinterpret_cast<error_type *>(ErrorStorage.buffer); | |||
| 639 | } | |||
| 640 | ||||
| 641 | const error_type *getErrorStorage() const { | |||
| 642 | assert(HasError && "Cannot get error when a value exists!")((HasError && "Cannot get error when a value exists!" ) ? static_cast<void> (0) : __assert_fail ("HasError && \"Cannot get error when a value exists!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 642, __PRETTY_FUNCTION__)); | |||
| 643 | return reinterpret_cast<const error_type *>(ErrorStorage.buffer); | |||
| 644 | } | |||
| 645 | ||||
| 646 | // Used by ExpectedAsOutParameter to reset the checked flag. | |||
| 647 | void setUnchecked() { | |||
| 648 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 649 | Unchecked = true; | |||
| 650 | #endif | |||
| 651 | } | |||
| 652 | ||||
| 653 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 654 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) | |||
| 655 | LLVM_ATTRIBUTE_NOINLINE__attribute__((noinline)) | |||
| 656 | void fatalUncheckedExpected() const { | |||
| 657 | dbgs() << "Expected<T> must be checked before access or destruction.\n"; | |||
| 658 | if (HasError) { | |||
| 659 | dbgs() << "Unchecked Expected<T> contained error:\n"; | |||
| 660 | (*getErrorStorage())->log(dbgs()); | |||
| 661 | } else | |||
| 662 | dbgs() << "Expected<T> value was in success state. (Note: Expected<T> " | |||
| 663 | "values in success mode must still be checked prior to being " | |||
| 664 | "destroyed).\n"; | |||
| 665 | abort(); | |||
| 666 | } | |||
| 667 | #endif | |||
| 668 | ||||
| 669 | void assertIsChecked() { | |||
| 670 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 671 | if (LLVM_UNLIKELY(Unchecked)__builtin_expect((bool)(Unchecked), false)) | |||
| 672 | fatalUncheckedExpected(); | |||
| 673 | #endif | |||
| 674 | } | |||
| 675 | ||||
| 676 | union { | |||
| 677 | AlignedCharArrayUnion<storage_type> TStorage; | |||
| 678 | AlignedCharArrayUnion<error_type> ErrorStorage; | |||
| 679 | }; | |||
| 680 | bool HasError : 1; | |||
| 681 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 | |||
| 682 | bool Unchecked : 1; | |||
| 683 | #endif | |||
| 684 | }; | |||
| 685 | ||||
| 686 | /// Report a serious error, calling any installed error handler. See | |||
| 687 | /// ErrorHandling.h. | |||
| 688 | LLVM_ATTRIBUTE_NORETURN__attribute__((noreturn)) void report_fatal_error(Error Err, | |||
| 689 | bool gen_crash_diag = true); | |||
| 690 | ||||
| 691 | /// Report a fatal error if Err is a failure value. | |||
| 692 | /// | |||
| 693 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
| 694 | /// is known that the Error will always be a success value. E.g. | |||
| 695 | /// | |||
| 696 | /// @code{.cpp} | |||
| 697 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
| 698 | /// // true. If DoFallibleOperation is false then foo always returns | |||
| 699 | /// // Error::success(). | |||
| 700 | /// Error foo(bool DoFallibleOperation); | |||
| 701 | /// | |||
| 702 | /// cantFail(foo(false)); | |||
| 703 | /// @endcode | |||
| 704 | inline void cantFail(Error Err, const char *Msg = nullptr) { | |||
| 705 | if (Err) { | |||
| 706 | if (!Msg) | |||
| 707 | Msg = "Failure value returned from cantFail wrapped call"; | |||
| 708 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 708); | |||
| 709 | } | |||
| 710 | } | |||
| 711 | ||||
| 712 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
| 713 | /// returns the contained value. | |||
| 714 | /// | |||
| 715 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
| 716 | /// is known that the Error will always be a success value. E.g. | |||
| 717 | /// | |||
| 718 | /// @code{.cpp} | |||
| 719 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
| 720 | /// // true. If DoFallibleOperation is false then foo always returns an int. | |||
| 721 | /// Expected<int> foo(bool DoFallibleOperation); | |||
| 722 | /// | |||
| 723 | /// int X = cantFail(foo(false)); | |||
| 724 | /// @endcode | |||
| 725 | template <typename T> | |||
| 726 | T cantFail(Expected<T> ValOrErr, const char *Msg = nullptr) { | |||
| 727 | if (ValOrErr) | |||
| 728 | return std::move(*ValOrErr); | |||
| 729 | else { | |||
| 730 | if (!Msg) | |||
| 731 | Msg = "Failure value returned from cantFail wrapped call"; | |||
| 732 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 732); | |||
| 733 | } | |||
| 734 | } | |||
| 735 | ||||
| 736 | /// Report a fatal error if ValOrErr is a failure value, otherwise unwraps and | |||
| 737 | /// returns the contained reference. | |||
| 738 | /// | |||
| 739 | /// This function can be used to wrap calls to fallible functions ONLY when it | |||
| 740 | /// is known that the Error will always be a success value. E.g. | |||
| 741 | /// | |||
| 742 | /// @code{.cpp} | |||
| 743 | /// // foo only attempts the fallible operation if DoFallibleOperation is | |||
| 744 | /// // true. If DoFallibleOperation is false then foo always returns a Bar&. | |||
| 745 | /// Expected<Bar&> foo(bool DoFallibleOperation); | |||
| 746 | /// | |||
| 747 | /// Bar &X = cantFail(foo(false)); | |||
| 748 | /// @endcode | |||
| 749 | template <typename T> | |||
| 750 | T& cantFail(Expected<T&> ValOrErr, const char *Msg = nullptr) { | |||
| 751 | if (ValOrErr) | |||
| 752 | return *ValOrErr; | |||
| 753 | else { | |||
| 754 | if (!Msg) | |||
| 755 | Msg = "Failure value returned from cantFail wrapped call"; | |||
| 756 | llvm_unreachable(Msg)::llvm::llvm_unreachable_internal(Msg, "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 756); | |||
| 757 | } | |||
| 758 | } | |||
| 759 | ||||
| 760 | /// Helper for testing applicability of, and applying, handlers for | |||
| 761 | /// ErrorInfo types. | |||
| 762 | template <typename HandlerT> | |||
| 763 | class ErrorHandlerTraits | |||
| 764 | : public ErrorHandlerTraits<decltype( | |||
| 765 | &std::remove_reference<HandlerT>::type::operator())> {}; | |||
| 766 | ||||
| 767 | // Specialization functions of the form 'Error (const ErrT&)'. | |||
| 768 | template <typename ErrT> class ErrorHandlerTraits<Error (&)(ErrT &)> { | |||
| 769 | public: | |||
| 770 | static bool appliesTo(const ErrorInfoBase &E) { | |||
| 771 | return E.template isA<ErrT>(); | |||
| 772 | } | |||
| 773 | ||||
| 774 | template <typename HandlerT> | |||
| 775 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
| 776 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 776, __PRETTY_FUNCTION__)); | |||
| 777 | return H(static_cast<ErrT &>(*E)); | |||
| 778 | } | |||
| 779 | }; | |||
| 780 | ||||
| 781 | // Specialization functions of the form 'void (const ErrT&)'. | |||
| 782 | template <typename ErrT> class ErrorHandlerTraits<void (&)(ErrT &)> { | |||
| 783 | public: | |||
| 784 | static bool appliesTo(const ErrorInfoBase &E) { | |||
| 785 | return E.template isA<ErrT>(); | |||
| 786 | } | |||
| 787 | ||||
| 788 | template <typename HandlerT> | |||
| 789 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
| 790 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 790, __PRETTY_FUNCTION__)); | |||
| 791 | H(static_cast<ErrT &>(*E)); | |||
| 792 | return Error::success(); | |||
| 793 | } | |||
| 794 | }; | |||
| 795 | ||||
| 796 | /// Specialization for functions of the form 'Error (std::unique_ptr<ErrT>)'. | |||
| 797 | template <typename ErrT> | |||
| 798 | class ErrorHandlerTraits<Error (&)(std::unique_ptr<ErrT>)> { | |||
| 799 | public: | |||
| 800 | static bool appliesTo(const ErrorInfoBase &E) { | |||
| 801 | return E.template isA<ErrT>(); | |||
| 802 | } | |||
| 803 | ||||
| 804 | template <typename HandlerT> | |||
| 805 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
| 806 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 806, __PRETTY_FUNCTION__)); | |||
| 807 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
| 808 | return H(std::move(SubE)); | |||
| 809 | } | |||
| 810 | }; | |||
| 811 | ||||
| 812 | /// Specialization for functions of the form 'void (std::unique_ptr<ErrT>)'. | |||
| 813 | template <typename ErrT> | |||
| 814 | class ErrorHandlerTraits<void (&)(std::unique_ptr<ErrT>)> { | |||
| 815 | public: | |||
| 816 | static bool appliesTo(const ErrorInfoBase &E) { | |||
| 817 | return E.template isA<ErrT>(); | |||
| 818 | } | |||
| 819 | ||||
| 820 | template <typename HandlerT> | |||
| 821 | static Error apply(HandlerT &&H, std::unique_ptr<ErrorInfoBase> E) { | |||
| 822 | assert(appliesTo(*E) && "Applying incorrect handler")((appliesTo(*E) && "Applying incorrect handler") ? static_cast <void> (0) : __assert_fail ("appliesTo(*E) && \"Applying incorrect handler\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 822, __PRETTY_FUNCTION__)); | |||
| 823 | std::unique_ptr<ErrT> SubE(static_cast<ErrT *>(E.release())); | |||
| 824 | H(std::move(SubE)); | |||
| 825 | return Error::success(); | |||
| 826 | } | |||
| 827 | }; | |||
| 828 | ||||
| 829 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
| 830 | template <typename C, typename RetT, typename ErrT> | |||
| 831 | class ErrorHandlerTraits<RetT (C::*)(ErrT &)> | |||
| 832 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
| 833 | ||||
| 834 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
| 835 | template <typename C, typename RetT, typename ErrT> | |||
| 836 | class ErrorHandlerTraits<RetT (C::*)(ErrT &) const> | |||
| 837 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
| 838 | ||||
| 839 | // Specialization for member functions of the form 'RetT (const ErrT&)'. | |||
| 840 | template <typename C, typename RetT, typename ErrT> | |||
| 841 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &)> | |||
| 842 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
| 843 | ||||
| 844 | // Specialization for member functions of the form 'RetT (const ErrT&) const'. | |||
| 845 | template <typename C, typename RetT, typename ErrT> | |||
| 846 | class ErrorHandlerTraits<RetT (C::*)(const ErrT &) const> | |||
| 847 | : public ErrorHandlerTraits<RetT (&)(ErrT &)> {}; | |||
| 848 | ||||
| 849 | /// Specialization for member functions of the form | |||
| 850 | /// 'RetT (std::unique_ptr<ErrT>)'. | |||
| 851 | template <typename C, typename RetT, typename ErrT> | |||
| 852 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>)> | |||
| 853 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
| 854 | ||||
| 855 | /// Specialization for member functions of the form | |||
| 856 | /// 'RetT (std::unique_ptr<ErrT>) const'. | |||
| 857 | template <typename C, typename RetT, typename ErrT> | |||
| 858 | class ErrorHandlerTraits<RetT (C::*)(std::unique_ptr<ErrT>) const> | |||
| 859 | : public ErrorHandlerTraits<RetT (&)(std::unique_ptr<ErrT>)> {}; | |||
| 860 | ||||
| 861 | inline Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload) { | |||
| 862 | return Error(std::move(Payload)); | |||
| 863 | } | |||
| 864 | ||||
| 865 | template <typename HandlerT, typename... HandlerTs> | |||
| 866 | Error handleErrorImpl(std::unique_ptr<ErrorInfoBase> Payload, | |||
| 867 | HandlerT &&Handler, HandlerTs &&... Handlers) { | |||
| 868 | if (ErrorHandlerTraits<HandlerT>::appliesTo(*Payload)) | |||
| 869 | return ErrorHandlerTraits<HandlerT>::apply(std::forward<HandlerT>(Handler), | |||
| 870 | std::move(Payload)); | |||
| 871 | return handleErrorImpl(std::move(Payload), | |||
| 872 | std::forward<HandlerTs>(Handlers)...); | |||
| 873 | } | |||
| 874 | ||||
| 875 | /// Pass the ErrorInfo(s) contained in E to their respective handlers. Any | |||
| 876 | /// unhandled errors (or Errors returned by handlers) are re-concatenated and | |||
| 877 | /// returned. | |||
| 878 | /// Because this function returns an error, its result must also be checked | |||
| 879 | /// or returned. If you intend to handle all errors use handleAllErrors | |||
| 880 | /// (which returns void, and will abort() on unhandled errors) instead. | |||
| 881 | template <typename... HandlerTs> | |||
| 882 | Error handleErrors(Error E, HandlerTs &&... Hs) { | |||
| 883 | if (!E) | |||
| 884 | return Error::success(); | |||
| 885 | ||||
| 886 | std::unique_ptr<ErrorInfoBase> Payload = E.takePayload(); | |||
| 887 | ||||
| 888 | if (Payload->isA<ErrorList>()) { | |||
| 889 | ErrorList &List = static_cast<ErrorList &>(*Payload); | |||
| 890 | Error R; | |||
| 891 | for (auto &P : List.Payloads) | |||
| 892 | R = ErrorList::join( | |||
| 893 | std::move(R), | |||
| 894 | handleErrorImpl(std::move(P), std::forward<HandlerTs>(Hs)...)); | |||
| 895 | return R; | |||
| 896 | } | |||
| 897 | ||||
| 898 | return handleErrorImpl(std::move(Payload), std::forward<HandlerTs>(Hs)...); | |||
| 899 | } | |||
| 900 | ||||
| 901 | /// Behaves the same as handleErrors, except that by contract all errors | |||
| 902 | /// *must* be handled by the given handlers (i.e. there must be no remaining | |||
| 903 | /// errors after running the handlers, or llvm_unreachable is called). | |||
| 904 | template <typename... HandlerTs> | |||
| 905 | void handleAllErrors(Error E, HandlerTs &&... Handlers) { | |||
| 906 | cantFail(handleErrors(std::move(E), std::forward<HandlerTs>(Handlers)...)); | |||
| 907 | } | |||
| 908 | ||||
| 909 | /// Check that E is a non-error, then drop it. | |||
| 910 | /// If E is an error, llvm_unreachable will be called. | |||
| 911 | inline void handleAllErrors(Error E) { | |||
| 912 | cantFail(std::move(E)); | |||
| 913 | } | |||
| 914 | ||||
| 915 | /// Handle any errors (if present) in an Expected<T>, then try a recovery path. | |||
| 916 | /// | |||
| 917 | /// If the incoming value is a success value it is returned unmodified. If it | |||
| 918 | /// is a failure value then it the contained error is passed to handleErrors. | |||
| 919 | /// If handleErrors is able to handle the error then the RecoveryPath functor | |||
| 920 | /// is called to supply the final result. If handleErrors is not able to | |||
| 921 | /// handle all errors then the unhandled errors are returned. | |||
| 922 | /// | |||
| 923 | /// This utility enables the follow pattern: | |||
| 924 | /// | |||
| 925 | /// @code{.cpp} | |||
| 926 | /// enum FooStrategy { Aggressive, Conservative }; | |||
| 927 | /// Expected<Foo> foo(FooStrategy S); | |||
| 928 | /// | |||
| 929 | /// auto ResultOrErr = | |||
| 930 | /// handleExpected( | |||
| 931 | /// foo(Aggressive), | |||
| 932 | /// []() { return foo(Conservative); }, | |||
| 933 | /// [](AggressiveStrategyError&) { | |||
| 934 | /// // Implicitly conusme this - we'll recover by using a conservative | |||
| 935 | /// // strategy. | |||
| 936 | /// }); | |||
| 937 | /// | |||
| 938 | /// @endcode | |||
| 939 | template <typename T, typename RecoveryFtor, typename... HandlerTs> | |||
| 940 | Expected<T> handleExpected(Expected<T> ValOrErr, RecoveryFtor &&RecoveryPath, | |||
| 941 | HandlerTs &&... Handlers) { | |||
| 942 | if (ValOrErr) | |||
| 943 | return ValOrErr; | |||
| 944 | ||||
| 945 | if (auto Err = handleErrors(ValOrErr.takeError(), | |||
| 946 | std::forward<HandlerTs>(Handlers)...)) | |||
| 947 | return std::move(Err); | |||
| 948 | ||||
| 949 | return RecoveryPath(); | |||
| 950 | } | |||
| 951 | ||||
| 952 | /// Log all errors (if any) in E to OS. If there are any errors, ErrorBanner | |||
| 953 | /// will be printed before the first one is logged. A newline will be printed | |||
| 954 | /// after each error. | |||
| 955 | /// | |||
| 956 | /// This is useful in the base level of your program to allow clean termination | |||
| 957 | /// (allowing clean deallocation of resources, etc.), while reporting error | |||
| 958 | /// information to the user. | |||
| 959 | void logAllUnhandledErrors(Error E, raw_ostream &OS, Twine ErrorBanner); | |||
| 960 | ||||
| 961 | /// Write all error messages (if any) in E to a string. The newline character | |||
| 962 | /// is used to separate error messages. | |||
| 963 | inline std::string toString(Error E) { | |||
| 964 | SmallVector<std::string, 2> Errors; | |||
| 965 | handleAllErrors(std::move(E), [&Errors](const ErrorInfoBase &EI) { | |||
| 966 | Errors.push_back(EI.message()); | |||
| 967 | }); | |||
| 968 | return join(Errors.begin(), Errors.end(), "\n"); | |||
| 969 | } | |||
| 970 | ||||
| 971 | /// Consume a Error without doing anything. This method should be used | |||
| 972 | /// only where an error can be considered a reasonable and expected return | |||
| 973 | /// value. | |||
| 974 | /// | |||
| 975 | /// Uses of this method are potentially indicative of design problems: If it's | |||
| 976 | /// legitimate to do nothing while processing an "error", the error-producer | |||
| 977 | /// might be more clearly refactored to return an Optional<T>. | |||
| 978 | inline void consumeError(Error Err) { | |||
| 979 | handleAllErrors(std::move(Err), [](const ErrorInfoBase &) {}); | |||
| 980 | } | |||
| 981 | ||||
| 982 | /// Helper for converting an Error to a bool. | |||
| 983 | /// | |||
| 984 | /// This method returns true if Err is in an error state, or false if it is | |||
| 985 | /// in a success state. Puts Err in a checked state in both cases (unlike | |||
| 986 | /// Error::operator bool(), which only does this for success states). | |||
| 987 | inline bool errorToBool(Error Err) { | |||
| 988 | bool IsError = static_cast<bool>(Err); | |||
| 989 | if (IsError) | |||
| 990 | consumeError(std::move(Err)); | |||
| 991 | return IsError; | |||
| 992 | } | |||
| 993 | ||||
| 994 | /// Helper for Errors used as out-parameters. | |||
| 995 | /// | |||
| 996 | /// This helper is for use with the Error-as-out-parameter idiom, where an error | |||
| 997 | /// is passed to a function or method by reference, rather than being returned. | |||
| 998 | /// In such cases it is helpful to set the checked bit on entry to the function | |||
| 999 | /// so that the error can be written to (unchecked Errors abort on assignment) | |||
| 1000 | /// and clear the checked bit on exit so that clients cannot accidentally forget | |||
| 1001 | /// to check the result. This helper performs these actions automatically using | |||
| 1002 | /// RAII: | |||
| 1003 | /// | |||
| 1004 | /// @code{.cpp} | |||
| 1005 | /// Result foo(Error &Err) { | |||
| 1006 | /// ErrorAsOutParameter ErrAsOutParam(&Err); // 'Checked' flag set | |||
| 1007 | /// // <body of foo> | |||
| 1008 | /// // <- 'Checked' flag auto-cleared when ErrAsOutParam is destructed. | |||
| 1009 | /// } | |||
| 1010 | /// @endcode | |||
| 1011 | /// | |||
| 1012 | /// ErrorAsOutParameter takes an Error* rather than Error& so that it can be | |||
| 1013 | /// used with optional Errors (Error pointers that are allowed to be null). If | |||
| 1014 | /// ErrorAsOutParameter took an Error reference, an instance would have to be | |||
| 1015 | /// created inside every condition that verified that Error was non-null. By | |||
| 1016 | /// taking an Error pointer we can just create one instance at the top of the | |||
| 1017 | /// function. | |||
| 1018 | class ErrorAsOutParameter { | |||
| 1019 | public: | |||
| 1020 | ErrorAsOutParameter(Error *Err) : Err(Err) { | |||
| 1021 | // Raise the checked bit if Err is success. | |||
| 1022 | if (Err) | |||
| 1023 | (void)!!*Err; | |||
| 1024 | } | |||
| 1025 | ||||
| 1026 | ~ErrorAsOutParameter() { | |||
| 1027 | // Clear the checked bit. | |||
| 1028 | if (Err && !*Err) | |||
| 1029 | *Err = Error::success(); | |||
| 1030 | } | |||
| 1031 | ||||
| 1032 | private: | |||
| 1033 | Error *Err; | |||
| 1034 | }; | |||
| 1035 | ||||
| 1036 | /// Helper for Expected<T>s used as out-parameters. | |||
| 1037 | /// | |||
| 1038 | /// See ErrorAsOutParameter. | |||
| 1039 | template <typename T> | |||
| 1040 | class ExpectedAsOutParameter { | |||
| 1041 | public: | |||
| 1042 | ExpectedAsOutParameter(Expected<T> *ValOrErr) | |||
| 1043 | : ValOrErr(ValOrErr) { | |||
| 1044 | if (ValOrErr) | |||
| 1045 | (void)!!*ValOrErr; | |||
| 1046 | } | |||
| 1047 | ||||
| 1048 | ~ExpectedAsOutParameter() { | |||
| 1049 | if (ValOrErr) | |||
| 1050 | ValOrErr->setUnchecked(); | |||
| 1051 | } | |||
| 1052 | ||||
| 1053 | private: | |||
| 1054 | Expected<T> *ValOrErr; | |||
| 1055 | }; | |||
| 1056 | ||||
| 1057 | /// This class wraps a std::error_code in a Error. | |||
| 1058 | /// | |||
| 1059 | /// This is useful if you're writing an interface that returns a Error | |||
| 1060 | /// (or Expected) and you want to call code that still returns | |||
| 1061 | /// std::error_codes. | |||
| 1062 | class ECError : public ErrorInfo<ECError> { | |||
| 1063 | friend Error errorCodeToError(std::error_code); | |||
| 1064 | ||||
| 1065 | public: | |||
| 1066 | void setErrorCode(std::error_code EC) { this->EC = EC; } | |||
| 1067 | std::error_code convertToErrorCode() const override { return EC; } | |||
| 1068 | void log(raw_ostream &OS) const override { OS << EC.message(); } | |||
| 1069 | ||||
| 1070 | // Used by ErrorInfo::classID. | |||
| 1071 | static char ID; | |||
| 1072 | ||||
| 1073 | protected: | |||
| 1074 | ECError() = default; | |||
| 1075 | ECError(std::error_code EC) : EC(EC) {} | |||
| 1076 | ||||
| 1077 | std::error_code EC; | |||
| 1078 | }; | |||
| 1079 | ||||
| 1080 | /// The value returned by this function can be returned from convertToErrorCode | |||
| 1081 | /// for Error values where no sensible translation to std::error_code exists. | |||
| 1082 | /// It should only be used in this situation, and should never be used where a | |||
| 1083 | /// sensible conversion to std::error_code is available, as attempts to convert | |||
| 1084 | /// to/from this error will result in a fatal error. (i.e. it is a programmatic | |||
| 1085 | ///error to try to convert such a value). | |||
| 1086 | std::error_code inconvertibleErrorCode(); | |||
| 1087 | ||||
| 1088 | /// Helper for converting an std::error_code to a Error. | |||
| 1089 | Error errorCodeToError(std::error_code EC); | |||
| 1090 | ||||
| 1091 | /// Helper for converting an ECError to a std::error_code. | |||
| 1092 | /// | |||
| 1093 | /// This method requires that Err be Error() or an ECError, otherwise it | |||
| 1094 | /// will trigger a call to abort(). | |||
| 1095 | std::error_code errorToErrorCode(Error Err); | |||
| 1096 | ||||
| 1097 | /// Convert an ErrorOr<T> to an Expected<T>. | |||
| 1098 | template <typename T> Expected<T> errorOrToExpected(ErrorOr<T> &&EO) { | |||
| 1099 | if (auto EC = EO.getError()) | |||
| 1100 | return errorCodeToError(EC); | |||
| 1101 | return std::move(*EO); | |||
| 1102 | } | |||
| 1103 | ||||
| 1104 | /// Convert an Expected<T> to an ErrorOr<T>. | |||
| 1105 | template <typename T> ErrorOr<T> expectedToErrorOr(Expected<T> &&E) { | |||
| 1106 | if (auto Err = E.takeError()) | |||
| 1107 | return errorToErrorCode(std::move(Err)); | |||
| 1108 | return std::move(*E); | |||
| 1109 | } | |||
| 1110 | ||||
| 1111 | /// This class wraps a string in an Error. | |||
| 1112 | /// | |||
| 1113 | /// StringError is useful in cases where the client is not expected to be able | |||
| 1114 | /// to consume the specific error message programmatically (for example, if the | |||
| 1115 | /// error message is to be presented to the user). | |||
| 1116 | /// | |||
| 1117 | /// StringError can also be used when additional information is to be printed | |||
| 1118 | /// along with a error_code message. Depending on the constructor called, this | |||
| 1119 | /// class can either display: | |||
| 1120 | /// 1. the error_code message (ECError behavior) | |||
| 1121 | /// 2. a string | |||
| 1122 | /// 3. the error_code message and a string | |||
| 1123 | /// | |||
| 1124 | /// These behaviors are useful when subtyping is required; for example, when a | |||
| 1125 | /// specific library needs an explicit error type. In the example below, | |||
| 1126 | /// PDBError is derived from StringError: | |||
| 1127 | /// | |||
| 1128 | /// @code{.cpp} | |||
| 1129 | /// Expected<int> foo() { | |||
| 1130 | /// return llvm::make_error<PDBError>(pdb_error_code::dia_failed_loading, | |||
| 1131 | /// "Additional information"); | |||
| 1132 | /// } | |||
| 1133 | /// @endcode | |||
| 1134 | /// | |||
| 1135 | class StringError : public ErrorInfo<StringError> { | |||
| 1136 | public: | |||
| 1137 | static char ID; | |||
| 1138 | ||||
| 1139 | // Prints EC + S and converts to EC | |||
| 1140 | StringError(std::error_code EC, const Twine &S = Twine()); | |||
| 1141 | ||||
| 1142 | // Prints S and converts to EC | |||
| 1143 | StringError(const Twine &S, std::error_code EC); | |||
| 1144 | ||||
| 1145 | void log(raw_ostream &OS) const override; | |||
| 1146 | std::error_code convertToErrorCode() const override; | |||
| 1147 | ||||
| 1148 | const std::string &getMessage() const { return Msg; } | |||
| 1149 | ||||
| 1150 | private: | |||
| 1151 | std::string Msg; | |||
| 1152 | std::error_code EC; | |||
| 1153 | const bool PrintMsgOnly = false; | |||
| 1154 | }; | |||
| 1155 | ||||
| 1156 | /// Create formatted StringError object. | |||
| 1157 | template <typename... Ts> | |||
| 1158 | Error createStringError(std::error_code EC, char const *Fmt, | |||
| 1159 | const Ts &... Vals) { | |||
| 1160 | std::string Buffer; | |||
| 1161 | raw_string_ostream Stream(Buffer); | |||
| 1162 | Stream << format(Fmt, Vals...); | |||
| 1163 | return make_error<StringError>(Stream.str(), EC); | |||
| 1164 | } | |||
| 1165 | ||||
| 1166 | Error createStringError(std::error_code EC, char const *Msg); | |||
| 1167 | ||||
| 1168 | /// This class wraps a filename and another Error. | |||
| 1169 | /// | |||
| 1170 | /// In some cases, an error needs to live along a 'source' name, in order to | |||
| 1171 | /// show more detailed information to the user. | |||
| 1172 | class FileError final : public ErrorInfo<FileError> { | |||
| 1173 | ||||
| 1174 | friend Error createFileError(std::string, Error); | |||
| 1175 | ||||
| 1176 | public: | |||
| 1177 | void log(raw_ostream &OS) const override { | |||
| 1178 | assert(Err && !FileName.empty() && "Trying to log after takeError().")((Err && !FileName.empty() && "Trying to log after takeError()." ) ? static_cast<void> (0) : __assert_fail ("Err && !FileName.empty() && \"Trying to log after takeError().\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1178, __PRETTY_FUNCTION__)); | |||
| 1179 | OS << "'" << FileName << "': "; | |||
| 1180 | Err->log(OS); | |||
| 1181 | } | |||
| 1182 | ||||
| 1183 | Error takeError() { return Error(std::move(Err)); } | |||
| 1184 | ||||
| 1185 | std::error_code convertToErrorCode() const override; | |||
| 1186 | ||||
| 1187 | // Used by ErrorInfo::classID. | |||
| 1188 | static char ID; | |||
| 1189 | ||||
| 1190 | private: | |||
| 1191 | FileError(std::string F, std::unique_ptr<ErrorInfoBase> E) { | |||
| 1192 | assert(E && "Cannot create FileError from Error success value.")((E && "Cannot create FileError from Error success value." ) ? static_cast<void> (0) : __assert_fail ("E && \"Cannot create FileError from Error success value.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1192, __PRETTY_FUNCTION__)); | |||
| 1193 | assert(!F.empty() &&((!F.empty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1194, __PRETTY_FUNCTION__)) | |||
| 1194 | "The file name provided to FileError must not be empty.")((!F.empty() && "The file name provided to FileError must not be empty." ) ? static_cast<void> (0) : __assert_fail ("!F.empty() && \"The file name provided to FileError must not be empty.\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/Support/Error.h" , 1194, __PRETTY_FUNCTION__)); | |||
| 1195 | FileName = F; | |||
| 1196 | Err = std::move(E); | |||
| 1197 | } | |||
| 1198 | ||||
| 1199 | static Error build(std::string F, Error E) { | |||
| 1200 | return Error(std::unique_ptr<FileError>(new FileError(F, E.takePayload()))); | |||
| 1201 | } | |||
| 1202 | ||||
| 1203 | std::string FileName; | |||
| 1204 | std::unique_ptr<ErrorInfoBase> Err; | |||
| 1205 | }; | |||
| 1206 | ||||
| 1207 | /// Concatenate a source file path and/or name with an Error. The resulting | |||
| 1208 | /// Error is unchecked. | |||
| 1209 | inline Error createFileError(std::string F, Error E) { | |||
| 1210 | return FileError::build(F, std::move(E)); | |||
| 1211 | } | |||
| 1212 | ||||
| 1213 | Error createFileError(std::string F, ErrorSuccess) = delete; | |||
| 1214 | ||||
| 1215 | /// Helper for check-and-exit error handling. | |||
| 1216 | /// | |||
| 1217 | /// For tool use only. NOT FOR USE IN LIBRARY CODE. | |||
| 1218 | /// | |||
| 1219 | class ExitOnError { | |||
| 1220 | public: | |||
| 1221 | /// Create an error on exit helper. | |||
| 1222 | ExitOnError(std::string Banner = "", int DefaultErrorExitCode = 1) | |||
| 1223 | : Banner(std::move(Banner)), | |||
| 1224 | GetExitCode([=](const Error &) { return DefaultErrorExitCode; }) {} | |||
| 1225 | ||||
| 1226 | /// Set the banner string for any errors caught by operator(). | |||
| 1227 | void setBanner(std::string Banner) { this->Banner = std::move(Banner); } | |||
| 1228 | ||||
| 1229 | /// Set the exit-code mapper function. | |||
| 1230 | void setExitCodeMapper(std::function<int(const Error &)> GetExitCode) { | |||
| 1231 | this->GetExitCode = std::move(GetExitCode); | |||
| 1232 | } | |||
| 1233 | ||||
| 1234 | /// Check Err. If it's in a failure state log the error(s) and exit. | |||
| 1235 | void operator()(Error Err) const { checkError(std::move(Err)); } | |||
| 1236 | ||||
| 1237 | /// Check E. If it's in a success state then return the contained value. If | |||
| 1238 | /// it's in a failure state log the error(s) and exit. | |||
| 1239 | template <typename T> T operator()(Expected<T> &&E) const { | |||
| 1240 | checkError(E.takeError()); | |||
| 1241 | return std::move(*E); | |||
| 1242 | } | |||
| 1243 | ||||
| 1244 | /// Check E. If it's in a success state then return the contained reference. If | |||
| 1245 | /// it's in a failure state log the error(s) and exit. | |||
| 1246 | template <typename T> T& operator()(Expected<T&> &&E) const { | |||
| 1247 | checkError(E.takeError()); | |||
| 1248 | return *E; | |||
| 1249 | } | |||
| 1250 | ||||
| 1251 | private: | |||
| 1252 | void checkError(Error Err) const { | |||
| 1253 | if (Err) { | |||
| 1254 | int ExitCode = GetExitCode(Err); | |||
| 1255 | logAllUnhandledErrors(std::move(Err), errs(), Banner); | |||
| 1256 | exit(ExitCode); | |||
| 1257 | } | |||
| 1258 | } | |||
| 1259 | ||||
| 1260 | std::string Banner; | |||
| 1261 | std::function<int(const Error &)> GetExitCode; | |||
| 1262 | }; | |||
| 1263 | ||||
| 1264 | /// Conversion from Error to LLVMErrorRef for C error bindings. | |||
| 1265 | inline LLVMErrorRef wrap(Error Err) { | |||
| 1266 | return reinterpret_cast<LLVMErrorRef>(Err.takePayload().release()); | |||
| 1267 | } | |||
| 1268 | ||||
| 1269 | /// Conversion from LLVMErrorRef to Error for C error bindings. | |||
| 1270 | inline Error unwrap(LLVMErrorRef ErrRef) { | |||
| 1271 | return Error(std::unique_ptr<ErrorInfoBase>( | |||
| 1272 | reinterpret_cast<ErrorInfoBase *>(ErrRef))); | |||
| 1273 | } | |||
| 1274 | ||||
| 1275 | } // end namespace llvm | |||
| 1276 | ||||
| 1277 | #endif // LLVM_SUPPORT_ERROR_H |
| 1 | //===- llvm/ADT/STLExtras.h - Useful STL related functions ------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file contains some templates that are useful if you are working with the |
| 11 | // STL at all. |
| 12 | // |
| 13 | // No library is required when using these functions. |
| 14 | // |
| 15 | //===----------------------------------------------------------------------===// |
| 16 | |
| 17 | #ifndef LLVM_ADT_STLEXTRAS_H |
| 18 | #define LLVM_ADT_STLEXTRAS_H |
| 19 | |
| 20 | #include "llvm/ADT/Optional.h" |
| 21 | #include "llvm/ADT/SmallVector.h" |
| 22 | #include "llvm/ADT/iterator.h" |
| 23 | #include "llvm/ADT/iterator_range.h" |
| 24 | #include "llvm/Config/abi-breaking.h" |
| 25 | #include "llvm/Support/ErrorHandling.h" |
| 26 | #include <algorithm> |
| 27 | #include <cassert> |
| 28 | #include <cstddef> |
| 29 | #include <cstdint> |
| 30 | #include <cstdlib> |
| 31 | #include <functional> |
| 32 | #include <initializer_list> |
| 33 | #include <iterator> |
| 34 | #include <limits> |
| 35 | #include <memory> |
| 36 | #include <tuple> |
| 37 | #include <type_traits> |
| 38 | #include <utility> |
| 39 | |
| 40 | #ifdef EXPENSIVE_CHECKS |
| 41 | #include <random> // for std::mt19937 |
| 42 | #endif |
| 43 | |
| 44 | namespace llvm { |
| 45 | |
| 46 | // Only used by compiler if both template types are the same. Useful when |
| 47 | // using SFINAE to test for the existence of member functions. |
| 48 | template <typename T, T> struct SameType; |
| 49 | |
| 50 | namespace detail { |
| 51 | |
| 52 | template <typename RangeT> |
| 53 | using IterOfRange = decltype(std::begin(std::declval<RangeT &>())); |
| 54 | |
| 55 | template <typename RangeT> |
| 56 | using ValueOfRange = typename std::remove_reference<decltype( |
| 57 | *std::begin(std::declval<RangeT &>()))>::type; |
| 58 | |
| 59 | } // end namespace detail |
| 60 | |
| 61 | //===----------------------------------------------------------------------===// |
| 62 | // Extra additions to <type_traits> |
| 63 | //===----------------------------------------------------------------------===// |
| 64 | |
| 65 | template <typename T> |
| 66 | struct negation : std::integral_constant<bool, !bool(T::value)> {}; |
| 67 | |
| 68 | template <typename...> struct conjunction : std::true_type {}; |
| 69 | template <typename B1> struct conjunction<B1> : B1 {}; |
| 70 | template <typename B1, typename... Bn> |
| 71 | struct conjunction<B1, Bn...> |
| 72 | : std::conditional<bool(B1::value), conjunction<Bn...>, B1>::type {}; |
| 73 | |
| 74 | //===----------------------------------------------------------------------===// |
| 75 | // Extra additions to <functional> |
| 76 | //===----------------------------------------------------------------------===// |
| 77 | |
| 78 | template <class Ty> struct identity { |
| 79 | using argument_type = Ty; |
| 80 | |
| 81 | Ty &operator()(Ty &self) const { |
| 82 | return self; |
| 83 | } |
| 84 | const Ty &operator()(const Ty &self) const { |
| 85 | return self; |
| 86 | } |
| 87 | }; |
| 88 | |
| 89 | template <class Ty> struct less_ptr { |
| 90 | bool operator()(const Ty* left, const Ty* right) const { |
| 91 | return *left < *right; |
| 92 | } |
| 93 | }; |
| 94 | |
| 95 | template <class Ty> struct greater_ptr { |
| 96 | bool operator()(const Ty* left, const Ty* right) const { |
| 97 | return *right < *left; |
| 98 | } |
| 99 | }; |
| 100 | |
| 101 | /// An efficient, type-erasing, non-owning reference to a callable. This is |
| 102 | /// intended for use as the type of a function parameter that is not used |
| 103 | /// after the function in question returns. |
| 104 | /// |
| 105 | /// This class does not own the callable, so it is not in general safe to store |
| 106 | /// a function_ref. |
| 107 | template<typename Fn> class function_ref; |
| 108 | |
| 109 | template<typename Ret, typename ...Params> |
| 110 | class function_ref<Ret(Params...)> { |
| 111 | Ret (*callback)(intptr_t callable, Params ...params) = nullptr; |
| 112 | intptr_t callable; |
| 113 | |
| 114 | template<typename Callable> |
| 115 | static Ret callback_fn(intptr_t callable, Params ...params) { |
| 116 | return (*reinterpret_cast<Callable*>(callable))( |
| 117 | std::forward<Params>(params)...); |
| 118 | } |
| 119 | |
| 120 | public: |
| 121 | function_ref() = default; |
| 122 | function_ref(std::nullptr_t) {} |
| 123 | |
| 124 | template <typename Callable> |
| 125 | function_ref(Callable &&callable, |
| 126 | typename std::enable_if< |
| 127 | !std::is_same<typename std::remove_reference<Callable>::type, |
| 128 | function_ref>::value>::type * = nullptr) |
| 129 | : callback(callback_fn<typename std::remove_reference<Callable>::type>), |
| 130 | callable(reinterpret_cast<intptr_t>(&callable)) {} |
| 131 | |
| 132 | Ret operator()(Params ...params) const { |
| 133 | return callback(callable, std::forward<Params>(params)...); |
| 134 | } |
| 135 | |
| 136 | operator bool() const { return callback; } |
| 137 | }; |
| 138 | |
| 139 | // deleter - Very very very simple method that is used to invoke operator |
| 140 | // delete on something. It is used like this: |
| 141 | // |
| 142 | // for_each(V.begin(), B.end(), deleter<Interval>); |
| 143 | template <class T> |
| 144 | inline void deleter(T *Ptr) { |
| 145 | delete Ptr; |
| 146 | } |
| 147 | |
| 148 | //===----------------------------------------------------------------------===// |
| 149 | // Extra additions to <iterator> |
| 150 | //===----------------------------------------------------------------------===// |
| 151 | |
| 152 | namespace adl_detail { |
| 153 | |
| 154 | using std::begin; |
| 155 | |
| 156 | template <typename ContainerTy> |
| 157 | auto adl_begin(ContainerTy &&container) |
| 158 | -> decltype(begin(std::forward<ContainerTy>(container))) { |
| 159 | return begin(std::forward<ContainerTy>(container)); |
| 160 | } |
| 161 | |
| 162 | using std::end; |
| 163 | |
| 164 | template <typename ContainerTy> |
| 165 | auto adl_end(ContainerTy &&container) |
| 166 | -> decltype(end(std::forward<ContainerTy>(container))) { |
| 167 | return end(std::forward<ContainerTy>(container)); |
| 168 | } |
| 169 | |
| 170 | using std::swap; |
| 171 | |
| 172 | template <typename T> |
| 173 | void adl_swap(T &&lhs, T &&rhs) noexcept(noexcept(swap(std::declval<T>(), |
| 174 | std::declval<T>()))) { |
| 175 | swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
| 176 | } |
| 177 | |
| 178 | } // end namespace adl_detail |
| 179 | |
| 180 | template <typename ContainerTy> |
| 181 | auto adl_begin(ContainerTy &&container) |
| 182 | -> decltype(adl_detail::adl_begin(std::forward<ContainerTy>(container))) { |
| 183 | return adl_detail::adl_begin(std::forward<ContainerTy>(container)); |
| 184 | } |
| 185 | |
| 186 | template <typename ContainerTy> |
| 187 | auto adl_end(ContainerTy &&container) |
| 188 | -> decltype(adl_detail::adl_end(std::forward<ContainerTy>(container))) { |
| 189 | return adl_detail::adl_end(std::forward<ContainerTy>(container)); |
| 190 | } |
| 191 | |
| 192 | template <typename T> |
| 193 | void adl_swap(T &&lhs, T &&rhs) noexcept( |
| 194 | noexcept(adl_detail::adl_swap(std::declval<T>(), std::declval<T>()))) { |
| 195 | adl_detail::adl_swap(std::forward<T>(lhs), std::forward<T>(rhs)); |
| 196 | } |
| 197 | |
| 198 | // mapped_iterator - This is a simple iterator adapter that causes a function to |
| 199 | // be applied whenever operator* is invoked on the iterator. |
| 200 | |
| 201 | template <typename ItTy, typename FuncTy, |
| 202 | typename FuncReturnTy = |
| 203 | decltype(std::declval<FuncTy>()(*std::declval<ItTy>()))> |
| 204 | class mapped_iterator |
| 205 | : public iterator_adaptor_base< |
| 206 | mapped_iterator<ItTy, FuncTy>, ItTy, |
| 207 | typename std::iterator_traits<ItTy>::iterator_category, |
| 208 | typename std::remove_reference<FuncReturnTy>::type> { |
| 209 | public: |
| 210 | mapped_iterator(ItTy U, FuncTy F) |
| 211 | : mapped_iterator::iterator_adaptor_base(std::move(U)), F(std::move(F)) {} |
| 212 | |
| 213 | ItTy getCurrent() { return this->I; } |
| 214 | |
| 215 | FuncReturnTy operator*() { return F(*this->I); } |
| 216 | |
| 217 | private: |
| 218 | FuncTy F; |
| 219 | }; |
| 220 | |
| 221 | // map_iterator - Provide a convenient way to create mapped_iterators, just like |
| 222 | // make_pair is useful for creating pairs... |
| 223 | template <class ItTy, class FuncTy> |
| 224 | inline mapped_iterator<ItTy, FuncTy> map_iterator(ItTy I, FuncTy F) { |
| 225 | return mapped_iterator<ItTy, FuncTy>(std::move(I), std::move(F)); |
| 226 | } |
| 227 | |
| 228 | /// Helper to determine if type T has a member called rbegin(). |
| 229 | template <typename Ty> class has_rbegin_impl { |
| 230 | using yes = char[1]; |
| 231 | using no = char[2]; |
| 232 | |
| 233 | template <typename Inner> |
| 234 | static yes& test(Inner *I, decltype(I->rbegin()) * = nullptr); |
| 235 | |
| 236 | template <typename> |
| 237 | static no& test(...); |
| 238 | |
| 239 | public: |
| 240 | static const bool value = sizeof(test<Ty>(nullptr)) == sizeof(yes); |
| 241 | }; |
| 242 | |
| 243 | /// Metafunction to determine if T& or T has a member called rbegin(). |
| 244 | template <typename Ty> |
| 245 | struct has_rbegin : has_rbegin_impl<typename std::remove_reference<Ty>::type> { |
| 246 | }; |
| 247 | |
| 248 | // Returns an iterator_range over the given container which iterates in reverse. |
| 249 | // Note that the container must have rbegin()/rend() methods for this to work. |
| 250 | template <typename ContainerTy> |
| 251 | auto reverse(ContainerTy &&C, |
| 252 | typename std::enable_if<has_rbegin<ContainerTy>::value>::type * = |
| 253 | nullptr) -> decltype(make_range(C.rbegin(), C.rend())) { |
| 254 | return make_range(C.rbegin(), C.rend()); |
| 255 | } |
| 256 | |
| 257 | // Returns a std::reverse_iterator wrapped around the given iterator. |
| 258 | template <typename IteratorTy> |
| 259 | std::reverse_iterator<IteratorTy> make_reverse_iterator(IteratorTy It) { |
| 260 | return std::reverse_iterator<IteratorTy>(It); |
| 261 | } |
| 262 | |
| 263 | // Returns an iterator_range over the given container which iterates in reverse. |
| 264 | // Note that the container must have begin()/end() methods which return |
| 265 | // bidirectional iterators for this to work. |
| 266 | template <typename ContainerTy> |
| 267 | auto reverse( |
| 268 | ContainerTy &&C, |
| 269 | typename std::enable_if<!has_rbegin<ContainerTy>::value>::type * = nullptr) |
| 270 | -> decltype(make_range(llvm::make_reverse_iterator(std::end(C)), |
| 271 | llvm::make_reverse_iterator(std::begin(C)))) { |
| 272 | return make_range(llvm::make_reverse_iterator(std::end(C)), |
| 273 | llvm::make_reverse_iterator(std::begin(C))); |
| 274 | } |
| 275 | |
| 276 | /// An iterator adaptor that filters the elements of given inner iterators. |
| 277 | /// |
| 278 | /// The predicate parameter should be a callable object that accepts the wrapped |
| 279 | /// iterator's reference type and returns a bool. When incrementing or |
| 280 | /// decrementing the iterator, it will call the predicate on each element and |
| 281 | /// skip any where it returns false. |
| 282 | /// |
| 283 | /// \code |
| 284 | /// int A[] = { 1, 2, 3, 4 }; |
| 285 | /// auto R = make_filter_range(A, [](int N) { return N % 2 == 1; }); |
| 286 | /// // R contains { 1, 3 }. |
| 287 | /// \endcode |
| 288 | /// |
| 289 | /// Note: filter_iterator_base implements support for forward iteration. |
| 290 | /// filter_iterator_impl exists to provide support for bidirectional iteration, |
| 291 | /// conditional on whether the wrapped iterator supports it. |
| 292 | template <typename WrappedIteratorT, typename PredicateT, typename IterTag> |
| 293 | class filter_iterator_base |
| 294 | : public iterator_adaptor_base< |
| 295 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
| 296 | WrappedIteratorT, |
| 297 | typename std::common_type< |
| 298 | IterTag, typename std::iterator_traits< |
| 299 | WrappedIteratorT>::iterator_category>::type> { |
| 300 | using BaseT = iterator_adaptor_base< |
| 301 | filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>, |
| 302 | WrappedIteratorT, |
| 303 | typename std::common_type< |
| 304 | IterTag, typename std::iterator_traits< |
| 305 | WrappedIteratorT>::iterator_category>::type>; |
| 306 | |
| 307 | protected: |
| 308 | WrappedIteratorT End; |
| 309 | PredicateT Pred; |
| 310 | |
| 311 | void findNextValid() { |
| 312 | while (this->I != End && !Pred(*this->I)) |
| 313 | BaseT::operator++(); |
| 314 | } |
| 315 | |
| 316 | // Construct the iterator. The begin iterator needs to know where the end |
| 317 | // is, so that it can properly stop when it gets there. The end iterator only |
| 318 | // needs the predicate to support bidirectional iteration. |
| 319 | filter_iterator_base(WrappedIteratorT Begin, WrappedIteratorT End, |
| 320 | PredicateT Pred) |
| 321 | : BaseT(Begin), End(End), Pred(Pred) { |
| 322 | findNextValid(); |
| 323 | } |
| 324 | |
| 325 | public: |
| 326 | using BaseT::operator++; |
| 327 | |
| 328 | filter_iterator_base &operator++() { |
| 329 | BaseT::operator++(); |
| 330 | findNextValid(); |
| 331 | return *this; |
| 332 | } |
| 333 | }; |
| 334 | |
| 335 | /// Specialization of filter_iterator_base for forward iteration only. |
| 336 | template <typename WrappedIteratorT, typename PredicateT, |
| 337 | typename IterTag = std::forward_iterator_tag> |
| 338 | class filter_iterator_impl |
| 339 | : public filter_iterator_base<WrappedIteratorT, PredicateT, IterTag> { |
| 340 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, IterTag>; |
| 341 | |
| 342 | public: |
| 343 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
| 344 | PredicateT Pred) |
| 345 | : BaseT(Begin, End, Pred) {} |
| 346 | }; |
| 347 | |
| 348 | /// Specialization of filter_iterator_base for bidirectional iteration. |
| 349 | template <typename WrappedIteratorT, typename PredicateT> |
| 350 | class filter_iterator_impl<WrappedIteratorT, PredicateT, |
| 351 | std::bidirectional_iterator_tag> |
| 352 | : public filter_iterator_base<WrappedIteratorT, PredicateT, |
| 353 | std::bidirectional_iterator_tag> { |
| 354 | using BaseT = filter_iterator_base<WrappedIteratorT, PredicateT, |
| 355 | std::bidirectional_iterator_tag>; |
| 356 | void findPrevValid() { |
| 357 | while (!this->Pred(*this->I)) |
| 358 | BaseT::operator--(); |
| 359 | } |
| 360 | |
| 361 | public: |
| 362 | using BaseT::operator--; |
| 363 | |
| 364 | filter_iterator_impl(WrappedIteratorT Begin, WrappedIteratorT End, |
| 365 | PredicateT Pred) |
| 366 | : BaseT(Begin, End, Pred) {} |
| 367 | |
| 368 | filter_iterator_impl &operator--() { |
| 369 | BaseT::operator--(); |
| 370 | findPrevValid(); |
| 371 | return *this; |
| 372 | } |
| 373 | }; |
| 374 | |
| 375 | namespace detail { |
| 376 | |
| 377 | template <bool is_bidirectional> struct fwd_or_bidi_tag_impl { |
| 378 | using type = std::forward_iterator_tag; |
| 379 | }; |
| 380 | |
| 381 | template <> struct fwd_or_bidi_tag_impl<true> { |
| 382 | using type = std::bidirectional_iterator_tag; |
| 383 | }; |
| 384 | |
| 385 | /// Helper which sets its type member to forward_iterator_tag if the category |
| 386 | /// of \p IterT does not derive from bidirectional_iterator_tag, and to |
| 387 | /// bidirectional_iterator_tag otherwise. |
| 388 | template <typename IterT> struct fwd_or_bidi_tag { |
| 389 | using type = typename fwd_or_bidi_tag_impl<std::is_base_of< |
| 390 | std::bidirectional_iterator_tag, |
| 391 | typename std::iterator_traits<IterT>::iterator_category>::value>::type; |
| 392 | }; |
| 393 | |
| 394 | } // namespace detail |
| 395 | |
| 396 | /// Defines filter_iterator to a suitable specialization of |
| 397 | /// filter_iterator_impl, based on the underlying iterator's category. |
| 398 | template <typename WrappedIteratorT, typename PredicateT> |
| 399 | using filter_iterator = filter_iterator_impl< |
| 400 | WrappedIteratorT, PredicateT, |
| 401 | typename detail::fwd_or_bidi_tag<WrappedIteratorT>::type>; |
| 402 | |
| 403 | /// Convenience function that takes a range of elements and a predicate, |
| 404 | /// and return a new filter_iterator range. |
| 405 | /// |
| 406 | /// FIXME: Currently if RangeT && is a rvalue reference to a temporary, the |
| 407 | /// lifetime of that temporary is not kept by the returned range object, and the |
| 408 | /// temporary is going to be dropped on the floor after the make_iterator_range |
| 409 | /// full expression that contains this function call. |
| 410 | template <typename RangeT, typename PredicateT> |
| 411 | iterator_range<filter_iterator<detail::IterOfRange<RangeT>, PredicateT>> |
| 412 | make_filter_range(RangeT &&Range, PredicateT Pred) { |
| 413 | using FilterIteratorT = |
| 414 | filter_iterator<detail::IterOfRange<RangeT>, PredicateT>; |
| 415 | return make_range( |
| 416 | FilterIteratorT(std::begin(std::forward<RangeT>(Range)), |
| 417 | std::end(std::forward<RangeT>(Range)), Pred), |
| 418 | FilterIteratorT(std::end(std::forward<RangeT>(Range)), |
| 419 | std::end(std::forward<RangeT>(Range)), Pred)); |
| 420 | } |
| 421 | |
| 422 | /// A pseudo-iterator adaptor that is designed to implement "early increment" |
| 423 | /// style loops. |
| 424 | /// |
| 425 | /// This is *not a normal iterator* and should almost never be used directly. It |
| 426 | /// is intended primarily to be used with range based for loops and some range |
| 427 | /// algorithms. |
| 428 | /// |
| 429 | /// The iterator isn't quite an `OutputIterator` or an `InputIterator` but |
| 430 | /// somewhere between them. The constraints of these iterators are: |
| 431 | /// |
| 432 | /// - On construction or after being incremented, it is comparable and |
| 433 | /// dereferencable. It is *not* incrementable. |
| 434 | /// - After being dereferenced, it is neither comparable nor dereferencable, it |
| 435 | /// is only incrementable. |
| 436 | /// |
| 437 | /// This means you can only dereference the iterator once, and you can only |
| 438 | /// increment it once between dereferences. |
| 439 | template <typename WrappedIteratorT> |
| 440 | class early_inc_iterator_impl |
| 441 | : public iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
| 442 | WrappedIteratorT, std::input_iterator_tag> { |
| 443 | using BaseT = |
| 444 | iterator_adaptor_base<early_inc_iterator_impl<WrappedIteratorT>, |
| 445 | WrappedIteratorT, std::input_iterator_tag>; |
| 446 | |
| 447 | using PointerT = typename std::iterator_traits<WrappedIteratorT>::pointer; |
| 448 | |
| 449 | protected: |
| 450 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
| 451 | bool IsEarlyIncremented = false; |
| 452 | #endif |
| 453 | |
| 454 | public: |
| 455 | early_inc_iterator_impl(WrappedIteratorT I) : BaseT(I) {} |
| 456 | |
| 457 | using BaseT::operator*; |
| 458 | typename BaseT::reference operator*() { |
| 459 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
| 460 | assert(!IsEarlyIncremented && "Cannot dereference twice!")((!IsEarlyIncremented && "Cannot dereference twice!") ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot dereference twice!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 460, __PRETTY_FUNCTION__)); |
| 461 | IsEarlyIncremented = true; |
| 462 | #endif |
| 463 | return *(this->I)++; |
| 464 | } |
| 465 | |
| 466 | using BaseT::operator++; |
| 467 | early_inc_iterator_impl &operator++() { |
| 468 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
| 469 | assert(IsEarlyIncremented && "Cannot increment before dereferencing!")((IsEarlyIncremented && "Cannot increment before dereferencing!" ) ? static_cast<void> (0) : __assert_fail ("IsEarlyIncremented && \"Cannot increment before dereferencing!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 469, __PRETTY_FUNCTION__)); |
| 470 | IsEarlyIncremented = false; |
| 471 | #endif |
| 472 | return *this; |
| 473 | } |
| 474 | |
| 475 | using BaseT::operator==; |
| 476 | bool operator==(const early_inc_iterator_impl &RHS) const { |
| 477 | #if LLVM_ENABLE_ABI_BREAKING_CHECKS1 |
| 478 | assert(!IsEarlyIncremented && "Cannot compare after dereferencing!")((!IsEarlyIncremented && "Cannot compare after dereferencing!" ) ? static_cast<void> (0) : __assert_fail ("!IsEarlyIncremented && \"Cannot compare after dereferencing!\"" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 478, __PRETTY_FUNCTION__)); |
| 479 | #endif |
| 480 | return BaseT::operator==(RHS); |
| 481 | } |
| 482 | }; |
| 483 | |
| 484 | /// Make a range that does early increment to allow mutation of the underlying |
| 485 | /// range without disrupting iteration. |
| 486 | /// |
| 487 | /// The underlying iterator will be incremented immediately after it is |
| 488 | /// dereferenced, allowing deletion of the current node or insertion of nodes to |
| 489 | /// not disrupt iteration provided they do not invalidate the *next* iterator -- |
| 490 | /// the current iterator can be invalidated. |
| 491 | /// |
| 492 | /// This requires a very exact pattern of use that is only really suitable to |
| 493 | /// range based for loops and other range algorithms that explicitly guarantee |
| 494 | /// to dereference exactly once each element, and to increment exactly once each |
| 495 | /// element. |
| 496 | template <typename RangeT> |
| 497 | iterator_range<early_inc_iterator_impl<detail::IterOfRange<RangeT>>> |
| 498 | make_early_inc_range(RangeT &&Range) { |
| 499 | using EarlyIncIteratorT = |
| 500 | early_inc_iterator_impl<detail::IterOfRange<RangeT>>; |
| 501 | return make_range(EarlyIncIteratorT(std::begin(std::forward<RangeT>(Range))), |
| 502 | EarlyIncIteratorT(std::end(std::forward<RangeT>(Range)))); |
| 503 | } |
| 504 | |
| 505 | // forward declarations required by zip_shortest/zip_first |
| 506 | template <typename R, typename UnaryPredicate> |
| 507 | bool all_of(R &&range, UnaryPredicate P); |
| 508 | |
| 509 | template <size_t... I> struct index_sequence; |
| 510 | |
| 511 | template <class... Ts> struct index_sequence_for; |
| 512 | |
| 513 | namespace detail { |
| 514 | |
| 515 | using std::declval; |
| 516 | |
| 517 | // We have to alias this since inlining the actual type at the usage site |
| 518 | // in the parameter list of iterator_facade_base<> below ICEs MSVC 2017. |
| 519 | template<typename... Iters> struct ZipTupleType { |
| 520 | using type = std::tuple<decltype(*declval<Iters>())...>; |
| 521 | }; |
| 522 | |
| 523 | template <typename ZipType, typename... Iters> |
| 524 | using zip_traits = iterator_facade_base< |
| 525 | ZipType, typename std::common_type<std::bidirectional_iterator_tag, |
| 526 | typename std::iterator_traits< |
| 527 | Iters>::iterator_category...>::type, |
| 528 | // ^ TODO: Implement random access methods. |
| 529 | typename ZipTupleType<Iters...>::type, |
| 530 | typename std::iterator_traits<typename std::tuple_element< |
| 531 | 0, std::tuple<Iters...>>::type>::difference_type, |
| 532 | // ^ FIXME: This follows boost::make_zip_iterator's assumption that all |
| 533 | // inner iterators have the same difference_type. It would fail if, for |
| 534 | // instance, the second field's difference_type were non-numeric while the |
| 535 | // first is. |
| 536 | typename ZipTupleType<Iters...>::type *, |
| 537 | typename ZipTupleType<Iters...>::type>; |
| 538 | |
| 539 | template <typename ZipType, typename... Iters> |
| 540 | struct zip_common : public zip_traits<ZipType, Iters...> { |
| 541 | using Base = zip_traits<ZipType, Iters...>; |
| 542 | using value_type = typename Base::value_type; |
| 543 | |
| 544 | std::tuple<Iters...> iterators; |
| 545 | |
| 546 | protected: |
| 547 | template <size_t... Ns> value_type deref(index_sequence<Ns...>) const { |
| 548 | return value_type(*std::get<Ns>(iterators)...); |
| 549 | } |
| 550 | |
| 551 | template <size_t... Ns> |
| 552 | decltype(iterators) tup_inc(index_sequence<Ns...>) const { |
| 553 | return std::tuple<Iters...>(std::next(std::get<Ns>(iterators))...); |
| 554 | } |
| 555 | |
| 556 | template <size_t... Ns> |
| 557 | decltype(iterators) tup_dec(index_sequence<Ns...>) const { |
| 558 | return std::tuple<Iters...>(std::prev(std::get<Ns>(iterators))...); |
| 559 | } |
| 560 | |
| 561 | public: |
| 562 | zip_common(Iters &&... ts) : iterators(std::forward<Iters>(ts)...) {} |
| 563 | |
| 564 | value_type operator*() { return deref(index_sequence_for<Iters...>{}); } |
| 565 | |
| 566 | const value_type operator*() const { |
| 567 | return deref(index_sequence_for<Iters...>{}); |
| 568 | } |
| 569 | |
| 570 | ZipType &operator++() { |
| 571 | iterators = tup_inc(index_sequence_for<Iters...>{}); |
| 572 | return *reinterpret_cast<ZipType *>(this); |
| 573 | } |
| 574 | |
| 575 | ZipType &operator--() { |
| 576 | static_assert(Base::IsBidirectional, |
| 577 | "All inner iterators must be at least bidirectional."); |
| 578 | iterators = tup_dec(index_sequence_for<Iters...>{}); |
| 579 | return *reinterpret_cast<ZipType *>(this); |
| 580 | } |
| 581 | }; |
| 582 | |
| 583 | template <typename... Iters> |
| 584 | struct zip_first : public zip_common<zip_first<Iters...>, Iters...> { |
| 585 | using Base = zip_common<zip_first<Iters...>, Iters...>; |
| 586 | |
| 587 | bool operator==(const zip_first<Iters...> &other) const { |
| 588 | return std::get<0>(this->iterators) == std::get<0>(other.iterators); |
| 589 | } |
| 590 | |
| 591 | zip_first(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
| 592 | }; |
| 593 | |
| 594 | template <typename... Iters> |
| 595 | class zip_shortest : public zip_common<zip_shortest<Iters...>, Iters...> { |
| 596 | template <size_t... Ns> |
| 597 | bool test(const zip_shortest<Iters...> &other, index_sequence<Ns...>) const { |
| 598 | return all_of(std::initializer_list<bool>{std::get<Ns>(this->iterators) != |
| 599 | std::get<Ns>(other.iterators)...}, |
| 600 | identity<bool>{}); |
| 601 | } |
| 602 | |
| 603 | public: |
| 604 | using Base = zip_common<zip_shortest<Iters...>, Iters...>; |
| 605 | |
| 606 | zip_shortest(Iters &&... ts) : Base(std::forward<Iters>(ts)...) {} |
| 607 | |
| 608 | bool operator==(const zip_shortest<Iters...> &other) const { |
| 609 | return !test(other, index_sequence_for<Iters...>{}); |
| 610 | } |
| 611 | }; |
| 612 | |
| 613 | template <template <typename...> class ItType, typename... Args> class zippy { |
| 614 | public: |
| 615 | using iterator = ItType<decltype(std::begin(std::declval<Args>()))...>; |
| 616 | using iterator_category = typename iterator::iterator_category; |
| 617 | using value_type = typename iterator::value_type; |
| 618 | using difference_type = typename iterator::difference_type; |
| 619 | using pointer = typename iterator::pointer; |
| 620 | using reference = typename iterator::reference; |
| 621 | |
| 622 | private: |
| 623 | std::tuple<Args...> ts; |
| 624 | |
| 625 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) const { |
| 626 | return iterator(std::begin(std::get<Ns>(ts))...); |
| 627 | } |
| 628 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) const { |
| 629 | return iterator(std::end(std::get<Ns>(ts))...); |
| 630 | } |
| 631 | |
| 632 | public: |
| 633 | zippy(Args &&... ts_) : ts(std::forward<Args>(ts_)...) {} |
| 634 | |
| 635 | iterator begin() const { return begin_impl(index_sequence_for<Args...>{}); } |
| 636 | iterator end() const { return end_impl(index_sequence_for<Args...>{}); } |
| 637 | }; |
| 638 | |
| 639 | } // end namespace detail |
| 640 | |
| 641 | /// zip iterator for two or more iteratable types. |
| 642 | template <typename T, typename U, typename... Args> |
| 643 | detail::zippy<detail::zip_shortest, T, U, Args...> zip(T &&t, U &&u, |
| 644 | Args &&... args) { |
| 645 | return detail::zippy<detail::zip_shortest, T, U, Args...>( |
| 646 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
| 647 | } |
| 648 | |
| 649 | /// zip iterator that, for the sake of efficiency, assumes the first iteratee to |
| 650 | /// be the shortest. |
| 651 | template <typename T, typename U, typename... Args> |
| 652 | detail::zippy<detail::zip_first, T, U, Args...> zip_first(T &&t, U &&u, |
| 653 | Args &&... args) { |
| 654 | return detail::zippy<detail::zip_first, T, U, Args...>( |
| 655 | std::forward<T>(t), std::forward<U>(u), std::forward<Args>(args)...); |
| 656 | } |
| 657 | |
| 658 | /// Iterator wrapper that concatenates sequences together. |
| 659 | /// |
| 660 | /// This can concatenate different iterators, even with different types, into |
| 661 | /// a single iterator provided the value types of all the concatenated |
| 662 | /// iterators expose `reference` and `pointer` types that can be converted to |
| 663 | /// `ValueT &` and `ValueT *` respectively. It doesn't support more |
| 664 | /// interesting/customized pointer or reference types. |
| 665 | /// |
| 666 | /// Currently this only supports forward or higher iterator categories as |
| 667 | /// inputs and always exposes a forward iterator interface. |
| 668 | template <typename ValueT, typename... IterTs> |
| 669 | class concat_iterator |
| 670 | : public iterator_facade_base<concat_iterator<ValueT, IterTs...>, |
| 671 | std::forward_iterator_tag, ValueT> { |
| 672 | using BaseT = typename concat_iterator::iterator_facade_base; |
| 673 | |
| 674 | /// We store both the current and end iterators for each concatenated |
| 675 | /// sequence in a tuple of pairs. |
| 676 | /// |
| 677 | /// Note that something like iterator_range seems nice at first here, but the |
| 678 | /// range properties are of little benefit and end up getting in the way |
| 679 | /// because we need to do mutation on the current iterators. |
| 680 | std::tuple<IterTs...> Begins; |
| 681 | std::tuple<IterTs...> Ends; |
| 682 | |
| 683 | /// Attempts to increment a specific iterator. |
| 684 | /// |
| 685 | /// Returns true if it was able to increment the iterator. Returns false if |
| 686 | /// the iterator is already at the end iterator. |
| 687 | template <size_t Index> bool incrementHelper() { |
| 688 | auto &Begin = std::get<Index>(Begins); |
| 689 | auto &End = std::get<Index>(Ends); |
| 690 | if (Begin == End) |
| 691 | return false; |
| 692 | |
| 693 | ++Begin; |
| 694 | return true; |
| 695 | } |
| 696 | |
| 697 | /// Increments the first non-end iterator. |
| 698 | /// |
| 699 | /// It is an error to call this with all iterators at the end. |
| 700 | template <size_t... Ns> void increment(index_sequence<Ns...>) { |
| 701 | // Build a sequence of functions to increment each iterator if possible. |
| 702 | bool (concat_iterator::*IncrementHelperFns[])() = { |
| 703 | &concat_iterator::incrementHelper<Ns>...}; |
| 704 | |
| 705 | // Loop over them, and stop as soon as we succeed at incrementing one. |
| 706 | for (auto &IncrementHelperFn : IncrementHelperFns) |
| 707 | if ((this->*IncrementHelperFn)()) |
| 708 | return; |
| 709 | |
| 710 | llvm_unreachable("Attempted to increment an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to increment an end concat iterator!" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 710); |
| 711 | } |
| 712 | |
| 713 | /// Returns null if the specified iterator is at the end. Otherwise, |
| 714 | /// dereferences the iterator and returns the address of the resulting |
| 715 | /// reference. |
| 716 | template <size_t Index> ValueT *getHelper() const { |
| 717 | auto &Begin = std::get<Index>(Begins); |
| 718 | auto &End = std::get<Index>(Ends); |
| 719 | if (Begin == End) |
| 720 | return nullptr; |
| 721 | |
| 722 | return &*Begin; |
| 723 | } |
| 724 | |
| 725 | /// Finds the first non-end iterator, dereferences, and returns the resulting |
| 726 | /// reference. |
| 727 | /// |
| 728 | /// It is an error to call this with all iterators at the end. |
| 729 | template <size_t... Ns> ValueT &get(index_sequence<Ns...>) const { |
| 730 | // Build a sequence of functions to get from iterator if possible. |
| 731 | ValueT *(concat_iterator::*GetHelperFns[])() const = { |
| 732 | &concat_iterator::getHelper<Ns>...}; |
| 733 | |
| 734 | // Loop over them, and return the first result we find. |
| 735 | for (auto &GetHelperFn : GetHelperFns) |
| 736 | if (ValueT *P = (this->*GetHelperFn)()) |
| 737 | return *P; |
| 738 | |
| 739 | llvm_unreachable("Attempted to get a pointer from an end concat iterator!")::llvm::llvm_unreachable_internal("Attempted to get a pointer from an end concat iterator!" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 739); |
| 740 | } |
| 741 | |
| 742 | public: |
| 743 | /// Constructs an iterator from a squence of ranges. |
| 744 | /// |
| 745 | /// We need the full range to know how to switch between each of the |
| 746 | /// iterators. |
| 747 | template <typename... RangeTs> |
| 748 | explicit concat_iterator(RangeTs &&... Ranges) |
| 749 | : Begins(std::begin(Ranges)...), Ends(std::end(Ranges)...) {} |
| 750 | |
| 751 | using BaseT::operator++; |
| 752 | |
| 753 | concat_iterator &operator++() { |
| 754 | increment(index_sequence_for<IterTs...>()); |
| 755 | return *this; |
| 756 | } |
| 757 | |
| 758 | ValueT &operator*() const { return get(index_sequence_for<IterTs...>()); } |
| 759 | |
| 760 | bool operator==(const concat_iterator &RHS) const { |
| 761 | return Begins == RHS.Begins && Ends == RHS.Ends; |
| 762 | } |
| 763 | }; |
| 764 | |
| 765 | namespace detail { |
| 766 | |
| 767 | /// Helper to store a sequence of ranges being concatenated and access them. |
| 768 | /// |
| 769 | /// This is designed to facilitate providing actual storage when temporaries |
| 770 | /// are passed into the constructor such that we can use it as part of range |
| 771 | /// based for loops. |
| 772 | template <typename ValueT, typename... RangeTs> class concat_range { |
| 773 | public: |
| 774 | using iterator = |
| 775 | concat_iterator<ValueT, |
| 776 | decltype(std::begin(std::declval<RangeTs &>()))...>; |
| 777 | |
| 778 | private: |
| 779 | std::tuple<RangeTs...> Ranges; |
| 780 | |
| 781 | template <size_t... Ns> iterator begin_impl(index_sequence<Ns...>) { |
| 782 | return iterator(std::get<Ns>(Ranges)...); |
| 783 | } |
| 784 | template <size_t... Ns> iterator end_impl(index_sequence<Ns...>) { |
| 785 | return iterator(make_range(std::end(std::get<Ns>(Ranges)), |
| 786 | std::end(std::get<Ns>(Ranges)))...); |
| 787 | } |
| 788 | |
| 789 | public: |
| 790 | concat_range(RangeTs &&... Ranges) |
| 791 | : Ranges(std::forward<RangeTs>(Ranges)...) {} |
| 792 | |
| 793 | iterator begin() { return begin_impl(index_sequence_for<RangeTs...>{}); } |
| 794 | iterator end() { return end_impl(index_sequence_for<RangeTs...>{}); } |
| 795 | }; |
| 796 | |
| 797 | } // end namespace detail |
| 798 | |
| 799 | /// Concatenated range across two or more ranges. |
| 800 | /// |
| 801 | /// The desired value type must be explicitly specified. |
| 802 | template <typename ValueT, typename... RangeTs> |
| 803 | detail::concat_range<ValueT, RangeTs...> concat(RangeTs &&... Ranges) { |
| 804 | static_assert(sizeof...(RangeTs) > 1, |
| 805 | "Need more than one range to concatenate!"); |
| 806 | return detail::concat_range<ValueT, RangeTs...>( |
| 807 | std::forward<RangeTs>(Ranges)...); |
| 808 | } |
| 809 | |
| 810 | //===----------------------------------------------------------------------===// |
| 811 | // Extra additions to <utility> |
| 812 | //===----------------------------------------------------------------------===// |
| 813 | |
| 814 | /// Function object to check whether the first component of a std::pair |
| 815 | /// compares less than the first component of another std::pair. |
| 816 | struct less_first { |
| 817 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
| 818 | return lhs.first < rhs.first; |
| 819 | } |
| 820 | }; |
| 821 | |
| 822 | /// Function object to check whether the second component of a std::pair |
| 823 | /// compares less than the second component of another std::pair. |
| 824 | struct less_second { |
| 825 | template <typename T> bool operator()(const T &lhs, const T &rhs) const { |
| 826 | return lhs.second < rhs.second; |
| 827 | } |
| 828 | }; |
| 829 | |
| 830 | /// \brief Function object to apply a binary function to the first component of |
| 831 | /// a std::pair. |
| 832 | template<typename FuncTy> |
| 833 | struct on_first { |
| 834 | FuncTy func; |
| 835 | |
| 836 | template <typename T> |
| 837 | auto operator()(const T &lhs, const T &rhs) const |
| 838 | -> decltype(func(lhs.first, rhs.first)) { |
| 839 | return func(lhs.first, rhs.first); |
| 840 | } |
| 841 | }; |
| 842 | |
| 843 | // A subset of N3658. More stuff can be added as-needed. |
| 844 | |
| 845 | /// Represents a compile-time sequence of integers. |
| 846 | template <class T, T... I> struct integer_sequence { |
| 847 | using value_type = T; |
| 848 | |
| 849 | static constexpr size_t size() { return sizeof...(I); } |
| 850 | }; |
| 851 | |
| 852 | /// Alias for the common case of a sequence of size_ts. |
| 853 | template <size_t... I> |
| 854 | struct index_sequence : integer_sequence<std::size_t, I...> {}; |
| 855 | |
| 856 | template <std::size_t N, std::size_t... I> |
| 857 | struct build_index_impl : build_index_impl<N - 1, N - 1, I...> {}; |
| 858 | template <std::size_t... I> |
| 859 | struct build_index_impl<0, I...> : index_sequence<I...> {}; |
| 860 | |
| 861 | /// Creates a compile-time integer sequence for a parameter pack. |
| 862 | template <class... Ts> |
| 863 | struct index_sequence_for : build_index_impl<sizeof...(Ts)> {}; |
| 864 | |
| 865 | /// Utility type to build an inheritance chain that makes it easy to rank |
| 866 | /// overload candidates. |
| 867 | template <int N> struct rank : rank<N - 1> {}; |
| 868 | template <> struct rank<0> {}; |
| 869 | |
| 870 | /// traits class for checking whether type T is one of any of the given |
| 871 | /// types in the variadic list. |
| 872 | template <typename T, typename... Ts> struct is_one_of { |
| 873 | static const bool value = false; |
| 874 | }; |
| 875 | |
| 876 | template <typename T, typename U, typename... Ts> |
| 877 | struct is_one_of<T, U, Ts...> { |
| 878 | static const bool value = |
| 879 | std::is_same<T, U>::value || is_one_of<T, Ts...>::value; |
| 880 | }; |
| 881 | |
| 882 | /// traits class for checking whether type T is a base class for all |
| 883 | /// the given types in the variadic list. |
| 884 | template <typename T, typename... Ts> struct are_base_of { |
| 885 | static const bool value = true; |
| 886 | }; |
| 887 | |
| 888 | template <typename T, typename U, typename... Ts> |
| 889 | struct are_base_of<T, U, Ts...> { |
| 890 | static const bool value = |
| 891 | std::is_base_of<T, U>::value && are_base_of<T, Ts...>::value; |
| 892 | }; |
| 893 | |
| 894 | //===----------------------------------------------------------------------===// |
| 895 | // Extra additions for arrays |
| 896 | //===----------------------------------------------------------------------===// |
| 897 | |
| 898 | /// Find the length of an array. |
| 899 | template <class T, std::size_t N> |
| 900 | constexpr inline size_t array_lengthof(T (&)[N]) { |
| 901 | return N; |
| 902 | } |
| 903 | |
| 904 | /// Adapt std::less<T> for array_pod_sort. |
| 905 | template<typename T> |
| 906 | inline int array_pod_sort_comparator(const void *P1, const void *P2) { |
| 907 | if (std::less<T>()(*reinterpret_cast<const T*>(P1), |
| 908 | *reinterpret_cast<const T*>(P2))) |
| 909 | return -1; |
| 910 | if (std::less<T>()(*reinterpret_cast<const T*>(P2), |
| 911 | *reinterpret_cast<const T*>(P1))) |
| 912 | return 1; |
| 913 | return 0; |
| 914 | } |
| 915 | |
| 916 | /// get_array_pod_sort_comparator - This is an internal helper function used to |
| 917 | /// get type deduction of T right. |
| 918 | template<typename T> |
| 919 | inline int (*get_array_pod_sort_comparator(const T &)) |
| 920 | (const void*, const void*) { |
| 921 | return array_pod_sort_comparator<T>; |
| 922 | } |
| 923 | |
| 924 | /// array_pod_sort - This sorts an array with the specified start and end |
| 925 | /// extent. This is just like std::sort, except that it calls qsort instead of |
| 926 | /// using an inlined template. qsort is slightly slower than std::sort, but |
| 927 | /// most sorts are not performance critical in LLVM and std::sort has to be |
| 928 | /// template instantiated for each type, leading to significant measured code |
| 929 | /// bloat. This function should generally be used instead of std::sort where |
| 930 | /// possible. |
| 931 | /// |
| 932 | /// This function assumes that you have simple POD-like types that can be |
| 933 | /// compared with std::less and can be moved with memcpy. If this isn't true, |
| 934 | /// you should use std::sort. |
| 935 | /// |
| 936 | /// NOTE: If qsort_r were portable, we could allow a custom comparator and |
| 937 | /// default to std::less. |
| 938 | template<class IteratorTy> |
| 939 | inline void array_pod_sort(IteratorTy Start, IteratorTy End) { |
| 940 | // Don't inefficiently call qsort with one element or trigger undefined |
| 941 | // behavior with an empty sequence. |
| 942 | auto NElts = End - Start; |
| 943 | if (NElts <= 1) return; |
| 944 | #ifdef EXPENSIVE_CHECKS |
| 945 | std::mt19937 Generator(std::random_device{}()); |
| 946 | std::shuffle(Start, End, Generator); |
| 947 | #endif |
| 948 | qsort(&*Start, NElts, sizeof(*Start), get_array_pod_sort_comparator(*Start)); |
| 949 | } |
| 950 | |
| 951 | template <class IteratorTy> |
| 952 | inline void array_pod_sort( |
| 953 | IteratorTy Start, IteratorTy End, |
| 954 | int (*Compare)( |
| 955 | const typename std::iterator_traits<IteratorTy>::value_type *, |
| 956 | const typename std::iterator_traits<IteratorTy>::value_type *)) { |
| 957 | // Don't inefficiently call qsort with one element or trigger undefined |
| 958 | // behavior with an empty sequence. |
| 959 | auto NElts = End - Start; |
| 960 | if (NElts <= 1) return; |
| 961 | #ifdef EXPENSIVE_CHECKS |
| 962 | std::mt19937 Generator(std::random_device{}()); |
| 963 | std::shuffle(Start, End, Generator); |
| 964 | #endif |
| 965 | qsort(&*Start, NElts, sizeof(*Start), |
| 966 | reinterpret_cast<int (*)(const void *, const void *)>(Compare)); |
| 967 | } |
| 968 | |
| 969 | // Provide wrappers to std::sort which shuffle the elements before sorting |
| 970 | // to help uncover non-deterministic behavior (PR35135). |
| 971 | template <typename IteratorTy> |
| 972 | inline void sort(IteratorTy Start, IteratorTy End) { |
| 973 | #ifdef EXPENSIVE_CHECKS |
| 974 | std::mt19937 Generator(std::random_device{}()); |
| 975 | std::shuffle(Start, End, Generator); |
| 976 | #endif |
| 977 | std::sort(Start, End); |
| 978 | } |
| 979 | |
| 980 | template <typename Container> inline void sort(Container &&C) { |
| 981 | llvm::sort(adl_begin(C), adl_end(C)); |
| 982 | } |
| 983 | |
| 984 | template <typename IteratorTy, typename Compare> |
| 985 | inline void sort(IteratorTy Start, IteratorTy End, Compare Comp) { |
| 986 | #ifdef EXPENSIVE_CHECKS |
| 987 | std::mt19937 Generator(std::random_device{}()); |
| 988 | std::shuffle(Start, End, Generator); |
| 989 | #endif |
| 990 | std::sort(Start, End, Comp); |
| 991 | } |
| 992 | |
| 993 | template <typename Container, typename Compare> |
| 994 | inline void sort(Container &&C, Compare Comp) { |
| 995 | llvm::sort(adl_begin(C), adl_end(C), Comp); |
| 996 | } |
| 997 | |
| 998 | //===----------------------------------------------------------------------===// |
| 999 | // Extra additions to <algorithm> |
| 1000 | //===----------------------------------------------------------------------===// |
| 1001 | |
| 1002 | /// For a container of pointers, deletes the pointers and then clears the |
| 1003 | /// container. |
| 1004 | template<typename Container> |
| 1005 | void DeleteContainerPointers(Container &C) { |
| 1006 | for (auto V : C) |
| 1007 | delete V; |
| 1008 | C.clear(); |
| 1009 | } |
| 1010 | |
| 1011 | /// In a container of pairs (usually a map) whose second element is a pointer, |
| 1012 | /// deletes the second elements and then clears the container. |
| 1013 | template<typename Container> |
| 1014 | void DeleteContainerSeconds(Container &C) { |
| 1015 | for (auto &V : C) |
| 1016 | delete V.second; |
| 1017 | C.clear(); |
| 1018 | } |
| 1019 | |
| 1020 | /// Get the size of a range. This is a wrapper function around std::distance |
| 1021 | /// which is only enabled when the operation is O(1). |
| 1022 | template <typename R> |
| 1023 | auto size(R &&Range, typename std::enable_if< |
| 1024 | std::is_same<typename std::iterator_traits<decltype( |
| 1025 | Range.begin())>::iterator_category, |
| 1026 | std::random_access_iterator_tag>::value, |
| 1027 | void>::type * = nullptr) |
| 1028 | -> decltype(std::distance(Range.begin(), Range.end())) { |
| 1029 | return std::distance(Range.begin(), Range.end()); |
| 1030 | } |
| 1031 | |
| 1032 | /// Provide wrappers to std::for_each which take ranges instead of having to |
| 1033 | /// pass begin/end explicitly. |
| 1034 | template <typename R, typename UnaryPredicate> |
| 1035 | UnaryPredicate for_each(R &&Range, UnaryPredicate P) { |
| 1036 | return std::for_each(adl_begin(Range), adl_end(Range), P); |
| 1037 | } |
| 1038 | |
| 1039 | /// Provide wrappers to std::all_of which take ranges instead of having to pass |
| 1040 | /// begin/end explicitly. |
| 1041 | template <typename R, typename UnaryPredicate> |
| 1042 | bool all_of(R &&Range, UnaryPredicate P) { |
| 1043 | return std::all_of(adl_begin(Range), adl_end(Range), P); |
| 1044 | } |
| 1045 | |
| 1046 | /// Provide wrappers to std::any_of which take ranges instead of having to pass |
| 1047 | /// begin/end explicitly. |
| 1048 | template <typename R, typename UnaryPredicate> |
| 1049 | bool any_of(R &&Range, UnaryPredicate P) { |
| 1050 | return std::any_of(adl_begin(Range), adl_end(Range), P); |
| 1051 | } |
| 1052 | |
| 1053 | /// Provide wrappers to std::none_of which take ranges instead of having to pass |
| 1054 | /// begin/end explicitly. |
| 1055 | template <typename R, typename UnaryPredicate> |
| 1056 | bool none_of(R &&Range, UnaryPredicate P) { |
| 1057 | return std::none_of(adl_begin(Range), adl_end(Range), P); |
| 1058 | } |
| 1059 | |
| 1060 | /// Provide wrappers to std::find which take ranges instead of having to pass |
| 1061 | /// begin/end explicitly. |
| 1062 | template <typename R, typename T> |
| 1063 | auto find(R &&Range, const T &Val) -> decltype(adl_begin(Range)) { |
| 1064 | return std::find(adl_begin(Range), adl_end(Range), Val); |
| 1065 | } |
| 1066 | |
| 1067 | /// Provide wrappers to std::find_if which take ranges instead of having to pass |
| 1068 | /// begin/end explicitly. |
| 1069 | template <typename R, typename UnaryPredicate> |
| 1070 | auto find_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
| 1071 | return std::find_if(adl_begin(Range), adl_end(Range), P); |
| 1072 | } |
| 1073 | |
| 1074 | template <typename R, typename UnaryPredicate> |
| 1075 | auto find_if_not(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
| 1076 | return std::find_if_not(adl_begin(Range), adl_end(Range), P); |
| 1077 | } |
| 1078 | |
| 1079 | /// Provide wrappers to std::remove_if which take ranges instead of having to |
| 1080 | /// pass begin/end explicitly. |
| 1081 | template <typename R, typename UnaryPredicate> |
| 1082 | auto remove_if(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
| 1083 | return std::remove_if(adl_begin(Range), adl_end(Range), P); |
| 1084 | } |
| 1085 | |
| 1086 | /// Provide wrappers to std::copy_if which take ranges instead of having to |
| 1087 | /// pass begin/end explicitly. |
| 1088 | template <typename R, typename OutputIt, typename UnaryPredicate> |
| 1089 | OutputIt copy_if(R &&Range, OutputIt Out, UnaryPredicate P) { |
| 1090 | return std::copy_if(adl_begin(Range), adl_end(Range), Out, P); |
| 1091 | } |
| 1092 | |
| 1093 | template <typename R, typename OutputIt> |
| 1094 | OutputIt copy(R &&Range, OutputIt Out) { |
| 1095 | return std::copy(adl_begin(Range), adl_end(Range), Out); |
| 1096 | } |
| 1097 | |
| 1098 | /// Wrapper function around std::find to detect if an element exists |
| 1099 | /// in a container. |
| 1100 | template <typename R, typename E> |
| 1101 | bool is_contained(R &&Range, const E &Element) { |
| 1102 | return std::find(adl_begin(Range), adl_end(Range), Element) != adl_end(Range); |
| 1103 | } |
| 1104 | |
| 1105 | /// Wrapper function around std::count to count the number of times an element |
| 1106 | /// \p Element occurs in the given range \p Range. |
| 1107 | template <typename R, typename E> |
| 1108 | auto count(R &&Range, const E &Element) -> |
| 1109 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
| 1110 | return std::count(adl_begin(Range), adl_end(Range), Element); |
| 1111 | } |
| 1112 | |
| 1113 | /// Wrapper function around std::count_if to count the number of times an |
| 1114 | /// element satisfying a given predicate occurs in a range. |
| 1115 | template <typename R, typename UnaryPredicate> |
| 1116 | auto count_if(R &&Range, UnaryPredicate P) -> |
| 1117 | typename std::iterator_traits<decltype(adl_begin(Range))>::difference_type { |
| 1118 | return std::count_if(adl_begin(Range), adl_end(Range), P); |
| 1119 | } |
| 1120 | |
| 1121 | /// Wrapper function around std::transform to apply a function to a range and |
| 1122 | /// store the result elsewhere. |
| 1123 | template <typename R, typename OutputIt, typename UnaryPredicate> |
| 1124 | OutputIt transform(R &&Range, OutputIt d_first, UnaryPredicate P) { |
| 1125 | return std::transform(adl_begin(Range), adl_end(Range), d_first, P); |
| 1126 | } |
| 1127 | |
| 1128 | /// Provide wrappers to std::partition which take ranges instead of having to |
| 1129 | /// pass begin/end explicitly. |
| 1130 | template <typename R, typename UnaryPredicate> |
| 1131 | auto partition(R &&Range, UnaryPredicate P) -> decltype(adl_begin(Range)) { |
| 1132 | return std::partition(adl_begin(Range), adl_end(Range), P); |
| 1133 | } |
| 1134 | |
| 1135 | /// Provide wrappers to std::lower_bound which take ranges instead of having to |
| 1136 | /// pass begin/end explicitly. |
| 1137 | template <typename R, typename ForwardIt> |
| 1138 | auto lower_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
| 1139 | return std::lower_bound(adl_begin(Range), adl_end(Range), I); |
| 1140 | } |
| 1141 | |
| 1142 | template <typename R, typename ForwardIt, typename Compare> |
| 1143 | auto lower_bound(R &&Range, ForwardIt I, Compare C) |
| 1144 | -> decltype(adl_begin(Range)) { |
| 1145 | return std::lower_bound(adl_begin(Range), adl_end(Range), I, C); |
| 1146 | } |
| 1147 | |
| 1148 | /// Provide wrappers to std::upper_bound which take ranges instead of having to |
| 1149 | /// pass begin/end explicitly. |
| 1150 | template <typename R, typename ForwardIt> |
| 1151 | auto upper_bound(R &&Range, ForwardIt I) -> decltype(adl_begin(Range)) { |
| 1152 | return std::upper_bound(adl_begin(Range), adl_end(Range), I); |
| 1153 | } |
| 1154 | |
| 1155 | template <typename R, typename ForwardIt, typename Compare> |
| 1156 | auto upper_bound(R &&Range, ForwardIt I, Compare C) |
| 1157 | -> decltype(adl_begin(Range)) { |
| 1158 | return std::upper_bound(adl_begin(Range), adl_end(Range), I, C); |
| 1159 | } |
| 1160 | /// Wrapper function around std::equal to detect if all elements |
| 1161 | /// in a container are same. |
| 1162 | template <typename R> |
| 1163 | bool is_splat(R &&Range) { |
| 1164 | size_t range_size = size(Range); |
| 1165 | return range_size != 0 && (range_size == 1 || |
| 1166 | std::equal(adl_begin(Range) + 1, adl_end(Range), adl_begin(Range))); |
| 1167 | } |
| 1168 | |
| 1169 | /// Given a range of type R, iterate the entire range and return a |
| 1170 | /// SmallVector with elements of the vector. This is useful, for example, |
| 1171 | /// when you want to iterate a range and then sort the results. |
| 1172 | template <unsigned Size, typename R> |
| 1173 | SmallVector<typename std::remove_const<detail::ValueOfRange<R>>::type, Size> |
| 1174 | to_vector(R &&Range) { |
| 1175 | return {adl_begin(Range), adl_end(Range)}; |
| 1176 | } |
| 1177 | |
| 1178 | /// Provide a container algorithm similar to C++ Library Fundamentals v2's |
| 1179 | /// `erase_if` which is equivalent to: |
| 1180 | /// |
| 1181 | /// C.erase(remove_if(C, pred), C.end()); |
| 1182 | /// |
| 1183 | /// This version works for any container with an erase method call accepting |
| 1184 | /// two iterators. |
| 1185 | template <typename Container, typename UnaryPredicate> |
| 1186 | void erase_if(Container &C, UnaryPredicate P) { |
| 1187 | C.erase(remove_if(C, P), C.end()); |
| 1188 | } |
| 1189 | |
| 1190 | //===----------------------------------------------------------------------===// |
| 1191 | // Extra additions to <memory> |
| 1192 | //===----------------------------------------------------------------------===// |
| 1193 | |
| 1194 | // Implement make_unique according to N3656. |
| 1195 | |
| 1196 | /// Constructs a `new T()` with the given args and returns a |
| 1197 | /// `unique_ptr<T>` which owns the object. |
| 1198 | /// |
| 1199 | /// Example: |
| 1200 | /// |
| 1201 | /// auto p = make_unique<int>(); |
| 1202 | /// auto p = make_unique<std::tuple<int, int>>(0, 1); |
| 1203 | template <class T, class... Args> |
| 1204 | typename std::enable_if<!std::is_array<T>::value, std::unique_ptr<T>>::type |
| 1205 | make_unique(Args &&... args) { |
| 1206 | return std::unique_ptr<T>(new T(std::forward<Args>(args)...)); |
| 1207 | } |
| 1208 | |
| 1209 | /// Constructs a `new T[n]` with the given args and returns a |
| 1210 | /// `unique_ptr<T[]>` which owns the object. |
| 1211 | /// |
| 1212 | /// \param n size of the new array. |
| 1213 | /// |
| 1214 | /// Example: |
| 1215 | /// |
| 1216 | /// auto p = make_unique<int[]>(2); // value-initializes the array with 0's. |
| 1217 | template <class T> |
| 1218 | typename std::enable_if<std::is_array<T>::value && std::extent<T>::value == 0, |
| 1219 | std::unique_ptr<T>>::type |
| 1220 | make_unique(size_t n) { |
| 1221 | return std::unique_ptr<T>(new typename std::remove_extent<T>::type[n]()); |
| 1222 | } |
| 1223 | |
| 1224 | /// This function isn't used and is only here to provide better compile errors. |
| 1225 | template <class T, class... Args> |
| 1226 | typename std::enable_if<std::extent<T>::value != 0>::type |
| 1227 | make_unique(Args &&...) = delete; |
| 1228 | |
| 1229 | struct FreeDeleter { |
| 1230 | void operator()(void* v) { |
| 1231 | ::free(v); |
| 1232 | } |
| 1233 | }; |
| 1234 | |
| 1235 | template<typename First, typename Second> |
| 1236 | struct pair_hash { |
| 1237 | size_t operator()(const std::pair<First, Second> &P) const { |
| 1238 | return std::hash<First>()(P.first) * 31 + std::hash<Second>()(P.second); |
| 1239 | } |
| 1240 | }; |
| 1241 | |
| 1242 | /// A functor like C++14's std::less<void> in its absence. |
| 1243 | struct less { |
| 1244 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
| 1245 | return std::forward<A>(a) < std::forward<B>(b); |
| 1246 | } |
| 1247 | }; |
| 1248 | |
| 1249 | /// A functor like C++14's std::equal<void> in its absence. |
| 1250 | struct equal { |
| 1251 | template <typename A, typename B> bool operator()(A &&a, B &&b) const { |
| 1252 | return std::forward<A>(a) == std::forward<B>(b); |
| 1253 | } |
| 1254 | }; |
| 1255 | |
| 1256 | /// Binary functor that adapts to any other binary functor after dereferencing |
| 1257 | /// operands. |
| 1258 | template <typename T> struct deref { |
| 1259 | T func; |
| 1260 | |
| 1261 | // Could be further improved to cope with non-derivable functors and |
| 1262 | // non-binary functors (should be a variadic template member function |
| 1263 | // operator()). |
| 1264 | template <typename A, typename B> |
| 1265 | auto operator()(A &lhs, B &rhs) const -> decltype(func(*lhs, *rhs)) { |
| 1266 | assert(lhs)((lhs) ? static_cast<void> (0) : __assert_fail ("lhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1266, __PRETTY_FUNCTION__)); |
| 1267 | assert(rhs)((rhs) ? static_cast<void> (0) : __assert_fail ("rhs", "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1267, __PRETTY_FUNCTION__)); |
| 1268 | return func(*lhs, *rhs); |
| 1269 | } |
| 1270 | }; |
| 1271 | |
| 1272 | namespace detail { |
| 1273 | |
| 1274 | template <typename R> class enumerator_iter; |
| 1275 | |
| 1276 | template <typename R> struct result_pair { |
| 1277 | friend class enumerator_iter<R>; |
| 1278 | |
| 1279 | result_pair() = default; |
| 1280 | result_pair(std::size_t Index, IterOfRange<R> Iter) |
| 1281 | : Index(Index), Iter(Iter) {} |
| 1282 | |
| 1283 | result_pair<R> &operator=(const result_pair<R> &Other) { |
| 1284 | Index = Other.Index; |
| 1285 | Iter = Other.Iter; |
| 1286 | return *this; |
| 1287 | } |
| 1288 | |
| 1289 | std::size_t index() const { return Index; } |
| 1290 | const ValueOfRange<R> &value() const { return *Iter; } |
| 1291 | ValueOfRange<R> &value() { return *Iter; } |
| 1292 | |
| 1293 | private: |
| 1294 | std::size_t Index = std::numeric_limits<std::size_t>::max(); |
| 1295 | IterOfRange<R> Iter; |
| 1296 | }; |
| 1297 | |
| 1298 | template <typename R> |
| 1299 | class enumerator_iter |
| 1300 | : public iterator_facade_base< |
| 1301 | enumerator_iter<R>, std::forward_iterator_tag, result_pair<R>, |
| 1302 | typename std::iterator_traits<IterOfRange<R>>::difference_type, |
| 1303 | typename std::iterator_traits<IterOfRange<R>>::pointer, |
| 1304 | typename std::iterator_traits<IterOfRange<R>>::reference> { |
| 1305 | using result_type = result_pair<R>; |
| 1306 | |
| 1307 | public: |
| 1308 | explicit enumerator_iter(IterOfRange<R> EndIter) |
| 1309 | : Result(std::numeric_limits<size_t>::max(), EndIter) {} |
| 1310 | |
| 1311 | enumerator_iter(std::size_t Index, IterOfRange<R> Iter) |
| 1312 | : Result(Index, Iter) {} |
| 1313 | |
| 1314 | result_type &operator*() { return Result; } |
| 1315 | const result_type &operator*() const { return Result; } |
| 1316 | |
| 1317 | enumerator_iter<R> &operator++() { |
| 1318 | assert(Result.Index != std::numeric_limits<size_t>::max())((Result.Index != std::numeric_limits<size_t>::max()) ? static_cast<void> (0) : __assert_fail ("Result.Index != std::numeric_limits<size_t>::max()" , "/build/llvm-toolchain-snapshot-8~svn345461/include/llvm/ADT/STLExtras.h" , 1318, __PRETTY_FUNCTION__)); |
| 1319 | ++Result.Iter; |
| 1320 | ++Result.Index; |
| 1321 | return *this; |
| 1322 | } |
| 1323 | |
| 1324 | bool operator==(const enumerator_iter<R> &RHS) const { |
| 1325 | // Don't compare indices here, only iterators. It's possible for an end |
| 1326 | // iterator to have different indices depending on whether it was created |
| 1327 | // by calling std::end() versus incrementing a valid iterator. |
| 1328 | return Result.Iter == RHS.Result.Iter; |
| 1329 | } |
| 1330 | |
| 1331 | enumerator_iter<R> &operator=(const enumerator_iter<R> &Other) { |
| 1332 | Result = Other.Result; |
| 1333 | return *this; |
| 1334 | } |
| 1335 | |
| 1336 | private: |
| 1337 | result_type Result; |
| 1338 | }; |
| 1339 | |
| 1340 | template <typename R> class enumerator { |
| 1341 | public: |
| 1342 | explicit enumerator(R &&Range) : TheRange(std::forward<R>(Range)) {} |
| 1343 | |
| 1344 | enumerator_iter<R> begin() { |
| 1345 | return enumerator_iter<R>(0, std::begin(TheRange)); |
| 1346 | } |
| 1347 | |
| 1348 | enumerator_iter<R> end() { |
| 1349 | return enumerator_iter<R>(std::end(TheRange)); |
| 1350 | } |
| 1351 | |
| 1352 | private: |
| 1353 | R TheRange; |
| 1354 | }; |
| 1355 | |
| 1356 | } // end namespace detail |
| 1357 | |
| 1358 | /// Given an input range, returns a new range whose values are are pair (A,B) |
| 1359 | /// such that A is the 0-based index of the item in the sequence, and B is |
| 1360 | /// the value from the original sequence. Example: |
| 1361 | /// |
| 1362 | /// std::vector<char> Items = {'A', 'B', 'C', 'D'}; |
| 1363 | /// for (auto X : enumerate(Items)) { |
| 1364 | /// printf("Item %d - %c\n", X.index(), X.value()); |
| 1365 | /// } |
| 1366 | /// |
| 1367 | /// Output: |
| 1368 | /// Item 0 - A |
| 1369 | /// Item 1 - B |
| 1370 | /// Item 2 - C |
| 1371 | /// Item 3 - D |
| 1372 | /// |
| 1373 | template <typename R> detail::enumerator<R> enumerate(R &&TheRange) { |
| 1374 | return detail::enumerator<R>(std::forward<R>(TheRange)); |
| 1375 | } |
| 1376 | |
| 1377 | namespace detail { |
| 1378 | |
| 1379 | template <typename F, typename Tuple, std::size_t... I> |
| 1380 | auto apply_tuple_impl(F &&f, Tuple &&t, index_sequence<I...>) |
| 1381 | -> decltype(std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...)) { |
| 1382 | return std::forward<F>(f)(std::get<I>(std::forward<Tuple>(t))...); |
| 1383 | } |
| 1384 | |
| 1385 | } // end namespace detail |
| 1386 | |
| 1387 | /// Given an input tuple (a1, a2, ..., an), pass the arguments of the |
| 1388 | /// tuple variadically to f as if by calling f(a1, a2, ..., an) and |
| 1389 | /// return the result. |
| 1390 | template <typename F, typename Tuple> |
| 1391 | auto apply_tuple(F &&f, Tuple &&t) -> decltype(detail::apply_tuple_impl( |
| 1392 | std::forward<F>(f), std::forward<Tuple>(t), |
| 1393 | build_index_impl< |
| 1394 | std::tuple_size<typename std::decay<Tuple>::type>::value>{})) { |
| 1395 | using Indices = build_index_impl< |
| 1396 | std::tuple_size<typename std::decay<Tuple>::type>::value>; |
| 1397 | |
| 1398 | return detail::apply_tuple_impl(std::forward<F>(f), std::forward<Tuple>(t), |
| 1399 | Indices{}); |
| 1400 | } |
| 1401 | |
| 1402 | } // end namespace llvm |
| 1403 | |
| 1404 | #endif // LLVM_ADT_STLEXTRAS_H |