include/yaz/mutex.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file mutex.h
  30  * \brief Header for Mutex functions
  31  */
  32 #ifndef YAZ_MUTEX_H
  33 #define YAZ_MUTEX_H
  34
  35 #include <stddef.h>
  36 #include <time.h>
  37 #include <yaz/yconfig.h>
  38
  39 YAZ_BEGIN_CDECL
  40
  41 /** \brief YAZ MUTEX opaque pointer */
  42 typedef struct yaz_mutex *YAZ_MUTEX;
  43
  44 /** \brief YAZ condition opaque pointer */
  45 typedef struct yaz_cond *YAZ_COND;
  46
  47 /** \brief create MUTEX
  48     \param mutexp is pointer to MUTEX handle (*mutexp must be NULL)
  49
  50     It is important that *mutexp is NULL. If not, yaz_mutex_create will
  51     not modify the handle (assumes it is already created!)
  52  */
  53 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *mutexp);
  54
  55 /** \brief enter critical section / AKA lock
  56     \param mutex MUTEX handle
  57  */
  58 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX mutex);
  59
  60
  61 /** \brief leave critical section / AKA unlock
  62     \param mutex MUTEX handle
  63  */
  64 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX mutex);
  65
  66
  67 /** \brief destroy MUTEX
  68     \param mutexp pointer to MUTEX handle
  69
  70     If *mutexp is NULL, then this function does nothing.
  71  */
  72 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *mutexp);
  73
  74
  75 /** \brief sets name of MUTEX for debugging purposes
  76     \param mutex MUTEX handle
  77     \param log_level YAZ log level
  78     \param name user-given name associated with MUTEX
  79
  80     If log_level != 0 and name != 0 this function will make yaz_mutex_enter
  81     and yaz_mutex_leave print information for each invocation using yaz_log
  82     with the level given. In particular when YAZ is compiled with pthreads,
  83     yaz_mutex_enter will inform if a lock is not immediately acquired.
  84     This function should be called after a MUTEX is created but before
  85     it is used for locking.
  86  */
  87 void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name);
  88
  89 /** \brief creates condition variable
  90     \param p reference to condition handle
  91
  92     Upon successful completion *p holds the condition handle; *p = 0
  93     on error.
  94 */
  95 void yaz_cond_create(YAZ_COND *p);
  96
  97 /** \brief destroys condition variable
  98     \param p reference to condition handle
  99
 100     Upon completion *p holds 0.
 101 */
 102 void yaz_cond_destroy(YAZ_COND *p);
 103
 104 /** \brief waits for condition
 105     \param p condition variable handle
 106     \param m mutex
 107     \param abstime wait until this time; 0 for indefinite wait
 108
 109     Semantics like pthread_cond_wait.
 110 */
 111 int yaz_cond_wait(YAZ_COND p, YAZ_MUTEX m, const struct timespec *abstime);
 112
 113 /** \brief unblock one thread waiting for block
 114     \param p condition variable handle
 115 */
 116 int yaz_cond_signal(YAZ_COND p);
 117
 118 /** \brief unblock all threads waiting for block
 119     \param p condition variable handle
 120 */
 121 int yaz_cond_broadcast(YAZ_COND p);
 122
 123 YAZ_END_CDECL
 124
 125 #endif
 126 /*
 127  * Local variables:
 128  * c-basic-offset: 4
 129  * c-file-style: "Stroustrup"
 130  * indent-tabs-mode: nil
 131  * End:
 132  * vim: shiftwidth=4 tabstop=8 expandtab
 133  */
 134