Brian Gaeke | d4dff19 | 2003-07-24 20:20:58 +0000 | [diff] [blame] | 1 | //===-- Mangler.cpp - Self-contained c/asm llvm name mangler --------------===// |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 2 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
Chris Lattner | f3ebc3f | 2007-12-29 20:36:04 +0000 | [diff] [blame] | 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
Misha Brukman | b1c9317 | 2005-04-21 23:48:37 +0000 | [diff] [blame] | 7 | // |
John Criswell | 482202a | 2003-10-20 19:43:21 +0000 | [diff] [blame] | 8 | //===----------------------------------------------------------------------===// |
Brian Gaeke | d4dff19 | 2003-07-24 20:20:58 +0000 | [diff] [blame] | 9 | // |
Chris Lattner | 1376b02 | 2010-01-16 21:08:46 +0000 | [diff] [blame] | 10 | // Unified name mangler for assembly backends. |
Brian Gaeke | d4dff19 | 2003-07-24 20:20:58 +0000 | [diff] [blame] | 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
Rafael Espindola | 894843c | 2014-01-07 21:19:40 +0000 | [diff] [blame] | 14 | #include "llvm/IR/Mangler.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 15 | #include "llvm/ADT/SmallString.h" |
Peter Collingbourne | c66018e | 2017-03-31 04:46:50 +0000 | [diff] [blame^] | 16 | #include "llvm/ADT/Triple.h" |
Chandler Carruth | ed0881b | 2012-12-03 16:50:05 +0000 | [diff] [blame] | 17 | #include "llvm/ADT/Twine.h" |
Chandler Carruth | 9fb823b | 2013-01-02 11:36:10 +0000 | [diff] [blame] | 18 | #include "llvm/IR/DataLayout.h" |
| 19 | #include "llvm/IR/DerivedTypes.h" |
| 20 | #include "llvm/IR/Function.h" |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 21 | #include "llvm/IR/Module.h" |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 22 | #include "llvm/Support/raw_ostream.h" |
Chris Lattner | c9499b6 | 2003-12-14 21:35:53 +0000 | [diff] [blame] | 23 | using namespace llvm; |
Brian Gaeke | 960707c | 2003-11-11 22:41:34 +0000 | [diff] [blame] | 24 | |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 25 | namespace { |
| 26 | enum ManglerPrefixTy { |
| 27 | Default, ///< Emit default string before each symbol. |
| 28 | Private, ///< Emit "private" prefix before each symbol. |
| 29 | LinkerPrivate ///< Emit "linker private" prefix before each symbol. |
| 30 | }; |
| 31 | } |
| 32 | |
Rafael Espindola | ce4c2bc | 2015-06-23 12:21:54 +0000 | [diff] [blame] | 33 | static void getNameWithPrefixImpl(raw_ostream &OS, const Twine &GVName, |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 34 | ManglerPrefixTy PrefixTy, |
Rafael Espindola | ce4c2bc | 2015-06-23 12:21:54 +0000 | [diff] [blame] | 35 | const DataLayout &DL, char Prefix) { |
Chris Lattner | 33535b3 | 2010-01-13 07:01:09 +0000 | [diff] [blame] | 36 | SmallString<256> TmpData; |
Benjamin Kramer | 2e06b93 | 2010-01-13 12:45:23 +0000 | [diff] [blame] | 37 | StringRef Name = GVName.toStringRef(TmpData); |
Chris Lattner | 33535b3 | 2010-01-13 07:01:09 +0000 | [diff] [blame] | 38 | assert(!Name.empty() && "getNameWithPrefix requires non-empty name"); |
Rafael Espindola | 5887356 | 2014-01-03 19:21:54 +0000 | [diff] [blame] | 39 | |
Rafael Espindola | 5d457de | 2014-08-01 14:16:40 +0000 | [diff] [blame] | 40 | // No need to do anything special if the global has the special "do not |
| 41 | // mangle" flag in the name. |
| 42 | if (Name[0] == '\1') { |
| 43 | OS << Name.substr(1); |
| 44 | return; |
| 45 | } |
| 46 | |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 47 | if (PrefixTy == Private) |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 48 | OS << DL.getPrivateGlobalPrefix(); |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 49 | else if (PrefixTy == LinkerPrivate) |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 50 | OS << DL.getLinkerPrivateGlobalPrefix(); |
Chris Lattner | b4ffc89 | 2010-01-17 18:22:35 +0000 | [diff] [blame] | 51 | |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 52 | if (Prefix != '\0') |
| 53 | OS << Prefix; |
Rafael Espindola | fdc8813 | 2013-11-13 14:01:59 +0000 | [diff] [blame] | 54 | |
Chris Lattner | 83e872e | 2010-01-17 19:23:46 +0000 | [diff] [blame] | 55 | // If this is a simple string that doesn't need escaping, just append it. |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 56 | OS << Name; |
| 57 | } |
| 58 | |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 59 | static void getNameWithPrefixImpl(raw_ostream &OS, const Twine &GVName, |
| 60 | const DataLayout &DL, |
| 61 | ManglerPrefixTy PrefixTy) { |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 62 | char Prefix = DL.getGlobalPrefix(); |
| 63 | return getNameWithPrefixImpl(OS, GVName, PrefixTy, DL, Prefix); |
Rafael Espindola | ce4c2bc | 2015-06-23 12:21:54 +0000 | [diff] [blame] | 64 | } |
| 65 | |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 66 | void Mangler::getNameWithPrefix(raw_ostream &OS, const Twine &GVName, |
| 67 | const DataLayout &DL) { |
| 68 | return getNameWithPrefixImpl(OS, GVName, DL, Default); |
| 69 | } |
| 70 | |
Rafael Espindola | ce4c2bc | 2015-06-23 12:21:54 +0000 | [diff] [blame] | 71 | void Mangler::getNameWithPrefix(SmallVectorImpl<char> &OutName, |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 72 | const Twine &GVName, const DataLayout &DL) { |
Rafael Espindola | ce4c2bc | 2015-06-23 12:21:54 +0000 | [diff] [blame] | 73 | raw_svector_ostream OS(OutName); |
| 74 | char Prefix = DL.getGlobalPrefix(); |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 75 | return getNameWithPrefixImpl(OS, GVName, Default, DL, Prefix); |
Chris Lattner | 33535b3 | 2010-01-13 07:01:09 +0000 | [diff] [blame] | 76 | } |
| 77 | |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 78 | static bool hasByteCountSuffix(CallingConv::ID CC) { |
| 79 | switch (CC) { |
| 80 | case CallingConv::X86_FastCall: |
| 81 | case CallingConv::X86_StdCall: |
| 82 | case CallingConv::X86_VectorCall: |
| 83 | return true; |
| 84 | default: |
| 85 | return false; |
| 86 | } |
| 87 | } |
| 88 | |
| 89 | /// Microsoft fastcall and stdcall functions require a suffix on their name |
| 90 | /// indicating the number of words of arguments they take. |
| 91 | static void addByteCountSuffix(raw_ostream &OS, const Function *F, |
Mehdi Amini | a28d91d | 2015-03-10 02:37:25 +0000 | [diff] [blame] | 92 | const DataLayout &DL) { |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 93 | // Calculate arguments size total. |
| 94 | unsigned ArgWords = 0; |
| 95 | for (Function::const_arg_iterator AI = F->arg_begin(), AE = F->arg_end(); |
| 96 | AI != AE; ++AI) { |
Chris Lattner | 229907c | 2011-07-18 04:54:35 +0000 | [diff] [blame] | 97 | Type *Ty = AI->getType(); |
Reid Kleckner | f5b7651 | 2014-01-31 23:50:57 +0000 | [diff] [blame] | 98 | // 'Dereference' type in case of byval or inalloca parameter attribute. |
| 99 | if (AI->hasByValOrInAllocaAttr()) |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 100 | Ty = cast<PointerType>(Ty)->getElementType(); |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 101 | // Size should be aligned to pointer size. |
Mehdi Amini | a28d91d | 2015-03-10 02:37:25 +0000 | [diff] [blame] | 102 | unsigned PtrSize = DL.getPointerSize(); |
Rui Ueyama | da00f2f | 2016-01-14 21:06:47 +0000 | [diff] [blame] | 103 | ArgWords += alignTo(DL.getTypeAllocSize(Ty), PtrSize); |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 104 | } |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 105 | |
| 106 | OS << '@' << ArgWords; |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 107 | } |
| 108 | |
Rafael Espindola | daeafb4 | 2014-02-19 17:23:20 +0000 | [diff] [blame] | 109 | void Mangler::getNameWithPrefix(raw_ostream &OS, const GlobalValue *GV, |
David Majnemer | 21fecf9 | 2015-03-17 20:40:21 +0000 | [diff] [blame] | 110 | bool CannotUsePrivateLabel) const { |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 111 | ManglerPrefixTy PrefixTy = Default; |
David Majnemer | 21fecf9 | 2015-03-17 20:40:21 +0000 | [diff] [blame] | 112 | if (GV->hasPrivateLinkage()) { |
Rafael Espindola | daeafb4 | 2014-02-19 17:23:20 +0000 | [diff] [blame] | 113 | if (CannotUsePrivateLabel) |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 114 | PrefixTy = LinkerPrivate; |
Rafael Espindola | daeafb4 | 2014-02-19 17:23:20 +0000 | [diff] [blame] | 115 | else |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 116 | PrefixTy = Private; |
Rafael Espindola | daeafb4 | 2014-02-19 17:23:20 +0000 | [diff] [blame] | 117 | } |
Nico Rieck | da881a2 | 2014-01-14 11:53:26 +0000 | [diff] [blame] | 118 | |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 119 | const DataLayout &DL = GV->getParent()->getDataLayout(); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 120 | if (!GV->hasName()) { |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 121 | // Get the ID for the global, assigning a new one if we haven't got one |
| 122 | // already. |
| 123 | unsigned &ID = AnonGlobalIDs[GV]; |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 124 | if (ID == 0) |
Eric Christopher | 1c3bb79 | 2016-09-29 02:03:50 +0000 | [diff] [blame] | 125 | ID = AnonGlobalIDs.size(); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 126 | |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 127 | // Must mangle the global into a unique ID. |
Rafael Espindola | 8c5f537 | 2015-06-23 14:11:09 +0000 | [diff] [blame] | 128 | getNameWithPrefixImpl(OS, "__unnamed_" + Twine(ID), DL, PrefixTy); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 129 | return; |
Chris Lattner | 8d99c76 | 2010-03-12 21:03:47 +0000 | [diff] [blame] | 130 | } |
Rafael Espindola | 5887356 | 2014-01-03 19:21:54 +0000 | [diff] [blame] | 131 | |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 132 | StringRef Name = GV->getName(); |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 133 | char Prefix = DL.getGlobalPrefix(); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 134 | |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 135 | // Mangle functions with Microsoft calling conventions specially. Only do |
| 136 | // this mangling for x86_64 vectorcall and 32-bit x86. |
| 137 | const Function *MSFunc = dyn_cast<Function>(GV); |
| 138 | if (Name.startswith("\01")) |
| 139 | MSFunc = nullptr; // Don't mangle when \01 is present. |
Aaron Ballman | 5af8ba4 | 2014-10-28 13:12:13 +0000 | [diff] [blame] | 140 | CallingConv::ID CC = |
| 141 | MSFunc ? MSFunc->getCallingConv() : (unsigned)CallingConv::C; |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 142 | if (!DL.hasMicrosoftFastStdCallMangling() && |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 143 | CC != CallingConv::X86_VectorCall) |
| 144 | MSFunc = nullptr; |
| 145 | if (MSFunc) { |
| 146 | if (CC == CallingConv::X86_FastCall) |
| 147 | Prefix = '@'; // fastcall functions have an @ prefix instead of _. |
| 148 | else if (CC == CallingConv::X86_VectorCall) |
| 149 | Prefix = '\0'; // vectorcall functions have no prefix. |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 150 | } |
| 151 | |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 152 | getNameWithPrefixImpl(OS, Name, PrefixTy, DL, Prefix); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 153 | |
| 154 | if (!MSFunc) |
| 155 | return; |
| 156 | |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 157 | // If we are supposed to add a microsoft-style suffix for stdcall, fastcall, |
| 158 | // or vectorcall, add it. These functions have a suffix of @N where N is the |
| 159 | // cumulative byte size of all of the parameters to the function in decimal. |
| 160 | if (CC == CallingConv::X86_VectorCall) |
| 161 | OS << '@'; // vectorcall functions use a double @ suffix. |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 162 | FunctionType *FT = MSFunc->getFunctionType(); |
Reid Kleckner | 9ccce99 | 2014-10-28 01:29:26 +0000 | [diff] [blame] | 163 | if (hasByteCountSuffix(CC) && |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 164 | // "Pure" variadic functions do not receive @0 suffix. |
| 165 | (!FT->isVarArg() || FT->getNumParams() == 0 || |
| 166 | (FT->getNumParams() == 1 && MSFunc->hasStructRetAttr()))) |
Rafael Espindola | c233f74 | 2015-06-23 13:59:29 +0000 | [diff] [blame] | 167 | addByteCountSuffix(OS, MSFunc, DL); |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 168 | } |
| 169 | |
| 170 | void Mangler::getNameWithPrefix(SmallVectorImpl<char> &OutName, |
Rafael Espindola | daeafb4 | 2014-02-19 17:23:20 +0000 | [diff] [blame] | 171 | const GlobalValue *GV, |
David Majnemer | 21fecf9 | 2015-03-17 20:40:21 +0000 | [diff] [blame] | 172 | bool CannotUsePrivateLabel) const { |
Rafael Espindola | 310f501 | 2014-01-29 02:30:38 +0000 | [diff] [blame] | 173 | raw_svector_ostream OS(OutName); |
David Majnemer | 21fecf9 | 2015-03-17 20:40:21 +0000 | [diff] [blame] | 174 | getNameWithPrefix(OS, GV, CannotUsePrivateLabel); |
Chris Lattner | 840c8d7 | 2009-09-11 05:40:42 +0000 | [diff] [blame] | 175 | } |
Peter Collingbourne | c66018e | 2017-03-31 04:46:50 +0000 | [diff] [blame^] | 176 | |
| 177 | void llvm::emitLinkerFlagsForGlobalCOFF(raw_ostream &OS, const GlobalValue *GV, |
| 178 | const Triple &TT, Mangler &Mangler) { |
| 179 | if (!GV->hasDLLExportStorageClass() || GV->isDeclaration()) |
| 180 | return; |
| 181 | |
| 182 | if (TT.isKnownWindowsMSVCEnvironment()) |
| 183 | OS << " /EXPORT:"; |
| 184 | else |
| 185 | OS << " -export:"; |
| 186 | |
| 187 | if (TT.isWindowsGNUEnvironment() || TT.isWindowsCygwinEnvironment()) { |
| 188 | std::string Flag; |
| 189 | raw_string_ostream FlagOS(Flag); |
| 190 | Mangler.getNameWithPrefix(FlagOS, GV, false); |
| 191 | FlagOS.flush(); |
| 192 | if (Flag[0] == GV->getParent()->getDataLayout().getGlobalPrefix()) |
| 193 | OS << Flag.substr(1); |
| 194 | else |
| 195 | OS << Flag; |
| 196 | } else { |
| 197 | Mangler.getNameWithPrefix(OS, GV, false); |
| 198 | } |
| 199 | |
| 200 | if (!GV->getValueType()->isFunctionTy()) { |
| 201 | if (TT.isKnownWindowsMSVCEnvironment()) |
| 202 | OS << ",DATA"; |
| 203 | else |
| 204 | OS << ",data"; |
| 205 | } |
| 206 | } |