[ELF] Fix variable names in comments after VariableName -> variableName change

Also fix some typos.

llvm-svn: 366181

Author: MaskRay

lld/ELF/AArch64ErrataFix.cpp

@@ -413,8 +413,8 @@ void lld::elf::Patch843419Section::writeTo(uint8_t *buf) {
   write32le(buf, read32le(patchee->data().begin() + patcheeOffset));
 
   // Apply any relocation transferred from the original PatcheeSection.
-  // For a SyntheticSection Buf already has OutSecOff added, but relocateAlloc
-  // also adds OutSecOff so we need to subtract to avoid double counting.
+  // For a SyntheticSection Buf already has outSecOff added, but relocateAlloc
+  // also adds outSecOff so we need to subtract to avoid double counting.
   this->relocateAlloc(buf - outSecOff, buf - outSecOff + getSize());
 
   // Return address is the next instruction after the one we have just copied.
@@ -427,7 +427,7 @@ void AArch64Err843419Patcher::init() {
   // The AArch64 ABI permits data in executable sections. We must avoid scanning
   // this data as if it were instructions to avoid false matches. We use the
   // mapping symbols in the InputObjects to identify this data, caching the
-  // results in SectionMap so we don't have to recalculate it each pass.
+  // results in sectionMap so we don't have to recalculate it each pass.
 
   // The ABI Section 4.5.4 Mapping symbols; defines local symbols that describe
   // half open intervals [Symbol Value, Next Symbol Value) of code and data
@@ -489,7 +489,7 @@ void AArch64Err843419Patcher::insertPatches(
   uint64_t patchUpperBound = prevIsecLimit + target->getThunkSectionSpacing();
   uint64_t outSecAddr = isd.sections.front()->getParent()->addr;
 
-  // Set the OutSecOff of patches to the place where we want to insert them.
+  // Set the outSecOff of patches to the place where we want to insert them.
   // We use a similar strategy to Thunk placement. Place patches roughly
   // every multiple of maximum branch range.
   auto patchIt = patches.begin();
@@ -511,10 +511,10 @@ void AArch64Err843419Patcher::insertPatches(
     (*patchIt)->outSecOff = isecLimit;
   }
 
-  // merge all patch sections. We use the OutSecOff assigned above to
+  // merge all patch sections. We use the outSecOff assigned above to
   // determine the insertion point. This is ok as we only merge into an
   // InputSectionDescription once per pass, and at the end of the pass
-  // assignAddresses() will recalculate all the OutSecOff values.
+  // assignAddresses() will recalculate all the outSecOff values.
   std::vector<InputSection *> tmp;
   tmp.reserve(isd.sections.size() + patches.size());
   auto mergeCmp = [](const InputSection *a, const InputSection *b) {
@@ -530,8 +530,8 @@ void AArch64Err843419Patcher::insertPatches(
   isd.sections = std::move(tmp);
 }
 
-// Given an erratum sequence that starts at address AdrpAddr, with an
-// instruction that we need to patch at PatcheeOffset from the start of
+// Given an erratum sequence that starts at address adrpAddr, with an
+// instruction that we need to patch at patcheeOffset from the start of
 // InputSection IS, create a Patch843419 Section and add it to the
 // Patches that we need to insert.
 static void implementPatch(uint64_t adrpAddr, uint64_t patcheeOffset,
@@ -587,10 +587,10 @@ AArch64Err843419Patcher::patchInputSectionDescription(
     //  LLD doesn't use the erratum sequence in SyntheticSections.
     if (isa<SyntheticSection>(isec))
       continue;
-    // Use SectionMap to make sure we only scan code and not inline data.
+    // Use sectionMap to make sure we only scan code and not inline data.
     // We have already sorted MapSyms in ascending order and removed consecutive
     // mapping symbols of the same type. Our range of executable instructions to
-    // scan is therefore [CodeSym->Value, DataSym->Value) or [CodeSym->Value,
+    // scan is therefore [codeSym->value, dataSym->value) or [codeSym->value,
     // section size).
     std::vector<const Defined *> &mapSyms = sectionMap[isec];
 

lld/ELF/AArch64ErrataFix.h

@@ -36,7 +36,7 @@ class AArch64Err843419Patcher {
 
   void init();
 
-  // A cache of the mapping symbols defined by the InputSecion sorted in order
+  // A cache of the mapping symbols defined by the InputSection sorted in order
   // of ascending value with redundant symbols removed. These describe
   // the ranges of code and data in an executable InputSection.
   std::map<InputSection *, std::vector<const Defined *>> sectionMap;

lld/ELF/Arch/AArch64.cpp

@@ -517,7 +517,7 @@ void AArch64BtiPac::writePltHeader(uint8_t *buf) const {
   uint64_t plt = in.plt->getVA();
 
   if (btiHeader) {
-    // PltHeader is called indirectly by Plt[N]. Prefix PltData with a BTI C
+    // PltHeader is called indirectly by plt[N]. Prefix pltData with a BTI C
     // instruction.
     memcpy(buf, btiData, sizeof(btiData));
     buf += sizeof(btiData);
@@ -538,7 +538,7 @@ void AArch64BtiPac::writePlt(uint8_t *buf, uint64_t gotPltEntryAddr,
                              uint64_t pltEntryAddr, int32_t index,
                              unsigned relOff) const {
   // The PLT entry is of the form:
-  // [BtiData] AddrInst (PacBr | StdBr) [NopData]
+  // [btiData] addrInst (pacBr | stdBr) [nopData]
   const uint8_t btiData[] = { 0x5f, 0x24, 0x03, 0xd5 }; // bti c
   const uint8_t addrInst[] = {
       0x10, 0x00, 0x00, 0x90,  // adrp x16, Page(&(.plt.got[n]))

lld/ELF/Arch/ARM.cpp

@@ -299,13 +299,13 @@ bool ARM::needsThunk(RelExpr expr, RelType type, const InputFile *file,
 
 uint32_t ARM::getThunkSectionSpacing() const {
   // The placing of pre-created ThunkSections is controlled by the value
-  // ThunkSectionSpacing returned by getThunkSectionSpacing(). The aim is to
+  // thunkSectionSpacing returned by getThunkSectionSpacing(). The aim is to
   // place the ThunkSection such that all branches from the InputSections
   // prior to the ThunkSection can reach a Thunk placed at the end of the
   // ThunkSection. Graphically:
-  // | up to ThunkSectionSpacing .text input sections |
+  // | up to thunkSectionSpacing .text input sections |
   // | ThunkSection                                   |
-  // | up to ThunkSectionSpacing .text input sections |
+  // | up to thunkSectionSpacing .text input sections |
   // | ThunkSection                                   |
 
   // Pre-created ThunkSections are spaced roughly 16MiB apart on ARMv7. This
@@ -316,14 +316,14 @@ uint32_t ARM::getThunkSectionSpacing() const {
   // Thumb B<cc>.W range +/- 1MiB
   // If a branch cannot reach a pre-created ThunkSection a new one will be
   // created so we can handle the rare cases of a Thumb 2 conditional branch.
-  // We intentionally use a lower size for ThunkSectionSpacing than the maximum
+  // We intentionally use a lower size for thunkSectionSpacing than the maximum
   // branch range so the end of the ThunkSection is more likely to be within
   // range of the branch instruction that is furthest away. The value we shorten
-  // ThunkSectionSpacing by is set conservatively to allow us to create 16,384
+  // thunkSectionSpacing by is set conservatively to allow us to create 16,384
   // 12 byte Thunks at any offset in a ThunkSection without risk of a branch to
   // one of the Thunks going out of range.
 
-  // On Arm the ThunkSectionSpacing depends on the range of the Thumb Branch
+  // On Arm the thunkSectionSpacing depends on the range of the Thumb Branch
   // range. On earlier Architectures such as ARMv4, ARMv5 and ARMv6 (except
   // ARMv6T2) the range is +/- 4MiB.
 

lld/ELF/Arch/RISCV.cpp

@@ -144,7 +144,7 @@ void RISCV::writePltHeader(uint8_t *buf) const {
   // 1: auipc t2, %pcrel_hi(.got.plt)
   // sub t1, t1, t3
   // l[wd] t3, %pcrel_lo(1b)(t2); t3 = _dl_runtime_resolve
-  // addi t1, t1, -PltHeaderSize-12; t1 = &.plt[i] - &.plt[0]
+  // addi t1, t1, -pltHeaderSize-12; t1 = &.plt[i] - &.plt[0]
   // addi t0, t2, %pcrel_lo(1b)
   // srli t1, t1, (rv64?1:2); t1 = &.got.plt[i] - &.got.plt[0]
   // l[wd] t0, Wordsize(t0); t0 = link_map

lld/ELF/CallGraphSort.cpp

@@ -177,7 +177,7 @@ void CallGraphSort::groupClusters() {
   });
 
   for (int si : sortedSecs) {
-    // Clusters[SI] is the same as SecToClusters[SI] here because it has not
+    // clusters[si] is the same as secToClusters[si] here because it has not
     // been merged into another cluster yet.
     Cluster &c = clusters[si];
 
@@ -233,8 +233,8 @@ DenseMap<const InputSectionBase *, int> CallGraphSort::run() {
       return orderMap;
     }
 
-    // Print the symbols ordered by C3, in the order of increasing CurOrder
-    // Instead of sorting all the OrderMap, just repeat the loops above.
+    // Print the symbols ordered by C3, in the order of increasing curOrder
+    // Instead of sorting all the orderMap, just repeat the loops above.
     for (const Cluster &c : clusters)
       for (int secIndex : c.sections)
         // Search all the symbols in the file of the section

lld/ELF/Config.h

@@ -249,7 +249,7 @@ struct Configuration {
   // True if the target is little-endian. False if big-endian.
   bool isLE;
 
-  // endianness::little if IsLE is true. endianness::big otherwise.
+  // endianness::little if isLE is true. endianness::big otherwise.
   llvm::support::endianness endianness;
 
   // True if the target is the little-endian MIPS64.

lld/ELF/Driver.cpp

@@ -1255,15 +1255,15 @@ static uint64_t getCommonPageSize(opt::InputArgList &args) {
       warn("-z common-page-size set, but paging disabled by omagic or nmagic");
     return 1;
   }
-  // CommonPageSize can't be larger than MaxPageSize.
+  // commonPageSize can't be larger than maxPageSize.
   if (val > config->maxPageSize)
     val = config->maxPageSize;
   return val;
 }
 
 // Parses -image-base option.
 static Optional<uint64_t> getImageBase(opt::InputArgList &args) {
-  // Because we are using "Config->MaxPageSize" here, this function has to be
+  // Because we are using "Config->maxPageSize" here, this function has to be
   // called after the variable is initialized.
   auto *arg = args.getLastArg(OPT_image_base);
   if (!arg)
@@ -1406,8 +1406,8 @@ static void demoteSharedSymbols() {
   });
 }
 
-// The section referred to by S is considered address-significant. Set the
-// KeepUnique flag on the section if appropriate.
+// The section referred to by `s` is considered address-significant. Set the
+// keepUnique flag on the section if appropriate.
 static void markAddrsig(Symbol *s) {
   if (auto *d = dyn_cast_or_null<Defined>(s))
     if (d->section)
@@ -1772,7 +1772,7 @@ template <class ELFT> void LinkerDriver::link(opt::InputArgList &args) {
   if (args.hasArg(OPT_exclude_libs))
     excludeLibs(args);
 
-  // Create ElfHeader early. We need a dummy section in
+  // Create elfHeader early. We need a dummy section in
   // addReservedSymbols to mark the created symbols as not absolute.
   Out::elfHeader = make<OutputSection>("", 0, SHF_ALLOC);
   Out::elfHeader->size = sizeof(typename ELFT::Ehdr);
@@ -1854,14 +1854,14 @@ template <class ELFT> void LinkerDriver::link(opt::InputArgList &args) {
   target = getTarget();
 
   config->eflags = target->calcEFlags();
-  // MaxPageSize (sometimes called abi page size) is the maximum page size that
+  // maxPageSize (sometimes called abi page size) is the maximum page size that
   // the output can be run on. For example if the OS can use 4k or 64k page
-  // sizes then MaxPageSize must be 64 for the output to be useable on both.
+  // sizes then maxPageSize must be 64k for the output to be useable on both.
   // All important alignment decisions must use this value.
   config->maxPageSize = getMaxPageSize(args);
-  // CommonPageSize is the most common page size that the output will be run on.
+  // commonPageSize is the most common page size that the output will be run on.
   // For example if an OS can use 4k or 64k page sizes and 4k is more common
-  // than 64k then CommonPageSize is set to 4k. CommonPageSize can be used for
+  // than 64k then commonPageSize is set to 4k. commonPageSize can be used for
   // optimizations such as DATA_SEGMENT_ALIGN in linker scripts. LLD's use of it
   // is limited to writing trap instructions on the last executable segment.
   config->commonPageSize = getCommonPageSize(args);

lld/ELF/InputFiles.cpp

@@ -229,7 +229,7 @@ static std::string getSrcMsgAux(ObjFile<ELFT> &file, const Symbol &sym,
           file.getVariableLoc(sym.getName()))
     return createFileLineMsg(fileLine->first, fileLine->second);
 
-  // File.SourceFile contains STT_FILE symbol, and that is a last resort.
+  // File.sourceFile contains STT_FILE symbol, and that is a last resort.
   return file.sourceFile;
 }
 
@@ -269,7 +269,7 @@ template <class ELFT> void ObjFile<ELFT>::initializeDwarf() {
       continue;
     lineTables.push_back(lt);
 
-    // Loop over variable records and insert them to VariableLoc.
+    // Loop over variable records and insert them to variableLoc.
     for (const auto &entry : cu->dies()) {
       DWARFDie die(cu.get(), &entry);
       // Skip all tags that are not variables.
@@ -290,7 +290,7 @@ template <class ELFT> void ObjFile<ELFT>::initializeDwarf() {
       // Get the line number on which the variable is declared.
       unsigned line = dwarf::toUnsigned(die.find(dwarf::DW_AT_decl_line), 0);
 
-      // Here we want to take the variable name to add it into VariableLoc.
+      // Here we want to take the variable name to add it into variableLoc.
       // Variable can have regular and linkage name associated. At first, we try
       // to get linkage name as it can be different, for example when we have
       // two variables in different namespaces of the same object. Use common
@@ -450,7 +450,7 @@ template <class ELFT> ArrayRef<Symbol *> ObjFile<ELFT>::getGlobalSymbols() {
 }
 
 template <class ELFT> void ObjFile<ELFT>::parse(bool ignoreComdats) {
-  // Read a section table. JustSymbols is usually false.
+  // Read a section table. justSymbols is usually false.
   if (this->justSymbols)
     initializeJustSymbols();
   else
@@ -1178,7 +1178,7 @@ static std::vector<const void *> parseVerdefs(const uint8_t *base,
   // We cannot determine the largest verdef identifier without inspecting
   // every Elf_Verdef, but both bfd and gold assign verdef identifiers
   // sequentially starting from 1, so we predict that the largest identifier
-  // will be VerdefCount.
+  // will be verdefCount.
   unsigned verdefCount = sec->sh_info;
   std::vector<const void *> verdefs(verdefCount + 1);
 
@@ -1262,7 +1262,7 @@ template <class ELFT> void SharedFile::parse() {
     return;
   }
 
-  // Search for a DT_SONAME tag to initialize this->SoName.
+  // Search for a DT_SONAME tag to initialize this->soName.
   for (const Elf_Dyn &dyn : dynamicTags) {
     if (dyn.d_tag == DT_NEEDED) {
       uint64_t val = dyn.getVal();

lld/ELF/InputFiles.h

@@ -117,7 +117,7 @@ class InputFile {
   // True if this is an argument for --just-symbols. Usually false.
   bool justSymbols = false;
 
-  // OutSecOff of .got2 in the current file. This is used by PPC32 -fPIC/-fPIE
+  // outSecOff of .got2 in the current file. This is used by PPC32 -fPIC/-fPIE
   // to compute offsets in PLT call stubs.
   uint32_t ppc32Got2OutSecOff = 0;
 
@@ -132,7 +132,7 @@ class InputFile {
   // [.got, .got + 0xFFFC].
   bool ppc64SmallCodeModelTocRelocs = false;
 
-  // GroupId is used for --warn-backrefs which is an optional error
+  // groupId is used for --warn-backrefs which is an optional error
   // checking feature. All files within the same --{start,end}-group or
   // --{start,end}-lib get the same group ID. Otherwise, each file gets a new
   // group ID. For more info, see checkDependency() in SymbolTable.cpp.

lld/ELF/InputSection.cpp

@@ -206,9 +206,9 @@ OutputSection *SectionBase::getOutputSection() {
   return sec ? sec->getParent() : nullptr;
 }
 
-// When a section is compressed, `RawData` consists with a header followed
+// When a section is compressed, `rawData` consists with a header followed
 // by zlib-compressed data. This function parses a header to initialize
-// `UncompressedSize` member and remove the header from `RawData`.
+// `uncompressedSize` member and remove the header from `rawData`.
 void InputSectionBase::parseCompressedHeader() {
   using Chdr64 = typename ELF64LE::Chdr;
   using Chdr32 = typename ELF32LE::Chdr;
@@ -306,7 +306,7 @@ std::string InputSectionBase::getLocation(uint64_t offset) {
     return info->FileName + ":" + std::to_string(info->Line) + ":(" +
            secAndOffset + ")";
 
-  // File->SourceFile contains STT_FILE symbol that contains a
+  // File->sourceFile contains STT_FILE symbol that contains a
   // source file name. If it's missing, we use an object file name.
   std::string srcFile = getFile<ELFT>()->sourceFile;
   if (srcFile.empty())

lld/ELF/InputSection.h

@@ -219,8 +219,8 @@ class InputSectionBase : public SectionBase {
 
   mutable ArrayRef<uint8_t> rawData;
 
-  // This field stores the uncompressed size of the compressed data in RawData,
-  // or -1 if RawData is not compressed (either because the section wasn't
+  // This field stores the uncompressed size of the compressed data in rawData,
+  // or -1 if rawData is not compressed (either because the section wasn't
   // compressed in the first place, or because we ended up uncompressing it).
   // Since the feature is not used often, this is usually -1.
   mutable int64_t uncompressedSize = -1;

lld/ELF/LTO.cpp

@@ -124,11 +124,11 @@ static lto::Config createConfig() {
 }
 
 BitcodeCompiler::BitcodeCompiler() {
-  // Initialize IndexFile.
+  // Initialize indexFile.
   if (!config->thinLTOIndexOnlyArg.empty())
     indexFile = openFile(config->thinLTOIndexOnlyArg);
 
-  // Initialize LTOObj.
+  // Initialize ltoObj.
   lto::ThinBackend backend;
   if (config->thinLTOIndexOnly) {
     auto onIndexWrite = [&](StringRef s) { thinIndices.erase(s); };
@@ -142,7 +142,7 @@ BitcodeCompiler::BitcodeCompiler() {
   ltoObj = llvm::make_unique<lto::LTO>(createConfig(), backend,
                                        config->ltoPartitions);
 
-  // Initialize UsedStartStop.
+  // Initialize usedStartStop.
   symtab->forEachSymbol([&](Symbol *sym) {
     StringRef s = sym->getName();
     for (StringRef prefix : {"__start_", "__stop_"})

lld/ELF/LinkerScript.cpp

@@ -115,7 +115,7 @@ void LinkerScript::expandMemoryRegions(uint64_t size) {
   if (ctx->memRegion)
     expandMemoryRegion(ctx->memRegion, size, ctx->memRegion->name,
                        ctx->outSec->name);
-  // Only expand the LMARegion if it is different from MemRegion.
+  // Only expand the LMARegion if it is different from memRegion.
   if (ctx->lmaRegion && ctx->memRegion != ctx->lmaRegion)
     expandMemoryRegion(ctx->lmaRegion, size, ctx->lmaRegion->name,
                        ctx->outSec->name);
@@ -1035,8 +1035,8 @@ static uint64_t getInitialDot() {
     return config->imageBase ? *config->imageBase : 0;
 
   uint64_t startAddr = UINT64_MAX;
-  // The Sections with -T<section> have been sorted in order of ascending
-  // address. We must lower StartAddr if the lowest -T<section address> as
+  // The sections with -T<section> have been sorted in order of ascending
+  // address. We must lower startAddr if the lowest -T<section address> as
   // calls to setDot() must be monotonically increasing.
   for (auto &kv : config->sectionStartMap)
     startAddr = std::min(startAddr, kv.second);