1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/* FS helper library definitions
Copyright (C) 1994, 1995 Free Software Foundation
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
#ifndef _HURD_FSHELP_
#define _HURD_FSHELP_
/* This library implements various things that are generic to
all or most implementors of the filesystem protocol. It
presumes that you are using the iohelp library as well. It
is divided into separate facilities which may be used independently. */
#include <errno.h>
#include <mach.h>
#include <hurd/hurd_types.h>
#include <cthreads.h>
/* Passive translator linkage */
/* These routines are self-contained and start passive translators,
returning the control port. They do not require multi threading
or the ports library. */
/* A callback used by the translator starting functions, which should be a
function that given some open flags, opens the appropiate file, and
returns the node port. */
typedef error_t (*fshelp_open_fn_t) (int flags,
file_t *node,
mach_msg_type_name_t *node_type);
/* Start a passive translator NAME with arguments ARGZ (length
ARGZ_LEN). Initialize the initports to PORTS (length PORTS_LEN),
the initints to INTS (length INTS_LEN), and the file descriptor
table to FDS (length FDS_LEN). Return the control port in
*CONTROL. If the translator doesn't respond or die in TIMEOUT
milliseconds (if TIMEOUT > 0), return an appropriate error. If the
translator dies before responding, return EDIED. */
error_t
fshelp_start_translator_long (fshelp_open_fn_t underlying_open_fn,
char *name, char *argz, int argz_len,
mach_port_t *fds,
mach_msg_type_name_t fds_type, int fds_len,
mach_port_t *ports,
mach_msg_type_name_t ports_type, int ports_len,
int *ints, int ints_len,
int timeout, fsys_t *control);
/* Same as fshelp_start_translator_long, except the initports and ints
are copied from our own state, fd[2] is copied from our own stderr,
and the other fds are cleared. */
error_t
fshelp_start_translator (fshelp_open_fn_t underlying_open_fn,
char *name, char *argz, int argz_len,
int timeout, fsys_t *control);
/* Active translator linkage */
/* These routines implement the linkage to active translators needed
by any filesystem which supports them. They require cthreads and
use the passive translator routines above, but they don't require
the ports library at all. */
struct transbox
{
fsys_t active;
struct mutex *lock;
int flags;
struct condition wakeup;
void *cookie;
};
#define TRANSBOX_STARTING 1
#define TRANSBOX_WANTED 2
/* This interface is complex, because creating the ports and state
necessary for start_translator_long is expensive. The caller to
fshelp_fetch_root should not need to create them on every call, since
usually there will be an existing active translator. */
/* This routine is called by fshelp_fetch_root to fetch more information.
Return the owner and group of the underlying translated file in *UID and
*GID; point *ARGZ at the entire passive translator spec for the file
(setting *ARGZ_LEN to the length.) If there is no passive translator,
then return ENOENT. COOKIE1 is the cookie passed in fshelp_transbox_init.
COOKIE2 is the cookie passed in the call to fshelp_fetch_root. */
typedef error_t (*fshelp_fetch_root_callback1_t) (void *cookie1, void *cookie2,
uid_t *uid, gid_t *gid,
char **argz, int *argz_len);
/* This routine is called by fshelp_fetch_root to fetch more information.
Return an unauthenticated node for the file itself in *UNDERLYING and
*UNDERLYING_TYPE (opened with FLAGS). COOKIE1 is the cookie passed in
fshelp_transbox_init. COOKIE2 is the cookie passed in the call to
fshelp_fetch_root. */
typedef error_t (*fshelp_fetch_root_callback2_t) (void *cookie1, void *cookie2,
int flags,
mach_port_t *underlying,
mach_msg_type_name_t
*underlying_type);
/* Fetch the root from TRANSBOX. DOTDOT is an unauthenticated port
for the directory in which we are looking; UIDS (length UIDS_LEN)
and GIDS (length GIDS_LEN) are the ids of the user responsible for
the call. FLAGS are as for dir_pathtrans (but O_CREAT and O_EXCL
are not meaningful and are ignored). The trasnbox lock (as
set by fshelp_transbox_init) must be held before the call, and will
be held upon return, but may be released during the operation of
the call. */
error_t
fshelp_fetch_root (struct transbox *transbox, void *cookie,
file_t dotdot,
uid_t *uids, int uids_len,
uid_t *gids, int gids_len,
int flags,
fshelp_fetch_root_callback1_t callback1,
fshelp_fetch_root_callback2_t callback2,
retry_type *retry, char *retryname, mach_port_t *root);
void
fshelp_transbox_init (struct transbox *transbox,
struct mutex *lock,
void *cookie);
/* Return true iff there is an active translator on this box */
extern inline int
fshelp_translated (struct transbox *box)
{
return (box->active != MACH_PORT_NULL);
}
/* Atomically replace the existing active translator port for this box
with NEWACTIVE. If EXCL is non-zero then don't frob an existing
active; return EBUSY instead. */
error_t fshelp_set_active (struct transbox *box,
fsys_t newactive, int excl);
/* Fetch the control port to make a request on it. It's a bad idea
to do fsys_getroot with the result; use fetch_root instead. */
error_t fshelp_fetch_control (struct transbox *box,
mach_port_t *control);
/* A transbox is being deallocated, clean associated state. */
void fshelp_drop_transbox (struct transbox *box);
/* Flock handling. */
struct lock_box
{
int type;
struct condition wait;
int waiting;
int shcount;
};
/* Call when a user makes a request to acquire an lock via file_lock.
There should be one lock box per object and one int per open; these
are passed as arguments BOX and USER respectively. FLAGS are as
per file_lock. MUT is a mutex which will be held whenever this
routine is called, to lock BOX->wait. */
error_t fshelp_acquire_lock (struct lock_box *box, int *user,
struct mutex *mut, int flags);
/* Initialize lock_box BOX. (The user int passed to fshelp_acquire_lock
should be initialized with LOCK_UN.). */
void fshelp_lock_init (struct lock_box *box);
/* Try to hand off responsibility from a translator to the server located on
the node SERVER_NAME. REQUESTOR is the translator's bootstrap port, and
ARGV is the command line. If SERVER_NAME is NULL, then a name is
concocted by appending ARGV[0] to _SERVERS. */
error_t fshelp_delegate_translation (char *server_name,
mach_port_t requestor, char **argv);
#endif
|
