contrib/llvm/tools/lld/ELF/ScriptLexer.cpp

   1 //===- ScriptLexer.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 // This file defines a lexer for the linker script.
  11 //
  12 // The linker script's grammar is not complex but ambiguous due to the
  13 // lack of the formal specification of the language. What we are trying to
  14 // do in this and other files in LLD is to make a "reasonable" linker
  15 // script processor.
  16 //
  17 // Among simplicity, compatibility and efficiency, we put the most
  18 // emphasis on simplicity when we wrote this lexer. Compatibility with the
  19 // GNU linkers is important, but we did not try to clone every tiny corner
  20 // case of their lexers, as even ld.bfd and ld.gold are subtly different
  21 // in various corner cases. We do not care much about efficiency because
  22 // the time spent in parsing linker scripts is usually negligible.
  23 //
  24 // Our grammar of the linker script is LL(2), meaning that it needs at
  25 // most two-token lookahead to parse. The only place we need two-token
  26 // lookahead is labels in version scripts, where we need to parse "local :"
  27 // as if "local:".
  28 //
  29 // Overall, this lexer works fine for most linker scripts. There might
  30 // be room for improving compatibility, but that's probably not at the
  31 // top of our todo list.
  32 //
  33 //===----------------------------------------------------------------------===//
  34
  35 #include "ScriptLexer.h"
  36 #include "lld/Common/ErrorHandler.h"
  37 #include "llvm/ADT/Twine.h"
  38
  39 using namespace llvm;
  40 using namespace lld;
  41 using namespace lld::elf;
  42
  43 // Returns a whole line containing the current token.
  44 StringRef ScriptLexer::getLine() {
  45   StringRef S = getCurrentMB().getBuffer();
  46   StringRef Tok = Tokens[Pos - 1];
  47
  48   size_t Pos = S.rfind('\n', Tok.data() - S.data());
  49   if (Pos != StringRef::npos)
  50     S = S.substr(Pos + 1);
  51   return S.substr(0, S.find_first_of("\r\n"));
  52 }
  53
  54 // Returns 1-based line number of the current token.
  55 size_t ScriptLexer::getLineNumber() {
  56   StringRef S = getCurrentMB().getBuffer();
  57   StringRef Tok = Tokens[Pos - 1];
  58   return S.substr(0, Tok.data() - S.data()).count('\n') + 1;
  59 }
  60
  61 // Returns 0-based column number of the current token.
  62 size_t ScriptLexer::getColumnNumber() {
  63   StringRef Tok = Tokens[Pos - 1];
  64   return Tok.data() - getLine().data();
  65 }
  66
  67 std::string ScriptLexer::getCurrentLocation() {
  68   std::string Filename = getCurrentMB().getBufferIdentifier();
  69   if (!Pos)
  70     return Filename;
  71   return (Filename + ":" + Twine(getLineNumber())).str();
  72 }
  73
  74 ScriptLexer::ScriptLexer(MemoryBufferRef MB) { tokenize(MB); }
  75
  76 // We don't want to record cascading errors. Keep only the first one.
  77 void ScriptLexer::setError(const Twine &Msg) {
  78   if (errorCount())
  79     return;
  80
  81   std::string S = (getCurrentLocation() + ": " + Msg).str();
  82   if (Pos)
  83     S += "\n>>> " + getLine().str() + "\n>>> " +
  84          std::string(getColumnNumber(), ' ') + "^";
  85   error(S);
  86 }
  87
  88 // Split S into linker script tokens.
  89 void ScriptLexer::tokenize(MemoryBufferRef MB) {
  90   std::vector<StringRef> Vec;
  91   MBs.push_back(MB);
  92   StringRef S = MB.getBuffer();
  93   StringRef Begin = S;
  94
  95   for (;;) {
  96     S = skipSpace(S);
  97     if (S.empty())
  98       break;
  99
 100     // Quoted token. Note that double-quote characters are parts of a token
 101     // because, in a glob match context, only unquoted tokens are interpreted
 102     // as glob patterns. Double-quoted tokens are literal patterns in that
 103     // context.
 104     if (S.startswith("\"")) {
 105       size_t E = S.find("\"", 1);
 106       if (E == StringRef::npos) {
 107         StringRef Filename = MB.getBufferIdentifier();
 108         size_t Lineno = Begin.substr(0, S.data() - Begin.data()).count('\n');
 109         error(Filename + ":" + Twine(Lineno + 1) + ": unclosed quote");
 110         return;
 111       }
 112
 113       Vec.push_back(S.take_front(E + 1));
 114       S = S.substr(E + 1);
 115       continue;
 116     }
 117
 118     // ">foo" is parsed to ">" and "foo", but ">>" is parsed to ">>".
 119     if (S.startswith("<<") || S.startswith("<=") || S.startswith(">>") ||
 120         S.startswith(">=")) {
 121       Vec.push_back(S.substr(0, 2));
 122       S = S.substr(2);
 123       continue;
 124     }
 125
 126     // Unquoted token. This is more relaxed than tokens in C-like language,
 127     // so that you can write "file-name.cpp" as one bare token, for example.
 128     size_t Pos = S.find_first_not_of(
 129         "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
 130         "0123456789_.$/\\~=+[]*?-!^:");
 131
 132     // A character that cannot start a word (which is usually a
 133     // punctuation) forms a single character token.
 134     if (Pos == 0)
 135       Pos = 1;
 136     Vec.push_back(S.substr(0, Pos));
 137     S = S.substr(Pos);
 138   }
 139
 140   Tokens.insert(Tokens.begin() + Pos, Vec.begin(), Vec.end());
 141 }
 142
 143 // Skip leading whitespace characters or comments.
 144 StringRef ScriptLexer::skipSpace(StringRef S) {
 145   for (;;) {
 146     if (S.startswith("/*")) {
 147       size_t E = S.find("*/", 2);
 148       if (E == StringRef::npos) {
 149         error("unclosed comment in a linker script");
 150         return "";
 151       }
 152       S = S.substr(E + 2);
 153       continue;
 154     }
 155     if (S.startswith("#")) {
 156       size_t E = S.find('\n', 1);
 157       if (E == StringRef::npos)
 158         E = S.size() - 1;
 159       S = S.substr(E + 1);
 160       continue;
 161     }
 162     size_t Size = S.size();
 163     S = S.ltrim();
 164     if (S.size() == Size)
 165       return S;
 166   }
 167 }
 168
 169 // An erroneous token is handled as if it were the last token before EOF.
 170 bool ScriptLexer::atEOF() { return errorCount() || Tokens.size() == Pos; }
 171
 172 // Split a given string as an expression.
 173 // This function returns "3", "*" and "5" for "3*5" for example.
 174 static std::vector<StringRef> tokenizeExpr(StringRef S) {
 175   StringRef Ops = "+-*/:!~"; // List of operators
 176
 177   // Quoted strings are literal strings, so we don't want to split it.
 178   if (S.startswith("\""))
 179     return {S};
 180
 181   // Split S with operators as separators.
 182   std::vector<StringRef> Ret;
 183   while (!S.empty()) {
 184     size_t E = S.find_first_of(Ops);
 185
 186     // No need to split if there is no operator.
 187     if (E == StringRef::npos) {
 188       Ret.push_back(S);
 189       break;
 190     }
 191
 192     // Get a token before the opreator.
 193     if (E != 0)
 194       Ret.push_back(S.substr(0, E));
 195
 196     // Get the operator as a token. Keep != as one token.
 197     if (S.substr(E).startswith("!=")) {
 198       Ret.push_back(S.substr(E, 2));
 199       S = S.substr(E + 2);
 200     } else {
 201       Ret.push_back(S.substr(E, 1));
 202       S = S.substr(E + 1);
 203     }
 204   }
 205   return Ret;
 206 }
 207
 208 // In contexts where expressions are expected, the lexer should apply
 209 // different tokenization rules than the default one. By default,
 210 // arithmetic operator characters are regular characters, but in the
 211 // expression context, they should be independent tokens.
 212 //
 213 // For example, "foo*3" should be tokenized to "foo", "*" and "3" only
 214 // in the expression context.
 215 //
 216 // This function may split the current token into multiple tokens.
 217 void ScriptLexer::maybeSplitExpr() {
 218   if (!InExpr || errorCount() || atEOF())
 219     return;
 220
 221   std::vector<StringRef> V = tokenizeExpr(Tokens[Pos]);
 222   if (V.size() == 1)
 223     return;
 224   Tokens.erase(Tokens.begin() + Pos);
 225   Tokens.insert(Tokens.begin() + Pos, V.begin(), V.end());
 226 }
 227
 228 StringRef ScriptLexer::next() {
 229   maybeSplitExpr();
 230
 231   if (errorCount())
 232     return "";
 233   if (atEOF()) {
 234     setError("unexpected EOF");
 235     return "";
 236   }
 237   return Tokens[Pos++];
 238 }
 239
 240 StringRef ScriptLexer::peek() {
 241   StringRef Tok = next();
 242   if (errorCount())
 243     return "";
 244   Pos = Pos - 1;
 245   return Tok;
 246 }
 247
 248 bool ScriptLexer::consume(StringRef Tok) {
 249   if (peek() == Tok) {
 250     skip();
 251     return true;
 252   }
 253   return false;
 254 }
 255
 256 // Consumes Tok followed by ":". Space is allowed between Tok and ":".
 257 bool ScriptLexer::consumeLabel(StringRef Tok) {
 258   if (consume((Tok + ":").str()))
 259     return true;
 260   if (Tokens.size() >= Pos + 2 && Tokens[Pos] == Tok &&
 261       Tokens[Pos + 1] == ":") {
 262     Pos += 2;
 263     return true;
 264   }
 265   return false;
 266 }
 267
 268 void ScriptLexer::skip() { (void)next(); }
 269
 270 void ScriptLexer::expect(StringRef Expect) {
 271   if (errorCount())
 272     return;
 273   StringRef Tok = next();
 274   if (Tok != Expect)
 275     setError(Expect + " expected, but got " + Tok);
 276 }
 277
 278 // Returns true if S encloses T.
 279 static bool encloses(StringRef S, StringRef T) {
 280   return S.bytes_begin() <= T.bytes_begin() && T.bytes_end() <= S.bytes_end();
 281 }
 282
 283 MemoryBufferRef ScriptLexer::getCurrentMB() {
 284   // Find input buffer containing the current token.
 285   assert(!MBs.empty());
 286   if (!Pos)
 287     return MBs[0];
 288
 289   for (MemoryBufferRef MB : MBs)
 290     if (encloses(MB.getBuffer(), Tokens[Pos - 1]))
 291       return MB;
 292   llvm_unreachable("getCurrentMB: failed to find a token");
 293 }