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