summaryrefslogtreecommitdiff
path: root/lnode.h
blob: 2a142094d5e756aef61f31237a7f1b617747eff3 (plain)
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
/*---------------------------------------------------------------------------*/
/*lnode.h*/
/*---------------------------------------------------------------------------*/
/*Management of cheap 'light nodes'*/
/*---------------------------------------------------------------------------*/
/*Based on the code of unionfs translator.*/
/*---------------------------------------------------------------------------*/
/*Copyright (C) 2001, 2002, 2005, 2008, 2009 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 __LNODE_H__
#define __LNODE_H__

/*---------------------------------------------------------------------------*/
#include <error.h>
#include <hurd/netfs.h>
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/*--------Macros-------------------------------------------------------------*/
/*The possible flags in an lnode*/
#define FLAG_LNODE_DIR	0x00000001	/*the lnode is a directory */
/*---------------------------------------------------------------------------*/

/*---------------------------------------------------------------------------*/
/*--------Types--------------------------------------------------------------*/
/*A candy synonym for the fundamental libnetfs node*/
typedef struct node node_t;
/*---------------------------------------------------------------------------*/
/*A list of lnodes*/
struct node_element
{
  /*the node associated with the current entry */
  node_t *node;

  /*the next element in the list */
  struct node_element *next;
};				/*struct node_element */
/*---------------------------------------------------------------------------*/
typedef struct node_element *node_list_t;
/*---------------------------------------------------------------------------*/
/*The light node*/
struct lnode
{
  /*the name of the lnode */
  char *name;

  /*the length of the name; `name` does not change, and this value is used
     quite often, therefore calculate it just once */
  size_t name_len;

  /*the full path to the lnode */
  char *path;

  /*the associated flags */
  int flags;

  /*the number of references to this lnode */
  int references;

  /*the reference to the real netfs node */
  node_t *node;

  /*the references to the proxy nodes of this lnode;
     lnodes do not hold references to */
  node_list_t proxies;

  /*the next lnode and the pointer to this lnode from the previous one */
  struct lnode *next, **prevp;

  /*the lnode (directory) in which this node is contained */
  struct lnode *dir;

  /*the beginning of the list of entries contained in this lnode (directory) */
  struct lnode *entries;

  /*the lock, protecting this lnode */
  struct mutex lock;
};				/*struct lnode */
/*---------------------------------------------------------------------------*/
typedef struct lnode lnode_t;
/*---------------------------------------------------------------------------*/

/*----------------------------------------------------------------------------*/
/*--------Functions----------------------------------------------------------*/
/*Adds a reference to the `lnode` (which must be locked)*/
void lnode_ref_add (lnode_t * node);
/*---------------------------------------------------------------------------*/
/*Removes a reference from `node` (which must be locked). If that was
  the last reference, destroy the node*/
void lnode_ref_remove (lnode_t * node);
/*---------------------------------------------------------------------------*/
/*Creates a new lnode with `name`; the new node is locked and contains
  a single reference*/
error_t lnode_create (char *name, lnode_t ** node);
/*---------------------------------------------------------------------------*/
/*Destroys the given lnode*/
void lnode_destroy (lnode_t * node);
/*---------------------------------------------------------------------------*/
/*Constructs the full path for the given lnode and stores the result
  both in the parameter and inside the lnode (the same string,
  actually)*/
error_t lnode_path_construct (lnode_t * node, char **path);
/*---------------------------------------------------------------------------*/
/*Gets a light node by its name, locks it and increments its refcount*/
error_t lnode_get (lnode_t * dir,	/*search here */
		   char *name,	        /*search for this name */
		   lnode_t ** node	/*put the result here */
		   );
/*---------------------------------------------------------------------------*/
/*Install the lnode into the lnode tree: add a reference to `dir`
  (which must be locked)*/
void lnode_install (lnode_t * dir,	/*install here */
		    lnode_t * node	/*install this */
		    );
/*---------------------------------------------------------------------------*/
/*Unistall the node from the node tree; remove a reference from the lnode*/
void lnode_uninstall (lnode_t * node);
/*---------------------------------------------------------------------------*/
/*Makes the specified lnode aware of another proxy. Both `node` and
  `proxy` must be locked*/
error_t lnode_add_proxy (lnode_t * node, node_t * proxy);
/*---------------------------------------------------------------------------*/
/*Removes the specified proxy from the list of proxies of the supplied
  lnode.  `proxy` must not be locked*/
void lnode_remove_proxy (lnode_t * node, node_t * proxy);
/*---------------------------------------------------------------------------*/
#endif /*__LNODE_H__*/