f803e720e0e69f9ed491bd5894490eb376eb8f58
[sip-router] / locking.h
1 /* $Id$ */
2 /*
3  *
4  * Copyright (C) 2001-2003 Fhg Fokus
5  *
6  * This file is part of ser, a free SIP server.
7  *
8  * ser is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * For a license to use the ser software under conditions
14  * other than those described here, or to purchase support for this
15  * software, please contact iptel.org by e-mail at the following addresses:
16  *    info@iptel.org
17  *
18  * ser is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License 
24  * along with this program; if not, write to the Free Software 
25  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26  */
27
28 /*
29  *   ser locking library
30  *
31  *  2002-12-16  created by andrei
32  *  2003-02-20  s/gen_lock_t/gen_lock_t/ to avoid a type conflict 
33  *               on solaris  (andrei)
34  *  2003-03-05  lock set support added for FAST_LOCK & SYSV (andrei)
35  *  2003-03-06  splited in two: lock_ops.h & lock_alloc.h, to avoid
36  *               shm_mem.h<->locking.h interdependency (andrei)
37  *  2004-07-28  s/lock_set_t/gen_lock_set_t/ because of a type conflict
38  *              on darwin (andrei)
39  *
40 Implements (in lock_ops.h & lock_alloc.h):
41
42         simple locks:
43         -------------
44         type: gen_lock_t
45         gen_lock_t* lock_alloc();                - allocates a lock in shared mem.
46         gen_lock_t* lock_init(gen_lock_t* lock); - inits the lock
47         void    lock_destroy(gen_lock_t* lock);  - removes the lock (e.g sysv rmid)
48         void    lock_dealloc(gen_lock_t* lock);  - deallocates the lock's shared m.
49         void    lock_get(gen_lock_t* lock);      - lock (mutex down)
50         void    lock_release(gen_lock_t* lock);  - unlock (mutex up)
51         
52         lock sets:
53         ----------
54         type: gen_lock_set_t
55         gen_lock_set_t* lock_set_alloc(no)               - allocs a lock set in shm.
56         gen_lock_set_t* lock_set_init(gen_lock_set_t* set);  - inits the lock set
57         void lock_set_destroy(gen_lock_set_t* s);        - removes the lock set
58         void lock_set_dealloc(gen_lock_set_t* s);        - deallocs the lock set shm.
59         void lock_set_get(gen_lock_set_t* s, int i);     - locks sem i from the set
60         void lock_set_release(gen_lock_set_t* s, int i)  - unlocks sem i from the set
61
62 WARNING: - lock_set_init may fail for large number of sems (e.g. sysv). 
63          - signals are not treated! (some locks are "awakened" by the signals)
64 */
65
66 #ifndef _locking_h
67 #define _locking_h
68
69 /* the order is important */
70 #include "lock_ops.h"
71 #include "lock_alloc.h" 
72
73 #endif