forked from OSchip/llvm-project
400 lines
13 KiB
C++
400 lines
13 KiB
C++
//===-- PIC16ABINames.h - PIC16 Naming conventios for ABI----- --*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file contains the functions to manage ABI Naming conventions for PIC16.
|
|
//
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TARGET_PIC16ABINAMES_H
|
|
#define LLVM_TARGET_PIC16ABINAMES_H
|
|
|
|
#include "llvm/Support/ErrorHandling.h"
|
|
#include "llvm/Target/TargetMachine.h"
|
|
#include <cassert>
|
|
#include <sstream>
|
|
#include <cstring>
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
class PIC16TargetMachine;
|
|
class FunctionPass;
|
|
class MachineCodeEmitter;
|
|
class formatted_raw_ostream;
|
|
|
|
// A Central class to manage all ABI naming conventions.
|
|
// PAN - [P]ic16 [A]BI [N]ames
|
|
class PAN {
|
|
public:
|
|
// Map the name of the symbol to its section name.
|
|
// Current ABI:
|
|
// -----------------------------------------------------
|
|
// ALL Names are prefixed with the symobl '@'.
|
|
// ------------------------------------------------------
|
|
// Global variables do not have any '.' in their names.
|
|
// These are maily function names and global variable names.
|
|
// Example - @foo, @i
|
|
// Static local variables - @<func>.<var>
|
|
// -------------------------------------------------------
|
|
// Functions and auto variables.
|
|
// Names are mangled as <prefix><funcname>.<tag>.<varname>
|
|
// Where <prefix> is '@' and <tag> is any one of
|
|
// the following
|
|
// .auto. - an automatic var of a function.
|
|
// .temp. - temproray data of a function.
|
|
// .ret. - return value label for a function.
|
|
// .frame. - Frame label for a function where retval, args
|
|
// and temps are stored.
|
|
// .args. - Label used to pass arguments to a direct call.
|
|
// Example - Function name: @foo
|
|
// Its frame: @foo.frame.
|
|
// Its retval: @foo.ret.
|
|
// Its local vars: @foo.auto.a
|
|
// Its temp data: @foo.temp.
|
|
// Its arg passing: @foo.args.
|
|
//----------------------------------------------
|
|
// Libcall - compiler generated libcall names must start with .lib.
|
|
// This id will be used to emit extern decls for libcalls.
|
|
// Example - libcall name: @.lib.sra.i8
|
|
// To pass args: @.lib.sra.i8.args.
|
|
// To return val: @.lib.sra.i8.ret.
|
|
//----------------------------------------------
|
|
// SECTION Names
|
|
// uninitialized globals - @udata.<num>.#
|
|
// initialized globals - @idata.<num>.#
|
|
// Program memory data - @romdata.#
|
|
// Variables with user defined section name - <user_defined_section>
|
|
// Variables with user defined address - @<var>.user_section.<address>.#
|
|
// Function frame - @<func>.frame_section.
|
|
// Function autos - @<func>.autos_section.
|
|
// Overlay sections - @<color>.##
|
|
// Declarations - Enclosed in comments. No section for them.
|
|
//----------------------------------------------------------
|
|
|
|
// Tags used to mangle different names.
|
|
enum TAGS {
|
|
PREFIX_SYMBOL,
|
|
GLOBAL,
|
|
STATIC_LOCAL,
|
|
AUTOS_LABEL,
|
|
FRAME_LABEL,
|
|
RET_LABEL,
|
|
ARGS_LABEL,
|
|
TEMPS_LABEL,
|
|
|
|
LIBCALL,
|
|
|
|
FRAME_SECTION,
|
|
AUTOS_SECTION,
|
|
CODE_SECTION,
|
|
USER_SECTION
|
|
};
|
|
|
|
// Textual names of the tags.
|
|
inline static const char *getTagName(TAGS tag) {
|
|
switch (tag) {
|
|
default: return "";
|
|
case PREFIX_SYMBOL: return "@";
|
|
case AUTOS_LABEL: return ".auto.";
|
|
case FRAME_LABEL: return ".frame.";
|
|
case TEMPS_LABEL: return ".temp.";
|
|
case ARGS_LABEL: return ".args.";
|
|
case RET_LABEL: return ".ret.";
|
|
case LIBCALL: return ".lib.";
|
|
case FRAME_SECTION: return ".frame_section.";
|
|
case AUTOS_SECTION: return ".autos_section.";
|
|
case CODE_SECTION: return ".code_section.";
|
|
case USER_SECTION: return ".user_section.";
|
|
}
|
|
}
|
|
|
|
// Get tag type for the Symbol.
|
|
inline static TAGS getSymbolTag(const std::string &Sym) {
|
|
if (Sym.find(getTagName(TEMPS_LABEL)) != std::string::npos)
|
|
return TEMPS_LABEL;
|
|
|
|
if (Sym.find(getTagName(FRAME_LABEL)) != std::string::npos)
|
|
return FRAME_LABEL;
|
|
|
|
if (Sym.find(getTagName(RET_LABEL)) != std::string::npos)
|
|
return RET_LABEL;
|
|
|
|
if (Sym.find(getTagName(ARGS_LABEL)) != std::string::npos)
|
|
return ARGS_LABEL;
|
|
|
|
if (Sym.find(getTagName(AUTOS_LABEL)) != std::string::npos)
|
|
return AUTOS_LABEL;
|
|
|
|
if (Sym.find(getTagName(LIBCALL)) != std::string::npos)
|
|
return LIBCALL;
|
|
|
|
// It does not have any Tag. So its a true global or static local.
|
|
if (Sym.find(".") == std::string::npos)
|
|
return GLOBAL;
|
|
|
|
// If a . is there, then it may be static local.
|
|
// We should mangle these as well in clang.
|
|
if (Sym.find(".") != std::string::npos)
|
|
return STATIC_LOCAL;
|
|
|
|
assert (0 && "Could not determine Symbol's tag");
|
|
return PREFIX_SYMBOL; // Silence warning when assertions are turned off.
|
|
}
|
|
|
|
// addPrefix - add prefix symbol to a name if there isn't one already.
|
|
inline static std::string addPrefix (const std::string &Name) {
|
|
std::string prefix = getTagName (PREFIX_SYMBOL);
|
|
|
|
// If this name already has a prefix, nothing to do.
|
|
if (Name.compare(0, prefix.size(), prefix) == 0)
|
|
return Name;
|
|
|
|
return prefix + Name;
|
|
}
|
|
|
|
// Get mangled func name from a mangled sym name.
|
|
// In all cases func name is the first component before a '.'.
|
|
static inline std::string getFuncNameForSym(const std::string &Sym1) {
|
|
assert (getSymbolTag(Sym1) != GLOBAL && "not belongs to a function");
|
|
|
|
std::string Sym = addPrefix(Sym1);
|
|
|
|
// Position of the . after func name. That's where func name ends.
|
|
size_t func_name_end = Sym.find ('.');
|
|
|
|
return Sym.substr (0, func_name_end);
|
|
}
|
|
|
|
// Get Frame start label for a func.
|
|
static std::string getFrameLabel(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(FRAME_LABEL);
|
|
return Func1 + tag;
|
|
}
|
|
|
|
// Get the retval label for the given function.
|
|
static std::string getRetvalLabel(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(RET_LABEL);
|
|
return Func1 + tag;
|
|
}
|
|
|
|
// Get the argument label for the given function.
|
|
static std::string getArgsLabel(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(ARGS_LABEL);
|
|
return Func1 + tag;
|
|
}
|
|
|
|
// Get the tempdata label for the given function.
|
|
static std::string getTempdataLabel(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(TEMPS_LABEL);
|
|
return Func1 + tag;
|
|
}
|
|
|
|
static std::string getFrameSectionName(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(FRAME_SECTION);
|
|
return Func1 + tag + "#";
|
|
}
|
|
|
|
static std::string getAutosSectionName(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(AUTOS_SECTION);
|
|
return Func1 + tag + "#";
|
|
}
|
|
|
|
static std::string getCodeSectionName(const std::string &Func) {
|
|
std::string Func1 = addPrefix(Func);
|
|
std::string tag = getTagName(CODE_SECTION);
|
|
return Func1 + tag + "#";
|
|
}
|
|
|
|
static std::string getUserSectionName(const std::string &Name) {
|
|
std::string sname = addPrefix(Name);;
|
|
std::string tag = getTagName(USER_SECTION);
|
|
return sname + tag + "#";
|
|
}
|
|
|
|
// udata, romdata and idata section names are generated by a given number.
|
|
// @udata.<num>.#
|
|
static std::string getUdataSectionName(unsigned num,
|
|
std::string prefix = "") {
|
|
std::ostringstream o;
|
|
o << getTagName(PREFIX_SYMBOL) << prefix << "udata." << num
|
|
<< ".#";
|
|
return o.str();
|
|
}
|
|
|
|
static std::string getRomdataSectionName() {
|
|
return "romdata.#";
|
|
}
|
|
|
|
static std::string getSharedUDataSectionName() {
|
|
std::ostringstream o;
|
|
o << getTagName(PREFIX_SYMBOL) << "udata_shr" << ".#";
|
|
return o.str();
|
|
}
|
|
|
|
static std::string getRomdataSectionName(unsigned num,
|
|
std::string prefix = "") {
|
|
std::ostringstream o;
|
|
o << getTagName(PREFIX_SYMBOL) << prefix << "romdata." << num
|
|
<< ".#";
|
|
return o.str();
|
|
}
|
|
|
|
static std::string getIdataSectionName(unsigned num,
|
|
std::string prefix = "") {
|
|
std::ostringstream o;
|
|
o << getTagName(PREFIX_SYMBOL) << prefix << "idata." << num
|
|
<< ".#";
|
|
return o.str();
|
|
}
|
|
|
|
inline static bool isLocalName (const std::string &Name) {
|
|
if (getSymbolTag(Name) == AUTOS_LABEL)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
inline static bool isMemIntrinsic (const std::string &Name) {
|
|
if (Name.compare("@memcpy") == 0 || Name.compare("@memset") == 0 ||
|
|
Name.compare("@memmove") == 0) {
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
// Currently names of libcalls are assigned during TargetLowering
|
|
// object construction. There is no provision to change the when the
|
|
// code for a function IL function being generated.
|
|
// So we have to change these names while printing assembly.
|
|
// We need to do that mainly for names related to intrinsics. This
|
|
// function returns true if a name needs to be cloned.
|
|
inline static bool isIntrinsicStuff(const std::string &Name) {
|
|
// Return true if the name contains LIBCALL marker, or a MemIntrinisc.
|
|
// these are mainly ARGS_LABEL, RET_LABEL, and the LIBCALL name itself.
|
|
if ((Name.find(getTagName(LIBCALL)) != std::string::npos)
|
|
|| isMemIntrinsic(Name))
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
// Rename the name for IL.
|
|
inline static std::string Rename(const std::string &Name) {
|
|
std::string Newname;
|
|
// If its a label (LIBCALL+Func+LABEL), change it to
|
|
// (LIBCALL+Func+IL+LABEL).
|
|
TAGS id = getSymbolTag(Name);
|
|
if (id == ARGS_LABEL || id == RET_LABEL) {
|
|
std::size_t pos = Name.find(getTagName(id));
|
|
Newname = Name.substr(0, pos) + ".IL" + getTagName(id);
|
|
return Newname;
|
|
}
|
|
|
|
// Else, just append IL to name.
|
|
return Name + ".IL";
|
|
}
|
|
|
|
|
|
|
|
|
|
inline static bool isLocalToFunc (std::string &Func, std::string &Var) {
|
|
if (! isLocalName(Var)) return false;
|
|
|
|
std::string Func1 = addPrefix(Func);
|
|
// Extract func name of the varilable.
|
|
const std::string &fname = getFuncNameForSym(Var);
|
|
|
|
if (fname.compare(Func1) == 0)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
|
|
// Get the section for the given external symbol names.
|
|
// This tries to find the type (Tag) of the symbol from its mangled name
|
|
// and return appropriate section name for it.
|
|
static inline std::string getSectionNameForSym(const std::string &Sym1) {
|
|
std::string Sym = addPrefix(Sym1);
|
|
|
|
std::string SectionName;
|
|
|
|
std::string Fname = getFuncNameForSym (Sym);
|
|
TAGS id = getSymbolTag (Sym);
|
|
|
|
switch (id) {
|
|
default : assert (0 && "Could not determine external symbol type");
|
|
case FRAME_LABEL:
|
|
case RET_LABEL:
|
|
case TEMPS_LABEL:
|
|
case ARGS_LABEL: {
|
|
return getFrameSectionName(Fname);
|
|
}
|
|
case AUTOS_LABEL: {
|
|
return getAutosSectionName(Fname);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Return Overlay Name for the section.
|
|
/// The ABI Convention is: @<Color>.##.<section_tag>
|
|
/// The section_tag is retrieved from the SectName parameter and
|
|
/// and Color is passed in parameter.
|
|
static inline std::string getOverlayName(std::string SectName, int Color) {
|
|
// FIXME: Only autos_section and frame_section are colored.
|
|
// So check and assert if the passed SectName does not have AUTOS_SECTION
|
|
// or FRAME_SECTION tag in it.
|
|
std::ostringstream o;
|
|
o << getTagName(PREFIX_SYMBOL) << Color << ".##"
|
|
<< SectName.substr(SectName.find("."));
|
|
|
|
return o.str();
|
|
}
|
|
|
|
// Return true if the current function is an ISR
|
|
inline static bool isISR(const std::string SectName) {
|
|
if (SectName.find("interrupt") != std::string::npos)
|
|
return true;
|
|
|
|
return false;
|
|
}
|
|
|
|
// Return the address for ISR starts in rom.
|
|
inline static std::string getISRAddr(void) {
|
|
return "0x4";
|
|
}
|
|
|
|
// Returns the name of clone of a function.
|
|
static std::string getCloneFnName(const std::string &Func) {
|
|
return (Func + ".IL");
|
|
}
|
|
|
|
// Returns the name of clone of a variable.
|
|
static std::string getCloneVarName(const std::string &Fn,
|
|
const std::string &Var) {
|
|
std::string cloneVarName = Var;
|
|
// These vars are named like fun.auto.var.
|
|
// Just replace the function name, with clone function name.
|
|
std::string cloneFnName = getCloneFnName(Fn);
|
|
cloneVarName.replace(cloneVarName.find(Fn), Fn.length(), cloneFnName);
|
|
return cloneVarName;
|
|
}
|
|
}; // class PAN.
|
|
} // end namespace llvm;
|
|
|
|
#endif
|