clzerointrin.h revision 321369
1/*===----------------------- clzerointrin.h - CLZERO ----------------------===
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#ifndef __X86INTRIN_H
24#error "Never use <clzerointrin.h> directly; include <x86intrin.h> instead."
25#endif
26
27#ifndef _CLZEROINTRIN_H
28#define _CLZEROINTRIN_H
29
30/* Define the default attributes for the functions in this file. */
31#define __DEFAULT_FN_ATTRS \
32  __attribute__((__always_inline__, __nodebug__,  __target__("clzero")))
33
34/// \brief Loads the cache line address and zero's out the cacheline
35///
36/// \headerfile <clzerointrin.h>
37///
38/// This intrinsic corresponds to the <c> CLZERO </c> instruction.
39///
40/// \param __line
41///    A pointer to a cacheline which needs to be zeroed out.
42static __inline__ void __DEFAULT_FN_ATTRS
43_mm_clzero (void * __line)
44{
45  __builtin_ia32_clzero ((void *)__line);
46}
47
48#undef __DEFAULT_FN_ATTRS
49
50#endif /* _CLZEROINTRIN_H */
51