File: ClangIndexRecordWriter.cpp

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (166 lines) | stat: -rw-r--r-- 5,807 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
//===--- ClangIndexRecordWriter.cpp - Index record serialization ----------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#include "ClangIndexRecordWriter.h"
#include "FileIndexRecord.h"
#include "clang/Index/IndexSymbol.h"
#include "clang/Index/IndexRecordReader.h"
#include "clang/Index/USRGeneration.h"
#include "clang/AST/ASTContext.h"
#include "clang/AST/DeclCXX.h"
#include "clang/AST/DeclObjC.h"

using namespace clang;
using namespace clang::index;

StringRef ClangIndexRecordWriter::getUSR(const Decl *D) {
  assert(D->isCanonicalDecl());
  auto Insert = USRByDecl.insert(std::make_pair(D, StringRef()));
  if (Insert.second) {
    Insert.first->second = getUSRNonCached(D);
  }
  return Insert.first->second;
}

StringRef ClangIndexRecordWriter::getUSR(const IdentifierInfo *Name,
                                         const MacroInfo *MI) {
  assert(Name && MI);
  auto Insert = USRByDecl.insert(std::make_pair(MI, StringRef()));
  if (Insert.second) {
    Insert.first->second = getUSRNonCached(Name, MI);
  }
  return Insert.first->second;
}

StringRef ClangIndexRecordWriter::getUSRNonCached(const Decl *D) {
  SmallString<256> Buf;
  bool Ignore = generateUSRForDecl(D, Buf);
  if (Ignore)
    return StringRef();
  StringRef USR = Buf.str();
  char *Ptr = Allocator.Allocate<char>(USR.size());
  std::copy(USR.begin(), USR.end(), Ptr);
  return StringRef(Ptr, USR.size());
}

StringRef ClangIndexRecordWriter::getUSRNonCached(const IdentifierInfo *Name,
                                                  const MacroInfo *MI) {
  SmallString<256> Buf;
  bool Ignore = generateUSRForMacro(Name->getName(), MI->getDefinitionLoc(),
                                    Ctx.getSourceManager(), Buf);
  if (Ignore)
    return StringRef();
  StringRef USR = Buf.str();
  char *Ptr = Allocator.Allocate<char>(USR.size());
  std::copy(USR.begin(), USR.end(), Ptr);
  return StringRef(Ptr, USR.size());
}

ClangIndexRecordWriter::ClangIndexRecordWriter(ASTContext &Ctx,
                                               RecordingOptions Opts)
    : Impl(Opts.DataDirPath), Ctx(Ctx), RecordOpts(std::move(Opts)),
      Hasher(Ctx) {
  if (Opts.RecordSymbolCodeGenName)
    ASTNameGen.reset(new ASTNameGenerator(Ctx));
}

ClangIndexRecordWriter::~ClangIndexRecordWriter() {}

bool ClangIndexRecordWriter::writeRecord(StringRef Filename,
                                         const FileIndexRecord &IdxRecord,
                                         std::string &Error,
                                         std::string *OutRecordFile) {

  auto RecordHash = Hasher.hashRecord(IdxRecord);

  switch (Impl.beginRecord(Filename, RecordHash, Error, OutRecordFile)) {
  case IndexRecordWriter::Result::Success:
    break; // Continue writing.
  case IndexRecordWriter::Result::Failure:
    return true;
  case IndexRecordWriter::Result::AlreadyExists:
    return false;
  }

  ASTContext &Ctx = getASTContext();
  SourceManager &SM = Ctx.getSourceManager();
  FileID FID = IdxRecord.getFileID();
  auto getLineCol = [&](unsigned Offset) -> std::pair<unsigned, unsigned> {
    unsigned LineNo = SM.getLineNumber(FID, Offset);
    unsigned ColNo = SM.getColumnNumber(FID, Offset);
    return std::make_pair(LineNo, ColNo);
  };

  llvm::DenseMap<const MacroInfo *, const IdentifierInfo *> MacroNames;

  for (auto &Occur : IdxRecord.getDeclOccurrencesSortedByOffset()) {
    unsigned Line, Col;
    std::tie(Line, Col) = getLineCol(Occur.Offset);
    SmallVector<writer::SymbolRelation, 3> Related;
    Related.reserve(Occur.Relations.size());
    for (auto &Rel : Occur.Relations)
      Related.push_back(writer::SymbolRelation{Rel.RelatedSymbol, Rel.Roles});
    if (Occur.MacroName)
      MacroNames[Occur.DeclOrMacro.get<const MacroInfo *>()] = Occur.MacroName;

    Impl.addOccurrence(Occur.DeclOrMacro.getOpaqueValue(), Occur.Roles, Line,
                       Col, Related);
  }

  PrintingPolicy Policy(Ctx.getLangOpts());
  Policy.SuppressTemplateArgsInCXXConstructors = true;

  auto Result = Impl.endRecord(Error,
      [&](writer::OpaqueDecl OD, SmallVectorImpl<char> &Scratch) {
    writer::Symbol Sym;
    auto DeclOrMacro =
        llvm::PointerUnion<const Decl *, const MacroInfo *>::getFromOpaqueValue(
            const_cast<void *>(OD));
    if (auto *MI = DeclOrMacro.dyn_cast<const MacroInfo *>()) {
      auto *II = MacroNames[MI];
      assert(II);
      Sym.SymInfo = getSymbolInfoForMacro(*MI);
      Sym.Name = II->getName();
      Sym.USR = getUSR(II, MI);
      assert(!Sym.USR.empty() && "Recorded macro without USR!");
    } else {
      const Decl *D = DeclOrMacro.get<const Decl *>();
      Sym.SymInfo = getSymbolInfo(D);

      auto *ND = dyn_cast<NamedDecl>(D);
      if (ND) {
        llvm::raw_svector_ostream OS(Scratch);
        DeclarationName DeclName = ND->getDeclName();
        if (!DeclName.isEmpty())
          DeclName.print(OS, Policy);
      }
      unsigned NameLen = Scratch.size();
      Sym.Name = StringRef(Scratch.data(), NameLen);

      Sym.USR = getUSR(D);
      assert(!Sym.USR.empty() && "Recorded decl without USR!");

      if (ASTNameGen && ND) {
        llvm::raw_svector_ostream OS(Scratch);
        ASTNameGen->writeName(ND, OS);
      }
      unsigned CGNameLen = Scratch.size() - NameLen;
      Sym.CodeGenName = StringRef(Scratch.data() + NameLen, CGNameLen);
    }

    return Sym;
  });

  switch (Result) {
  case IndexRecordWriter::Result::Success:
  case IndexRecordWriter::Result::AlreadyExists:
    return false;
  case IndexRecordWriter::Result::Failure:
    return true;
  }
}