mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-24 11:42:57 +01:00
98e0298cb2
This patch fixes PR41523 https://bugs.llvm.org/show_bug.cgi?id=41523 Regions can now nest/overlap provided that they have different names. Anonymous regions cannot overlap. Region end markers must specify the region name. The only exception is for when there is only one user-defined region; in that particular case, the region end marker doesn't need to specify a name. Incorrect region end markers are no longer ignored. Instead, the tool reports an error and we exit with an error code. Added test cases to verify the new diagnostic error messages. Updated the llvm-mca docs to reflect this feature change. Differential Revision: https://reviews.llvm.org/D61676 llvm-svn: 360351
129 lines
4.0 KiB
C++
129 lines
4.0 KiB
C++
//===-------------------------- CodeRegion.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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
/// \file
|
|
///
|
|
/// This file implements class CodeRegion and CodeRegions.
|
|
///
|
|
/// A CodeRegion describes a region of assembly code guarded by special LLVM-MCA
|
|
/// comment directives.
|
|
///
|
|
/// # LLVM-MCA-BEGIN foo
|
|
/// ... ## asm
|
|
/// # LLVM-MCA-END
|
|
///
|
|
/// A comment starting with substring LLVM-MCA-BEGIN marks the beginning of a
|
|
/// new region of code.
|
|
/// A comment starting with substring LLVM-MCA-END marks the end of the
|
|
/// last-seen region of code.
|
|
///
|
|
/// Code regions are not allowed to overlap. Each region can have a optional
|
|
/// description; internally, regions are described by a range of source
|
|
/// locations (SMLoc objects).
|
|
///
|
|
/// An instruction (a MCInst) is added to a region R only if its location is in
|
|
/// range [R.RangeStart, R.RangeEnd].
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_TOOLS_LLVM_MCA_CODEREGION_H
|
|
#define LLVM_TOOLS_LLVM_MCA_CODEREGION_H
|
|
|
|
#include "llvm/ADT/ArrayRef.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/MC/MCInst.h"
|
|
#include "llvm/Support/SMLoc.h"
|
|
#include "llvm/Support/SourceMgr.h"
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
namespace mca {
|
|
|
|
/// A region of assembly code.
|
|
///
|
|
/// It identifies a sequence of machine instructions.
|
|
class CodeRegion {
|
|
// An optional descriptor for this region.
|
|
llvm::StringRef Description;
|
|
// Instructions that form this region.
|
|
llvm::SmallVector<llvm::MCInst, 8> Instructions;
|
|
// Source location range.
|
|
llvm::SMLoc RangeStart;
|
|
llvm::SMLoc RangeEnd;
|
|
|
|
CodeRegion(const CodeRegion &) = delete;
|
|
CodeRegion &operator=(const CodeRegion &) = delete;
|
|
|
|
public:
|
|
CodeRegion(llvm::StringRef Desc, llvm::SMLoc Start)
|
|
: Description(Desc), RangeStart(Start), RangeEnd() {}
|
|
|
|
void addInstruction(const llvm::MCInst &Instruction) {
|
|
Instructions.emplace_back(Instruction);
|
|
}
|
|
|
|
llvm::SMLoc startLoc() const { return RangeStart; }
|
|
llvm::SMLoc endLoc() const { return RangeEnd; }
|
|
|
|
void setEndLocation(llvm::SMLoc End) { RangeEnd = End; }
|
|
bool empty() const { return Instructions.empty(); }
|
|
bool isLocInRange(llvm::SMLoc Loc) const;
|
|
|
|
llvm::ArrayRef<llvm::MCInst> getInstructions() const { return Instructions; }
|
|
|
|
llvm::StringRef getDescription() const { return Description; }
|
|
};
|
|
|
|
class CodeRegionParseError final : public Error {};
|
|
|
|
class CodeRegions {
|
|
// A source manager. Used by the tool to generate meaningful warnings.
|
|
llvm::SourceMgr &SM;
|
|
|
|
using UniqueCodeRegion = std::unique_ptr<CodeRegion>;
|
|
std::vector<UniqueCodeRegion> Regions;
|
|
llvm::StringMap<unsigned> ActiveRegions;
|
|
bool FoundErrors;
|
|
|
|
CodeRegions(const CodeRegions &) = delete;
|
|
CodeRegions &operator=(const CodeRegions &) = delete;
|
|
|
|
public:
|
|
CodeRegions(llvm::SourceMgr &S);
|
|
|
|
typedef std::vector<UniqueCodeRegion>::iterator iterator;
|
|
typedef std::vector<UniqueCodeRegion>::const_iterator const_iterator;
|
|
|
|
iterator begin() { return Regions.begin(); }
|
|
iterator end() { return Regions.end(); }
|
|
const_iterator begin() const { return Regions.cbegin(); }
|
|
const_iterator end() const { return Regions.cend(); }
|
|
|
|
void beginRegion(llvm::StringRef Description, llvm::SMLoc Loc);
|
|
void endRegion(llvm::StringRef Description, llvm::SMLoc Loc);
|
|
void addInstruction(const llvm::MCInst &Instruction);
|
|
llvm::SourceMgr &getSourceMgr() const { return SM; }
|
|
|
|
llvm::ArrayRef<llvm::MCInst> getInstructionSequence(unsigned Idx) const {
|
|
return Regions[Idx]->getInstructions();
|
|
}
|
|
|
|
bool empty() const {
|
|
return llvm::all_of(Regions, [](const UniqueCodeRegion &Region) {
|
|
return Region->empty();
|
|
});
|
|
}
|
|
|
|
bool isValid() const { return !FoundErrors; }
|
|
};
|
|
|
|
} // namespace mca
|
|
} // namespace llvm
|
|
|
|
#endif
|