[BOLT] Fixed some typos

[GabrielRavier]

Summary

I went over the output of the following mess of a command:

(ulimit -m 2000000; ulimit -v 2000000; git ls-files -z | parallel --xargs -0 cat | aspell list --mode=none --ignore-case | grep -E '^[A-Za-z][a-z]*$' | sort | uniq -c | sort -n | grep -vE '.{25}' | aspell pipe -W3 | grep : | cut -d' ' -f2 | less)

and proceeded to spend a few days looking at it to find probable typos
and fixed a few hundred of them in all of the llvm project (note, the
ones I found are not anywhere near all of them, but it seems like a
good start).

[Amir]

@GabrielRavier: thank you for improving LLVM/BOLT codebase.

Please capitalize BOLT in the commit title and address one question inline. LGTM otherwise.

bolt/lib/Passes/RetpolineInsertion.cpp

47–57

I don't see any typos fixed here, can you please revert this hunk?

[GabrielRavier]

Well, I assumed it was supposed to be [bolt] and not [BOLT] on the basis that the previous commit wrote it as [bolt] too but I'll change it, looking at the git log does indicate that [BOLT] is the more commonly used one

bolt/lib/Passes/RetpolineInsertion.cpp

47–57

The fixed typo is "availablity" (which is spelled availability from what I can see), otherwise the formatting in general is caused by the git clang-format command that the LLVM documentation implies is required when making a patch.

[Amir]

bolt/lib/Passes/RetpolineInsertion.cpp

47–57

Sorry, you’re right.

[maksfb]

Title nit: "[BOLT] Fix typos". Thanks!

[Amir]

@GabrielRavier
Do you need help landing this diff?

[GabrielRavier]

In D130824#3826365, @Amir wrote:

@GabrielRavier
Do you need help landing this diff?

I do not have commit access, so yes.

[GabrielRavier]

(PS: I normally use Gabriel Ravier <[e-mail]> as my details on git commits)

[Amir]

In D130824#3827059, @GabrielRavier wrote:

(PS: I normally use Gabriel Ravier <[e-mail]> as my details on git commits)

Yes, that's set in the commit author field.

[Amir]

Thank you again!

bolt/include/bolt/Core/DebugData.h

public:
   }
 
   /// Returns False if .debug_addr section was created..
   bool isInitialized() const { return !AddressMaps.empty(); }
 
 protected:
   class AddressForDWOCU {
   public:
-    AddressToIndexMap::iterator find(uint64_t Adddress) {
-      return AddressToIndex.find(Adddress);
+    AddressToIndexMap::iterator find(uint64_t Address) {
+      return AddressToIndex.find(Address);
     }
     AddressToIndexMap::iterator end() { return AddressToIndex.end(); }
     AddressToIndexMap::iterator begin() { return AddressToIndex.begin(); }
 
     IndexToAddressMap::iterator indexToAdddessEnd() {
       return IndexToAddress.end();
     }
     IndexToAddressMap::iterator indexToAddressBegin() {

bolt/include/bolt/Core/MCPlusBuilder.h

   }
 
   /// Create a return instruction.
   virtual bool createReturn(MCInst &Inst) const {
     llvm_unreachable("not implemented");
     return false;
   }
 
-  /// Store \p Target absolute adddress to \p RegName
+  /// Store \p Target absolute address to \p RegName
   virtual InstructionListType materializeAddress(const MCSymbol *Target,
                                                  MCContext *Ctx,
                                                  MCPhysReg RegName,
                                                  int64_t Addend = 0) const {
     llvm_unreachable("not implemented");
     return {};
   }
 

bolt/lib/Passes/BinaryPasses.cpp

for (BinaryBasicBlock *PredBB : BB->predecessors()) {
         MIB->replaceBranchTarget(*CondBranch, CalleeSymbol, Ctx);
         Count = PredBB->getTakenBranchInfo().Count;
       }
       const uint64_t CTCTakenFreq =
           Count == BinaryBasicBlock::COUNT_NO_PROFILE ? 0 : Count;
 
       // Annotate it, so "isCall" returns true for this jcc
       MIB->setConditionalTailCall(*CondBranch);
-      // Add info abount the conditional tail call frequency, otherwise this
+      // Add info about the conditional tail call frequency, otherwise this
       // info will be lost when we delete the associated BranchInfo entry
       auto &CTCAnnotation =
           MIB->getOrCreateAnnotationAs<uint64_t>(*CondBranch, "CTCTakenCount");
       CTCAnnotation = CTCTakenFreq;
 
       // Remove the unused successor which may be eliminated later
       // if there are no other users.
       PredBB->removeSuccessor(BB);

bolt/lib/Passes/IndirectCallPromotion.cpp

dbgs() << "Jmp info: Type = " << (unsigned)Type << ", "
            << "DispExpr = " << DispExpr << ", "
            << "MemLocInstr = ";
     BC.printInstruction(dbgs(), *MemLocInstr, 0, &Function);
     dbgs() << "\n";
   });
 
   ++TotalIndexBasedCandidates;
 
-  auto ErrorOrMemAccesssProfile =
+  auto ErrorOrMemAccessProfile =
       BC.MIB->tryGetAnnotationAs<MemoryAccessProfile>(*MemLocInstr,
                                                       "MemoryAccessProfile");
-  if (!ErrorOrMemAccesssProfile) {
+  if (!ErrorOrMemAccessProfile) {
     DEBUG_VERBOSE(1, dbgs()
                          << "BOLT-INFO: ICP no memory profiling data found\n");
     return JumpTableInfoType();
   }
-  MemoryAccessProfile &MemAccessProfile = ErrorOrMemAccesssProfile.get();
+  MemoryAccessProfile &MemAccessProfile = ErrorOrMemAccessProfile.get();
 
   uint64_t ArrayStart;
   if (DispExpr) {
     ErrorOr<uint64_t> DispValueOrError =
         BC.getSymbolValue(*BC.MIB->getTargetSymbol(DispExpr));
     assert(DispValueOrError && "global symbol needs a value");
     ArrayStart = *DispValueOrError;
   } else {
DEBUG_VERBOSE(1, {
     for (MCInst *Inst : MethodFetchInsns)
       BC.printInstruction(dbgs(), *Inst, 0, &Function);
 
     if (MethodFetchInsns.back() != &Inst)
       BC.printInstruction(dbgs(), Inst, 0, &Function);
   });
 
   // Try to get value profiling data for the method load instruction.
-  auto ErrorOrMemAccesssProfile =
+  auto ErrorOrMemAccessProfile =
       BC.MIB->tryGetAnnotationAs<MemoryAccessProfile>(*MethodFetchInsns.back(),
                                                       "MemoryAccessProfile");
-  if (!ErrorOrMemAccesssProfile) {
+  if (!ErrorOrMemAccessProfile) {
     DEBUG_VERBOSE(1, dbgs()
                          << "BOLT-INFO: ICP no memory profiling data found\n");
     return MethodInfoType();
   }
-  MemoryAccessProfile &MemAccessProfile = ErrorOrMemAccesssProfile.get();
+  MemoryAccessProfile &MemAccessProfile = ErrorOrMemAccessProfile.get();
 
   // Find the vtable that each method belongs to.
   std::map<const MCSymbol *, uint64_t> MethodToVtable;
 
   for (const AddressAccess &AccessInfo : MemAccessProfile.AddressAccessInfo) {
     uint64_t Address = AccessInfo.Offset;
     if (AccessInfo.MemoryObject)
       Address += AccessInfo.MemoryObject->getAddress();

bolt/lib/Passes/ReorderData.cpp

void ReorderData::assignMemData(BinaryContext &BC) {
   uint64_t TotalCount = 0;
   for (auto &BFI : BC.getBinaryFunctions()) {
     const BinaryFunction &BF = BFI.second;
     if (!BF.hasMemoryProfile())
       continue;
 
     for (const BinaryBasicBlock &BB : BF) {
       for (const MCInst &Inst : BB) {
-        auto ErrorOrMemAccesssProfile =
+        auto ErrorOrMemAccessProfile =
             BC.MIB->tryGetAnnotationAs<MemoryAccessProfile>(
                 Inst, "MemoryAccessProfile");
-        if (!ErrorOrMemAccesssProfile)
+        if (!ErrorOrMemAccessProfile)
           continue;
 
         const MemoryAccessProfile &MemAccessProfile =
-            ErrorOrMemAccesssProfile.get();
+            ErrorOrMemAccessProfile.get();
         for (const AddressAccess &AccessInfo :
              MemAccessProfile.AddressAccessInfo) {
           if (BinaryData *BD = AccessInfo.MemoryObject) {
             BinaryDataCounts[BD->getAtomicRoot()] += AccessInfo.Count;
             Counts[BD->getSectionName()] += AccessInfo.Count;
             if (BD->getAtomicRoot()->isJumpTable())
               JumpTableCounts[BD->getSectionName()] += AccessInfo.Count;
           } else {
ReorderData::sortedByFunc(BinaryContext &BC, const BinarySection &Section,
 
   auto dataUses = [&BC](const BinaryFunction &BF, bool OnlyHot) {
     std::set<BinaryData *> Uses;
     for (const BinaryBasicBlock &BB : BF) {
       if (OnlyHot && BB.isCold())
         continue;
 
       for (const MCInst &Inst : BB) {
-        auto ErrorOrMemAccesssProfile =
+        auto ErrorOrMemAccessProfile =
             BC.MIB->tryGetAnnotationAs<MemoryAccessProfile>(
                 Inst, "MemoryAccessProfile");
-        if (!ErrorOrMemAccesssProfile)
+        if (!ErrorOrMemAccessProfile)
           continue;
 
         const MemoryAccessProfile &MemAccessProfile =
-            ErrorOrMemAccesssProfile.get();
+            ErrorOrMemAccessProfile.get();
         for (const AddressAccess &AccessInfo :
              MemAccessProfile.AddressAccessInfo) {
           if (AccessInfo.MemoryObject)
             Uses.insert(AccessInfo.MemoryObject);
         }
       }
     }
     return Uses;

bolt/lib/Passes/RetpolineInsertion.cpp

 llvm::cl::opt<bool>
 RetpolineLfence("retpoline-lfence",
   cl::desc("determine if lfence instruction should exist in the retpoline"),
   cl::init(true),
   cl::ZeroOrMore,
   cl::Hidden,
   cl::cat(BoltCategory));
 
-cl::opt<RetpolineInsertion::AvailabilityOptions>
-R11Availability("r11-availability",
-  cl::desc("determine the availablity of r11 before indirect branches"),
+cl::opt<RetpolineInsertion::AvailabilityOptions> R11Availability(
+    "r11-availability",
+    cl::desc("determine the availability of r11 before indirect branches"),
     cl::init(RetpolineInsertion::AvailabilityOptions::NEVER),
-  cl::values(
-    clEnumValN(RetpolineInsertion::AvailabilityOptions::NEVER,
+    cl::values(clEnumValN(RetpolineInsertion::AvailabilityOptions::NEVER,
                           "never", "r11 not available"),
                clEnumValN(RetpolineInsertion::AvailabilityOptions::ALWAYS,
                           "always", "r11 avaialable before calls and jumps"),
-    clEnumValN(RetpolineInsertion::AvailabilityOptions::ABI,
-      "abi", "r11 avaialable before calls but not before jumps")),
-  cl::ZeroOrMore,
-  cl::cat(BoltCategory));
+               clEnumValN(RetpolineInsertion::AvailabilityOptions::ABI, "abi",
+                          "r11 avaialable before calls but not before jumps")),
+    cl::ZeroOrMore, cl::cat(BoltCategory));
 
 } // namespace opts
 
 namespace llvm {
 namespace bolt {
 
 // Retpoline function structure:
 // BB0: call BB2

bolt/lib/RuntimeLibs/HugifyRuntimeLibrary.cpp

 } // namespace opts
 
 void HugifyRuntimeLibrary::adjustCommandLineOptions(
     const BinaryContext &BC) const {
   if (opts::HotText) {
     errs()
         << "BOLT-ERROR: -hot-text should be applied to binaries with "
            "pre-compiled manual hugify support, while -hugify will add hugify "
-           "support automatcally. These two options cannot both be present.\n";
+           "support automatically. These two options cannot both be present.\n";
     exit(1);
   }
   // After the check, we set HotText to be true because automated hugify support
   // relies on it.
   opts::HotText = true;
   if (!BC.StartFunctionAddress) {
     errs() << "BOLT-ERROR: hugify runtime libraries require a known entry "
               "point of "