Coverage Report

Created: 2020-09-22 08:39

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/AST/CharUnits.h
Line
Count
Source (jump to first uncovered line)
1
//===--- CharUnits.h - Character units for sizes and offsets ----*- 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
//  This file defines the CharUnits class
10
//
11
//===----------------------------------------------------------------------===//
12
13
#ifndef LLVM_CLANG_AST_CHARUNITS_H
14
#define LLVM_CLANG_AST_CHARUNITS_H
15
16
#include "llvm/ADT/DenseMapInfo.h"
17
#include "llvm/Support/Alignment.h"
18
#include "llvm/Support/DataTypes.h"
19
#include "llvm/Support/MathExtras.h"
20
21
namespace clang {
22
23
  /// CharUnits - This is an opaque type for sizes expressed in character units.
24
  /// Instances of this type represent a quantity as a multiple of the size
25
  /// of the standard C type, char, on the target architecture. As an opaque
26
  /// type, CharUnits protects you from accidentally combining operations on
27
  /// quantities in bit units and character units.
28
  ///
29
  /// In both C and C++, an object of type 'char', 'signed char', or 'unsigned
30
  /// char' occupies exactly one byte, so 'character unit' and 'byte' refer to
31
  /// the same quantity of storage. However, we use the term 'character unit'
32
  /// rather than 'byte' to avoid an implication that a character unit is
33
  /// exactly 8 bits.
34
  ///
35
  /// For portability, never assume that a target character is 8 bits wide. Use
36
  /// CharUnit values wherever you calculate sizes, offsets, or alignments
37
  /// in character units.
38
  class CharUnits {
39
    public:
40
      typedef int64_t QuantityType;
41
42
    private:
43
      QuantityType Quantity = 0;
44
45
37.1M
      explicit CharUnits(QuantityType C) : Quantity(C) {}
46
47
    public:
48
49
      /// CharUnits - A default constructor.
50
25.9M
      CharUnits() = default;
51
52
      /// Zero - Construct a CharUnits quantity of zero.
53
1.59M
      static CharUnits Zero() {
54
1.59M
        return CharUnits(0);
55
1.59M
      }
56
57
      /// One - Construct a CharUnits quantity of one.
58
2.32M
      static CharUnits One() {
59
2.32M
        return CharUnits(1);
60
2.32M
      }
61
62
      /// fromQuantity - Construct a CharUnits quantity from a raw integer type.
63
27.4M
      static CharUnits fromQuantity(QuantityType Quantity) {
64
27.4M
        return CharUnits(Quantity);
65
27.4M
      }
66
67
      // Compound assignment.
68
210k
      CharUnits& operator+= (const CharUnits &Other) {
69
210k
        Quantity += Other.Quantity;
70
210k
        return *this;
71
210k
      }
72
1.48k
      CharUnits& operator++ () {
73
1.48k
        ++Quantity;
74
1.48k
        return *this;
75
1.48k
      }
76
297
      CharUnits operator++ (int) {
77
297
        return CharUnits(Quantity++);
78
297
      }
79
1.29k
      CharUnits& operator-= (const CharUnits &Other) {
80
1.29k
        Quantity -= Other.Quantity;
81
1.29k
        return *this;
82
1.29k
      }
83
0
      CharUnits& operator-- () {
84
0
        --Quantity;
85
0
        return *this;
86
0
      }
87
0
      CharUnits operator-- (int) {
88
0
        return CharUnits(Quantity--);
89
0
      }
90
91
      // Comparison operators.
92
3.61M
      bool operator== (const CharUnits &Other) const {
93
3.61M
        return Quantity == Other.Quantity;
94
3.61M
      }
95
370k
      bool operator!= (const CharUnits &Other) const {
96
370k
        return Quantity != Other.Quantity;
97
370k
      }
98
99
      // Relational operators.
100
5.84M
      bool operator<  (const CharUnits &Other) const {
101
5.84M
        return Quantity <  Other.Quantity;
102
5.84M
      }
103
1.05M
      bool operator<= (const CharUnits &Other) const {
104
1.05M
        return Quantity <= Other.Quantity;
105
1.05M
      }
106
3.81M
      bool operator>  (const CharUnits &Other) const {
107
3.81M
        return Quantity >  Other.Quantity;
108
3.81M
      }
109
901k
      bool operator>= (const CharUnits &Other) const {
110
901k
        return Quantity >= Other.Quantity;
111
901k
      }
112
113
      // Other predicates.
114
115
      /// isZero - Test whether the quantity equals zero.
116
21.1M
      bool isZero() const     { return Quantity == 0; }
117
118
      /// isOne - Test whether the quantity equals one.
119
2.44k
      bool isOne() const      { return Quantity == 1; }
120
121
      /// isPositive - Test whether the quantity is greater than zero.
122
5.71k
      bool isPositive() const { return Quantity  > 0; }
123
124
      /// isNegative - Test whether the quantity is less than zero.
125
82.1k
      bool isNegative() const { return Quantity  < 0; }
126
127
      /// isPowerOfTwo - Test whether the quantity is a power of two.
128
      /// Zero is not a power of two.
129
844
      bool isPowerOfTwo() const {
130
844
        return (Quantity & -Quantity) == Quantity;
131
844
      }
132
133
      /// Test whether this is a multiple of the other value.
134
      ///
135
      /// Among other things, this promises that
136
      /// self.alignTo(N) will just return self.
137
25.1k
      bool isMultipleOf(CharUnits N) const {
138
25.1k
        return (*this % N) == 0;
139
25.1k
      }
140
141
      // Arithmetic operators.
142
118k
      CharUnits operator* (QuantityType N) const {
143
118k
        return CharUnits(Quantity * N);
144
118k
      }
145
4.34k
      CharUnits &operator*= (QuantityType N) {
146
4.34k
        Quantity *= N;
147
4.34k
        return *this;
148
4.34k
      }
149
238
      CharUnits operator/ (QuantityType N) const {
150
238
        return CharUnits(Quantity / N);
151
238
      }
152
60
      CharUnits &operator/= (QuantityType N) {
153
60
        Quantity /= N;
154
60
        return *this;
155
60
      }
156
793
      QuantityType operator/ (const CharUnits &Other) const {
157
793
        return Quantity / Other.Quantity;
158
793
      }
159
151
      CharUnits operator% (QuantityType N) const {
160
151
        return CharUnits(Quantity % N);
161
151
      }
162
464k
      QuantityType operator% (const CharUnits &Other) const {
163
464k
        return Quantity % Other.Quantity;
164
464k
      }
165
3.38M
      CharUnits operator+ (const CharUnits &Other) const {
166
3.38M
        return CharUnits(Quantity + Other.Quantity);
167
3.38M
      }
168
44.6k
      CharUnits operator- (const CharUnits &Other) const {
169
44.6k
        return CharUnits(Quantity - Other.Quantity);
170
44.6k
      }
171
9.19k
      CharUnits operator- () const {
172
9.19k
        return CharUnits(-Quantity);
173
9.19k
      }
174
175
176
      // Conversions.
177
178
      /// getQuantity - Get the raw integer representation of this quantity.
179
22.8M
      QuantityType getQuantity() const { return Quantity; }
180
181
      /// getAsAlign - Returns Quantity as a valid llvm::Align,
182
      /// Beware llvm::Align assumes power of two 8-bit bytes.
183
3.67M
      llvm::Align getAsAlign() const { return llvm::Align(Quantity); }
184
185
      /// alignTo - Returns the next integer (mod 2**64) that is
186
      /// greater than or equal to this quantity and is a multiple of \p Align.
187
      /// Align must be non-zero.
188
1.89M
      CharUnits alignTo(const CharUnits &Align) const {
189
1.89M
        return CharUnits(llvm::alignTo(Quantity, Align.Quantity));
190
1.89M
      }
191
192
      /// Given that this is a non-zero alignment value, what is the
193
      /// alignment at the given offset?
194
345k
      CharUnits alignmentAtOffset(CharUnits offset) const {
195
345k
        assert(Quantity != 0 && "offsetting from unknown alignment?");
196
345k
        return CharUnits(llvm::MinAlign(Quantity, offset.Quantity));
197
345k
      }
198
199
      /// Given that this is the alignment of the first element of an
200
      /// array, return the minimum alignment of any element in the array.
201
36.1k
      CharUnits alignmentOfArrayElement(CharUnits elementSize) const {
202
        // Since we don't track offsetted alignments, the alignment of
203
        // the second element (or any odd element) will be minimally
204
        // aligned.
205
36.1k
        return alignmentAtOffset(elementSize);
206
36.1k
      }
207
208
209
  }; // class CharUnit
210
} // namespace clang
211
212
inline clang::CharUnits operator* (clang::CharUnits::QuantityType Scale,
213
110k
                                   const clang::CharUnits &CU) {
214
110k
  return CU * Scale;
215
110k
}
216
217
namespace llvm {
218
219
template<> struct DenseMapInfo<clang::CharUnits> {
220
302k
  static clang::CharUnits getEmptyKey() {
221
302k
    clang::CharUnits::QuantityType Quantity =
222
302k
      DenseMapInfo<clang::CharUnits::QuantityType>::getEmptyKey();
223
224
302k
    return clang::CharUnits::fromQuantity(Quantity);
225
302k
  }
226
227
212k
  static clang::CharUnits getTombstoneKey() {
228
212k
    clang::CharUnits::QuantityType Quantity =
229
212k
      DenseMapInfo<clang::CharUnits::QuantityType>::getTombstoneKey();
230
231
212k
    return clang::CharUnits::fromQuantity(Quantity);
232
212k
  }
233
234
203k
  static unsigned getHashValue(const clang::CharUnits &CU) {
235
203k
    clang::CharUnits::QuantityType Quantity = CU.getQuantity();
236
203k
    return DenseMapInfo<clang::CharUnits::QuantityType>::getHashValue(Quantity);
237
203k
  }
238
239
  static bool isEqual(const clang::CharUnits &LHS,
240
2.52M
                      const clang::CharUnits &RHS) {
241
2.52M
    return LHS == RHS;
242
2.52M
  }
243
};
244
245
} // end namespace llvm
246
247
#endif // LLVM_CLANG_AST_CHARUNITS_H