xref: /aosp_15_r20/external/clang/lib/Headers/__wmmintrin_pclmul.h (revision 67e74705e28f6214e480b399dd47ea732279e315)
1*67e74705SXin Li /*===---- __wmmintrin_pclmul.h - PCMUL intrinsics ---------------------------===
2*67e74705SXin Li  *
3*67e74705SXin Li  * Permission is hereby granted, free of charge, to any person obtaining a copy
4*67e74705SXin Li  * of this software and associated documentation files (the "Software"), to deal
5*67e74705SXin Li  * in the Software without restriction, including without limitation the rights
6*67e74705SXin Li  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7*67e74705SXin Li  * copies of the Software, and to permit persons to whom the Software is
8*67e74705SXin Li  * furnished to do so, subject to the following conditions:
9*67e74705SXin Li  *
10*67e74705SXin Li  * The above copyright notice and this permission notice shall be included in
11*67e74705SXin Li  * all copies or substantial portions of the Software.
12*67e74705SXin Li  *
13*67e74705SXin Li  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14*67e74705SXin Li  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15*67e74705SXin Li  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16*67e74705SXin Li  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17*67e74705SXin Li  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18*67e74705SXin Li  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19*67e74705SXin Li  * THE SOFTWARE.
20*67e74705SXin Li  *
21*67e74705SXin Li  *===-----------------------------------------------------------------------===
22*67e74705SXin Li  */
23*67e74705SXin Li #ifndef _WMMINTRIN_PCLMUL_H
24*67e74705SXin Li #define _WMMINTRIN_PCLMUL_H
25*67e74705SXin Li 
26*67e74705SXin Li /// \brief Multiplies two 64-bit integer values, which are selected from source
27*67e74705SXin Li ///    operands using the immediate-value operand. The multiplication is a
28*67e74705SXin Li ///    carry-less multiplication, and the 128-bit integer product is stored in
29*67e74705SXin Li ///    the destination.
30*67e74705SXin Li ///
31*67e74705SXin Li /// \headerfile <x86intrin.h>
32*67e74705SXin Li ///
33*67e74705SXin Li /// \code
34*67e74705SXin Li /// __m128i _mm_clmulepi64_si128(__m128i __X, __m128i __Y, const int __I);
35*67e74705SXin Li /// \endcode
36*67e74705SXin Li ///
37*67e74705SXin Li /// This intrinsic corresponds to the \c VPCLMULQDQ instruction.
38*67e74705SXin Li ///
39*67e74705SXin Li /// \param __X
40*67e74705SXin Li ///    A 128-bit vector of [2 x i64] containing one of the source operands.
41*67e74705SXin Li /// \param __Y
42*67e74705SXin Li ///    A 128-bit vector of [2 x i64] containing one of the source operands.
43*67e74705SXin Li /// \param __I
44*67e74705SXin Li ///    An immediate value specifying which 64-bit values to select from the
45*67e74705SXin Li ///    operands.
46*67e74705SXin Li ///    Bit 0 is used to select a value from operand __X,
47*67e74705SXin Li ///    and bit 4 is used to select a value from operand __Y:
48*67e74705SXin Li ///    Bit[0]=0 indicates that bits[63:0] of operand __X are used.
49*67e74705SXin Li ///    Bit[0]=1 indicates that bits[127:64] of operand __X are used.
50*67e74705SXin Li ///    Bit[4]=0 indicates that bits[63:0] of operand __Y are used.
51*67e74705SXin Li ///    Bit[4]=1 indicates that bits[127:64] of operand __Y are used.
52*67e74705SXin Li /// \returns The 128-bit integer vector containing the result of the carry-less
53*67e74705SXin Li ///    multiplication of the selected 64-bit values.
54*67e74705SXin Li #define _mm_clmulepi64_si128(__X, __Y, __I) \
55*67e74705SXin Li   ((__m128i)__builtin_ia32_pclmulqdq128((__v2di)(__m128i)(__X), \
56*67e74705SXin Li                                         (__v2di)(__m128i)(__Y), (char)(__I)))
57*67e74705SXin Li 
58*67e74705SXin Li #endif /* _WMMINTRIN_PCLMUL_H */
59