[BOLT][NFC] Fix file-description comments

Summary: Fix comments at the start of source files.

(cherry picked from FBD33274597)

bolt/include/bolt/Core/BinaryBasicBlock.h

@@ -1,4 +1,4 @@
-//===--- BinaryBasicBlock.h - Interface for assembly-level basic block ----===//
+//===- bolt/Core/BinaryBasicBlock.h - Low-level basic block -----*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Sequence of MC(Plus) instructions. Call/invoke does not terminate the block.
+// Sequence of MC/MCPlus instructions. Call/invoke does not terminate the block.
+// CFI instructions are part of the instruction list with the initial CFI state
+// defined at the beginning of the block.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Core/BinaryContext.h

@@ -1,4 +1,4 @@
-//===--- BinaryContext.h  - Interface for machine-level context -----------===//
+//===- bolt/Core/BinaryContext.h - Low-level context ------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Context for processing binary executables in files and/or memory.
+// Context for processing binary executable/library files.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Core/BinaryData.h

@@ -1,4 +1,4 @@
-//===--- BinaryData.h  - Representation of section data objects -----------===//
+//===- bolt/Core/BinaryData.h - Objects in a binary file --------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,10 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains the declaration of the BinaryData class, which represents
+// an allocatable entity in a binary file, such as a data object, a jump table,
+// or a function.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_BINARY_DATA_H

bolt/include/bolt/Core/BinaryEmitter.h

@@ -1,4 +1,4 @@
-//===--- BinaryEmitter.h - collection of functions to emit code and data --===//
+//===- bolt/Core/BinaryEmitter.h - Emit code and data -----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains declarations of functions for emitting code and data into
+// a binary file.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_BINARY_EMITTER_H
@@ -20,7 +23,7 @@ namespace bolt {
 class BinaryContext;
 class BinaryFunction;
 
-/// Emit all code and data in the BinaryContext \p BC.
+/// Emit all code and data from the BinaryContext \p BC into the \p Streamer.
 ///
 /// \p OrgSecPrefix is used to modify name of emitted original sections
 /// contained in \p BC. This is done to distinguish them from sections emitted

bolt/include/bolt/Core/BinaryFunction.h

@@ -1,4 +1,4 @@
-//===--- BinaryFunction.h - Interface for machine-level function ----------===//
+//===- bolt/Core/BinaryFunction.h - Low-level function ----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,8 +6,19 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Interface to function in binary (machine) form. This is assembly-level
-// code representation with the control flow.
+// This file contains the declaration of the BinaryFunction class. It represents
+// a function at the lowest IR level. Typically, a BinaryFunction represents a
+// function object in a compiled and linked binary file. However, a
+// BinaryFunction can also be constructed manually, e.g. for injecting into a
+// binary file.
+//
+// A BinaryFunction could be in one of the several states described in
+// BinaryFunction::State. While in the disassembled state, it will contain a
+// list of instructions with their offsets. In the CFG state, it will contain a
+// list of BinaryBasicBlocks that form a control-flow graph. This state is best
+// suited for binary analysis and optimizations. However, sometimes it's
+// impossible to build the precise CFG due to the ambiguity of indirect
+// branches.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Core/BinaryLoop.h

@@ -1,4 +1,4 @@
-//===--- BinaryLoop.h - Interface for machine-level loop ------------------===//
+//===- bolt/Core/BinaryLoop.h - Loop info at low-level IR -------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Core/BinarySection.h

@@ -1,4 +1,4 @@
-//===--- BinarySection.h - Interface for object file section --------------===//
+//===- bolt/Core/BinarySection.h - Section in a binary file -----*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,10 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains the declaration of the BinarySection class, which
+// represents a section in an executable file and contains its properties,
+// flags, contents, and relocations.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_BINARY_SECTION_H

bolt/include/bolt/Core/DebugData.h

@@ -1,4 +1,4 @@
-//===-- DebugData.h - Representation and writing of debugging information. -==//
+//===- bolt/Core/DebugData.h - Debugging information handling ---*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Classes that represent and serialize DWARF-related entities.
+// This file contains declaration of classes that represent and serialize
+// DWARF-related entities.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Core/DynoStats.h

@@ -1,4 +1,4 @@
-//===--- DynoStats.h ------------------------------------------------------===//
+//===- bolt/Core/DynoStats.h - Dynamic execution stats ----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// Keep track of statistics about the trace of execution captured in BOLT
+// profile.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_DYNO_STATS_H

bolt/include/bolt/Core/Exceptions.h

@@ -1,4 +1,4 @@
-//===-- Exceptions.h - Helpers for processing C++ exceptions --------------===//
+//===- bolt/Core/Exceptions.h - Helpers for C++ exceptions ------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains declarations of classes for handling C++ exception info.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_EXCEPTIONS_H
@@ -19,7 +21,9 @@
 #include <vector>
 
 namespace llvm {
+
 class DWARFDebugFrame;
+
 namespace dwarf {
 class FDE;
 } // namespace dwarf

bolt/include/bolt/Core/JumpTable.h

@@ -1,4 +1,4 @@
-//===--- JumpTable.h - Representation of a jump table ---------------------===//
+//===- bolt/Core/JumpTable.h - Jump table at low-level IR -------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file defines the JumpTable class, which represents a jump table in a
+// binary file.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_JUMP_TABLE_H

bolt/include/bolt/Core/MCPlus.h

@@ -1,4 +1,4 @@
-//===--- MCPlus.h - helpers for MCPlus-level instructions -----------------===//
+//===- bolt/Core/MCPlus.h - Helpers for MCPlus instructions -----*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains declarations for helper functions for adding annotations
+// to MCInst objects.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_MCPLUS_H

bolt/include/bolt/Core/MCPlusBuilder.h

@@ -1,4 +1,4 @@
-//===--- MCPlusBuilder.h - main interface for MCPlus-level instructions ---===//
+//===- bolt/Core/MCPlusBuilder.h - Interface for MCPlus ---------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Create/analyze/modify instructions at MC+ level.
+// This file contains the declaration of MCPlusBuilder class, which provides
+// means to create/analyze/modify instructions at MCPlus level.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Core/ParallelUtilities.h

@@ -1,15 +1,16 @@
-//===-- ParallelUtilities.h - -----------------------------------*- C++ -*-===//
+//===- bolt/Core/ParallelUtilities.h - Parallel utilities -------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-// This class creates an interface that can be used to run parallel tasks that
-// operate on functions. Several scheduling criteria are supported using
-// SchedulingPolicy, and are defined by how the runtime cost should be
-// estimated.
-// If the NoThreads flags is passed, work will execute sequentially.
+//
+// This file contains functions for assisting parallel processing of binary
+// functions. Several scheduling criteria are supported using SchedulingPolicy,
+// and are defined by how the runtime cost should be estimated. If the NoThreads
+// flags is passed, all jobs will execute sequentially.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_PARALLEL_UTILITIES_H
@@ -49,7 +50,7 @@ enum SchedulingPolicy {
   SP_BB_QUADRATIC,   /// cost is estimated by the square of the BB count
 };
 
-/// Return the managed threadpool and initialize it if not intiliazed
+/// Return the managed thread pool and initialize it if not initiliazed.
 ThreadPool &getThreadPool();
 
 /// Perform the work on each BinaryFunction except those that are accepted

bolt/include/bolt/Core/Relocation.h

@@ -1,4 +1,4 @@
-//===--- Relocation.h  - Interface for object file relocations ------------===//
+//===- bolt/Core/Relocation.h - Object file relocations ---------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains the declaration of Relocation class, which represents a
+// relocation in an object or a binary file.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_RELOCATION_H

bolt/include/bolt/Passes/ADRRelaxationPass.h

@@ -1,4 +1,4 @@
-//===--------- Passes/ADRRelaxationPass.h ---------------------------------===//
+//===- bolt/Passes/ADRRelaxationPass.h --------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -7,6 +7,13 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file declares the ADRRelaxationPass class, which replaces AArch64
+// non-local ADR instructions with ADRP + ADD due to small offset range of ADR
+// instruction (+- 1MB) which could be easily overflowed after BOLT
+// optimizations. Such problems are usually connected with errata 843419
+// https://developer.arm.com/documentation/epm048406/2100/
+// The linker could replace ADRP instruction with ADR in some cases.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_ADRRELAXATIONPASS_H
@@ -14,13 +21,6 @@
 
 #include "bolt/Passes/BinaryPasses.h"
 
-// This pass replaces AArch64 non-local ADR instructions
-// with ADRP + ADD due to small offset range of ADR instruction
-// (+- 1MB) which could be easely overflowed after BOLT optimizations
-// Such problems are usually connected with errata 843419
-// https://developer.arm.com/documentation/epm048406/2100/
-// The linker could replace ADRP instruction with ADR in some cases.
-
 namespace llvm {
 namespace bolt {
 

bolt/include/bolt/Passes/Aligner.h

@@ -1,4 +1,4 @@
-//===--------- Passes/Aligner.h -------------------------------------------===//
+//===- bolt/Passes/Aligner.h - Pass for optimal code alignment --*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,10 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains the declaration of the Aligner class, which provides
+// alignment for code, e.g. basic block and functions, with the goal to achieve
+// the optimal performance.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_ALIGNER_H

bolt/include/bolt/Passes/AllocCombiner.h

@@ -1,12 +1,10 @@
-//===--- Passes/AllocCombiner.h -------------------------------------------===//
+//===- bolt/Passes/AllocCombiner.h ------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_FRAMEDEFRAG_H
 #define BOLT_PASSES_FRAMEDEFRAG_H

bolt/include/bolt/Passes/AsmDump.h

@@ -1,4 +1,4 @@
-//===--- AsmDump.h - Dumping of a BinaryFunction into assembly ----------===//
+//===- bolt/Passes/AsmDump.h - Dump BinaryFunction as assembly --*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/BinaryFunctionCallGraph.h

@@ -1,12 +1,10 @@
-//===--- Passes/CallGraph.h -----------------------------------------------===//
+//===- bolt/Passes/CallGraph.h ----------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_BINARY_FUNCTION_CALLGRAPH_H
 #define BOLT_PASSES_BINARY_FUNCTION_CALLGRAPH_H

bolt/include/bolt/Passes/BinaryPasses.h

@@ -1,4 +1,4 @@
-//===--- BinaryPasses.h - Binary-level analysis/optimization passes -------===//
+//===- bolt/Passes/BinaryPasses.h - Binary-level passes ---------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/CacheMetrics.h

@@ -1,4 +1,4 @@
-//===- CacheMetrics.h - Interface for instruction cache evaluation       --===//
+//===- bolt/Passes/CacheMetrics.h - Instruction cache metrics ---*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Functions to show metrics of cache lines
+// Functions to show metrics of cache lines.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Passes/CallGraph.h

@@ -1,12 +1,10 @@
-//===--- Passes/CallGraph.h -----------------------------------------------===//
+//===- bolt/Passes/CallGraph.h ----------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_CALLGRAPH_H
 #define BOLT_PASSES_CALLGRAPH_H

bolt/include/bolt/Passes/CallGraphWalker.h

@@ -1,12 +1,10 @@
-//===--- Passes/CallGraphWalker.h -----------------------------------------===//
+//===- bolt/Passes/CallGraphWalker.h ----------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_CALLGRAPHWALKER_H
 #define BOLT_PASSES_CALLGRAPHWALKER_H

bolt/include/bolt/Passes/DataflowAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/DataflowAnalysis.h ----------------------------------------===//
+//===- bolt/Passes/DataflowAnalysis.h ---------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_DATAFLOWANALYSIS_H
 #define BOLT_PASSES_DATAFLOWANALYSIS_H

bolt/include/bolt/Passes/DataflowInfoManager.h

@@ -1,12 +1,10 @@
-//===--- Passes/DataflowInfoManager.h -------------------------------------===//
+//===- bolt/Passes/DataflowInfoManager.h ------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_DATAFLOWINFOMANAGER_H
 #define BOLT_PASSES_DATAFLOWINFOMANAGER_H

bolt/include/bolt/Passes/DominatorAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/DominatorAnalysis.h ---------------------------------------===//
+//===- bolt/Passes/DominatorAnalysis.h --------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_DOMINATORANALYSIS_H
 #define BOLT_PASSES_DOMINATORANALYSIS_H

bolt/include/bolt/Passes/FrameAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/FrameAnalysis.h -------------------------------------------===//
+//===- bolt/Passes/FrameAnalysis.h ------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_FRAMEANALYSIS_H
 #define BOLT_PASSES_FRAMEANALYSIS_H

bolt/include/bolt/Passes/FrameOptimizer.h

@@ -1,12 +1,10 @@
-//===--- Passes/FrameOptimizer.h ------------------------------------------===//
+//===- bolt/Passes/FrameOptimizer.h -----------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_FRAMEOPTIMIZER_H
 #define BOLT_PASSES_FRAMEOPTIMIZER_H

bolt/include/bolt/Passes/HFSort.h

@@ -1,4 +1,4 @@
-//===--- HFSort.h - Cluster functions by hotness --------------------------===//
+//===- bolt/Passes/HFSort.h - Cluster functions by hotness ------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -15,7 +15,6 @@
 // 3. pettisAndHansen
 // 4. randomClusters
 //
-// See original code in hphp/utils/hfsort.[h,cpp]
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_HFSORT_H

bolt/include/bolt/Passes/IdenticalCodeFolding.h

@@ -1,12 +1,10 @@
-//===--- IdenticalCodeFolding.h -------------------------------------------===//
+//===- bolt/Passes/IdenticalCodeFolding.h -----------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_IDENTICAL_CODE_FOLDING_H
 #define BOLT_PASSES_IDENTICAL_CODE_FOLDING_H

bolt/include/bolt/Passes/IndirectCallPromotion.h

@@ -1,4 +1,4 @@
-//===--- BinaryPasses.h - Binary-level analysis/optimization passes -------===//
+//===- bolt/Passes/IndirectCallPromotion.h ----------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/Inliner.h

@@ -1,4 +1,4 @@
-//===--- Passes/Inliner.h - Inlining infra for BOLT -----------------------===//
+//===- bolt/Passes/Inliner.h - Inlining infra for BOLT ----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/Instrumentation.h

@@ -1,4 +1,4 @@
-//===--- Passes/Instrumentation.h -----------------------------------------===//
+//===- bolt/Passes/Instrumentation.h ----------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -13,6 +13,7 @@
 // runtime/instr.cpp
 //
 //===----------------------------------------------------------------------===//
+
 #ifndef BOLT_PASSES_INSTRUMENTATION_H
 #define BOLT_PASSES_INSTRUMENTATION_H
 

bolt/include/bolt/Passes/InstrumentationSummary.h

@@ -1,13 +1,15 @@
-//===--- InstrumentationSummary.h -------------------------------------===//
+//===- bolt/Passes/InstrumentationSummary.h ---------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
+//
 // InstrumentationSummary holds all the data generated during
 // the Instrumentation pass, which will be needed latter for runtime library
 // binary emit and linking.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_INSTRUMENTATION_SUMMARY_H

bolt/include/bolt/Passes/JTFootprintReduction.h

@@ -1,4 +1,4 @@
-//===--- JTFootprintReduction.h -------------------------------------------===//
+//===- bolt/Passes/JTFootprintReduction.h -----------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/LivenessAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/LivenessAnalysis.h ----------------------------------------===//
+//===- bolt/Passes/LivenessAnalysis.h ---------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_LIVENESSANALYSIS_H
 #define BOLT_PASSES_LIVENESSANALYSIS_H

bolt/include/bolt/Passes/LongJmp.h

@@ -1,12 +1,10 @@
-//===--- Passes/LongJmp.h -------------------------------------------------===//
+//===- bolt/Passes/LongJmp.h ------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_LONGJMP_H
 #define BOLT_PASSES_LONGJMP_H

bolt/include/bolt/Passes/LoopInversionPass.h

@@ -1,12 +1,10 @@
-//===--------- Passes/LoopInversionPass.h ---------------------------------===//
+//===- bolt/Passes/LoopInversionPass.h --------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_LOOPINVERSION_H
 #define BOLT_PASSES_LOOPINVERSION_H

bolt/include/bolt/Passes/MCF.h

@@ -1,12 +1,10 @@
-//===--- Passes/MCF.h -----------------------------------------------------===//
+//===- bolt/Passes/MCF.h ----------------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_MCF_H
 #define BOLT_PASSES_MCF_H

bolt/include/bolt/Passes/PLTCall.h

@@ -1,12 +1,10 @@
-//===--- Passes/PLTCall.h - PLT call optimization -------------------------===//
+//===- bolt/Passes/PLTCall.h - PLT call optimization ------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_PLTCALL_H
 #define BOLT_PASSES_PLTCALL_H

bolt/include/bolt/Passes/PatchEntries.h

@@ -1,4 +1,4 @@
-//===--- PatchEntries.h - pass for patching function entries --------------===//
+//===- bolt/Passes/PatchEntries.h - Patch function entries ------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/ReachingDefOrUse.h

@@ -1,12 +1,10 @@
-//===--- Passes/ReachingDefOrUse.h ----------------------------------------===//
+//===- bolt/Passes/ReachingDefOrUse.h ---------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REACHINGDEFORUSE_H
 #define BOLT_PASSES_REACHINGDEFORUSE_H

bolt/include/bolt/Passes/ReachingInsns.h

@@ -1,12 +1,10 @@
-//===--- Passes/ReachingInsns.h -------------------------------------------===//
+//===- bolt/Passes/ReachingInsns.h ------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REACHINGINSNS_H
 #define BOLT_PASSES_REACHINGINSNS_H

bolt/include/bolt/Passes/RegAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/RegAnalysis.h ---------------------------------------------===//
+//===- bolt/Passes/RegAnalysis.h --------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REGANALYSIS_H
 #define BOLT_PASSES_REGANALYSIS_H

bolt/include/bolt/Passes/RegReAssign.h

@@ -1,13 +1,11 @@
-//===--- Passes/RegReAssign.h
-//----------------------------------------------===//
+//===- bolt/Passes/RegReAssign.h --------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
+
 #ifndef BOLT_PASSES_REGREASSIGN_H
 #define BOLT_PASSES_REGREASSIGN_H
 

bolt/include/bolt/Passes/ReorderAlgorithm.h

@@ -1,4 +1,4 @@
-// Passes/ReorderAlgorithm.h - Interface for basic block reorderng algorithms //
+//===- bolt/Passes/ReorderAlgorithm.h - Basic block reorderng ---*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Passes/ReorderData.h

@@ -1,12 +1,10 @@
-//===--- ReorderSection.h - Profile based reordering of section data =========//
+//===- bolt/Passes/ReorderSection.h - Reorder section data ------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REORDER_DATA_H
 #define BOLT_PASSES_REORDER_DATA_H

bolt/include/bolt/Passes/ReorderFunctions.h

@@ -1,12 +1,10 @@
-//===--- ReorderFunctions.h - Function reordering pass --------------------===//
+//===- bolt/Passes/ReorderFunctions.h - Reorder functions -------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REORDER_FUNCTIONS_H
 #define BOLT_PASSES_REORDER_FUNCTIONS_H

bolt/include/bolt/Passes/ReorderUtils.h

@@ -1,4 +1,4 @@
-// Passes/ReorderUtils.h - Helper methods for function and block reordering   //
+//===- bolt/Passes/ReorderUtils.h -------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file contains classes and functions to assist function and basic block
+// reordering.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_REORDER_UTILS_H

bolt/include/bolt/Passes/RetpolineInsertion.h

@@ -1,12 +1,10 @@
-//===--- Passes/RetpolineInsertion.h --------------------------------------===//
+//===- bolt/Passes/RetpolineInsertion.h -------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_RETPOLINE_INSERTION_H
 #define BOLT_PASSES_RETPOLINE_INSERTION_H

bolt/include/bolt/Passes/ShrinkWrapping.h

@@ -1,12 +1,10 @@
-//===--- Passes/ShrinkWrapping.h ------------------------------------------===//
+//===- bolt/Passes/ShrinkWrapping.h -----------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_SHRINKWRAPPING_H
 #define BOLT_PASSES_SHRINKWRAPPING_H

bolt/include/bolt/Passes/SplitFunctions.h

@@ -1,12 +1,10 @@
-//===--- SplitFunctions.h - pass for splitting function code --------------===//
+//===- bolt/Passes/SplitFunctions.h - Split function code -------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_SPLIT_FUNCTIONS_H
 #define BOLT_PASSES_SPLIT_FUNCTIONS_H

bolt/include/bolt/Passes/StackAllocationAnalysis.h

@@ -1,12 +1,10 @@
-//===--- Passes/StackAllocationAnalysis.h ---------------------------------===//
+//===- bolt/Passes/StackAllocationAnalysis.h --------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_STACKALLOCATIONANALYSIS_H
 #define BOLT_PASSES_STACKALLOCATIONANALYSIS_H

bolt/include/bolt/Passes/StackAvailableExpressions.h

@@ -1,12 +1,10 @@
-//===--- Passes/StackAvailableExpressions.h -------------------------------===//
+//===- bolt/Passes/StackAvailableExpressions.h ------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_STACKAVAILABLEEXPRESSIONS_H
 #define BOLT_PASSES_STACKAVAILABLEEXPRESSIONS_H

bolt/include/bolt/Passes/StackPointerTracking.h

@@ -1,12 +1,10 @@
-//===--- Passes/StackPointerTracking.h ------------------------------------===//
+//===- bolt/Passes/StackPointerTracking.h -----------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_STACKPOINTERTRACKING_H
 #define BOLT_PASSES_STACKPOINTERTRACKING_H

bolt/include/bolt/Passes/StackReachingUses.h

@@ -1,12 +1,10 @@
-//===--- Passes/StackReachingUses.h ---------------------------------------===//
+//===- bolt/Passes/StackReachingUses.h --------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_STACKREACHINGUSES_H
 #define BOLT_PASSES_STACKREACHINGUSES_H

bolt/include/bolt/Passes/StokeInfo.h

@@ -1,10 +1,11 @@
-//===--- Passes/StokeInfo.h -------------------------------------------===//
+//===- bolt/Passes/StokeInfo.h ----------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
+//
 //  Pass to get information for functions for the Stoke Optimization
 //  To use the Stoke optimization technique to optimize the HHVM.
 //  This Pass solves the two major problems to use the Stoke program without
@@ -20,6 +21,7 @@
 //  .csv file. Next, we use python scripts to process the file, filter
 //  out functions for optimization and automatically generate configure files.
 //  Finally, these configure files are feed to the Stoke to do the job.
+//
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_STOKEINFO_H

bolt/include/bolt/Passes/TailDuplication.h

@@ -1,4 +1,4 @@
-//===--------- Passes/TailDuplication.h ---------------------------------===//
+//===- bolt/Passes/TailDuplication.h ----------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,13 +6,6 @@
 //
 //===----------------------------------------------------------------------===//
 //
-//===----------------------------------------------------------------------===//
-
-#ifndef BOLT_PASSES_TAILDUPLICATION_H
-#define BOLT_PASSES_TAILDUPLICATION_H
-
-#include "bolt/Passes/BinaryPasses.h"
-
 // This pass founds cases when BBs have layout:
 // #BB0:
 // <body>
@@ -39,6 +32,13 @@
 // that if there is too much code duplication, we may end up evicting hot cache
 // lines and causing the opposite effect, hurting i-cache performance This needs
 // to be well balanced to achieve the optimal effect
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef BOLT_PASSES_TAILDUPLICATION_H
+#define BOLT_PASSES_TAILDUPLICATION_H
+
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/include/bolt/Passes/ThreeWayBranch.h

@@ -1,12 +1,10 @@
-//===--------- Passes/ThreeWayBranch.h ------------------------------------===//
+//===- bolt/Passes/ThreeWayBranch.h -----------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_THREEWAYBRANCH_H
 #define BOLT_PASSES_THREEWAYBRANCH_H

bolt/include/bolt/Passes/ValidateInternalCalls.h

@@ -1,12 +1,11 @@
-//===--- Passes/ValidateInternalCalls.h -----------------------------------===//
+//===- bolt/Passes/ValidateInternalCalls.h ----------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
+
 #ifndef BOLT_PASSES_VALIDATEINTERNALCALLS_H
 #define BOLT_PASSES_VALIDATEINTERNALCALLS_H
 

bolt/include/bolt/Passes/VeneerElimination.h

@@ -1,12 +1,10 @@
-//===--- Passes/VeneerElimination.h ---------------------------------------===//
+//===- bolt/Passes/VeneerElimination.h --------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PASSES_VENEER_ELIMINATION_H
 #define BOLT_PASSES_VENEER_ELIMINATION_H

bolt/include/bolt/Profile/BoltAddressTranslation.h

@@ -1,12 +1,10 @@
-//===--- BoltAddressTranslation.h -----------------------------------------===//
+//===- bolt/Profile/BoltAddressTranslation.h --------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PROFILE_BOLTADDRESSTRANSLATION_H
 #define BOLT_PROFILE_BOLTADDRESSTRANSLATION_H

bolt/include/bolt/Profile/DataAggregator.h

@@ -1,4 +1,4 @@
-//===-- DataAggregator.h - Perf data aggregator -----------------*- C++ -*-===//
+//===- bolt/Profile/DataAggregator.h - Perf data aggregator -----*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Profile/DataReader.h

@@ -1,4 +1,4 @@
-//===-- Reader/DataReader.h - Perf data reader ------------------*- C++ -*-===//
+//===- bolt/Profile/DataReader.h - Perf data reader -------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Profile/Heatmap.h

@@ -1,12 +1,10 @@
-//===-- Heatmap.h -----------------------------------------------*- C++ -*-===//
+//===- bolt/Profile/Heatmap.h -----------------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PROFILE_HEATMAP_H
 #define BOLT_PROFILE_HEATMAP_H

bolt/include/bolt/Profile/ProfileReaderBase.h

@@ -1,4 +1,4 @@
-//===-- ProfileReaderBase.h - Base class for profile readers ----*- C++ -*-===//
+//===- bolt/Profile/ProfileReaderBase.h -------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Profile/ProfileYAMLMapping.h

@@ -1,4 +1,4 @@
-//===-- ProfileYAMLMapping.h - mappings for BOLT profile --------*- C++ -*-===//
+//===- bolt/Profile/ProfileYAMLMapping.h ------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Profile/YAMLProfileReader.h

@@ -1,12 +1,10 @@
-//===-- YAMLProfileReader.h - BOLT YAML profile deserializer ----*- C++ -*-===//
+//===- bolt/Profile/YAMLProfileReader.h - YAML profile reader ---*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PROFILE_YAML_PROFILE_READER_H
 #define BOLT_PROFILE_YAML_PROFILE_READER_H

bolt/include/bolt/Profile/YAMLProfileWriter.h

@@ -1,13 +1,10 @@
-//===- YAMLProfileWriter.cpp - serialize profiling data in YAML -*- C++ -*-===//
+//===- bolt/Profile/YAMLProfileWriter.h - Write profile in YAML -*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_PROFILE_YAML_PROFILE_WRITER_H
 #define BOLT_PROFILE_YAML_PROFILE_WRITER_H

bolt/include/bolt/Rewrite/BinaryPassManager.h

@@ -1,4 +1,4 @@
-//===--- BinaryPassManager.h - Binary-level analysis/optimization passes --===//
+//===- bolt/Rewrite/BinaryPassManager.h - Binary-level passes ---*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Rewrite/DWARFRewriter.h

@@ -1,12 +1,10 @@
-//===--- DWARFRewriter.h --------------------------------------------------===//
+//===- bolt/Rewrite/DWARFRewriter.h -----------------------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_REWRITE_DWARF_REWRITER_H
 #define BOLT_REWRITE_DWARF_REWRITER_H

bolt/include/bolt/Rewrite/ExecutableFileMemoryManager.h

@@ -1,12 +1,10 @@
-//===--- ExecutableFileMemoryManager.h ------------------------------------===//
+//===- bolt/Rewrite/ExecutableFileMemoryManager.h ---------------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
-//
-//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_REWRITE_EXECUTABLE_FILE_MEMORY_MANAGER_H
 #define BOLT_REWRITE_EXECUTABLE_FILE_MEMORY_MANAGER_H

bolt/include/bolt/Rewrite/MachORewriteInstance.h

@@ -1,4 +1,4 @@
-//===--- MachORewriteInstance.h - Instance of a rewriting process. --------===//
+//===- bolt/Rewrite/MachORewriteInstance.h - MachO rewriter -----*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Rewrite/RewriteInstance.h

@@ -1,4 +1,4 @@
-//===--- RewriteInstance.h - Instance of a rewriting process. -------------===//
+//===- bolt/Rewrite/RewriteInstance.h - ELF rewriter ------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/RuntimeLibs/HugifyRuntimeLibrary.h

@@ -1,10 +1,14 @@
-//===------- HugifyRuntimeLibrary.h - The Hugify Runtime Library ----------===//
+//===- bolt/RuntimeLibs/HugifyRuntimeLibrary.h - Hugify Lib -----*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the declaration of the HugifyRuntimeLibrary class.
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_RUNTIMELIBS_HUGIFY_RUNTIME_LIBRARY_H
 #define BOLT_RUNTIMELIBS_HUGIFY_RUNTIME_LIBRARY_H

bolt/include/bolt/RuntimeLibs/InstrumentationRuntimeLibrary.h

@@ -1,10 +1,15 @@
-//===--- InstrumentationRuntimeLibrary.h - The Instrument Runtime Library -===//
+//===- bolt/RuntimeLibs/InstrumentationRuntimeLibrary.h ---------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
+//
+// This file contains the declaration of the InstrumentationRuntimeLibrary
+// class.
+//
+//===----------------------------------------------------------------------===//
 
 #ifndef BOLT_RUNTIMELIBS_INSTRUMENTATION_RUNTIME_LIBRARY_H
 #define BOLT_RUNTIMELIBS_INSTRUMENTATION_RUNTIME_LIBRARY_H

bolt/include/bolt/RuntimeLibs/RuntimeLibrary.h

@@ -1,4 +1,4 @@
-//===------------- RuntimeLibrary.h - The Runtime Library -----------------===//
+//===- bolt/RuntimeLibs/RuntimeLibrary.h - Runtime Library ------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,8 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Provides all the necessary utilities to link runtime libraries during
-// binary rewriting, such as the instrumentation runtime library.
+// This file contains the declaration of the RuntimeLibrary class, which
+// provides all the necessary utilities to link runtime libraries during binary
+// rewriting, such as the instrumentation runtime library.
 //
 //===----------------------------------------------------------------------===//
 

bolt/include/bolt/Utils/CommandLineOpts.h

@@ -1,4 +1,4 @@
-//===--- CommandLineOpts.h - BOLT CLI options -----------------------------===//
+//===- bolt/Utils/CommandLineOpts.h - BOLT CLI options ----------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -9,6 +9,7 @@
 // BOLT CLI options
 //
 //===----------------------------------------------------------------------===//
+
 #ifndef BOLT_UTILS_COMMAND_LINE_OPTS_H
 #define BOLT_UTILS_COMMAND_LINE_OPTS_H
 

bolt/include/bolt/Utils/NameResolver.h

@@ -1,4 +1,4 @@
-//===--- NameResolver.h - Helper class for names deduplication ------------===//
+//===- bolt/Utils/NameResolver.h - Names deduplication helper ---*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Utils/NameShortener.h

@@ -1,4 +1,4 @@
-//===--- NameShortener.h - Helper class for shortening names --------------===//
+//===- bolt/Utils/NameShortener.h - Name shortener --------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/include/bolt/Utils/Utils.h

@@ -1,4 +1,4 @@
-//===--- Utils.h - Common helper functions --------------------------------===//
+//===- bolt/Utils/Utils.h - Common helper functions -------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.

bolt/lib/Core/BinaryBasicBlock.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryBasicBlock.cpp - Interface for assembly-level basic block --===//
+//===- bolt/Core/BinaryBasicBlock.cpp - Low-level basic block -------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the BinaryBasicBlock class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryBasicBlock.h"

bolt/lib/Core/BinaryContext.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryContext.cpp  - Interface for machine-level context ---------===//
+//===- bolt/Core/BinaryContext.cpp - Low-level context --------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the BinaryContext class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryContext.h"

bolt/lib/Core/BinaryData.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryData.cpp - Representation of section data objects ----------===//
+//===- bolt/Core/BinaryData.cpp - Objects in a binary file ----------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the BinaryData class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryData.h"

bolt/lib/Core/BinaryEmitter.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryEmitter.cpp - collection of functions to emit code and data ===//
+//===- bolt/Core/BinaryEmitter.cpp - Emit code and data -------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the collection of functions and classes used for
+// emission of code and data into object/binary file.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryEmitter.h"

bolt/lib/Core/BinaryFunction.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryFunction.cpp - Interface for machine-level function --------===//
+//===- bolt/Core/BinaryFunction.cpp - Low-level function ------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the BinaryFunction class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryFunction.h"

bolt/lib/Core/BinaryFunctionProfile.cpp

@@ -1,4 +1,4 @@
-//===--- BinaryFunctionProfile.cpp                                 --------===//
+//===- bolt/Core/BinaryFunctionProfile.cpp - Profile processing -----------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,9 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements BinaryFunction member functions related to processing
+// the execution profile.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryBasicBlock.h"

bolt/lib/Core/BinarySection.cpp

@@ -1,4 +1,4 @@
-//===--- BinarySection.cpp  - Interface for object file section -----------===//
+//===- bolt/Core/BinarySection.cpp - Section in a binary file -------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the BinarySection class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinarySection.h"

bolt/lib/Core/DebugData.cpp

@@ -1,4 +1,4 @@
-//===- DebugData.cpp - Representation and writing of debugging information. ==//
+//===- bolt/Core/DebugData.cpp - Debugging information handling -----------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements functions and classes for handling debug info.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/DebugData.h"

bolt/lib/Core/DynoStats.cpp

@@ -1,4 +1,4 @@
-//===--- DynoStats.cpp ----------------------------------------------------===//
+//===- bolt/Core/DynoStats.cpp - Dynamic execution stats ------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the DynoStats class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/DynoStats.h"

bolt/lib/Core/Exceptions.cpp

@@ -1,4 +1,4 @@
-//===-- Exceptions.cpp - Helpers for processing C++ exceptions ------------===//
+//===- bolt/Core/Exceptions.cpp - Helpers for C++ exceptions --------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements functions for handling C++ exception meta data.
+//
 // Some of the code is taken from examples/ExceptionDemo
 //
 //===----------------------------------------------------------------------===//

bolt/lib/Core/JumpTable.cpp

@@ -1,4 +1,4 @@
-//===--- JumpTable.h - Representation of a jump table ---------------------===//
+//===- bolt/Core/JumpTable.cpp - Jump table at low-level IR ---------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the JumpTable class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/JumpTable.h"

bolt/lib/Core/MCPlusBuilder.cpp

@@ -1,4 +1,4 @@
-//===- MCPlusBuilder.cpp - main interface for MCPlus-level instructions ---===//
+//===- bolt/Core/MCPlusBuilder.cpp - Interface for MCPlus -----------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// Create/analyze/modify instructions at MC+ level.
+// This file implements the MCPlusBuilder class.
 //
 //===----------------------------------------------------------------------===//
 

bolt/lib/Core/ParallelUtilities.cpp

@@ -1,4 +1,4 @@
-//===--- ParallelUtilities.cpp --------------------------------------------===//
+//===- bolt/Core/ParallelUtilities.cpp - Parallel utilities ---------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// Implementation of the class that manages parallel work on BinaryFunctions.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/ParallelUtilities.h"

bolt/lib/Core/Relocation.cpp

@@ -1,4 +1,4 @@
-//===--- Relocation.cpp  - Interface for object file relocations ----------===//
+//===- bolt/Core/Relocation.cpp - Object file relocations -----------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the Relocation class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/Relocation.h"

bolt/lib/Passes/ADRRelaxationPass.cpp

@@ -1,4 +1,4 @@
-//===--- ADRRelaxationPass.cpp --------------------------------------------===//
+//===- bolt/Passes/ADRRelaxationPass.cpp ----------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -7,6 +7,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the ADRRelaxationPass class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Passes/ADRRelaxationPass.h"

bolt/lib/Passes/Aligner.cpp

@@ -1,4 +1,4 @@
-//===--- Aligner.cpp ------------------------------------------------------===//
+//===- bolt/Passes/Aligner.cpp - Pass for optimal code alignment ----------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the AlignerPass class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Passes/Aligner.h"

bolt/lib/Passes/AllocCombiner.cpp

@@ -1,4 +1,4 @@
-//===--- Passes/AllocCombiner.cpp -----------------------------------------===//
+//===- bolt/Passes/AllocCombiner.cpp --------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the AllocCombinerPass class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Passes/AllocCombiner.h"

bolt/lib/Passes/AsmDump.cpp

@@ -1,4 +1,4 @@
-//===--- AsmDump.cpp - Dumping of a BinaryFunction into assembly --------===//
+//===- bolt/Passes/AsmDump.cpp - Dump BinaryFunction into assembly --------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -6,6 +6,8 @@
 //
 //===----------------------------------------------------------------------===//
 //
+// This file implements the AsmDumpPass class.
+//
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Passes/AsmDump.h"