xref: /aosp_15_r20/external/libaom/aom_ports/bitops.h (revision 77c1e3ccc04c968bd2bc212e87364f250e820521)
1 /*
2  * Copyright (c) 2016, Alliance for Open Media. All rights reserved.
3  *
4  * This source code is subject to the terms of the BSD 2 Clause License and
5  * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
6  * was not distributed with this source code in the LICENSE file, you can
7  * obtain it at www.aomedia.org/license/software. If the Alliance for Open
8  * Media Patent License 1.0 was not distributed with this source code in the
9  * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
10  */
11 
12 #ifndef AOM_AOM_PORTS_BITOPS_H_
13 #define AOM_AOM_PORTS_BITOPS_H_
14 
15 #include <assert.h>
16 #include <stdint.h>
17 
18 #include "config/aom_config.h"
19 
20 #ifdef _MSC_VER
21 #if defined(_M_X64) || defined(_M_IX86) || defined(_M_ARM64) || defined(_M_ARM)
22 #include <intrin.h>
23 #define USE_MSC_INTRINSICS
24 #endif
25 #endif
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 // get_msb:
32 // Returns (int)floor(log2(n)). n must be > 0.
33 // These versions of get_msb() are only valid when n != 0 because all
34 // of the optimized versions are undefined when n == 0:
35 
36 // GCC compiler: https://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html
37 // MSVC: https://learn.microsoft.com/en-us/cpp/intrinsics/compiler-intrinsics
38 
39 // use GNU builtins where available.
40 #if defined(__GNUC__) && \
41     ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
get_msb(unsigned int n)42 static inline int get_msb(unsigned int n) {
43   assert(n != 0);
44   return 31 ^ __builtin_clz(n);
45 }
46 #elif defined(USE_MSC_INTRINSICS)
47 #pragma intrinsic(_BitScanReverse)
48 
49 static inline int get_msb(unsigned int n) {
50   unsigned long first_set_bit;
51   assert(n != 0);
52   _BitScanReverse(&first_set_bit, n);
53   return first_set_bit;
54 }
55 #else
56 static inline int get_msb(unsigned int n) {
57   int log = 0;
58   unsigned int value = n;
59 
60   assert(n != 0);
61 
62   for (int shift = 16; shift != 0; shift >>= 1) {
63     const unsigned int x = value >> shift;
64     if (x != 0) {
65       value = x;
66       log += shift;
67     }
68   }
69   return log;
70 }
71 #endif
72 
73 #if defined(__GNUC__) && \
74     ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
aom_clzll(uint64_t n)75 static inline int aom_clzll(uint64_t n) { return __builtin_clzll(n); }
76 #elif defined(USE_MSC_INTRINSICS)
77 #if defined(_M_X64) || defined(_M_ARM64)
78 #pragma intrinsic(_BitScanReverse64)
79 #endif
80 
aom_clzll(uint64_t n)81 static inline int aom_clzll(uint64_t n) {
82   assert(n != 0);
83   unsigned long first_set_bit;  // NOLINT(runtime/int)
84 #if defined(_M_X64) || defined(_M_ARM64)
85   const unsigned char bit_set =
86       _BitScanReverse64(&first_set_bit, (unsigned __int64)n);
87 #else  // !(defined(_M_X64) || defined(_M_ARM64))
88   const unsigned long n_hi = (unsigned long)(n >> 32);  // NOLINT(runtime/int)
89   if (n_hi != 0) {
90     const unsigned char bit_set = _BitScanReverse(&first_set_bit, n_hi);
91     assert(bit_set != 0);
92     (void)bit_set;
93     return 31 ^ (int)first_set_bit;
94   }
95   const unsigned char bit_set =
96       _BitScanReverse(&first_set_bit, (unsigned long)n);  // NOLINT(runtime/int)
97 #endif
98   assert(bit_set != 0);
99   (void)bit_set;
100   return 63 ^ (int)first_set_bit;
101 }
102 #undef USE_MSC_INTRINSICS
103 #else
aom_clzll(uint64_t n)104 static inline int aom_clzll(uint64_t n) {
105   assert(n != 0);
106 
107   int res = 0;
108   uint64_t high_bit = 1ULL << 63;
109   while (!(n & high_bit)) {
110     res++;
111     n <<= 1;
112   }
113   return res;
114 }
115 #endif
116 
117 #ifdef __cplusplus
118 }  // extern "C"
119 #endif
120 
121 #endif  // AOM_AOM_PORTS_BITOPS_H_
122