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