1 //===-- Path.cpp - Implement OS Path Concept --------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header file implements the operating system Path concept.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/Support/Path.h"
15 #include "llvm/Config/config.h"
16 #include "llvm/Support/Endian.h"
17 #include "llvm/Support/FileSystem.h"
24 using support::ulittle32_t;
27 //===----------------------------------------------------------------------===//
28 //=== WARNING: Implementation here must contain only TRULY operating system
29 //=== independent code.
30 //===----------------------------------------------------------------------===//
32 bool Path::operator==(const Path &that) const {
33 return path == that.path;
36 bool Path::operator<(const Path& that) const {
37 return path < that.path;
41 sys::identifyFileType(const char *Magic, unsigned Length) {
42 assert(Magic && "Invalid magic number string");
43 assert(Length >=4 && "Invalid magic number length");
44 switch ((unsigned char)Magic[0]) {
45 case 0xDE: // 0x0B17C0DE = BC wraper
46 if (Magic[1] == (char)0xC0 && Magic[2] == (char)0x17 &&
47 Magic[3] == (char)0x0B)
48 return Bitcode_FileType;
51 if (Magic[1] == 'C' && Magic[2] == (char)0xC0 && Magic[3] == (char)0xDE)
52 return Bitcode_FileType;
56 if (memcmp(Magic,"!<arch>\n",8) == 0)
57 return Archive_FileType;
61 if (Length >= 18 && Magic[1] == 'E' && Magic[2] == 'L' &&
63 bool Data2MSB = Magic[5] == 2;
64 unsigned high = Data2MSB ? 16 : 17;
65 unsigned low = Data2MSB ? 17 : 16;
69 case 1: return ELF_Relocatable_FileType;
70 case 2: return ELF_Executable_FileType;
71 case 3: return ELF_SharedObject_FileType;
72 case 4: return ELF_Core_FileType;
78 if (Magic[1] == char(0xFE) && Magic[2] == char(0xBA) &&
79 Magic[3] == char(0xBE)) {
80 // This is complicated by an overlap with Java class files.
81 // See the Mach-O section in /usr/share/file/magic for details.
82 if (Length >= 8 && Magic[7] < 43)
83 // FIXME: Universal Binary of any type.
84 return Mach_O_DynamicallyLinkedSharedLib_FileType;
88 // The two magic numbers for mach-o are:
89 // 0xfeedface - 32-bit mach-o
90 // 0xfeedfacf - 64-bit mach-o
95 if (Magic[0] == char(0xFE) && Magic[1] == char(0xED) &&
96 Magic[2] == char(0xFA) &&
97 (Magic[3] == char(0xCE) || Magic[3] == char(0xCF))) {
99 if (Length >= 16) type = Magic[14] << 8 | Magic[15];
100 } else if ((Magic[0] == char(0xCE) || Magic[0] == char(0xCF)) &&
101 Magic[1] == char(0xFA) && Magic[2] == char(0xED) &&
102 Magic[3] == char(0xFE)) {
104 if (Length >= 14) type = Magic[13] << 8 | Magic[12];
108 case 1: return Mach_O_Object_FileType;
109 case 2: return Mach_O_Executable_FileType;
110 case 3: return Mach_O_FixedVirtualMemorySharedLib_FileType;
111 case 4: return Mach_O_Core_FileType;
112 case 5: return Mach_O_PreloadExecutable_FileType;
113 case 6: return Mach_O_DynamicallyLinkedSharedLib_FileType;
114 case 7: return Mach_O_DynamicLinker_FileType;
115 case 8: return Mach_O_Bundle_FileType;
116 case 9: return Mach_O_DynamicallyLinkedSharedLibStub_FileType;
117 case 10: return Mach_O_DSYMCompanion_FileType;
121 case 0xF0: // PowerPC Windows
122 case 0x83: // Alpha 32-bit
123 case 0x84: // Alpha 64-bit
124 case 0x66: // MPS R4000 Windows
126 case 0x4c: // 80386 Windows
127 if (Magic[1] == 0x01)
128 return COFF_FileType;
130 case 0x90: // PA-RISC Windows
131 case 0x68: // mc68K Windows
132 if (Magic[1] == 0x02)
133 return COFF_FileType;
136 case 0x4d: // Possible MS-DOS stub on Windows PE file
137 if (Magic[1] == 0x5a) {
139 *reinterpret_cast<const ulittle32_t *>(Magic + 0x3c);
140 // PE/COFF file, either EXE or DLL.
141 if (off < Length && memcmp(Magic + off, "PE\0\0",4) == 0)
142 return COFF_FileType;
146 case 0x64: // x86-64 Windows.
147 if (Magic[1] == char(0x86))
148 return COFF_FileType;
154 return Unknown_FileType;
158 Path::isArchive() const {
160 if (fs::identify_magic(str(), type))
162 return type == fs::file_magic::archive;
166 Path::isDynamicLibrary() const {
168 if (fs::identify_magic(str(), type))
171 default: return false;
172 case fs::file_magic::macho_fixed_virtual_memory_shared_lib:
173 case fs::file_magic::macho_dynamically_linked_shared_lib:
174 case fs::file_magic::macho_dynamically_linked_shared_lib_stub:
175 case fs::file_magic::elf_shared_object:
176 case fs::file_magic::pecoff_executable: return true;
181 Path::isObjectFile() const {
183 if (fs::identify_magic(str(), type) || type == fs::file_magic::unknown)
189 Path::FindLibrary(std::string& name) {
190 std::vector<sys::Path> LibPaths;
191 GetSystemLibraryPaths(LibPaths);
192 for (unsigned i = 0; i < LibPaths.size(); ++i) {
193 sys::Path FullPath(LibPaths[i]);
194 FullPath.appendComponent("lib" + name + LTDL_SHLIB_EXT);
195 if (FullPath.isDynamicLibrary())
197 FullPath.eraseSuffix();
198 FullPath.appendSuffix("a");
199 if (FullPath.isArchive())
205 StringRef Path::GetDLLSuffix() {
206 return &(LTDL_SHLIB_EXT[1]);
210 Path::appendSuffix(StringRef suffix) {
211 if (!suffix.empty()) {
218 Path::isBitcodeFile() const {
220 if (fs::identify_magic(str(), type))
222 return type == fs::file_magic::bitcode;
225 bool Path::hasMagicNumber(StringRef Magic) const {
226 std::string actualMagic;
227 if (getMagicNumber(actualMagic, static_cast<unsigned>(Magic.size())))
228 return Magic == actualMagic;
232 static void getPathList(const char*path, std::vector<Path>& Paths) {
233 const char* at = path;
234 const char* delim = strchr(at, PathSeparator);
237 std::string tmp(at, size_t(delim-at));
238 if (tmpPath.set(tmp))
239 if (tmpPath.canRead())
240 Paths.push_back(tmpPath);
242 delim = strchr(at, PathSeparator);
246 if (tmpPath.set(std::string(at)))
247 if (tmpPath.canRead())
248 Paths.push_back(tmpPath);
251 static StringRef getDirnameCharSep(StringRef path, const char *Sep) {
252 assert(Sep[0] != '\0' && Sep[1] == '\0' &&
253 "Sep must be a 1-character string literal.");
257 // If the path is all slashes, return a single slash.
258 // Otherwise, remove all trailing slashes.
260 signed pos = static_cast<signed>(path.size()) - 1;
262 while (pos >= 0 && path[pos] == Sep[0])
266 return path[0] == Sep[0] ? Sep : ".";
271 while (i < pos && path[i] != Sep[0])
274 if (i == pos) // No slashes? Return "."
277 // There is at least one slash left. Remove all trailing non-slashes.
278 while (pos >= 0 && path[pos] != Sep[0])
281 // Remove any trailing slashes.
282 while (pos >= 0 && path[pos] == Sep[0])
286 return path[0] == Sep[0] ? Sep : ".";
288 return path.substr(0, pos+1);
291 // Include the truly platform-specific parts of this class.
292 #if defined(LLVM_ON_UNIX)
293 #include "Unix/Path.inc"
295 #if defined(LLVM_ON_WIN32)
296 #include "Windows/Path.inc"