1  /* Copyright (C) 2012-2023 Free Software Foundation, Inc.
       2  
       3     This file is part of GCC.
       4  
       5     GCC is free software; you can redistribute it and/or modify
       6     it under the terms of the GNU General Public License as published by
       7     the Free Software Foundation; either version 3, or (at your option)
       8     any later version.
       9  
      10     GCC is distributed in the hope that it will be useful,
      11     but WITHOUT ANY WARRANTY; without even the implied warranty of
      12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      13     GNU General Public License for more details.
      14  
      15     Under Section 7 of GPL version 3, you are granted additional
      16     permissions described in the GCC Runtime Library Exception, version
      17     3.1, as published by the Free Software Foundation.
      18  
      19     You should have received a copy of the GNU General Public License and
      20     a copy of the GCC Runtime Library Exception along with this program;
      21     see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
      22     <http://www.gnu.org/licenses/>.  */
      23  
      24  #ifndef _X86GPRINTRIN_H_INCLUDED
      25  # error "Never use <rtmintrin.h> directly; include <x86gprintrin.h> instead."
      26  #endif
      27  
      28  #ifndef _RTMINTRIN_H_INCLUDED
      29  #define _RTMINTRIN_H_INCLUDED
      30  
      31  #ifndef __RTM__
      32  #pragma GCC push_options
      33  #pragma GCC target("rtm")
      34  #define __DISABLE_RTM__
      35  #endif /* __RTM__ */
      36  
      37  #define _XBEGIN_STARTED		(~0u)
      38  #define _XABORT_EXPLICIT	(1 << 0)
      39  #define _XABORT_RETRY		(1 << 1)
      40  #define _XABORT_CONFLICT	(1 << 2)
      41  #define _XABORT_CAPACITY	(1 << 3)
      42  #define _XABORT_DEBUG		(1 << 4)
      43  #define _XABORT_NESTED		(1 << 5)
      44  #define _XABORT_CODE(x)		(((x) >> 24) & 0xFF)
      45  
      46  /* Start an RTM code region.  Return _XBEGIN_STARTED on success and the
      47     abort condition otherwise.  */
      48  extern __inline unsigned int
      49  __attribute__((__gnu_inline__, __always_inline__, __artificial__))
      50  _xbegin (void)
      51  {
      52    return __builtin_ia32_xbegin ();
      53  }
      54  
      55  /* Specify the end of an RTM code region.  If it corresponds to the
      56     outermost transaction, then attempts the transaction commit.  If the
      57     commit fails, then control is transferred to the outermost transaction
      58     fallback handler.  */
      59  extern __inline void
      60  __attribute__((__gnu_inline__, __always_inline__, __artificial__))
      61  _xend (void)
      62  {
      63    __builtin_ia32_xend ();
      64  }
      65  
      66  /* Force an RTM abort condition. The control is transferred to the
      67     outermost transaction fallback handler with the abort condition IMM.  */
      68  #ifdef __OPTIMIZE__
      69  extern __inline void
      70  __attribute__((__gnu_inline__, __always_inline__, __artificial__))
      71  _xabort (const unsigned int __imm)
      72  {
      73    __builtin_ia32_xabort (__imm);
      74  }
      75  #else
      76  #define _xabort(N)  __builtin_ia32_xabort (N)
      77  #endif /* __OPTIMIZE__ */
      78  
      79  #ifdef __DISABLE_RTM__
      80  #undef __DISABLE_RTM__
      81  #pragma GCC pop_options
      82  #endif /* __DISABLE_RTM__ */
      83  
      84  #endif /* _RTMINTRIN_H_INCLUDED */