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 create MUTEX with custom MUTEX flags
  56     \param mutexp is pointer to MUTEX handle (*mutexp must be NULL)
  57     \param attr is flags defined by PTHREAD_MUTEX_xxx
  58
  59     It is important that *mutexp is NULL. If not, yaz_mutex_create will
  60     not modify the handle (assumes it is already created!)
  61
  62     This calls yax_mutex_create_attr(mutexp, PTHREAD_MUTEX_NORMAL)
  63  */
  64 YAZ_EXPORT void yaz_mutex_create_attr(YAZ_MUTEX *mutexp, int flags);
  65
  66 /** \brief enter critical section / AKA lock
  67     \param mutex MUTEX handle
  68  */
  69 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX mutex);
  70
  71
  72 /** \brief leave critical section / AKA unlock
  73     \param mutex MUTEX handle
  74  */
  75 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX mutex);
  76
  77
  78 /** \brief destroy MUTEX
  79     \param mutexp pointer to MUTEX handle
  80
  81     If *mutexp is NULL, then this function does nothing.
  82  */
  83 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *mutexp);
  84
  85
  86 /** \brief sets name of MUTEX for debugging purposes
  87     \param mutex MUTEX handle
  88     \param log_level YAZ log level
  89     \param name user-given name associated with MUTEX
  90
  91     If log_level != 0 and name != 0 this function will make yaz_mutex_enter
  92     and yaz_mutex_leave print information for each invocation using yaz_log
  93     with the level given. In particular when YAZ is compiled with pthreads,
  94     yaz_mutex_enter will inform if a lock is not immediately acquired.
  95     This function should be called after a MUTEX is created but before
  96     it is used for locking.
  97  */
  98 YAZ_EXPORT
  99 void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name);
 100
 101 /** \brief creates condition variable
 102     \param p reference to condition handle
 103
 104     Upon successful completion *p holds the condition handle; *p = 0
 105     on error.
 106 */
 107 YAZ_EXPORT void yaz_cond_create(YAZ_COND *p);
 108
 109 /** \brief destroys condition variable
 110     \param p reference to condition handle
 111
 112     Upon completion *p holds 0.
 113 */
 114 YAZ_EXPORT
 115 void yaz_cond_destroy(YAZ_COND *p);
 116
 117 struct timeval;
 118
 119 /** \brief waits for condition
 120     \param p condition variable handle
 121     \param m mutex
 122     \param abstime wait until this time; 0 for indefinite wait
 123
 124     Semantics like pthread_cond_wait.
 125 */
 126 YAZ_EXPORT
 127 int yaz_cond_wait(YAZ_COND p, YAZ_MUTEX m, const struct timeval *abstime);
 128
 129 /** \brief unblock one thread waiting for block
 130     \param p condition variable handle
 131 */
 132 YAZ_EXPORT
 133 int yaz_cond_signal(YAZ_COND p);
 134
 135 /** \brief unblock all threads waiting for block
 136     \param p condition variable handle
 137 */
 138 YAZ_EXPORT
 139 int yaz_cond_broadcast(YAZ_COND p);
 140
 141 YAZ_END_CDECL
 142
 143 #endif
 144 /*
 145  * Local variables:
 146  * c-basic-offset: 4
 147  * c-file-style: "Stroustrup"
 148  * indent-tabs-mode: nil
 149  * End:
 150  * vim: shiftwidth=4 tabstop=8 expandtab
 151  */
 152