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