From 832a07c9d566c5aad19e1ba5c3c924d8d384499f Mon Sep 17 00:00:00 2001 From: Ekaterina Romanova Date: Fri, 18 Nov 2016 01:42:01 +0000 Subject: [PATCH] Add doxygen comments to fxsrintrin.h's intrinsics. The doxygen comments are automatically generated based on Sony's intrinsics document. I got an OK from Eric Christopher to commit doxygen comments without prior code review upstream. This patch was internally reviewed by Paul Robinson and Charles Li. git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@287295 91177308-0d34-0410-b5e6-96231b3b80d8 --- lib/Headers/fxsrintrin.h | 56 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 4 deletions(-) diff --git a/lib/Headers/fxsrintrin.h b/lib/Headers/fxsrintrin.h index f77aa484b5..6b581c415c 100644 --- a/lib/Headers/fxsrintrin.h +++ b/lib/Headers/fxsrintrin.h @@ -30,24 +30,72 @@ #define __DEFAULT_FN_ATTRS __attribute__((__always_inline__, __nodebug__, __target__("fxsr"))) +/// \brief Saves the XMM, MMX, MXCSR and x87 FPU registers into a 512-byte +/// memory region pointed to by the input parameter __p. +/// +/// \headerfile +/// +/// This intrinsic corresponds to the \c FXSAVE instruction. +/// +/// \param __p +/// A pointer to a 512-byte memory region. The beginning of this memory +/// region should be aligned on a 16-byte boundary. static __inline__ void __DEFAULT_FN_ATTRS -_fxsave(void *__p) { +_fxsave(void *__p) +{ return __builtin_ia32_fxsave(__p); } +/// \brief Restores the XMM, MMX, MXCSR and x87 FPU registers from the 512-byte +/// memory region pointed to by the input parameter __p. The contents of this +/// memory region should have been written to by a previous _fxsave or +/// _fxsave64 intrinsic. +/// +/// \headerfile +/// +/// This intrinsic corresponds to the \c FXRSTOR instruction. +/// +/// \param __p +/// A pointer to a 512-byte memory region. The beginning of this memory +/// region should be aligned on a 16-byte boundary. static __inline__ void __DEFAULT_FN_ATTRS -_fxrstor(void *__p) { +_fxrstor(void *__p) +{ return __builtin_ia32_fxrstor(__p); } #ifdef __x86_64__ +/// \brief Saves the XMM, MMX, MXCSR and x87 FPU registers into a 512-byte +/// memory region pointed to by the input parameter__p. +/// +/// \headerfile +/// +/// This intrinsic corresponds to the \c FXSAVE64 instruction. +/// +/// \param __p +/// A pointer to a 512-byte memory region. The beginning of this memory +/// region should be aligned on a 16-byte boundary. static __inline__ void __DEFAULT_FN_ATTRS -_fxsave64(void *__p) { +_fxsave64(void *__p) +{ return __builtin_ia32_fxsave64(__p); } +/// \brief Restores the XMM, MMX, MXCSR and x87 FPU registers from the 512-byte +/// memory region pointed to by the input parameter __p. The contents of this +/// memory region should have been written to by a previous _fxsave or +/// _fxsave64 intrinsic. +/// +/// \headerfile +/// +/// This intrinsic corresponds to the \c FXRSTOR64 instruction. +/// +/// \param __p +/// A pointer to a 512-byte memory region. The beginning of this memory +/// region should be aligned on a 16-byte boundary. static __inline__ void __DEFAULT_FN_ATTRS -_fxrstor64(void *__p) { +_fxrstor64(void *__p) +{ return __builtin_ia32_fxrstor64(__p); } #endif -- 2.40.0