include/osl/interlck.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_OSL_INTERLCK_H
  21 #define INCLUDED_OSL_INTERLCK_H
  22
  23 #include <sal/config.h>
  24
  25 #include <sal/saldllapi.h>
  26 #include <sal/types.h>
  27
  28 #if defined(_WIN32)
  29 #include <intrin.h>
  30 #endif
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef sal_Int32 oslInterlockedCount;
  37
  38 /** Increments the count variable addressed by pCount.
  39     @param pCount Address of count variable
  40     @return The adjusted value of the count variable.
  41 */
  42 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_incrementInterlockedCount(oslInterlockedCount* pCount);
  43
  44 /** Decrement the count variable addressed by pCount.
  45     @param pCount Address of count variable
  46     @return The adjusted value of the count variable.
  47 */
  48 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_decrementInterlockedCount(oslInterlockedCount* pCount);
  49
  50
  51 /// @cond INTERNAL
  52
  53 /** Increments the count variable addressed by p.
  54
  55     @attention This functionality should only be used internally within
  56     LibreOffice.
  57
  58     @param p Address of count variable
  59     @return The adjusted value of the count variable.
  60
  61     @since LibreOffice 4.0
  62 */
  63 #if HAVE_GCC_BUILTIN_ATOMIC
  64 #    define osl_atomic_increment(p)  __sync_add_and_fetch((p), 1)
  65 #elif defined WNT
  66 #    define osl_atomic_increment(p)  _InterlockedIncrement(p)
  67 #else
  68 #    define osl_atomic_increment(p) osl_incrementInterlockedCount((p))
  69 #endif
  70
  71
  72 /** Decrement the count variable addressed by p.
  73
  74     @attention This functionality should only be used internally within
  75     LibreOffice.
  76
  77     @param p Address of count variable
  78     @return The adjusted value of the count variable.
  79
  80     @since LibreOffice 4.0
  81 */
  82 #if HAVE_GCC_BUILTIN_ATOMIC
  83 #    define osl_atomic_decrement(p) __sync_sub_and_fetch((p), 1)
  84 #elif defined WNT
  85 #    define osl_atomic_decrement(p)  _InterlockedDecrement(p)
  86 #else
  87 #    define osl_atomic_decrement(p) osl_decrementInterlockedCount((p))
  88 #endif
  89
  90 /// @endcond
  91
  92 #ifdef __cplusplus
  93 }
  94 #endif
  95
  96
  97 #endif // INCLUDED_OSL_INTERLCK_H
  98
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */