2003-07-25 04:20:58 +08:00
|
|
|
//===-- Mangler.cpp - Self-contained c/asm llvm name mangler --------------===//
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
// The LLVM Compiler Infrastructure
|
|
|
|
//
|
2007-12-30 04:36:04 +08:00
|
|
|
// This file is distributed under the University of Illinois Open Source
|
|
|
|
// License. See LICENSE.TXT for details.
|
2005-04-22 07:48:37 +08:00
|
|
|
//
|
2003-10-21 03:43:21 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
2003-07-25 04:20:58 +08:00
|
|
|
//
|
2010-01-17 05:08:46 +08:00
|
|
|
// Unified name mangler for assembly backends.
|
2003-07-25 04:20:58 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
2010-01-17 05:57:06 +08:00
|
|
|
#include "llvm/Target/Mangler.h"
|
2012-12-04 00:50:05 +08:00
|
|
|
#include "llvm/ADT/SmallString.h"
|
|
|
|
#include "llvm/ADT/Twine.h"
|
2013-01-02 19:36:10 +08:00
|
|
|
#include "llvm/IR/DataLayout.h"
|
|
|
|
#include "llvm/IR/DerivedTypes.h"
|
|
|
|
#include "llvm/IR/Function.h"
|
2010-01-18 02:22:35 +08:00
|
|
|
#include "llvm/MC/MCAsmInfo.h"
|
2010-03-13 02:44:54 +08:00
|
|
|
#include "llvm/MC/MCContext.h"
|
2013-05-30 04:37:19 +08:00
|
|
|
#include "llvm/Target/TargetMachine.h"
|
2010-03-13 05:03:47 +08:00
|
|
|
#include "llvm/Support/raw_ostream.h"
|
2003-12-15 05:35:53 +08:00
|
|
|
using namespace llvm;
|
2003-11-12 06:41:34 +08:00
|
|
|
|
2012-04-07 08:37:53 +08:00
|
|
|
static bool isAcceptableChar(char C, bool AllowPeriod, bool AllowUTF8) {
|
2010-01-18 03:23:46 +08:00
|
|
|
if ((C < 'a' || C > 'z') &&
|
|
|
|
(C < 'A' || C > 'Z') &&
|
|
|
|
(C < '0' || C > '9') &&
|
2010-04-29 12:00:56 +08:00
|
|
|
C != '_' && C != '$' && C != '@' &&
|
2012-04-07 08:37:53 +08:00
|
|
|
!(AllowPeriod && C == '.') &&
|
|
|
|
!(AllowUTF8 && (C & 0x80)))
|
2010-01-18 03:23:46 +08:00
|
|
|
return false;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
static char HexDigit(int V) {
|
|
|
|
return V < 10 ? V+'0' : V+'A'-10;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void MangleLetter(SmallVectorImpl<char> &OutName, unsigned char C) {
|
|
|
|
OutName.push_back('_');
|
|
|
|
OutName.push_back(HexDigit(C >> 4));
|
|
|
|
OutName.push_back(HexDigit(C & 15));
|
|
|
|
OutName.push_back('_');
|
|
|
|
}
|
|
|
|
|
2012-09-14 22:57:36 +08:00
|
|
|
/// NameNeedsEscaping - Return true if the identifier \p Str needs quotes
|
2010-01-18 03:23:46 +08:00
|
|
|
/// for this assembler.
|
2013-06-18 15:20:20 +08:00
|
|
|
static bool NameNeedsEscaping(StringRef Str, const MCAsmInfo *MAI) {
|
2010-01-18 03:23:46 +08:00
|
|
|
assert(!Str.empty() && "Cannot create an empty MCSymbol");
|
|
|
|
|
|
|
|
// If the first character is a number and the target does not allow this, we
|
|
|
|
// need quotes.
|
2013-06-18 15:20:20 +08:00
|
|
|
if (!MAI->doesAllowNameToStartWithDigit() && Str[0] >= '0' && Str[0] <= '9')
|
2010-01-18 03:23:46 +08:00
|
|
|
return true;
|
|
|
|
|
|
|
|
// If any of the characters in the string is an unacceptable character, force
|
|
|
|
// quotes.
|
2013-06-18 15:20:20 +08:00
|
|
|
bool AllowPeriod = MAI->doesAllowPeriodsInName();
|
|
|
|
bool AllowUTF8 = MAI->doesAllowUTF8();
|
2010-01-18 03:23:46 +08:00
|
|
|
for (unsigned i = 0, e = Str.size(); i != e; ++i)
|
2012-04-07 08:37:53 +08:00
|
|
|
if (!isAcceptableChar(Str[i], AllowPeriod, AllowUTF8))
|
2010-01-18 03:23:46 +08:00
|
|
|
return true;
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/// appendMangledName - Add the specified string in mangled form if it uses
|
|
|
|
/// any unusual characters.
|
2010-01-18 03:32:29 +08:00
|
|
|
static void appendMangledName(SmallVectorImpl<char> &OutName, StringRef Str,
|
2013-06-18 15:20:20 +08:00
|
|
|
const MCAsmInfo *MAI) {
|
2010-01-18 03:23:46 +08:00
|
|
|
// The first character is not allowed to be a number unless the target
|
|
|
|
// explicitly allows it.
|
2013-06-18 15:20:20 +08:00
|
|
|
if (!MAI->doesAllowNameToStartWithDigit() && Str[0] >= '0' && Str[0] <= '9') {
|
2010-01-18 03:23:46 +08:00
|
|
|
MangleLetter(OutName, Str[0]);
|
|
|
|
Str = Str.substr(1);
|
|
|
|
}
|
2010-04-29 12:00:56 +08:00
|
|
|
|
2013-06-18 15:20:20 +08:00
|
|
|
bool AllowPeriod = MAI->doesAllowPeriodsInName();
|
|
|
|
bool AllowUTF8 = MAI->doesAllowUTF8();
|
2010-01-18 03:23:46 +08:00
|
|
|
for (unsigned i = 0, e = Str.size(); i != e; ++i) {
|
2012-04-07 08:37:53 +08:00
|
|
|
if (!isAcceptableChar(Str[i], AllowPeriod, AllowUTF8))
|
2010-01-18 03:23:46 +08:00
|
|
|
MangleLetter(OutName, Str[i]);
|
|
|
|
else
|
|
|
|
OutName.push_back(Str[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/// appendMangledQuotedName - On systems that support quoted symbols, we still
|
|
|
|
/// have to escape some (obscure) characters like " and \n which would break the
|
|
|
|
/// assembler's lexing.
|
|
|
|
static void appendMangledQuotedName(SmallVectorImpl<char> &OutName,
|
|
|
|
StringRef Str) {
|
|
|
|
for (unsigned i = 0, e = Str.size(); i != e; ++i) {
|
|
|
|
if (Str[i] == '"' || Str[i] == '\n')
|
|
|
|
MangleLetter(OutName, Str[i]);
|
|
|
|
else
|
|
|
|
OutName.push_back(Str[i]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2010-01-13 15:01:09 +08:00
|
|
|
/// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
|
|
|
|
/// and the specified name as the global variable name. GVName must not be
|
|
|
|
/// empty.
|
|
|
|
void Mangler::getNameWithPrefix(SmallVectorImpl<char> &OutName,
|
|
|
|
const Twine &GVName, ManglerPrefixTy PrefixTy) {
|
|
|
|
SmallString<256> TmpData;
|
2010-01-13 20:45:23 +08:00
|
|
|
StringRef Name = GVName.toStringRef(TmpData);
|
2010-01-13 15:01:09 +08:00
|
|
|
assert(!Name.empty() && "getNameWithPrefix requires non-empty name");
|
|
|
|
|
2013-06-18 15:20:20 +08:00
|
|
|
const MCAsmInfo *MAI = Context.getAsmInfo();
|
2010-03-13 02:44:54 +08:00
|
|
|
|
2010-01-13 15:01:09 +08:00
|
|
|
// If the global name is not led with \1, add the appropriate prefixes.
|
2010-01-18 03:23:46 +08:00
|
|
|
if (Name[0] == '\1') {
|
|
|
|
Name = Name.substr(1);
|
|
|
|
} else {
|
2010-01-18 02:22:35 +08:00
|
|
|
if (PrefixTy == Mangler::Private) {
|
2013-06-18 15:20:20 +08:00
|
|
|
const char *Prefix = MAI->getPrivateGlobalPrefix();
|
2010-01-18 02:22:35 +08:00
|
|
|
OutName.append(Prefix, Prefix+strlen(Prefix));
|
|
|
|
} else if (PrefixTy == Mangler::LinkerPrivate) {
|
2013-06-18 15:20:20 +08:00
|
|
|
const char *Prefix = MAI->getLinkerPrivateGlobalPrefix();
|
2010-01-18 02:22:35 +08:00
|
|
|
OutName.append(Prefix, Prefix+strlen(Prefix));
|
|
|
|
}
|
|
|
|
|
2013-06-18 15:20:20 +08:00
|
|
|
const char *Prefix = MAI->getGlobalPrefix();
|
2010-01-13 15:01:09 +08:00
|
|
|
if (Prefix[0] == 0)
|
|
|
|
; // Common noop, no prefix.
|
|
|
|
else if (Prefix[1] == 0)
|
|
|
|
OutName.push_back(Prefix[0]); // Common, one character prefix.
|
|
|
|
else
|
2010-01-18 02:22:35 +08:00
|
|
|
OutName.append(Prefix, Prefix+strlen(Prefix)); // Arbitrary length prefix.
|
2010-01-13 15:01:09 +08:00
|
|
|
}
|
|
|
|
|
2010-01-18 03:23:46 +08:00
|
|
|
// If this is a simple string that doesn't need escaping, just append it.
|
|
|
|
if (!NameNeedsEscaping(Name, MAI) ||
|
|
|
|
// If quotes are supported, they can be used unless the string contains
|
|
|
|
// a quote or newline.
|
2013-06-18 15:20:20 +08:00
|
|
|
(MAI->doesAllowQuotesInName() &&
|
2010-01-18 03:23:46 +08:00
|
|
|
Name.find_first_of("\n\"") == StringRef::npos)) {
|
|
|
|
OutName.append(Name.begin(), Name.end());
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
// On systems that do not allow quoted names, we need to mangle most
|
|
|
|
// strange characters.
|
2013-06-18 15:20:20 +08:00
|
|
|
if (!MAI->doesAllowQuotesInName())
|
2010-03-13 02:44:54 +08:00
|
|
|
return appendMangledName(OutName, Name, MAI);
|
2010-01-18 03:23:46 +08:00
|
|
|
|
|
|
|
// Okay, the system allows quoted strings. We can quote most anything, the
|
|
|
|
// only characters that need escaping are " and \n.
|
|
|
|
assert(Name.find_first_of("\n\"") != StringRef::npos);
|
|
|
|
return appendMangledQuotedName(OutName, Name);
|
2010-01-13 15:01:09 +08:00
|
|
|
}
|
|
|
|
|
2010-03-13 05:03:47 +08:00
|
|
|
/// AddFastCallStdCallSuffix - Microsoft fastcall and stdcall functions require
|
|
|
|
/// a suffix on their name indicating the number of words of arguments they
|
|
|
|
/// take.
|
|
|
|
static void AddFastCallStdCallSuffix(SmallVectorImpl<char> &OutName,
|
2012-10-09 00:38:25 +08:00
|
|
|
const Function *F, const DataLayout &TD) {
|
2010-03-13 05:03:47 +08:00
|
|
|
// Calculate arguments size total.
|
|
|
|
unsigned ArgWords = 0;
|
|
|
|
for (Function::const_arg_iterator AI = F->arg_begin(), AE = F->arg_end();
|
|
|
|
AI != AE; ++AI) {
|
2011-07-18 12:54:35 +08:00
|
|
|
Type *Ty = AI->getType();
|
2010-03-13 05:03:47 +08:00
|
|
|
// 'Dereference' type in case of byval parameter attribute
|
|
|
|
if (AI->hasByValAttr())
|
|
|
|
Ty = cast<PointerType>(Ty)->getElementType();
|
|
|
|
// Size should be aligned to DWORD boundary
|
|
|
|
ArgWords += ((TD.getTypeAllocSize(Ty) + 3)/4)*4;
|
|
|
|
}
|
|
|
|
|
|
|
|
raw_svector_ostream(OutName) << '@' << ArgWords;
|
|
|
|
}
|
|
|
|
|
2009-09-11 13:40:42 +08:00
|
|
|
|
|
|
|
/// getNameWithPrefix - Fill OutName with the name of the appropriate prefix
|
|
|
|
/// and the specified global variable's name. If the global variable doesn't
|
|
|
|
/// have a name, this fills in a unique name for the global.
|
|
|
|
void Mangler::getNameWithPrefix(SmallVectorImpl<char> &OutName,
|
|
|
|
const GlobalValue *GV,
|
|
|
|
bool isImplicitlyPrivate) {
|
2010-01-18 02:52:16 +08:00
|
|
|
ManglerPrefixTy PrefixTy = Mangler::Default;
|
|
|
|
if (GV->hasPrivateLinkage() || isImplicitlyPrivate)
|
|
|
|
PrefixTy = Mangler::Private;
|
2012-08-18 02:33:14 +08:00
|
|
|
else if (GV->hasLinkerPrivateLinkage() || GV->hasLinkerPrivateWeakLinkage())
|
2010-01-18 02:52:16 +08:00
|
|
|
PrefixTy = Mangler::LinkerPrivate;
|
|
|
|
|
2010-01-13 15:01:09 +08:00
|
|
|
// If this global has a name, handle it simply.
|
2010-03-13 05:03:47 +08:00
|
|
|
if (GV->hasName()) {
|
2013-04-20 05:20:56 +08:00
|
|
|
StringRef Name = GV->getName();
|
|
|
|
getNameWithPrefix(OutName, Name, PrefixTy);
|
|
|
|
// No need to do anything else if the global has the special "do not mangle"
|
|
|
|
// flag in the name.
|
|
|
|
if (Name[0] == 1)
|
|
|
|
return;
|
2010-03-13 05:03:47 +08:00
|
|
|
} else {
|
|
|
|
// Get the ID for the global, assigning a new one if we haven't got one
|
|
|
|
// already.
|
|
|
|
unsigned &ID = AnonGlobalIDs[GV];
|
|
|
|
if (ID == 0) ID = NextAnonGlobalID++;
|
2010-01-13 15:01:09 +08:00
|
|
|
|
2010-03-13 05:03:47 +08:00
|
|
|
// Must mangle the global into a unique ID.
|
|
|
|
getNameWithPrefix(OutName, "__unnamed_" + Twine(ID), PrefixTy);
|
|
|
|
}
|
2009-09-11 13:40:42 +08:00
|
|
|
|
2010-03-13 05:03:47 +08:00
|
|
|
// If we are supposed to add a microsoft-style suffix for stdcall/fastcall,
|
|
|
|
// add it.
|
2013-06-18 15:20:20 +08:00
|
|
|
if (Context.getAsmInfo()->hasMicrosoftFastStdCallMangling()) {
|
2010-03-13 05:03:47 +08:00
|
|
|
if (const Function *F = dyn_cast<Function>(GV)) {
|
|
|
|
CallingConv::ID CC = F->getCallingConv();
|
|
|
|
|
|
|
|
// fastcall functions need to start with @.
|
|
|
|
// FIXME: This logic seems unlikely to be right.
|
|
|
|
if (CC == CallingConv::X86_FastCall) {
|
|
|
|
if (OutName[0] == '_')
|
|
|
|
OutName[0] = '@';
|
|
|
|
else
|
|
|
|
OutName.insert(OutName.begin(), '@');
|
|
|
|
}
|
|
|
|
|
|
|
|
// fastcall and stdcall functions usually need @42 at the end to specify
|
|
|
|
// the argument info.
|
2011-07-18 12:54:35 +08:00
|
|
|
FunctionType *FT = F->getFunctionType();
|
2010-03-13 05:03:47 +08:00
|
|
|
if ((CC == CallingConv::X86_FastCall || CC == CallingConv::X86_StdCall) &&
|
|
|
|
// "Pure" variadic functions do not receive @0 suffix.
|
|
|
|
(!FT->isVarArg() || FT->getNumParams() == 0 ||
|
|
|
|
(FT->getNumParams() == 1 && F->hasStructRetAttr())))
|
2013-05-30 04:37:19 +08:00
|
|
|
AddFastCallStdCallSuffix(OutName, F, *TM->getDataLayout());
|
2010-03-13 05:03:47 +08:00
|
|
|
}
|
|
|
|
}
|
2009-09-11 13:40:42 +08:00
|
|
|
}
|
|
|
|
|
2010-03-13 02:55:20 +08:00
|
|
|
/// getSymbol - Return the MCSymbol for the specified global value. This
|
|
|
|
/// symbol is the main label that is the address of the global.
|
|
|
|
MCSymbol *Mangler::getSymbol(const GlobalValue *GV) {
|
|
|
|
SmallString<60> NameStr;
|
|
|
|
getNameWithPrefix(NameStr, GV, false);
|
2010-03-31 02:10:53 +08:00
|
|
|
return Context.GetOrCreateSymbol(NameStr.str());
|
2010-03-13 02:55:20 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
|