LLVM 19.0.0git
DWARFAddressRange.h
Go to the documentation of this file.
1//===- DWARFAddressRange.h --------------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_DEBUGINFO_DWARF_DWARFADDRESSRANGE_H
10#define LLVM_DEBUGINFO_DWARF_DWARFADDRESSRANGE_H
11
14#include <algorithm>
15#include <cassert>
16#include <cstdint>
17#include <tuple>
18#include <vector>
19
20namespace llvm {
21
22class raw_ostream;
23class DWARFObject;
24
29
30 DWARFAddressRange() = default;
31
32 /// Used for unit testing.
37
38 /// Returns true if LowPC is smaller or equal to HighPC. This accounts for
39 /// dead-stripped ranges.
40 bool valid() const { return LowPC <= HighPC; }
41
42 /// Returns true if [LowPC, HighPC) intersects with [RHS.LowPC, RHS.HighPC).
43 bool intersects(const DWARFAddressRange &RHS) const {
44 assert(valid() && RHS.valid());
45 if (SectionIndex != RHS.SectionIndex)
46 return false;
47 // Empty ranges can't intersect.
48 if (LowPC == HighPC || RHS.LowPC == RHS.HighPC)
49 return false;
50 return LowPC < RHS.HighPC && RHS.LowPC < HighPC;
51 }
52
53 /// Union two address ranges if they intersect.
54 ///
55 /// This function will union two address ranges if they intersect by
56 /// modifying this range to be the union of both ranges. If the two ranges
57 /// don't intersect this range will be left alone.
58 ///
59 /// \param RHS Another address range to combine with.
60 ///
61 /// \returns false if the ranges don't intersect, true if they do and the
62 /// ranges were combined.
64 if (!intersects(RHS))
65 return false;
66 LowPC = std::min<uint64_t>(LowPC, RHS.LowPC);
67 HighPC = std::max<uint64_t>(HighPC, RHS.HighPC);
68 return true;
69 }
70
71 void dump(raw_ostream &OS, uint32_t AddressSize, DIDumpOptions DumpOpts = {},
72 const DWARFObject *Obj = nullptr) const;
73};
74
75inline bool operator<(const DWARFAddressRange &LHS,
76 const DWARFAddressRange &RHS) {
77 return std::tie(LHS.SectionIndex, LHS.LowPC, LHS.HighPC) < std::tie(RHS.SectionIndex, RHS.LowPC, RHS.HighPC);
78}
79
80inline bool operator==(const DWARFAddressRange &LHS,
81 const DWARFAddressRange &RHS) {
82 return std::tie(LHS.SectionIndex, LHS.LowPC, LHS.HighPC) == std::tie(RHS.SectionIndex, RHS.LowPC, RHS.HighPC);
83}
84
85raw_ostream &operator<<(raw_ostream &OS, const DWARFAddressRange &R);
86
87/// DWARFAddressRangesVector - represents a set of absolute address ranges.
88using DWARFAddressRangesVector = std::vector<DWARFAddressRange>;
89
90} // end namespace llvm
91
92#endif // LLVM_DEBUGINFO_DWARF_DWARFADDRESSRANGE_H
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
raw_pwrite_stream & OS
Value * RHS
Value * LHS
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
bool operator<(int64_t V1, const APSInt &V2)
Definition: APSInt.h:361
std::vector< DWARFAddressRange > DWARFAddressRangesVector
DWARFAddressRangesVector - represents a set of absolute address ranges.
bool operator==(const AddressRangeValuePair &LHS, const AddressRangeValuePair &RHS)
raw_ostream & operator<<(raw_ostream &OS, const APFixedPoint &FX)
Definition: APFixedPoint.h:293
Container for dump options that control which debug information will be dumped.
Definition: DIContext.h:193
bool valid() const
Returns true if LowPC is smaller or equal to HighPC.
bool intersects(const DWARFAddressRange &RHS) const
Returns true if [LowPC, HighPC) intersects with [RHS.LowPC, RHS.HighPC).
bool merge(const DWARFAddressRange &RHS)
Union two address ranges if they intersect.
DWARFAddressRange(uint64_t LowPC, uint64_t HighPC, uint64_t SectionIndex=object::SectionedAddress::UndefSection)
Used for unit testing.
void dump(raw_ostream &OS, uint32_t AddressSize, DIDumpOptions DumpOpts={}, const DWARFObject *Obj=nullptr) const
static const uint64_t UndefSection
Definition: ObjectFile.h:146