← Back to branch summary

~ubuntu-branches/ubuntu/trusty/xulrunner/trusty

« back to all changes in this revision

Viewing changes to security/nss-fips/lib/util/nssrwlk.h

  • Committer: Bazaar Package Importer
  • Author(s): Devid Antonio Filoni
  • Date: 2008-08-25 13:04:18 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20080825130418-ck1i2ms384tzb9m0
Tags: 1.8.1.16+nobinonly-0ubuntu1
https://launchpad.net/bugs/254618
* New upstream release (taken from upstream CVS), LP: #254618.
* Fix MFSA 2008-35, MFSA 2008-34, MFSA 2008-33, MFSA 2008-32, MFSA 2008-31,
  MFSA 2008-30, MFSA 2008-29, MFSA 2008-28, MFSA 2008-27, MFSA 2008-25,
  MFSA 2008-24, MFSA 2008-23, MFSA 2008-22, MFSA 2008-21, MFSA 2008-26 also
  known as CVE-2008-2933, CVE-2008-2785, CVE-2008-2811, CVE-2008-2810,
  CVE-2008-2809, CVE-2008-2808, CVE-2008-2807, CVE-2008-2806, CVE-2008-2805,
  CVE-2008-2803, CVE-2008-2802, CVE-2008-2801, CVE-2008-2800, CVE-2008-2798.
* Drop 89_bz419350_attachment_306066 patch, merged upstream.
* Bump Standards-Version to 3.8.0.

Show diffs side-by-side

added added

removed removed

Lines of Context:
security/nss-fips/lib/util/nssrwlk.h
 
1
/* ***** BEGIN LICENSE BLOCK *****
 
2
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 
3
 *
 
4
 * The contents of this file are subject to the Mozilla Public License Version
 
5
 * 1.1 (the "License"); you may not use this file except in compliance with
 
6
 * the License. You may obtain a copy of the License at
 
7
 * http://www.mozilla.org/MPL/
 
8
 *
 
9
 * Software distributed under the License is distributed on an "AS IS" basis,
 
10
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
11
 * for the specific language governing rights and limitations under the
 
12
 * License.
 
13
 *
 
14
 * The Original Code is the Netscape security libraries.
 
15
 *
 
16
 * The Initial Developer of the Original Code is
 
17
 * Netscape Communications Corporation.
 
18
 * Portions created by the Initial Developer are Copyright (C) 1994-2000
 
19
 * the Initial Developer. All Rights Reserved.
 
20
 *
 
21
 * Contributor(s):
 
22
 *
 
23
 * Alternatively, the contents of this file may be used under the terms of
 
24
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
25
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
26
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
27
 * of those above. If you wish to allow use of your version of this file only
 
28
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
29
 * use your version of this file under the terms of the MPL, indicate your
 
30
 * decision by deleting the provisions above and replace them with the notice
 
31
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
32
 * the provisions above, a recipient may use your version of this file under
 
33
 * the terms of any one of the MPL, the GPL or the LGPL.
 
34
 *
 
35
 * ***** END LICENSE BLOCK ***** */
 
36
 
 
37
/*
 
38
** File:                nsrwlock.h
 
39
** Description: API to basic reader-writer lock functions of NSS.
 
40
**      These are re-entrant reader writer locks; that is,
 
41
**      If I hold the write lock, I can ask for it and get it again.
 
42
**      If I hold the write lock, I can also ask for and get a read lock.
 
43
**      I can then release the locks in any order (read or write).
 
44
**      I must release each lock type as many times as I acquired it.
 
45
**      Otherwise, these are normal reader/writer locks.
 
46
**
 
47
** For deadlock detection, locks should be ranked, and no lock may be aquired
 
48
** while I hold a lock of higher rank number.
 
49
** If you don't want that feature, always use NSS_RWLOCK_RANK_NONE.
 
50
** Lock name is for debugging, and is optional (may be NULL)
 
51
**/
 
52
 
 
53
#ifndef nssrwlk_h___
 
54
#define nssrwlk_h___
 
55
 
 
56
#include "prtypes.h"
 
57
#include "nssrwlkt.h"
 
58
 
 
59
#define NSS_RWLOCK_RANK_NONE    0
 
60
 
 
61
/* SEC_BEGIN_PROTOS */
 
62
PR_BEGIN_EXTERN_C
 
63
 
 
64
/***********************************************************************
 
65
** FUNCTION:    NSSRWLock_New
 
66
** DESCRIPTION:
 
67
**  Returns a pointer to a newly created reader-writer lock object.
 
68
** INPUTS:      Lock rank
 
69
**              Lock name
 
70
** OUTPUTS:     void
 
71
** RETURN:      NSSRWLock*
 
72
**   If the lock cannot be created because of resource constraints, NULL
 
73
**   is returned.
 
74
**  
 
75
***********************************************************************/
 
76
PR_EXTERN(NSSRWLock*) NSSRWLock_New(PRUint32 lock_rank, const char *lock_name);
 
77
 
 
78
/***********************************************************************
 
79
** FUNCTION:    NSSRWLock_AtomicCreate
 
80
** DESCRIPTION:
 
81
**  Given the address of a NULL pointer to a NSSRWLock, 
 
82
**  atomically initializes that pointer to a newly created NSSRWLock.
 
83
**  Returns the value placed into that pointer, or NULL.
 
84
**
 
85
** INPUTS:      address of NSRWLock pointer
 
86
**              Lock rank
 
87
**              Lock name
 
88
** OUTPUTS:     NSSRWLock*
 
89
** RETURN:      NSSRWLock*
 
90
**   If the lock cannot be created because of resource constraints, 
 
91
**   the pointer will be left NULL.
 
92
**  
 
93
***********************************************************************/
 
94
PR_EXTERN(NSSRWLock *)
 
95
nssRWLock_AtomicCreate( NSSRWLock  ** prwlock, 
 
96
                        PRUint32      lock_rank, 
 
97
                        const char *  lock_name);
 
98
 
 
99
/***********************************************************************
 
100
** FUNCTION:    NSSRWLock_Destroy
 
101
** DESCRIPTION:
 
102
**  Destroys a given RW lock object.
 
103
** INPUTS:      NSSRWLock *lock - Lock to be freed.
 
104
** OUTPUTS:     void
 
105
** RETURN:      None
 
106
***********************************************************************/
 
107
PR_EXTERN(void) NSSRWLock_Destroy(NSSRWLock *lock);
 
108
 
 
109
/***********************************************************************
 
110
** FUNCTION:    NSSRWLock_LockRead
 
111
** DESCRIPTION:
 
112
**  Apply a read lock (non-exclusive) on a RWLock
 
113
** INPUTS:      NSSRWLock *lock - Lock to be read-locked.
 
114
** OUTPUTS:     void
 
115
** RETURN:      None
 
116
***********************************************************************/
 
117
PR_EXTERN(void) NSSRWLock_LockRead(NSSRWLock *lock);
 
118
 
 
119
/***********************************************************************
 
120
** FUNCTION:    NSSRWLock_LockWrite
 
121
** DESCRIPTION:
 
122
**  Apply a write lock (exclusive) on a RWLock
 
123
** INPUTS:      NSSRWLock *lock - Lock to write-locked.
 
124
** OUTPUTS:     void
 
125
** RETURN:      None
 
126
***********************************************************************/
 
127
PR_EXTERN(void) NSSRWLock_LockWrite(NSSRWLock *lock);
 
128
 
 
129
/***********************************************************************
 
130
** FUNCTION:    NSSRWLock_UnlockRead
 
131
** DESCRIPTION:
 
132
**  Release a Read lock. Unlocking an unlocked lock has undefined results.
 
133
** INPUTS:      NSSRWLock *lock - Lock to unlocked.
 
134
** OUTPUTS:     void
 
135
** RETURN:      void
 
136
***********************************************************************/
 
137
PR_EXTERN(void) NSSRWLock_UnlockRead(NSSRWLock *lock);
 
138
 
 
139
/***********************************************************************
 
140
** FUNCTION:    NSSRWLock_UnlockWrite
 
141
** DESCRIPTION:
 
142
**  Release a Write lock. Unlocking an unlocked lock has undefined results.
 
143
** INPUTS:      NSSRWLock *lock - Lock to unlocked.
 
144
** OUTPUTS:     void
 
145
** RETURN:      void
 
146
***********************************************************************/
 
147
PR_EXTERN(void) NSSRWLock_UnlockWrite(NSSRWLock *lock);
 
148
 
 
149
/***********************************************************************
 
150
** FUNCTION:    NSSRWLock_HaveWriteLock
 
151
** DESCRIPTION:
 
152
**  Tells caller whether the current thread holds the write lock, or not.
 
153
** INPUTS:      NSSRWLock *lock - Lock to test.
 
154
** OUTPUTS:     void
 
155
** RETURN:      PRBool  PR_TRUE IFF the current thread holds the write lock.
 
156
***********************************************************************/
 
157
 
 
158
PR_EXTERN(PRBool) NSSRWLock_HaveWriteLock(NSSRWLock *rwlock);
 
159
 
 
160
/* SEC_END_PROTOS */
 
161
PR_END_EXTERN_C
 
162
 
 
163
#endif /* nsrwlock_h___ */