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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
Copyright (C) 1994, 1995, 1996, 1997 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 __TRIVFS_H__
#define __TRIVFS_H__
#include <errno.h>
#include <cthreads.h> /* for mutexes &c */
#include <sys/types.h> /* for uid_t &c */
#include <mach/mach.h>
#include <hurd/ports.h>
#include <hurd/iohelp.h>
struct trivfs_protid
{
struct port_info pi;
struct iouser *user;
int isroot;
/* REALNODE will be null if this protid wasn't fully created (currently
only in the case where trivfs_protid_create_hook returns an error). */
mach_port_t realnode; /* restricted permissions */
void *hook; /* for user use */
struct trivfs_peropen *po;
};
/* These can be used as `intran' and `destructor' functions for
a MiG port type, to have the stubs called with the protid pointer. */
struct trivfs_protid *trivfs_begin_using_protid (mach_port_t);
void trivfs_end_using_protid (struct trivfs_protid *);
struct trivfs_peropen
{
void *hook; /* for user use */
int openmodes;
int refcnt;
struct trivfs_control *cntl;
};
struct trivfs_control
{
struct port_info pi;
struct mutex lock;
struct port_class *protid_class;
struct port_bucket *protid_bucket;
mach_port_t filesys_id;
mach_port_t file_id;
mach_port_t underlying;
void *hook; /* for user use */
};
/* These can be used as `intran' and `destructor' functions for
a MiG port type, to have the stubs called with the control pointer. */
struct trivfs_control *trivfs_begin_using_control (mach_port_t);
void trivfs_end_using_control (struct trivfs_control *);
/* The user must define these variables. */
extern int trivfs_fstype;
extern int trivfs_fsid;
/* Set these if trivfs should allow read, write,
or execute of file. */
extern int trivfs_support_read;
extern int trivfs_support_write;
extern int trivfs_support_exec;
/* Set this some combination of O_READ, O_WRITE, and O_EXEC;
trivfs will only allow opens of the specified modes.
(trivfs_support_* is not used to validate opens, only actual
operations.) */
extern int trivfs_allow_open;
extern struct port_class *trivfs_protid_portclasses[];
extern int trivfs_protid_nportclasses;
extern struct port_class *trivfs_cntl_portclasses[];
extern int trivfs_cntl_nportclasses;
/* The user must define this function. This should modify a struct
stat (as returned from the underlying node) for presentation to
callers of io_stat. It is permissable for this function to do
nothing. */
void trivfs_modify_stat (struct trivfs_protid *cred, struct stat *);
/* If this variable is set, it is called every time an open happens.
USER and FLAGS are from the open; CNTL identifies the
node being opened. This call need not check permissions on the underlying
node. This call can block as necessary, unless O_NONBLOCK is set
in FLAGS. Any desired error can be returned, which will be reflected
to the user and prevent the open from succeeding. */
error_t (*trivfs_check_open_hook) (struct trivfs_control *cntl,
struct iouser *user, int flags);
/* If this variable is set, it is called every time a new protid
structure is created and initialized. */
error_t (*trivfs_protid_create_hook) (struct trivfs_protid *);
/* If this variable is set, it is called every time a new peropen
structure is created and initialized. */
error_t (*trivfs_peropen_create_hook) (struct trivfs_peropen *);
/* If this variable is set, it is called every time a protid structure
is about to be destroyed. */
void (*trivfs_protid_destroy_hook) (struct trivfs_protid *);
/* If this variable is set, it is called every time a peropen structure
is about to be destroyed. */
void (*trivfs_peropen_destroy_hook) (struct trivfs_peropen *);
/* If this variable is set, it is called by trivfs_S_fsys_getroot before any
other processing takes place; if the return value is EAGAIN, normal trivfs
getroot processing continues, otherwise the rpc returns with that return
value. */
error_t (*trivfs_getroot_hook) (struct trivfs_control *cntl,
mach_port_t reply_port,
mach_msg_type_name_t reply_port_type,
mach_port_t dotdot,
uid_t *uids, u_int nuids, uid_t *gids, u_int ngids,
int flags,
retry_type *do_retry, char *retry_name,
mach_port_t *node, mach_msg_type_name_t *node_type);
/* Creates a control port for this filesystem and sends it to BOOTSTRAP with
fsys_startup. CONTROL_CLASS & CONTROL_BUCKET are passed to the ports
library to create the control port, and PROTID_CLASS & PROTID_BUCKET are
used when creating ports representing opens of this node. If CONTROL
isn't NULL, the trivfs control port is return in it. If any error occurs
sending fsys_startup, it is returned, otherwise 0. FLAGS specifies how to
open the underlying node (O_*). */
error_t trivfs_startup (mach_port_t bootstrap, int flags,
struct port_class *control_class,
struct port_bucket *control_bucket,
struct port_class *protid_class,
struct port_bucket *protid_bucket,
struct trivfs_control **control);
/* Create a new trivfs control port, with underlying node UNDERLYING, and
return it in CONTROL. CONTROL_CLASS & CONTROL_BUCKET are passed to
the ports library to create the control port, and PROTID_CLASS &
PROTID_BUCKET are used when creating ports representing opens of this
node. */
error_t
trivfs_create_control (mach_port_t underlying,
struct port_class *control_class,
struct port_bucket *control_bucket,
struct port_class *protid_class,
struct port_bucket *protid_bucket,
struct trivfs_control **control);
/* Install these as libports cleanroutines for trivfs_protid_class
and trivfs_cntl_class respectively. */
void trivfs_clean_protid (void *);
void trivfs_clean_cntl (void *);
/* This demultiplees messages for trivfs ports. */
int trivfs_demuxer (mach_msg_header_t *, mach_msg_header_t *);
/* Return a new protid pointing to a new peropen in CRED, with REALNODE as
the underlying node reference, with the given identity, and open flags in
FLAGS. CNTL is the trivfs control object. */
error_t trivfs_open (struct trivfs_control *fsys,
struct iouser *user,
unsigned flags,
mach_port_t realnode,
struct trivfs_protid **cred);
/* Return a duplicate of CRED in DUP, sharing the same peropen and hook. A
non-null hook may be used to detect that this is a duplicate by
trivfs_peropen_create_hook. */
error_t trivfs_protid_dup (struct trivfs_protid *cred,
struct trivfs_protid **dup);
/* The user must define this function. Someone wants the filesystem
CNTL to go away. FLAGS are from the set FSYS_GOAWAY_*. */
error_t trivfs_goaway (struct trivfs_control *cntl, int flags);
/* Call this to set atime for the node to the current time. */
error_t trivfs_set_atime (struct trivfs_control *cntl);
/* Call this to set mtime for the node to the current time. */
error_t trivfs_set_mtime (struct trivfs_control *cntl);
/* If this is defined or set to an argp structure, it will be used by the
default trivfs_set_options to handle runtime options parsing. Redefining
this is the normal way to add option parsing to a trivfs program. */
extern struct argp *trivfs_runtime_argp;
/* Set runtime options for FSYS to ARGZ & ARGZ_LEN. The default definition
for this routine simply uses TRIVFS_RUNTIME_ARGP (supply FSYS as the argp
input field). */
error_t trivfs_set_options (struct trivfs_control *fsys,
char *argz, size_t argz_len);
/* Append to the malloced string *ARGZ of length *ARGZ_LEN a NUL-separated
list of the arguments to this translator. The default definition of this
routine simply calls diskfs_append_std_options. */
error_t trivfs_append_args (struct trivfs_control *fsys,
char **argz, size_t *argz_len);
#endif /* __TRIVFS_H__ */
|
