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
|
/* FS helper library definitions
Copyright (C) 1994 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. */
/* Translator linkage. These routines only work for multi-threaded
servers, and assume you are using the ports library. */
/* Define one of these structures as part of every disk node. */
struct trans_link
{
/* control port for the child filesystem */
fsys_t control;
/* this is woken up when fsys_startup is receieved
from the child filesystem. */
struct condition initwait;
/* This indicates that someone has already started up the translator */
int starting;
/* Linked list of all translators */
struct trans_link *next, **prevp;
};
/* The user must define this variable. This is the libports type for
bootstrap ports given to newly started translators. */
extern int fshelp_transboot_port_type;
/* Call this before calling any of the other translator linkage routines,
normally from your main node initialization routine. */
void fshelp_init_trans_link (struct trans_link *LINK);
/* The user must define this function. This is used to create ports
for translator startup from files. NODE identifies the file for
which a port is required; UID and GID identifies the identity of
the user for the open. Both arguments are opaque to the library
(and must be provided to the fshelp_start_translator call). This
should return the name of a receive right from which exactly one
send right will be created. */
mach_port_t fshelp_get_node_port (void *node, uid_t uid, gid_t gid);
/* Call to set the control field of translator LINK to CTL
directly. */
void fshelp_set_control (struct trans_link *link, mach_port_t ctl);
/* Call this when the control field of a translator is null and you
want to have the translator started so you can talk to it. LINK is
the trans_link structure for this node; NAME is the file to execute
as the translator (*NAME may be modified). fshelp_get_node_port
will be called with DIR and NODE as necessary. (These values must
remain valid until fshelp_done_with_node is called.) DIR should
refer to the directory holding the node being translater, and will
be provided as the cwdir of the process and as the dotdot return
value from fsys_startup. NODE will should refer to the node being
translated, and will be provided as the realnode return value from
fsys_startup. UID and GID will be provided as the second and third
arguments to fshelp_get_node_port for both these calls. LOCK must
be a mutex which you hold; it is assumed that the trans_link
structure will not be changed unless this is held. */
error_t fshelp_start_translator (struct trans_link *link, char *name,
int namelen, void *dir, void *node,
uid_t uid, gid_t gid, struct mutex *lock);
/* The user must define this function. This will be called for the
DIR and NODE arguments to fshelp_start_translator when the library
no longer needs them. */
void fshelp_done_with_node (void *);
/* Call this when you receive a fsys_startup message on a port of type
fshelp_transboot_port_type. PORTSTRUCT is the result of
ports_check_port_type/ports_get_port; this routine does not call
ports_done_with_port so the caller normally should. CTL, REAL,
REALPOLY, DOTDOT, and DOTDOTPOLY are copied from the fsys_startup
message; CTL will be installed as the control field of the
translator making this call, *REAL will be set to be the underlying
port (by calling the MAKE_PORT function set at
fshelp_start_translator time with the NODE argument to that call);
*DOTDOT will be set similarly, but from the DIR argument to
fshelp_start_translator. *REALPOLY and *DOTDOTPOLY will be set to
the Mach message transmission types for those two ports.
If this routine returns an error, then the CTL port must be deallocated
by the caller. */
error_t fshelp_handle_fsys_startup (void *portstruct, mach_port_t ctl,
mach_port_t *real,
mach_msg_type_name_t *realpoly,
mach_port_t *dotdot,
mach_msg_type_name_t *dotdotpoly);
/* Install this routine as the ports library type-specific clean routine
for ports of type fshelp_transboot_port_type. */
void fshelp_transboot_clean (void *arg);
/* Call function FUNC for each translator that has completed its
startup. The arguments to FUNC are the translator and ARG
respectively. */
void fshelp_translator_iterate (void (*func)(struct trans_link *, void *),
void *arg);
/* A trans_link structure is being deallocated; clean up any state
we need to. */
void fshelp_kill_translator (struct trans_link *link);
/* 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);
#endif
|
