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 #if defined LIBO_INTERNAL_ONLY
  33 #include "config_global.h"
  34 #endif
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef sal_Int32 oslInterlockedCount;
  41
  42 /** Increments the count variable addressed by pCount.
  43     @param pCount Address of count variable
  44     @return The adjusted value of the count variable.
  45 */
  46 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_incrementInterlockedCount(oslInterlockedCount* pCount);
  47
  48 /** Decrement the count variable addressed by pCount.
  49     @param pCount Address of count variable
  50     @return The adjusted value of the count variable.
  51 */
  52 SAL_DLLPUBLIC oslInterlockedCount SAL_CALL osl_decrementInterlockedCount(oslInterlockedCount* pCount);
  53
  54
  55 /// @cond INTERNAL
  56
  57 /** Increments the count variable addressed by p.
  58
  59     @attention This functionality should only be used internally within
  60     LibreOffice.
  61
  62     @param p Address of count variable
  63     @return The adjusted value of the count variable.
  64
  65     @since LibreOffice 4.0
  66 */
  67 #if HAVE_GCC_BUILTIN_ATOMIC
  68 #    define osl_atomic_increment(p)  __sync_add_and_fetch((p), 1)
  69 #elif defined WNT
  70 #    define osl_atomic_increment(p)  _InterlockedIncrement(p)
  71 #else
  72 #    define osl_atomic_increment(p) osl_incrementInterlockedCount((p))
  73 #endif
  74
  75
  76 /** Decrement the count variable addressed by p.
  77
  78     @attention This functionality should only be used internally within
  79     LibreOffice.
  80
  81     @param p Address of count variable
  82     @return The adjusted value of the count variable.
  83
  84     @since LibreOffice 4.0
  85 */
  86 #if HAVE_GCC_BUILTIN_ATOMIC
  87 #    define osl_atomic_decrement(p) __sync_sub_and_fetch((p), 1)
  88 #elif defined WNT
  89 #    define osl_atomic_decrement(p)  _InterlockedDecrement(p)
  90 #else
  91 #    define osl_atomic_decrement(p) osl_decrementInterlockedCount((p))
  92 #endif
  93
  94 /// @endcond
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99
 100
 101 #endif // INCLUDED_OSL_INTERLCK_H
 102
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */