Formerly ../hurd/hurd/userlink.h.~3~
[kopensolaris-gnu/glibc.git] / hurd / hurd / userlink.h
1 /* Support for chains recording users of a resource; `struct hurd_userlink'.
2 Copyright (C) 1994 Free Software Foundation, Inc.
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 Library General Public License for more details.
14
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB.  If
17 not, write to the Free Software Foundation, Inc., 675 Mass Ave,
18 Cambridge, MA 02139, USA.  */
19
20 #ifndef _HURD_USERLINK_H
21
22 #define _HURD_USERLINK_H        1
23 #include <features.h>
24
25 #define __need_NULL
26 #include <stddef.h>
27
28
29 /* This structure is simply a doubly-linked list.  Users of a given
30    resource are recorded by their presence in a list associated with that
31    resource.  A user attaches his own link (in local storage) to a shared
32    chain at the time he begins using some resource.  When finished with
33    that resource, the user removes his link from the chain.  If his link is
34    the last (there are no other users of the resource), and his chain has
35    been detached from the shared cell (the resource in the cell has been
36    replaced), then the user deallocates the resource that he used.  */
37
38 struct hurd_userlink
39   {
40     struct hurd_userlink *next, **prevp;
41   };
42
43
44 /* Attach LINK to the chain of users at *CHAINP.  */
45
46 extern inline void
47 _hurd_userlink_link (struct hurd_userlink **chainp,
48                      struct hurd_userlink *link)
49 {
50   link->next = *chainp;
51   if (link->next)
52     link->next->prevp = &link->next;
53   link->prevp = chainp;
54   *chainp = link;
55 }
56
57
58 /* Detach LINK from its chain.  If the return value is nonzero, the caller
59    should deallocate the resource he started using after attaching LINK to
60    the chain it's on.  If the return value is zero, then someone else is
61    still using the resource.  */
62
63 extern inline int
64 _hurd_userlink_unlink (struct hurd_userlink *link)
65 {
66   /* The caller should deallocate the resource he used if his chain has
67      been detached from the cell (and thus has a nil `prevp'), and there is
68      no next link representing another user reference to the same resource. */
69   int dealloc = ! link->next && ! link->prevp;
70
71   /* Remove our link from the chain of current users.  */
72   if (link->prevp)
73     *link->prevp = link->next;
74   if (link->next)
75     link->next->prevp = link->prevp;
76
77   return dealloc;
78 }
79
80
81 /* Clear all users from *CHAINP.  Call this when the resource *CHAINP
82    protects is changing.  If the return value is nonzero, no users are on
83    the chain and the caller should deallocate the resource.  If the return
84    value is zero, someone is still using the resource and they will
85    deallocate it when they are finished.  */
86
87 extern inline int
88 _hurd_userlink_clear (struct hurd_userlink **chainp)
89 {
90   if (*chainp == NULL)
91     return 1;
92
93   /* Detach the chain of current users from the cell.  The last user to
94      remove his link from that chain will deallocate the old resource.  */
95   (*chainp)->prevp = NULL;
96   *chainp = NULL;
97   return 0;
98 }
99
100 #endif  /* hurd/userlink.h */