gcc/ada/libgnat/s-atopex.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT RUN-TIME COMPONENTS                         --
   4 --                                                                          --
   5 --                    System.Atomic_Operations.Exchange                     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --                 Copyright (C) 2019-2024, Free Software Foundation, Inc.  --
  10 --                                                                          --
  11 -- This specification is derived from the Ada Reference Manual for use with --
  12 -- GNAT. The copyright notice above, and the license provisions that follow --
  13 -- apply solely to the  contents of the part following the private keyword. --
  14 --                                                                          --
  15 -- GNAT is free software;  you can  redistribute it  and/or modify it under --
  16 -- terms of the  GNU General Public License as published  by the Free Soft- --
  17 -- ware  Foundation;  either version 3,  or (at your option) any later ver- --
  18 -- sion.  GNAT is distributed in the hope that it will be useful, but WITH- --
  19 -- OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY --
  20 -- or FITNESS FOR A PARTICULAR PURPOSE.                                     --
  21 --                                                                          --
  22 -- As a special exception under Section 7 of GPL version 3, you are granted --
  23 -- additional permissions described in the GCC Runtime Library Exception,   --
  24 -- version 3.1, as published by the Free Software Foundation.               --
  25 --                                                                          --
  26 -- You should have received a copy of the GNU General Public License and    --
  27 -- a copy of the GCC Runtime Library Exception along with this program;     --
  28 -- see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see    --
  29 -- <http://www.gnu.org/licenses/>.                                          --
  30 --                                                                          --
  31 -- GNAT was originally developed  by the GNAT team at  New York University. --
  32 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  33 --                                                                          --
  34 ------------------------------------------------------------------------------
  35
  36 generic
  37    type Atomic_Type is private with Atomic;
  38 package System.Atomic_Operations.Exchange
  39   with Pure
  40 is
  41    function Atomic_Exchange
  42      (Item  : aliased in out Atomic_Type;
  43       Value : Atomic_Type) return Atomic_Type with Convention => Intrinsic;
  44
  45    function Atomic_Compare_And_Exchange
  46      (Item    : aliased in out Atomic_Type;
  47       Prior   : aliased in out Atomic_Type;
  48       Desired : Atomic_Type) return Boolean with Convention => Intrinsic;
  49
  50    function Is_Lock_Free
  51      (Item : aliased Atomic_Type) return Boolean with Convention => Intrinsic;
  52
  53 private
  54    pragma Inline_Always (Atomic_Exchange);
  55    pragma Inline_Always (Atomic_Compare_And_Exchange);
  56    pragma Inline_Always (Is_Lock_Free);
  57 end System.Atomic_Operations.Exchange;