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
|
/*---------------------------------------------------------------------------*/
/*node.h*/
/*---------------------------------------------------------------------------*/
/*Node management. Also see lnode.h*/
/*---------------------------------------------------------------------------*/
/*Based on the code of unionfs translator.*/
/*---------------------------------------------------------------------------*/
/*Copyright (C) 2001, 2002, 2005, 2008 Free Software Foundation, Inc.
Written by Sergiu Ivanov <unlimitedscolobb@gmail.com>.
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 of the
License, 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA.*/
/*---------------------------------------------------------------------------*/
#ifndef __NODE_H__
#define __NODE_H__
/*---------------------------------------------------------------------------*/
#include <error.h>
#include <sys/stat.h>
#include <hurd/netfs.h>
/*---------------------------------------------------------------------------*/
#include "lnode.h"
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*--------Macros-------------------------------------------------------------*/
/*Checks whether the give node is the root of the proxy filesystem*/
#define NODE_IS_ROOT(n) (((n)->nn->lnode->dir) ? (0) : (1))
/*---------------------------------------------------------------------------*/
/*Node flags*/
#define FLAG_NODE_ULFS_FIXED 0x00000001 /*this node should not be updated */
#define FLAG_NODE_INVALIDATE 0x00000002 /*this node must be updated */
#define FLAG_NODE_ULFS_UPTODATE 0x00000004 /*this node has just been updated */
/*---------------------------------------------------------------------------*/
/*The type of offset corresponding to the current platform*/
#ifdef __USE_FILE_OFFSET64
# define OFFSET_T __off64_t
#else
# define OFFSET_T __off_t
#endif /*__USE_FILE_OFFSET64*/
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*--------Types--------------------------------------------------------------*/
/*A list element containing a port*/
struct port_el
{
/*the port */
mach_port_t p;
/*the next element in the list */
struct port_el *next;
}; /*struct port_el */
/*---------------------------------------------------------------------------*/
typedef struct port_el port_el_t;
/*---------------------------------------------------------------------------*/
/*The user-defined node for libnetfs*/
struct netnode
{
/*the reference to the corresponding light node */
lnode_t *lnode;
/*the flags associated with this node */
int flags;
/*a port to the underlying filesystem */
file_t port;
/*the port to the untranslated version of the node */
file_t port_notrans;
/*the malloced set of translators which have to be stacked upon this node
and upon its children; the corresponding translators will have to decide
on their own whether to accept directories or not */
char *trans;
/*the number of translators listed in `translators` */
size_t ntrans;
/*the length of the list of translators (in bytes) */
size_t translen;
/*the list of control ports to the translators being set on this node */
port_el_t *cntl_ports;
/*the neighbouring entries in the cache */
node_t *ncache_prev, *ncache_next;
}; /*struct netnode */
/*---------------------------------------------------------------------------*/
typedef struct netnode netnode_t;
/*---------------------------------------------------------------------------*/
/*A list element containing directory entry*/
struct node_dirent
{
/*the directory entry */
struct dirent *dirent;
/*the next element */
struct node_dirent *next;
}; /*struct node_dirent */
/*---------------------------------------------------------------------------*/
typedef struct node_dirent node_dirent_t;
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*--------Global Variables---------------------------------------------------*/
/*The lock protecting the underlying filesystem*/
extern struct mutex ulfs_lock;
/*---------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/*--------Functions----------------------------------------------------------*/
/*Derives a new node from `lnode` and adds a reference to `lnode`*/
error_t node_create (lnode_t * lnode, node_t ** node);
/*---------------------------------------------------------------------------*/
/*Derives a new proxy from `lnode`*/
error_t node_create_proxy (lnode_t * lnode, node_t ** node);
/*---------------------------------------------------------------------------*/
/*Destroys the specified node and removes a light reference from the
associated light node*/
void node_destroy (node_t * np);
/*---------------------------------------------------------------------------*/
/*Creates the root node and the corresponding lnode*/
error_t node_create_root (node_t ** root_node);
/*---------------------------------------------------------------------------*/
/*Initializes the port to the underlying filesystem for the root node*/
error_t node_init_root (node_t * node);
/*---------------------------------------------------------------------------*/
/*Frees a list of dirents*/
void node_entries_free (node_dirent_t * dirents);
/*---------------------------------------------------------------------------*/
/*Reads the directory entries from `node`, which must be locked*/
error_t node_entries_get (node_t * node, node_dirent_t ** dirents);
/*---------------------------------------------------------------------------*/
/*Makes sure that all ports to the underlying filesystem of `node` are
up to date*/
error_t node_update (node_t * node);
/*---------------------------------------------------------------------------*/
/*Computes the size of the given directory*/
error_t node_get_size (node_t * dir, OFFSET_T * off);
/*---------------------------------------------------------------------------*/
/*Remove the file called `name` under `dir`*/
error_t node_unlink_file (node_t * dir, char *name);
/*---------------------------------------------------------------------------*/
/*Sets the given translators on the specified node and returns the
port to the topmost one opened as `flags` require*/
error_t node_set_translators (struct protid *diruser, node_t * np,
char *trans, /*set these on `node` */
size_t ntrans, int flags, mach_port_t * port);
/*---------------------------------------------------------------------------*/
/*Kill the topmost translator for this node*/
/*This function will normally be called from netfs_attempt_lookup,
therefore it's better that the caller should provide the parent node
for `node`.*/
error_t node_kill_translator (node_t * dir, node_t * node);
/*---------------------------------------------------------------------------*/
/*Kills all translators on the current node or on all underlying nodes
it the current node is a directory*/
void node_kill_translators (node_t * node);
/*---------------------------------------------------------------------------*/
#endif /*__NODE_H__*/
|
