Formerly ../hurd/hurd/threadvar.h.~4~
[kopensolaris-gnu/glibc.git] / hurd / hurd / port.h
1 /* Lightweight user references for ports.
2 Copyright (C) 1993, 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_PORT_H
21
22 #define _HURD_PORT_H    1
23 #include <features.h>
24
25 #include <mach.h>
26 #include <hurd/userlink.h>
27 #include <spin-lock.h>
28
29
30 /* Structure describing a cell containing a port.  With the lock held, a
31    user extracts PORT, and attaches his own link (in local storage) to the
32    USERS chain.  PORT can then safely be used.  When PORT is no longer
33    needed, with the lock held, the user removes his link from the chain.
34    If his link is the last, and PORT has changed since he fetched it, the
35    user deallocates the port he used.  See <hurd/userlink.h>.  */
36
37 struct hurd_port
38   {
39     spin_lock_t lock;           /* Locks rest.  */
40     struct hurd_userlink *users; /* Chain of users; see below.  */
41     mach_port_t port;           /* Port. */
42   };
43
44
45 /* Evaluate EXPR with the variable `port' bound to the port in PORTCELL.  */
46
47 #define HURD_PORT_USE(portcell, expr)                                         \
48   ({ struct hurd_port *const __p = (portcell);                                \
49      struct hurd_userlink __link;                                             \
50      const mach_port_t port = _hurd_port_get (__p, &__link);                  \
51      __typeof(expr) __result = (expr);                                        \
52      _hurd_port_free (__p, &__link, port);                                    \
53      __result; })
54
55
56 #ifndef _EXTERN_INLINE
57 #define _EXTERN_INLINE extern __inline
58 #endif
59
60
61 /* Initialize *PORT to INIT.  */
62
63 _EXTERN_INLINE void
64 _hurd_port_init (struct hurd_port *port, mach_port_t init)
65 {
66   __spin_lock_init (&port->lock);
67   port->users = NULL;
68   port->port = init;
69 }
70
71
72 /* Get a reference to *PORT, which is locked.
73    Pass return value and LINK to _hurd_port_free when done.  */
74
75 _EXTERN_INLINE mach_port_t
76 _hurd_port_locked_get (struct hurd_port *port,
77                        struct hurd_userlink *link)
78 {
79   mach_port_t result;
80   result = port->port;
81   if (result != MACH_PORT_NULL)
82     _hurd_userlink_link (&port->users, link);
83   __spin_unlock (&port->lock);
84   return result;
85 }
86
87 /* Same, but locks PORT first.  */
88
89 _EXTERN_INLINE mach_port_t
90 _hurd_port_get (struct hurd_port *port,
91                 struct hurd_userlink *link)
92 {
93   __spin_lock (&port->lock);
94   return _hurd_port_locked_get (port, link);
95 }
96
97
98 /* Free a reference gotten with `USED_PORT = _hurd_port_get (PORT, LINK);' */
99
100 _EXTERN_INLINE void
101 _hurd_port_free (struct hurd_port *port,
102                  struct hurd_userlink *link,
103                  mach_port_t used_port)
104 {
105   int dealloc;
106   if (used_port == MACH_PORT_NULL)
107     /* When we fetch an empty port cell with _hurd_port_get,
108        it does not link us on the users chain, since there is
109        no shared resource.  */
110     return;
111   __spin_lock (&port->lock);
112   dealloc = _hurd_userlink_unlink (link);
113   __spin_unlock (&port->lock);
114   if (dealloc)
115     __mach_port_deallocate (__mach_task_self (), used_port);
116 }
117
118
119 /* Set *PORT's port to NEWPORT.  NEWPORT's reference is consumed by PORT->port.
120    PORT->lock is locked.  */
121
122 _EXTERN_INLINE void
123 _hurd_port_locked_set (struct hurd_port *port, mach_port_t newport)
124 {
125   mach_port_t old;
126   old = _hurd_userlink_clear (&port->users) ? port->port : MACH_PORT_NULL;
127   port->port = newport;
128   __spin_unlock (&port->lock);
129   if (old != MACH_PORT_NULL)
130     __mach_port_deallocate (__mach_task_self (), old);
131 }
132
133 /* Same, but locks PORT first.  */
134
135 _EXTERN_INLINE void
136 _hurd_port_set (struct hurd_port *port, mach_port_t newport)
137 {
138   __spin_lock (&port->lock);
139   return _hurd_port_locked_set (port, newport);
140 }
141
142
143 #endif  /* hurd/port.h */