blob: 5a067d17b3f4c5b7023fc6d5eccdbf0baa02fa74 [file] [log] [blame]
mistergc2e75482017-09-19 16:54:40 -04001//
2// Copyright 2017 The Abseil Authors.
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
nik727338b70432019-03-08 10:27:53 -05008// https://www.apache.org/licenses/LICENSE-2.0
mistergc2e75482017-09-19 16:54:40 -04009//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16// -----------------------------------------------------------------------------
17// File: int128.h
18// -----------------------------------------------------------------------------
19//
Abseil Team2103fd92019-11-18 11:02:26 -080020// This header file defines 128-bit integer types, `uint128` and `int128`.
Abseil Team8e088c52021-08-10 08:52:44 -070021//
22// TODO(absl-team): This module is inconsistent as many inline `uint128` methods
23// are defined in this file, while many inline `int128` methods are defined in
24// the `int128_*_intrinsic.inc` files.
mistergc2e75482017-09-19 16:54:40 -040025
26#ifndef ABSL_NUMERIC_INT128_H_
27#define ABSL_NUMERIC_INT128_H_
28
29#include <cassert>
30#include <cmath>
31#include <cstdint>
32#include <cstring>
33#include <iosfwd>
34#include <limits>
Tsige Solomon34eb7672023-06-21 08:52:53 -070035#include <string>
Abseil Team2c5af552018-07-18 11:29:01 -070036#include <utility>
mistergc2e75482017-09-19 16:54:40 -040037
38#include "absl/base/config.h"
39#include "absl/base/macros.h"
40#include "absl/base/port.h"
Benjamin Barenblat192e9592024-04-18 10:36:51 -070041#include "absl/types/compare.h"
mistergc2e75482017-09-19 16:54:40 -040042
Abseil Team389ec3f2018-12-13 10:30:03 -080043#if defined(_MSC_VER)
44// In very old versions of MSVC and when the /Zc:wchar_t flag is off, wchar_t is
45// a typedef for unsigned short. Otherwise wchar_t is mapped to the __wchar_t
46// builtin type. We need to make sure not to define operator wchar_t()
47// alongside operator unsigned short() in these instances.
48#define ABSL_INTERNAL_WCHAR_T __wchar_t
Ben Niu4c015db2022-03-18 13:10:10 -070049#if defined(_M_X64) && !defined(_M_ARM64EC)
Abseil Team7b46e1d2018-11-13 13:22:00 -080050#include <intrin.h>
51#pragma intrinsic(_umul128)
Tom Tanaca04732019-01-02 17:55:33 -080052#endif // defined(_M_X64)
Abseil Team389ec3f2018-12-13 10:30:03 -080053#else // defined(_MSC_VER)
54#define ABSL_INTERNAL_WCHAR_T wchar_t
55#endif // defined(_MSC_VER)
Abseil Team7b46e1d2018-11-13 13:22:00 -080056
mistergc2e75482017-09-19 16:54:40 -040057namespace absl {
Abseil Team12bc53e2019-12-12 10:36:03 -080058ABSL_NAMESPACE_BEGIN
mistergc2e75482017-09-19 16:54:40 -040059
Abseil Team2103fd92019-11-18 11:02:26 -080060class int128;
61
mistergc2e75482017-09-19 16:54:40 -040062// uint128
63//
64// An unsigned 128-bit integer type. The API is meant to mimic an intrinsic type
65// as closely as is practical, including exhibiting undefined behavior in
66// analogous cases (e.g. division by zero). This type is intended to be a
67// drop-in replacement once C++ supports an intrinsic `uint128_t` type; when
Abseil Team0d40cb72018-02-22 08:36:39 -080068// that occurs, existing well-behaved uses of `uint128` will continue to work
69// using that new type.
mistergc2e75482017-09-19 16:54:40 -040070//
Abseil Team8d8dcb02017-09-29 08:44:28 -070071// Note: code written with this type will continue to compile once `uint128_t`
mistergc2e75482017-09-19 16:54:40 -040072// is introduced, provided the replacement helper functions
73// `Uint128(Low|High)64()` and `MakeUint128()` are made.
74//
75// A `uint128` supports the following:
76//
77// * Implicit construction from integral types
78// * Explicit conversion to integral types
79//
80// Additionally, if your compiler supports `__int128`, `uint128` is
81// interoperable with that type. (Abseil checks for this compatibility through
82// the `ABSL_HAVE_INTRINSIC_INT128` macro.)
83//
84// However, a `uint128` differs from intrinsic integral types in the following
85// ways:
86//
Abseil Team25274b32018-01-09 08:46:23 -080087// * Errors on implicit conversions that do not preserve value (such as
mistergc2e75482017-09-19 16:54:40 -040088// loss of precision when converting to float values).
89// * Requires explicit construction from and conversion to floating point
90// types.
91// * Conversion to integral types requires an explicit static_cast() to
92// mimic use of the `-Wnarrowing` compiler flag.
Abseil Team0d40cb72018-02-22 08:36:39 -080093// * The alignment requirement of `uint128` may differ from that of an
94// intrinsic 128-bit integer type depending on platform and build
95// configuration.
mistergc2e75482017-09-19 16:54:40 -040096//
97// Example:
98//
Abseil Teambe40fdf2018-01-12 07:45:05 -080099// float y = absl::Uint128Max(); // Error. uint128 cannot be implicitly
100// // converted to float.
mistergc2e75482017-09-19 16:54:40 -0400101//
Abseil Team6a88b402017-11-20 13:53:50 -0800102// absl::uint128 v;
Abseil Team475d64f2018-04-09 10:01:14 -0700103// uint64_t i = v; // Error
104// uint64_t i = static_cast<uint64_t>(v); // OK
mistergc2e75482017-09-19 16:54:40 -0400105//
Abseil Team0d40cb72018-02-22 08:36:39 -0800106class
107#if defined(ABSL_HAVE_INTRINSIC_INT128)
108 alignas(unsigned __int128)
109#endif // ABSL_HAVE_INTRINSIC_INT128
110 uint128 {
mistergc2e75482017-09-19 16:54:40 -0400111 public:
112 uint128() = default;
113
114 // Constructors from arithmetic types
115 constexpr uint128(int v); // NOLINT(runtime/explicit)
116 constexpr uint128(unsigned int v); // NOLINT(runtime/explicit)
117 constexpr uint128(long v); // NOLINT(runtime/int)
118 constexpr uint128(unsigned long v); // NOLINT(runtime/int)
119 constexpr uint128(long long v); // NOLINT(runtime/int)
120 constexpr uint128(unsigned long long v); // NOLINT(runtime/int)
121#ifdef ABSL_HAVE_INTRINSIC_INT128
122 constexpr uint128(__int128 v); // NOLINT(runtime/explicit)
123 constexpr uint128(unsigned __int128 v); // NOLINT(runtime/explicit)
Patrick Xia65109ec2023-04-27 09:23:15 -0700124#endif // ABSL_HAVE_INTRINSIC_INT128
125 constexpr uint128(int128 v); // NOLINT(runtime/explicit)
Abseil Team075cf622017-11-06 12:54:54 -0800126 explicit uint128(float v);
127 explicit uint128(double v);
128 explicit uint128(long double v);
mistergc2e75482017-09-19 16:54:40 -0400129
130 // Assignment operators from arithmetic types
131 uint128& operator=(int v);
132 uint128& operator=(unsigned int v);
133 uint128& operator=(long v); // NOLINT(runtime/int)
134 uint128& operator=(unsigned long v); // NOLINT(runtime/int)
135 uint128& operator=(long long v); // NOLINT(runtime/int)
136 uint128& operator=(unsigned long long v); // NOLINT(runtime/int)
137#ifdef ABSL_HAVE_INTRINSIC_INT128
138 uint128& operator=(__int128 v);
139 uint128& operator=(unsigned __int128 v);
140#endif // ABSL_HAVE_INTRINSIC_INT128
Abseil Team2103fd92019-11-18 11:02:26 -0800141 uint128& operator=(int128 v);
mistergc2e75482017-09-19 16:54:40 -0400142
143 // Conversion operators to other arithmetic types
144 constexpr explicit operator bool() const;
145 constexpr explicit operator char() const;
146 constexpr explicit operator signed char() const;
147 constexpr explicit operator unsigned char() const;
148 constexpr explicit operator char16_t() const;
149 constexpr explicit operator char32_t() const;
Abseil Team389ec3f2018-12-13 10:30:03 -0800150 constexpr explicit operator ABSL_INTERNAL_WCHAR_T() const;
mistergc2e75482017-09-19 16:54:40 -0400151 constexpr explicit operator short() const; // NOLINT(runtime/int)
152 // NOLINTNEXTLINE(runtime/int)
153 constexpr explicit operator unsigned short() const;
154 constexpr explicit operator int() const;
155 constexpr explicit operator unsigned int() const;
156 constexpr explicit operator long() const; // NOLINT(runtime/int)
157 // NOLINTNEXTLINE(runtime/int)
158 constexpr explicit operator unsigned long() const;
159 // NOLINTNEXTLINE(runtime/int)
160 constexpr explicit operator long long() const;
161 // NOLINTNEXTLINE(runtime/int)
162 constexpr explicit operator unsigned long long() const;
163#ifdef ABSL_HAVE_INTRINSIC_INT128
164 constexpr explicit operator __int128() const;
165 constexpr explicit operator unsigned __int128() const;
166#endif // ABSL_HAVE_INTRINSIC_INT128
167 explicit operator float() const;
168 explicit operator double() const;
169 explicit operator long double() const;
170
171 // Trivial copy constructor, assignment operator and destructor.
172
173 // Arithmetic operators.
Abseil Team1b8dacc2017-12-05 10:58:48 -0800174 uint128& operator+=(uint128 other);
175 uint128& operator-=(uint128 other);
176 uint128& operator*=(uint128 other);
mistergc2e75482017-09-19 16:54:40 -0400177 // Long division/modulo for uint128.
Abseil Team1b8dacc2017-12-05 10:58:48 -0800178 uint128& operator/=(uint128 other);
179 uint128& operator%=(uint128 other);
mistergc2e75482017-09-19 16:54:40 -0400180 uint128 operator++(int);
181 uint128 operator--(int);
182 uint128& operator<<=(int);
183 uint128& operator>>=(int);
Abseil Team1b8dacc2017-12-05 10:58:48 -0800184 uint128& operator&=(uint128 other);
185 uint128& operator|=(uint128 other);
186 uint128& operator^=(uint128 other);
mistergc2e75482017-09-19 16:54:40 -0400187 uint128& operator++();
188 uint128& operator--();
189
190 // Uint128Low64()
191 //
192 // Returns the lower 64-bit value of a `uint128` value.
Abseil Team1b8dacc2017-12-05 10:58:48 -0800193 friend constexpr uint64_t Uint128Low64(uint128 v);
mistergc2e75482017-09-19 16:54:40 -0400194
195 // Uint128High64()
196 //
197 // Returns the higher 64-bit value of a `uint128` value.
Abseil Team1b8dacc2017-12-05 10:58:48 -0800198 friend constexpr uint64_t Uint128High64(uint128 v);
mistergc2e75482017-09-19 16:54:40 -0400199
200 // MakeUInt128()
201 //
202 // Constructs a `uint128` numeric value from two 64-bit unsigned integers.
203 // Note that this factory function is the only way to construct a `uint128`
204 // from integer values greater than 2^64.
205 //
206 // Example:
207 //
208 // absl::uint128 big = absl::MakeUint128(1, 0);
Abseil Team25274b32018-01-09 08:46:23 -0800209 friend constexpr uint128 MakeUint128(uint64_t high, uint64_t low);
mistergc2e75482017-09-19 16:54:40 -0400210
Abseil Teambe40fdf2018-01-12 07:45:05 -0800211 // Uint128Max()
212 //
213 // Returns the highest value for a 128-bit unsigned integer.
214 friend constexpr uint128 Uint128Max();
215
Abseil Teamf21d1872018-10-02 12:09:18 -0700216 // Support for absl::Hash.
217 template <typename H>
218 friend H AbslHashValue(H h, uint128 v) {
219 return H::combine(std::move(h), Uint128High64(v), Uint128Low64(v));
220 }
221
Tsige Solomon34eb7672023-06-21 08:52:53 -0700222 // Support for absl::StrCat() etc.
223 template <typename Sink>
224 friend void AbslStringify(Sink& sink, uint128 v) {
225 sink.Append(v.ToString());
226 }
227
mistergc2e75482017-09-19 16:54:40 -0400228 private:
Abseil Team25274b32018-01-09 08:46:23 -0800229 constexpr uint128(uint64_t high, uint64_t low);
mistergc2e75482017-09-19 16:54:40 -0400230
Tsige Solomon34eb7672023-06-21 08:52:53 -0700231 std::string ToString() const;
232
mistergc2e75482017-09-19 16:54:40 -0400233 // TODO(strel) Update implementation to use __int128 once all users of
234 // uint128 are fixed to not depend on alignof(uint128) == 8. Also add
235 // alignas(16) to class definition to keep alignment consistent across
236 // platforms.
237#if defined(ABSL_IS_LITTLE_ENDIAN)
238 uint64_t lo_;
239 uint64_t hi_;
240#elif defined(ABSL_IS_BIG_ENDIAN)
241 uint64_t hi_;
242 uint64_t lo_;
243#else // byte order
244#error "Unsupported byte order: must be little-endian or big-endian."
245#endif // byte order
246};
247
mistergc2e75482017-09-19 16:54:40 -0400248// allow uint128 to be logged
Abseil Team0fa86ca2018-02-02 10:36:07 -0800249std::ostream& operator<<(std::ostream& os, uint128 v);
mistergc2e75482017-09-19 16:54:40 -0400250
Abseil Team1b8dacc2017-12-05 10:58:48 -0800251// TODO(strel) add operator>>(std::istream&, uint128)
mistergc2e75482017-09-19 16:54:40 -0400252
Abseil Team87a4c072018-06-25 09:18:19 -0700253constexpr uint128 Uint128Max() {
Abseil Teama4c3fff2018-10-29 15:53:34 -0700254 return uint128((std::numeric_limits<uint64_t>::max)(),
255 (std::numeric_limits<uint64_t>::max)());
Abseil Team87a4c072018-06-25 09:18:19 -0700256}
257
Abseil Team12bc53e2019-12-12 10:36:03 -0800258ABSL_NAMESPACE_END
Abseil Team87a4c072018-06-25 09:18:19 -0700259} // namespace absl
260
261// Specialized numeric_limits for uint128.
262namespace std {
263template <>
264class numeric_limits<absl::uint128> {
265 public:
266 static constexpr bool is_specialized = true;
267 static constexpr bool is_signed = false;
268 static constexpr bool is_integer = true;
269 static constexpr bool is_exact = true;
270 static constexpr bool has_infinity = false;
271 static constexpr bool has_quiet_NaN = false;
272 static constexpr bool has_signaling_NaN = false;
Pavel P09083762024-04-18 13:00:54 -0700273 ABSL_INTERNAL_DISABLE_DEPRECATED_DECLARATION_WARNING
Abseil Team87a4c072018-06-25 09:18:19 -0700274 static constexpr float_denorm_style has_denorm = denorm_absent;
Pavel P09083762024-04-18 13:00:54 -0700275 ABSL_INTERNAL_RESTORE_DEPRECATED_DECLARATION_WARNING
Abseil Team87a4c072018-06-25 09:18:19 -0700276 static constexpr bool has_denorm_loss = false;
277 static constexpr float_round_style round_style = round_toward_zero;
278 static constexpr bool is_iec559 = false;
279 static constexpr bool is_bounded = true;
280 static constexpr bool is_modulo = true;
281 static constexpr int digits = 128;
282 static constexpr int digits10 = 38;
283 static constexpr int max_digits10 = 0;
284 static constexpr int radix = 2;
285 static constexpr int min_exponent = 0;
286 static constexpr int min_exponent10 = 0;
287 static constexpr int max_exponent = 0;
288 static constexpr int max_exponent10 = 0;
289#ifdef ABSL_HAVE_INTRINSIC_INT128
290 static constexpr bool traps = numeric_limits<unsigned __int128>::traps;
291#else // ABSL_HAVE_INTRINSIC_INT128
292 static constexpr bool traps = numeric_limits<uint64_t>::traps;
293#endif // ABSL_HAVE_INTRINSIC_INT128
294 static constexpr bool tinyness_before = false;
295
Patrick Xia65109ec2023-04-27 09:23:15 -0700296 static constexpr absl::uint128(min)() { return 0; }
Abseil Team87a4c072018-06-25 09:18:19 -0700297 static constexpr absl::uint128 lowest() { return 0; }
Patrick Xia65109ec2023-04-27 09:23:15 -0700298 static constexpr absl::uint128(max)() { return absl::Uint128Max(); }
Abseil Team87a4c072018-06-25 09:18:19 -0700299 static constexpr absl::uint128 epsilon() { return 0; }
300 static constexpr absl::uint128 round_error() { return 0; }
301 static constexpr absl::uint128 infinity() { return 0; }
302 static constexpr absl::uint128 quiet_NaN() { return 0; }
303 static constexpr absl::uint128 signaling_NaN() { return 0; }
304 static constexpr absl::uint128 denorm_min() { return 0; }
305};
306} // namespace std
307
Abseil Team2103fd92019-11-18 11:02:26 -0800308namespace absl {
Abseil Team12bc53e2019-12-12 10:36:03 -0800309ABSL_NAMESPACE_BEGIN
Abseil Team2103fd92019-11-18 11:02:26 -0800310
311// int128
312//
313// A signed 128-bit integer type. The API is meant to mimic an intrinsic
314// integral type as closely as is practical, including exhibiting undefined
315// behavior in analogous cases (e.g. division by zero).
316//
317// An `int128` supports the following:
318//
319// * Implicit construction from integral types
320// * Explicit conversion to integral types
321//
322// However, an `int128` differs from intrinsic integral types in the following
323// ways:
324//
325// * It is not implicitly convertible to other integral types.
326// * Requires explicit construction from and conversion to floating point
327// types.
328
329// Additionally, if your compiler supports `__int128`, `int128` is
330// interoperable with that type. (Abseil checks for this compatibility through
331// the `ABSL_HAVE_INTRINSIC_INT128` macro.)
332//
333// The design goal for `int128` is that it will be compatible with a future
334// `int128_t`, if that type becomes a part of the standard.
335//
336// Example:
337//
338// float y = absl::int128(17); // Error. int128 cannot be implicitly
339// // converted to float.
340//
341// absl::int128 v;
342// int64_t i = v; // Error
343// int64_t i = static_cast<int64_t>(v); // OK
344//
345class int128 {
346 public:
347 int128() = default;
348
349 // Constructors from arithmetic types
350 constexpr int128(int v); // NOLINT(runtime/explicit)
351 constexpr int128(unsigned int v); // NOLINT(runtime/explicit)
352 constexpr int128(long v); // NOLINT(runtime/int)
353 constexpr int128(unsigned long v); // NOLINT(runtime/int)
354 constexpr int128(long long v); // NOLINT(runtime/int)
355 constexpr int128(unsigned long long v); // NOLINT(runtime/int)
356#ifdef ABSL_HAVE_INTRINSIC_INT128
357 constexpr int128(__int128 v); // NOLINT(runtime/explicit)
358 constexpr explicit int128(unsigned __int128 v);
359#endif // ABSL_HAVE_INTRINSIC_INT128
360 constexpr explicit int128(uint128 v);
361 explicit int128(float v);
362 explicit int128(double v);
363 explicit int128(long double v);
364
365 // Assignment operators from arithmetic types
366 int128& operator=(int v);
367 int128& operator=(unsigned int v);
368 int128& operator=(long v); // NOLINT(runtime/int)
369 int128& operator=(unsigned long v); // NOLINT(runtime/int)
370 int128& operator=(long long v); // NOLINT(runtime/int)
371 int128& operator=(unsigned long long v); // NOLINT(runtime/int)
372#ifdef ABSL_HAVE_INTRINSIC_INT128
373 int128& operator=(__int128 v);
374#endif // ABSL_HAVE_INTRINSIC_INT128
375
376 // Conversion operators to other arithmetic types
377 constexpr explicit operator bool() const;
378 constexpr explicit operator char() const;
379 constexpr explicit operator signed char() const;
380 constexpr explicit operator unsigned char() const;
381 constexpr explicit operator char16_t() const;
382 constexpr explicit operator char32_t() const;
383 constexpr explicit operator ABSL_INTERNAL_WCHAR_T() const;
384 constexpr explicit operator short() const; // NOLINT(runtime/int)
385 // NOLINTNEXTLINE(runtime/int)
386 constexpr explicit operator unsigned short() const;
387 constexpr explicit operator int() const;
388 constexpr explicit operator unsigned int() const;
389 constexpr explicit operator long() const; // NOLINT(runtime/int)
390 // NOLINTNEXTLINE(runtime/int)
391 constexpr explicit operator unsigned long() const;
392 // NOLINTNEXTLINE(runtime/int)
393 constexpr explicit operator long long() const;
394 // NOLINTNEXTLINE(runtime/int)
395 constexpr explicit operator unsigned long long() const;
396#ifdef ABSL_HAVE_INTRINSIC_INT128
397 constexpr explicit operator __int128() const;
398 constexpr explicit operator unsigned __int128() const;
399#endif // ABSL_HAVE_INTRINSIC_INT128
400 explicit operator float() const;
401 explicit operator double() const;
402 explicit operator long double() const;
403
404 // Trivial copy constructor, assignment operator and destructor.
405
406 // Arithmetic operators
407 int128& operator+=(int128 other);
408 int128& operator-=(int128 other);
409 int128& operator*=(int128 other);
410 int128& operator/=(int128 other);
411 int128& operator%=(int128 other);
412 int128 operator++(int); // postfix increment: i++
413 int128 operator--(int); // postfix decrement: i--
414 int128& operator++(); // prefix increment: ++i
415 int128& operator--(); // prefix decrement: --i
416 int128& operator&=(int128 other);
417 int128& operator|=(int128 other);
418 int128& operator^=(int128 other);
419 int128& operator<<=(int amount);
420 int128& operator>>=(int amount);
421
422 // Int128Low64()
423 //
424 // Returns the lower 64-bit value of a `int128` value.
425 friend constexpr uint64_t Int128Low64(int128 v);
426
427 // Int128High64()
428 //
429 // Returns the higher 64-bit value of a `int128` value.
430 friend constexpr int64_t Int128High64(int128 v);
431
432 // MakeInt128()
433 //
434 // Constructs a `int128` numeric value from two 64-bit integers. Note that
435 // signedness is conveyed in the upper `high` value.
436 //
437 // (absl::int128(1) << 64) * high + low
438 //
439 // Note that this factory function is the only way to construct a `int128`
440 // from integer values greater than 2^64 or less than -2^64.
441 //
442 // Example:
443 //
444 // absl::int128 big = absl::MakeInt128(1, 0);
445 // absl::int128 big_n = absl::MakeInt128(-1, 0);
446 friend constexpr int128 MakeInt128(int64_t high, uint64_t low);
447
448 // Int128Max()
449 //
450 // Returns the maximum value for a 128-bit signed integer.
451 friend constexpr int128 Int128Max();
452
453 // Int128Min()
454 //
455 // Returns the minimum value for a 128-bit signed integer.
456 friend constexpr int128 Int128Min();
457
458 // Support for absl::Hash.
459 template <typename H>
460 friend H AbslHashValue(H h, int128 v) {
461 return H::combine(std::move(h), Int128High64(v), Int128Low64(v));
462 }
463
Tsige Solomon34eb7672023-06-21 08:52:53 -0700464 // Support for absl::StrCat() etc.
465 template <typename Sink>
466 friend void AbslStringify(Sink& sink, int128 v) {
467 sink.Append(v.ToString());
468 }
469
Abseil Team2103fd92019-11-18 11:02:26 -0800470 private:
471 constexpr int128(int64_t high, uint64_t low);
472
Tsige Solomon34eb7672023-06-21 08:52:53 -0700473 std::string ToString() const;
474
Abseil Team2103fd92019-11-18 11:02:26 -0800475#if defined(ABSL_HAVE_INTRINSIC_INT128)
476 __int128 v_;
477#else // ABSL_HAVE_INTRINSIC_INT128
478#if defined(ABSL_IS_LITTLE_ENDIAN)
479 uint64_t lo_;
480 int64_t hi_;
481#elif defined(ABSL_IS_BIG_ENDIAN)
482 int64_t hi_;
483 uint64_t lo_;
484#else // byte order
485#error "Unsupported byte order: must be little-endian or big-endian."
486#endif // byte order
487#endif // ABSL_HAVE_INTRINSIC_INT128
488};
489
490std::ostream& operator<<(std::ostream& os, int128 v);
491
492// TODO(absl-team) add operator>>(std::istream&, int128)
493
494constexpr int128 Int128Max() {
495 return int128((std::numeric_limits<int64_t>::max)(),
496 (std::numeric_limits<uint64_t>::max)());
497}
498
499constexpr int128 Int128Min() {
500 return int128((std::numeric_limits<int64_t>::min)(), 0);
501}
502
Abseil Team12bc53e2019-12-12 10:36:03 -0800503ABSL_NAMESPACE_END
Abseil Team2103fd92019-11-18 11:02:26 -0800504} // namespace absl
505
506// Specialized numeric_limits for int128.
507namespace std {
508template <>
509class numeric_limits<absl::int128> {
510 public:
511 static constexpr bool is_specialized = true;
512 static constexpr bool is_signed = true;
513 static constexpr bool is_integer = true;
514 static constexpr bool is_exact = true;
515 static constexpr bool has_infinity = false;
516 static constexpr bool has_quiet_NaN = false;
517 static constexpr bool has_signaling_NaN = false;
Pavel P09083762024-04-18 13:00:54 -0700518 ABSL_INTERNAL_DISABLE_DEPRECATED_DECLARATION_WARNING
Abseil Team2103fd92019-11-18 11:02:26 -0800519 static constexpr float_denorm_style has_denorm = denorm_absent;
Pavel P09083762024-04-18 13:00:54 -0700520 ABSL_INTERNAL_RESTORE_DEPRECATED_DECLARATION_WARNING
Abseil Team2103fd92019-11-18 11:02:26 -0800521 static constexpr bool has_denorm_loss = false;
522 static constexpr float_round_style round_style = round_toward_zero;
523 static constexpr bool is_iec559 = false;
524 static constexpr bool is_bounded = true;
525 static constexpr bool is_modulo = false;
526 static constexpr int digits = 127;
527 static constexpr int digits10 = 38;
528 static constexpr int max_digits10 = 0;
529 static constexpr int radix = 2;
530 static constexpr int min_exponent = 0;
531 static constexpr int min_exponent10 = 0;
532 static constexpr int max_exponent = 0;
533 static constexpr int max_exponent10 = 0;
534#ifdef ABSL_HAVE_INTRINSIC_INT128
535 static constexpr bool traps = numeric_limits<__int128>::traps;
536#else // ABSL_HAVE_INTRINSIC_INT128
537 static constexpr bool traps = numeric_limits<uint64_t>::traps;
538#endif // ABSL_HAVE_INTRINSIC_INT128
539 static constexpr bool tinyness_before = false;
540
Patrick Xia65109ec2023-04-27 09:23:15 -0700541 static constexpr absl::int128(min)() { return absl::Int128Min(); }
Abseil Team2103fd92019-11-18 11:02:26 -0800542 static constexpr absl::int128 lowest() { return absl::Int128Min(); }
Patrick Xia65109ec2023-04-27 09:23:15 -0700543 static constexpr absl::int128(max)() { return absl::Int128Max(); }
Abseil Team2103fd92019-11-18 11:02:26 -0800544 static constexpr absl::int128 epsilon() { return 0; }
545 static constexpr absl::int128 round_error() { return 0; }
546 static constexpr absl::int128 infinity() { return 0; }
547 static constexpr absl::int128 quiet_NaN() { return 0; }
548 static constexpr absl::int128 signaling_NaN() { return 0; }
549 static constexpr absl::int128 denorm_min() { return 0; }
550};
551} // namespace std
mistergc2e75482017-09-19 16:54:40 -0400552
553// --------------------------------------------------------------------------
554// Implementation details follow
555// --------------------------------------------------------------------------
Abseil Team87a4c072018-06-25 09:18:19 -0700556namespace absl {
Abseil Team12bc53e2019-12-12 10:36:03 -0800557ABSL_NAMESPACE_BEGIN
mistergc2e75482017-09-19 16:54:40 -0400558
Abseil Team25274b32018-01-09 08:46:23 -0800559constexpr uint128 MakeUint128(uint64_t high, uint64_t low) {
560 return uint128(high, low);
mistergc2e75482017-09-19 16:54:40 -0400561}
562
563// Assignment from integer types.
564
Abseil Team075cf622017-11-06 12:54:54 -0800565inline uint128& uint128::operator=(int v) { return *this = uint128(v); }
mistergc2e75482017-09-19 16:54:40 -0400566
567inline uint128& uint128::operator=(unsigned int v) {
568 return *this = uint128(v);
569}
570
571inline uint128& uint128::operator=(long v) { // NOLINT(runtime/int)
572 return *this = uint128(v);
573}
574
575// NOLINTNEXTLINE(runtime/int)
576inline uint128& uint128::operator=(unsigned long v) {
577 return *this = uint128(v);
578}
579
580// NOLINTNEXTLINE(runtime/int)
Patrick Xia65109ec2023-04-27 09:23:15 -0700581inline uint128& uint128::operator=(long long v) { return *this = uint128(v); }
mistergc2e75482017-09-19 16:54:40 -0400582
583// NOLINTNEXTLINE(runtime/int)
584inline uint128& uint128::operator=(unsigned long long v) {
585 return *this = uint128(v);
586}
587
588#ifdef ABSL_HAVE_INTRINSIC_INT128
Patrick Xia65109ec2023-04-27 09:23:15 -0700589inline uint128& uint128::operator=(__int128 v) { return *this = uint128(v); }
mistergc2e75482017-09-19 16:54:40 -0400590
591inline uint128& uint128::operator=(unsigned __int128 v) {
592 return *this = uint128(v);
593}
594#endif // ABSL_HAVE_INTRINSIC_INT128
595
Patrick Xia65109ec2023-04-27 09:23:15 -0700596inline uint128& uint128::operator=(int128 v) { return *this = uint128(v); }
Abseil Team2103fd92019-11-18 11:02:26 -0800597
Abseil Team39171202018-02-06 06:42:19 -0800598// Arithmetic operators.
mistergc2e75482017-09-19 16:54:40 -0400599
Abseil Teama05366d2021-08-19 13:34:28 -0700600constexpr uint128 operator<<(uint128 lhs, int amount);
601constexpr uint128 operator>>(uint128 lhs, int amount);
602constexpr uint128 operator+(uint128 lhs, uint128 rhs);
603constexpr uint128 operator-(uint128 lhs, uint128 rhs);
Abseil Team39171202018-02-06 06:42:19 -0800604uint128 operator*(uint128 lhs, uint128 rhs);
605uint128 operator/(uint128 lhs, uint128 rhs);
606uint128 operator%(uint128 lhs, uint128 rhs);
mistergc2e75482017-09-19 16:54:40 -0400607
Abseil Team39171202018-02-06 06:42:19 -0800608inline uint128& uint128::operator<<=(int amount) {
609 *this = *this << amount;
610 return *this;
611}
mistergc2e75482017-09-19 16:54:40 -0400612
Abseil Team39171202018-02-06 06:42:19 -0800613inline uint128& uint128::operator>>=(int amount) {
614 *this = *this >> amount;
615 return *this;
616}
mistergc2e75482017-09-19 16:54:40 -0400617
Abseil Team39171202018-02-06 06:42:19 -0800618inline uint128& uint128::operator+=(uint128 other) {
619 *this = *this + other;
620 return *this;
621}
mistergc2e75482017-09-19 16:54:40 -0400622
Abseil Team39171202018-02-06 06:42:19 -0800623inline uint128& uint128::operator-=(uint128 other) {
624 *this = *this - other;
625 return *this;
626}
mistergc2e75482017-09-19 16:54:40 -0400627
Abseil Team39171202018-02-06 06:42:19 -0800628inline uint128& uint128::operator*=(uint128 other) {
629 *this = *this * other;
630 return *this;
631}
mistergc2e75482017-09-19 16:54:40 -0400632
Abseil Team39171202018-02-06 06:42:19 -0800633inline uint128& uint128::operator/=(uint128 other) {
634 *this = *this / other;
635 return *this;
636}
637
638inline uint128& uint128::operator%=(uint128 other) {
639 *this = *this % other;
640 return *this;
641}
mistergc2e75482017-09-19 16:54:40 -0400642
Abseil Team1b8dacc2017-12-05 10:58:48 -0800643constexpr uint64_t Uint128Low64(uint128 v) { return v.lo_; }
mistergc2e75482017-09-19 16:54:40 -0400644
Abseil Team1b8dacc2017-12-05 10:58:48 -0800645constexpr uint64_t Uint128High64(uint128 v) { return v.hi_; }
mistergc2e75482017-09-19 16:54:40 -0400646
647// Constructors from integer types.
648
649#if defined(ABSL_IS_LITTLE_ENDIAN)
650
Patrick Xia65109ec2023-04-27 09:23:15 -0700651constexpr uint128::uint128(uint64_t high, uint64_t low) : lo_{low}, hi_{high} {}
mistergc2e75482017-09-19 16:54:40 -0400652
Abseil Team075cf622017-11-06 12:54:54 -0800653constexpr uint128::uint128(int v)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800654 : lo_{static_cast<uint64_t>(v)},
Abseil Teama4c3fff2018-10-29 15:53:34 -0700655 hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0} {}
Abseil Team075cf622017-11-06 12:54:54 -0800656constexpr uint128::uint128(long v) // NOLINT(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800657 : lo_{static_cast<uint64_t>(v)},
Abseil Teama4c3fff2018-10-29 15:53:34 -0700658 hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0} {}
Abseil Team075cf622017-11-06 12:54:54 -0800659constexpr uint128::uint128(long long v) // NOLINT(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800660 : lo_{static_cast<uint64_t>(v)},
Abseil Teama4c3fff2018-10-29 15:53:34 -0700661 hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0} {}
mistergc2e75482017-09-19 16:54:40 -0400662
Abseil Team0fa86ca2018-02-02 10:36:07 -0800663constexpr uint128::uint128(unsigned int v) : lo_{v}, hi_{0} {}
mistergc2e75482017-09-19 16:54:40 -0400664// NOLINTNEXTLINE(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800665constexpr uint128::uint128(unsigned long v) : lo_{v}, hi_{0} {}
mistergc2e75482017-09-19 16:54:40 -0400666// NOLINTNEXTLINE(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800667constexpr uint128::uint128(unsigned long long v) : lo_{v}, hi_{0} {}
mistergc2e75482017-09-19 16:54:40 -0400668
669#ifdef ABSL_HAVE_INTRINSIC_INT128
Abseil Team075cf622017-11-06 12:54:54 -0800670constexpr uint128::uint128(__int128 v)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800671 : lo_{static_cast<uint64_t>(v & ~uint64_t{0})},
672 hi_{static_cast<uint64_t>(static_cast<unsigned __int128>(v) >> 64)} {}
Abseil Team075cf622017-11-06 12:54:54 -0800673constexpr uint128::uint128(unsigned __int128 v)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800674 : lo_{static_cast<uint64_t>(v & ~uint64_t{0})},
675 hi_{static_cast<uint64_t>(v >> 64)} {}
mistergc2e75482017-09-19 16:54:40 -0400676#endif // ABSL_HAVE_INTRINSIC_INT128
677
Abseil Team2103fd92019-11-18 11:02:26 -0800678constexpr uint128::uint128(int128 v)
679 : lo_{Int128Low64(v)}, hi_{static_cast<uint64_t>(Int128High64(v))} {}
680
mistergc2e75482017-09-19 16:54:40 -0400681#elif defined(ABSL_IS_BIG_ENDIAN)
682
Patrick Xia65109ec2023-04-27 09:23:15 -0700683constexpr uint128::uint128(uint64_t high, uint64_t low) : hi_{high}, lo_{low} {}
mistergc2e75482017-09-19 16:54:40 -0400684
Abseil Team075cf622017-11-06 12:54:54 -0800685constexpr uint128::uint128(int v)
Abseil Teama4c3fff2018-10-29 15:53:34 -0700686 : hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0},
Abseil Team0fa86ca2018-02-02 10:36:07 -0800687 lo_{static_cast<uint64_t>(v)} {}
Abseil Team075cf622017-11-06 12:54:54 -0800688constexpr uint128::uint128(long v) // NOLINT(runtime/int)
Abseil Teama4c3fff2018-10-29 15:53:34 -0700689 : hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0},
Abseil Team0fa86ca2018-02-02 10:36:07 -0800690 lo_{static_cast<uint64_t>(v)} {}
Abseil Team075cf622017-11-06 12:54:54 -0800691constexpr uint128::uint128(long long v) // NOLINT(runtime/int)
Abseil Teama4c3fff2018-10-29 15:53:34 -0700692 : hi_{v < 0 ? (std::numeric_limits<uint64_t>::max)() : 0},
Abseil Team0fa86ca2018-02-02 10:36:07 -0800693 lo_{static_cast<uint64_t>(v)} {}
mistergc2e75482017-09-19 16:54:40 -0400694
Abseil Team0fa86ca2018-02-02 10:36:07 -0800695constexpr uint128::uint128(unsigned int v) : hi_{0}, lo_{v} {}
mistergc2e75482017-09-19 16:54:40 -0400696// NOLINTNEXTLINE(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800697constexpr uint128::uint128(unsigned long v) : hi_{0}, lo_{v} {}
mistergc2e75482017-09-19 16:54:40 -0400698// NOLINTNEXTLINE(runtime/int)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800699constexpr uint128::uint128(unsigned long long v) : hi_{0}, lo_{v} {}
mistergc2e75482017-09-19 16:54:40 -0400700
701#ifdef ABSL_HAVE_INTRINSIC_INT128
Abseil Team075cf622017-11-06 12:54:54 -0800702constexpr uint128::uint128(__int128 v)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800703 : hi_{static_cast<uint64_t>(static_cast<unsigned __int128>(v) >> 64)},
704 lo_{static_cast<uint64_t>(v & ~uint64_t{0})} {}
Abseil Team075cf622017-11-06 12:54:54 -0800705constexpr uint128::uint128(unsigned __int128 v)
Abseil Team0fa86ca2018-02-02 10:36:07 -0800706 : hi_{static_cast<uint64_t>(v >> 64)},
707 lo_{static_cast<uint64_t>(v & ~uint64_t{0})} {}
mistergc2e75482017-09-19 16:54:40 -0400708#endif // ABSL_HAVE_INTRINSIC_INT128
709
Abseil Team2103fd92019-11-18 11:02:26 -0800710constexpr uint128::uint128(int128 v)
711 : hi_{static_cast<uint64_t>(Int128High64(v))}, lo_{Int128Low64(v)} {}
712
mistergc2e75482017-09-19 16:54:40 -0400713#else // byte order
714#error "Unsupported byte order: must be little-endian or big-endian."
715#endif // byte order
716
717// Conversion operators to integer types.
718
Abseil Team075cf622017-11-06 12:54:54 -0800719constexpr uint128::operator bool() const { return lo_ || hi_; }
mistergc2e75482017-09-19 16:54:40 -0400720
Abseil Team075cf622017-11-06 12:54:54 -0800721constexpr uint128::operator char() const { return static_cast<char>(lo_); }
mistergc2e75482017-09-19 16:54:40 -0400722
Abseil Team075cf622017-11-06 12:54:54 -0800723constexpr uint128::operator signed char() const {
mistergc2e75482017-09-19 16:54:40 -0400724 return static_cast<signed char>(lo_);
725}
726
Abseil Team075cf622017-11-06 12:54:54 -0800727constexpr uint128::operator unsigned char() const {
mistergc2e75482017-09-19 16:54:40 -0400728 return static_cast<unsigned char>(lo_);
729}
730
Abseil Team075cf622017-11-06 12:54:54 -0800731constexpr uint128::operator char16_t() const {
mistergc2e75482017-09-19 16:54:40 -0400732 return static_cast<char16_t>(lo_);
733}
734
Abseil Team075cf622017-11-06 12:54:54 -0800735constexpr uint128::operator char32_t() const {
mistergc2e75482017-09-19 16:54:40 -0400736 return static_cast<char32_t>(lo_);
737}
738
Abseil Team389ec3f2018-12-13 10:30:03 -0800739constexpr uint128::operator ABSL_INTERNAL_WCHAR_T() const {
740 return static_cast<ABSL_INTERNAL_WCHAR_T>(lo_);
mistergc2e75482017-09-19 16:54:40 -0400741}
742
743// NOLINTNEXTLINE(runtime/int)
Abseil Team075cf622017-11-06 12:54:54 -0800744constexpr uint128::operator short() const { return static_cast<short>(lo_); }
745
746constexpr uint128::operator unsigned short() const { // NOLINT(runtime/int)
747 return static_cast<unsigned short>(lo_); // NOLINT(runtime/int)
mistergc2e75482017-09-19 16:54:40 -0400748}
749
Abseil Team075cf622017-11-06 12:54:54 -0800750constexpr uint128::operator int() const { return static_cast<int>(lo_); }
mistergc2e75482017-09-19 16:54:40 -0400751
Abseil Team075cf622017-11-06 12:54:54 -0800752constexpr uint128::operator unsigned int() const {
mistergc2e75482017-09-19 16:54:40 -0400753 return static_cast<unsigned int>(lo_);
754}
755
756// NOLINTNEXTLINE(runtime/int)
Abseil Team075cf622017-11-06 12:54:54 -0800757constexpr uint128::operator long() const { return static_cast<long>(lo_); }
758
759constexpr uint128::operator unsigned long() const { // NOLINT(runtime/int)
760 return static_cast<unsigned long>(lo_); // NOLINT(runtime/int)
mistergc2e75482017-09-19 16:54:40 -0400761}
762
Abseil Team075cf622017-11-06 12:54:54 -0800763constexpr uint128::operator long long() const { // NOLINT(runtime/int)
764 return static_cast<long long>(lo_); // NOLINT(runtime/int)
mistergc2e75482017-09-19 16:54:40 -0400765}
766
Abseil Team075cf622017-11-06 12:54:54 -0800767constexpr uint128::operator unsigned long long() const { // NOLINT(runtime/int)
768 return static_cast<unsigned long long>(lo_); // NOLINT(runtime/int)
mistergc2e75482017-09-19 16:54:40 -0400769}
770
771#ifdef ABSL_HAVE_INTRINSIC_INT128
Abseil Team075cf622017-11-06 12:54:54 -0800772constexpr uint128::operator __int128() const {
mistergc2e75482017-09-19 16:54:40 -0400773 return (static_cast<__int128>(hi_) << 64) + lo_;
774}
775
Abseil Team075cf622017-11-06 12:54:54 -0800776constexpr uint128::operator unsigned __int128() const {
mistergc2e75482017-09-19 16:54:40 -0400777 return (static_cast<unsigned __int128>(hi_) << 64) + lo_;
778}
779#endif // ABSL_HAVE_INTRINSIC_INT128
780
781// Conversion operators to floating point types.
782
783inline uint128::operator float() const {
784 return static_cast<float>(lo_) + std::ldexp(static_cast<float>(hi_), 64);
785}
786
787inline uint128::operator double() const {
788 return static_cast<double>(lo_) + std::ldexp(static_cast<double>(hi_), 64);
789}
790
791inline uint128::operator long double() const {
792 return static_cast<long double>(lo_) +
793 std::ldexp(static_cast<long double>(hi_), 64);
794}
795
796// Comparison operators.
797
Abseil Teama05366d2021-08-19 13:34:28 -0700798constexpr bool operator==(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -0700799#if defined(ABSL_HAVE_INTRINSIC_INT128)
800 return static_cast<unsigned __int128>(lhs) ==
801 static_cast<unsigned __int128>(rhs);
802#else
mistergc2e75482017-09-19 16:54:40 -0400803 return (Uint128Low64(lhs) == Uint128Low64(rhs) &&
804 Uint128High64(lhs) == Uint128High64(rhs));
Abseil Team8e088c52021-08-10 08:52:44 -0700805#endif
mistergc2e75482017-09-19 16:54:40 -0400806}
807
Abseil Teama05366d2021-08-19 13:34:28 -0700808constexpr bool operator!=(uint128 lhs, uint128 rhs) { return !(lhs == rhs); }
mistergc2e75482017-09-19 16:54:40 -0400809
Abseil Teama05366d2021-08-19 13:34:28 -0700810constexpr bool operator<(uint128 lhs, uint128 rhs) {
Abseil Teamd9360522020-03-09 12:34:31 -0700811#ifdef ABSL_HAVE_INTRINSIC_INT128
812 return static_cast<unsigned __int128>(lhs) <
813 static_cast<unsigned __int128>(rhs);
814#else
mistergc2e75482017-09-19 16:54:40 -0400815 return (Uint128High64(lhs) == Uint128High64(rhs))
816 ? (Uint128Low64(lhs) < Uint128Low64(rhs))
817 : (Uint128High64(lhs) < Uint128High64(rhs));
Abseil Teamd9360522020-03-09 12:34:31 -0700818#endif
mistergc2e75482017-09-19 16:54:40 -0400819}
820
Abseil Teama05366d2021-08-19 13:34:28 -0700821constexpr bool operator>(uint128 lhs, uint128 rhs) { return rhs < lhs; }
mistergc2e75482017-09-19 16:54:40 -0400822
Abseil Teama05366d2021-08-19 13:34:28 -0700823constexpr bool operator<=(uint128 lhs, uint128 rhs) { return !(rhs < lhs); }
mistergc2e75482017-09-19 16:54:40 -0400824
Abseil Teama05366d2021-08-19 13:34:28 -0700825constexpr bool operator>=(uint128 lhs, uint128 rhs) { return !(lhs < rhs); }
mistergc2e75482017-09-19 16:54:40 -0400826
Benjamin Barenblat192e9592024-04-18 10:36:51 -0700827#ifdef __cpp_impl_three_way_comparison
828constexpr absl::strong_ordering operator<=>(uint128 lhs, uint128 rhs) {
829#if defined(ABSL_HAVE_INTRINSIC_INT128)
830 if (auto lhs_128 = static_cast<unsigned __int128>(lhs),
831 rhs_128 = static_cast<unsigned __int128>(rhs);
832 lhs_128 < rhs_128) {
833 return absl::strong_ordering::less;
834 } else if (lhs_128 > rhs_128) {
835 return absl::strong_ordering::greater;
836 } else {
837 return absl::strong_ordering::equal;
838 }
839#else
840 if (uint64_t lhs_high = Uint128High64(lhs), rhs_high = Uint128High64(rhs);
841 lhs_high < rhs_high) {
842 return absl::strong_ordering::less;
843 } else if (lhs_high > rhs_high) {
844 return absl::strong_ordering::greater;
845 } else if (uint64_t lhs_low = Uint128Low64(lhs), rhs_low = Uint128Low64(rhs);
846 lhs_low < rhs_low) {
847 return absl::strong_ordering::less;
848 } else if (lhs_low > rhs_low) {
849 return absl::strong_ordering::greater;
850 } else {
851 return absl::strong_ordering::equal;
852 }
853#endif
854}
855#endif
856
mistergc2e75482017-09-19 16:54:40 -0400857// Unary operators.
858
Patrick Xia65109ec2023-04-27 09:23:15 -0700859constexpr inline uint128 operator+(uint128 val) { return val; }
Abseil Teamf7297262021-06-08 18:40:58 -0700860
Patrick Xia65109ec2023-04-27 09:23:15 -0700861constexpr inline int128 operator+(int128 val) { return val; }
Abseil Teamf7297262021-06-08 18:40:58 -0700862
Abseil Teama05366d2021-08-19 13:34:28 -0700863constexpr uint128 operator-(uint128 val) {
Abseil Team8e088c52021-08-10 08:52:44 -0700864#if defined(ABSL_HAVE_INTRINSIC_INT128)
865 return -static_cast<unsigned __int128>(val);
866#else
Abseil Teama05366d2021-08-19 13:34:28 -0700867 return MakeUint128(
868 ~Uint128High64(val) + static_cast<unsigned long>(Uint128Low64(val) == 0),
869 ~Uint128Low64(val) + 1);
Abseil Team8e088c52021-08-10 08:52:44 -0700870#endif
mistergc2e75482017-09-19 16:54:40 -0400871}
872
Abseil Teame38e1aa2021-04-22 04:30:35 -0700873constexpr inline bool operator!(uint128 val) {
Abseil Team8e088c52021-08-10 08:52:44 -0700874#if defined(ABSL_HAVE_INTRINSIC_INT128)
875 return !static_cast<unsigned __int128>(val);
876#else
mistergc2e75482017-09-19 16:54:40 -0400877 return !Uint128High64(val) && !Uint128Low64(val);
Abseil Team8e088c52021-08-10 08:52:44 -0700878#endif
mistergc2e75482017-09-19 16:54:40 -0400879}
880
881// Logical operators.
882
Abseil Teame38e1aa2021-04-22 04:30:35 -0700883constexpr inline uint128 operator~(uint128 val) {
Abseil Team8e088c52021-08-10 08:52:44 -0700884#if defined(ABSL_HAVE_INTRINSIC_INT128)
885 return ~static_cast<unsigned __int128>(val);
886#else
mistergc2e75482017-09-19 16:54:40 -0400887 return MakeUint128(~Uint128High64(val), ~Uint128Low64(val));
Abseil Team8e088c52021-08-10 08:52:44 -0700888#endif
mistergc2e75482017-09-19 16:54:40 -0400889}
890
Abseil Teame38e1aa2021-04-22 04:30:35 -0700891constexpr inline uint128 operator|(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -0700892#if defined(ABSL_HAVE_INTRINSIC_INT128)
893 return static_cast<unsigned __int128>(lhs) |
894 static_cast<unsigned __int128>(rhs);
895#else
mistergc2e75482017-09-19 16:54:40 -0400896 return MakeUint128(Uint128High64(lhs) | Uint128High64(rhs),
Abseil Team8e088c52021-08-10 08:52:44 -0700897 Uint128Low64(lhs) | Uint128Low64(rhs));
898#endif
mistergc2e75482017-09-19 16:54:40 -0400899}
900
Abseil Teame38e1aa2021-04-22 04:30:35 -0700901constexpr inline uint128 operator&(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -0700902#if defined(ABSL_HAVE_INTRINSIC_INT128)
903 return static_cast<unsigned __int128>(lhs) &
904 static_cast<unsigned __int128>(rhs);
905#else
mistergc2e75482017-09-19 16:54:40 -0400906 return MakeUint128(Uint128High64(lhs) & Uint128High64(rhs),
Abseil Team8e088c52021-08-10 08:52:44 -0700907 Uint128Low64(lhs) & Uint128Low64(rhs));
908#endif
mistergc2e75482017-09-19 16:54:40 -0400909}
910
Abseil Teame38e1aa2021-04-22 04:30:35 -0700911constexpr inline uint128 operator^(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -0700912#if defined(ABSL_HAVE_INTRINSIC_INT128)
913 return static_cast<unsigned __int128>(lhs) ^
914 static_cast<unsigned __int128>(rhs);
915#else
mistergc2e75482017-09-19 16:54:40 -0400916 return MakeUint128(Uint128High64(lhs) ^ Uint128High64(rhs),
Abseil Team8e088c52021-08-10 08:52:44 -0700917 Uint128Low64(lhs) ^ Uint128Low64(rhs));
918#endif
mistergc2e75482017-09-19 16:54:40 -0400919}
920
Abseil Team1b8dacc2017-12-05 10:58:48 -0800921inline uint128& uint128::operator|=(uint128 other) {
Abseil Team8e088c52021-08-10 08:52:44 -0700922 *this = *this | other;
mistergc2e75482017-09-19 16:54:40 -0400923 return *this;
924}
925
Abseil Team1b8dacc2017-12-05 10:58:48 -0800926inline uint128& uint128::operator&=(uint128 other) {
Abseil Team8e088c52021-08-10 08:52:44 -0700927 *this = *this & other;
mistergc2e75482017-09-19 16:54:40 -0400928 return *this;
929}
930
Abseil Team1b8dacc2017-12-05 10:58:48 -0800931inline uint128& uint128::operator^=(uint128 other) {
Abseil Team8e088c52021-08-10 08:52:44 -0700932 *this = *this ^ other;
mistergc2e75482017-09-19 16:54:40 -0400933 return *this;
934}
935
Abseil Team39171202018-02-06 06:42:19 -0800936// Arithmetic operators.
mistergc2e75482017-09-19 16:54:40 -0400937
Abseil Teama05366d2021-08-19 13:34:28 -0700938constexpr uint128 operator<<(uint128 lhs, int amount) {
Abseil Teamd9360522020-03-09 12:34:31 -0700939#ifdef ABSL_HAVE_INTRINSIC_INT128
940 return static_cast<unsigned __int128>(lhs) << amount;
941#else
mistergc2e75482017-09-19 16:54:40 -0400942 // uint64_t shifts of >= 64 are undefined, so we will need some
943 // special-casing.
Patrick Xia65109ec2023-04-27 09:23:15 -0700944 return amount >= 64 ? MakeUint128(Uint128Low64(lhs) << (amount - 64), 0)
Abseil Teama05366d2021-08-19 13:34:28 -0700945 : amount == 0 ? lhs
946 : MakeUint128((Uint128High64(lhs) << amount) |
947 (Uint128Low64(lhs) >> (64 - amount)),
948 Uint128Low64(lhs) << amount);
Abseil Teamd9360522020-03-09 12:34:31 -0700949#endif
mistergc2e75482017-09-19 16:54:40 -0400950}
951
Abseil Teama05366d2021-08-19 13:34:28 -0700952constexpr uint128 operator>>(uint128 lhs, int amount) {
Abseil Teamd9360522020-03-09 12:34:31 -0700953#ifdef ABSL_HAVE_INTRINSIC_INT128
954 return static_cast<unsigned __int128>(lhs) >> amount;
955#else
mistergc2e75482017-09-19 16:54:40 -0400956 // uint64_t shifts of >= 64 are undefined, so we will need some
957 // special-casing.
Patrick Xia65109ec2023-04-27 09:23:15 -0700958 return amount >= 64 ? MakeUint128(0, Uint128High64(lhs) >> (amount - 64))
Abseil Teama05366d2021-08-19 13:34:28 -0700959 : amount == 0 ? lhs
960 : MakeUint128(Uint128High64(lhs) >> amount,
961 (Uint128Low64(lhs) >> amount) |
962 (Uint128High64(lhs) << (64 - amount)));
Abseil Teamd9360522020-03-09 12:34:31 -0700963#endif
mistergc2e75482017-09-19 16:54:40 -0400964}
965
Abseil Teama05366d2021-08-19 13:34:28 -0700966#if !defined(ABSL_HAVE_INTRINSIC_INT128)
967namespace int128_internal {
968constexpr uint128 AddResult(uint128 result, uint128 lhs) {
969 // check for carry
970 return (Uint128Low64(result) < Uint128Low64(lhs))
971 ? MakeUint128(Uint128High64(result) + 1, Uint128Low64(result))
972 : result;
973}
974} // namespace int128_internal
975#endif
976
977constexpr uint128 operator+(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -0700978#if defined(ABSL_HAVE_INTRINSIC_INT128)
979 return static_cast<unsigned __int128>(lhs) +
980 static_cast<unsigned __int128>(rhs);
981#else
Abseil Teama05366d2021-08-19 13:34:28 -0700982 return int128_internal::AddResult(
983 MakeUint128(Uint128High64(lhs) + Uint128High64(rhs),
984 Uint128Low64(lhs) + Uint128Low64(rhs)),
985 lhs);
Abseil Team8e088c52021-08-10 08:52:44 -0700986#endif
mistergc2e75482017-09-19 16:54:40 -0400987}
988
Abseil Teama05366d2021-08-19 13:34:28 -0700989#if !defined(ABSL_HAVE_INTRINSIC_INT128)
990namespace int128_internal {
991constexpr uint128 SubstructResult(uint128 result, uint128 lhs, uint128 rhs) {
992 // check for carry
993 return (Uint128Low64(lhs) < Uint128Low64(rhs))
994 ? MakeUint128(Uint128High64(result) - 1, Uint128Low64(result))
995 : result;
996}
997} // namespace int128_internal
998#endif
999
1000constexpr uint128 operator-(uint128 lhs, uint128 rhs) {
Abseil Team8e088c52021-08-10 08:52:44 -07001001#if defined(ABSL_HAVE_INTRINSIC_INT128)
1002 return static_cast<unsigned __int128>(lhs) -
1003 static_cast<unsigned __int128>(rhs);
1004#else
Abseil Teama05366d2021-08-19 13:34:28 -07001005 return int128_internal::SubstructResult(
1006 MakeUint128(Uint128High64(lhs) - Uint128High64(rhs),
1007 Uint128Low64(lhs) - Uint128Low64(rhs)),
1008 lhs, rhs);
Abseil Team8e088c52021-08-10 08:52:44 -07001009#endif
mistergc2e75482017-09-19 16:54:40 -04001010}
1011
Abseil Team39171202018-02-06 06:42:19 -08001012inline uint128 operator*(uint128 lhs, uint128 rhs) {
mistergc2e75482017-09-19 16:54:40 -04001013#if defined(ABSL_HAVE_INTRINSIC_INT128)
1014 // TODO(strel) Remove once alignment issues are resolved and unsigned __int128
1015 // can be used for uint128 storage.
Abseil Team39171202018-02-06 06:42:19 -08001016 return static_cast<unsigned __int128>(lhs) *
1017 static_cast<unsigned __int128>(rhs);
Ben Niu4c015db2022-03-18 13:10:10 -07001018#elif defined(_MSC_VER) && defined(_M_X64) && !defined(_M_ARM64EC)
Abseil Team7b46e1d2018-11-13 13:22:00 -08001019 uint64_t carry;
1020 uint64_t low = _umul128(Uint128Low64(lhs), Uint128Low64(rhs), &carry);
1021 return MakeUint128(Uint128Low64(lhs) * Uint128High64(rhs) +
1022 Uint128High64(lhs) * Uint128Low64(rhs) + carry,
1023 low);
mistergc2e75482017-09-19 16:54:40 -04001024#else // ABSL_HAVE_INTRINSIC128
Abseil Team39171202018-02-06 06:42:19 -08001025 uint64_t a32 = Uint128Low64(lhs) >> 32;
1026 uint64_t a00 = Uint128Low64(lhs) & 0xffffffff;
1027 uint64_t b32 = Uint128Low64(rhs) >> 32;
1028 uint64_t b00 = Uint128Low64(rhs) & 0xffffffff;
1029 uint128 result =
1030 MakeUint128(Uint128High64(lhs) * Uint128Low64(rhs) +
1031 Uint128Low64(lhs) * Uint128High64(rhs) + a32 * b32,
1032 a00 * b00);
1033 result += uint128(a32 * b00) << 32;
1034 result += uint128(a00 * b32) << 32;
1035 return result;
mistergc2e75482017-09-19 16:54:40 -04001036#endif // ABSL_HAVE_INTRINSIC128
1037}
1038
Abseil Team8e088c52021-08-10 08:52:44 -07001039#if defined(ABSL_HAVE_INTRINSIC_INT128)
1040inline uint128 operator/(uint128 lhs, uint128 rhs) {
1041 return static_cast<unsigned __int128>(lhs) /
1042 static_cast<unsigned __int128>(rhs);
1043}
1044
1045inline uint128 operator%(uint128 lhs, uint128 rhs) {
1046 return static_cast<unsigned __int128>(lhs) %
1047 static_cast<unsigned __int128>(rhs);
1048}
1049#endif
1050
mistergc2e75482017-09-19 16:54:40 -04001051// Increment/decrement operators.
1052
1053inline uint128 uint128::operator++(int) {
1054 uint128 tmp(*this);
1055 *this += 1;
1056 return tmp;
1057}
1058
1059inline uint128 uint128::operator--(int) {
1060 uint128 tmp(*this);
1061 *this -= 1;
1062 return tmp;
1063}
1064
1065inline uint128& uint128::operator++() {
1066 *this += 1;
1067 return *this;
1068}
1069
1070inline uint128& uint128::operator--() {
1071 *this -= 1;
1072 return *this;
1073}
1074
Abseil Team2103fd92019-11-18 11:02:26 -08001075constexpr int128 MakeInt128(int64_t high, uint64_t low) {
1076 return int128(high, low);
1077}
1078
1079// Assignment from integer types.
Patrick Xia65109ec2023-04-27 09:23:15 -07001080inline int128& int128::operator=(int v) { return *this = int128(v); }
Abseil Team2103fd92019-11-18 11:02:26 -08001081
Patrick Xia65109ec2023-04-27 09:23:15 -07001082inline int128& int128::operator=(unsigned int v) { return *this = int128(v); }
Abseil Team2103fd92019-11-18 11:02:26 -08001083
1084inline int128& int128::operator=(long v) { // NOLINT(runtime/int)
1085 return *this = int128(v);
1086}
1087
1088// NOLINTNEXTLINE(runtime/int)
Patrick Xia65109ec2023-04-27 09:23:15 -07001089inline int128& int128::operator=(unsigned long v) { return *this = int128(v); }
Abseil Team2103fd92019-11-18 11:02:26 -08001090
1091// NOLINTNEXTLINE(runtime/int)
Patrick Xia65109ec2023-04-27 09:23:15 -07001092inline int128& int128::operator=(long long v) { return *this = int128(v); }
Abseil Team2103fd92019-11-18 11:02:26 -08001093
1094// NOLINTNEXTLINE(runtime/int)
1095inline int128& int128::operator=(unsigned long long v) {
1096 return *this = int128(v);
1097}
1098
1099// Arithmetic operators.
Abseil Teama05366d2021-08-19 13:34:28 -07001100constexpr int128 operator-(int128 v);
1101constexpr int128 operator+(int128 lhs, int128 rhs);
1102constexpr int128 operator-(int128 lhs, int128 rhs);
Abseil Team2103fd92019-11-18 11:02:26 -08001103int128 operator*(int128 lhs, int128 rhs);
1104int128 operator/(int128 lhs, int128 rhs);
1105int128 operator%(int128 lhs, int128 rhs);
Abseil Teama05366d2021-08-19 13:34:28 -07001106constexpr int128 operator|(int128 lhs, int128 rhs);
1107constexpr int128 operator&(int128 lhs, int128 rhs);
1108constexpr int128 operator^(int128 lhs, int128 rhs);
1109constexpr int128 operator<<(int128 lhs, int amount);
1110constexpr int128 operator>>(int128 lhs, int amount);
Abseil Team2103fd92019-11-18 11:02:26 -08001111
1112inline int128& int128::operator+=(int128 other) {
1113 *this = *this + other;
1114 return *this;
1115}
1116
1117inline int128& int128::operator-=(int128 other) {
1118 *this = *this - other;
1119 return *this;
1120}
1121
1122inline int128& int128::operator*=(int128 other) {
1123 *this = *this * other;
1124 return *this;
1125}
1126
1127inline int128& int128::operator/=(int128 other) {
1128 *this = *this / other;
1129 return *this;
1130}
1131
1132inline int128& int128::operator%=(int128 other) {
1133 *this = *this % other;
1134 return *this;
1135}
1136
1137inline int128& int128::operator|=(int128 other) {
1138 *this = *this | other;
1139 return *this;
1140}
1141
1142inline int128& int128::operator&=(int128 other) {
1143 *this = *this & other;
1144 return *this;
1145}
1146
1147inline int128& int128::operator^=(int128 other) {
1148 *this = *this ^ other;
1149 return *this;
1150}
1151
1152inline int128& int128::operator<<=(int amount) {
1153 *this = *this << amount;
1154 return *this;
1155}
1156
1157inline int128& int128::operator>>=(int amount) {
1158 *this = *this >> amount;
1159 return *this;
1160}
1161
Abseil Teama05366d2021-08-19 13:34:28 -07001162// Forward declaration for comparison operators.
1163constexpr bool operator!=(int128 lhs, int128 rhs);
1164
Abseil Team2103fd92019-11-18 11:02:26 -08001165namespace int128_internal {
1166
1167// Casts from unsigned to signed while preserving the underlying binary
1168// representation.
1169constexpr int64_t BitCastToSigned(uint64_t v) {
1170 // Casting an unsigned integer to a signed integer of the same
1171 // width is implementation defined behavior if the source value would not fit
1172 // in the destination type. We step around it with a roundtrip bitwise not
1173 // operation to make sure this function remains constexpr. Clang, GCC, and
1174 // MSVC optimize this to a no-op on x86-64.
1175 return v & (uint64_t{1} << 63) ? ~static_cast<int64_t>(~v)
1176 : static_cast<int64_t>(v);
1177}
1178
1179} // namespace int128_internal
1180
Abseil Teamee2e3f62017-11-07 04:53:20 -08001181#if defined(ABSL_HAVE_INTRINSIC_INT128)
Abseil Teamfa8c7512019-11-13 08:54:32 -08001182#include "absl/numeric/int128_have_intrinsic.inc" // IWYU pragma: export
Abseil Teamee2e3f62017-11-07 04:53:20 -08001183#else // ABSL_HAVE_INTRINSIC_INT128
Abseil Teamfa8c7512019-11-13 08:54:32 -08001184#include "absl/numeric/int128_no_intrinsic.inc" // IWYU pragma: export
Abseil Teamee2e3f62017-11-07 04:53:20 -08001185#endif // ABSL_HAVE_INTRINSIC_INT128
1186
Abseil Team12bc53e2019-12-12 10:36:03 -08001187ABSL_NAMESPACE_END
mistergc2e75482017-09-19 16:54:40 -04001188} // namespace absl
1189
Abseil Team389ec3f2018-12-13 10:30:03 -08001190#undef ABSL_INTERNAL_WCHAR_T
1191
mistergc2e75482017-09-19 16:54:40 -04001192#endif // ABSL_NUMERIC_INT128_H_