]> arthur.barton.de Git - netatalk.git/blob - etc/afpd/directory.h
Readability fix (endif comment was wrong), remove ifdef DEBUG, adjust loglevel to...
[netatalk.git] / etc / afpd / directory.h
1 /*
2  * $Id: directory.h,v 1.27 2009-09-14 00:02:21 didg Exp $
3  *
4  * Copyright (c) 1990,1991 Regents of The University of Michigan.
5  * All Rights Reserved.
6  *
7  * Permission to use, copy, modify, and distribute this software and
8  * its documentation for any purpose and without fee is hereby granted,
9  * provided that the above copyright notice appears in all copies and
10  * that both that copyright notice and this permission notice appear
11  * in supporting documentation, and that the name of The University
12  * of Michigan not be used in advertising or publicity pertaining to
13  * distribution of the software without specific, written prior
14  * permission. This software is supplied as is without expressed or
15  * implied warranties of any kind.
16  *
17  *      Research Systems Unix Group
18  *      The University of Michigan
19  *      c/o Mike Clark
20  *      535 W. William Street
21  *      Ann Arbor, Michigan
22  *      +1-313-763-0525
23  *      netatalk@itd.umich.edu
24  */
25
26 #ifndef AFPD_DIRECTORY_H
27 #define AFPD_DIRECTORY_H 1
28
29 #include <sys/cdefs.h>
30 #include <sys/types.h>
31 /*#include <sys/stat.h>*/ /* including it here causes some confusion */
32 #include <netatalk/endian.h>
33 #include <dirent.h>
34
35 /* sys/types.h usually snarfs in major/minor macros. if they don't
36  * try this file. */
37 #ifndef major
38 #include <sys/sysmacros.h>
39 #endif
40
41 #include "globals.h"
42 #include "volume.h"
43
44 /* the did tree is now a red-black tree while the parent/child
45  * tree is a circular doubly-linked list. how exciting. */
46 struct dir {
47     struct dir  *d_left, *d_right, *d_back; /* for red-black tree */
48     int         d_color;
49     struct dir  *d_parent, *d_child; /* parent-child */
50     struct dir  *d_prev, *d_next;    /* siblings */
51     void        *d_ofork;            /* oforks using this directory. */
52     u_int32_t   d_did;
53     int         d_flags;
54
55     time_t      ctime;                /* inode ctime */
56     u_int32_t   offcnt;               /* offspring count */
57
58     char        *d_m_name;            /* mac name */
59     char        *d_u_name;            /* unix name */
60     ucs2_t      *d_m_name_ucs2;       /* mac name as UCS2 */
61 };
62
63 struct path {
64     int         m_type;             /* mac name type (long name, unicode */
65     char        *m_name;            /* mac name */
66     char        *u_name;            /* unix name */
67     cnid_t      id;                 /* file id (only for getmetadata) */
68     struct dir  *d_dir;             /* */
69     int         st_valid;           /* does st_errno and st set */
70     int         st_errno;
71     struct stat st;
72 };
73
74 static inline int path_isadir(struct path *o_path)
75 {
76     return o_path->d_dir != NULL;
77 #if 0
78     return o_path->m_name == '\0' || /* we are in a it */
79            !o_path->st_valid ||      /* in cache but we can't chdir in it */ 
80            (!o_path->st_errno && S_ISDIR(o_path->st.st_mode)); /* not in cache an can't chdir */
81 #endif
82 }
83
84 #define DIRTREE_COLOR_RED    0
85 #define DIRTREE_COLOR_BLACK  1
86
87 /* setgid directories */
88 #ifndef DIRBITS
89 # ifdef AFS
90 #  define DIRBITS 0
91 # else /* AFS */
92 #  define DIRBITS S_ISGID
93 # endif /* AFS */
94 #endif /* DIRBITS */
95
96 #define DIRF_FSMASK     (3<<0)
97 #define DIRF_NOFS       (0<<0)
98 #define DIRF_AFS        (1<<0)
99 #define DIRF_UFS        (2<<0)
100
101 #define DIRF_OFFCNT     (1<<4)  /* offsprings count is valid */
102 #define DIRF_CNID       (1<<5)  /* renumerate id */
103
104
105 #define AFPDIR_READ     (1<<0)
106
107 /* directory bits */
108 #define DIRPBIT_ATTR    0
109 #define DIRPBIT_PDID    1
110 #define DIRPBIT_CDATE   2
111 #define DIRPBIT_MDATE   3
112 #define DIRPBIT_BDATE   4
113 #define DIRPBIT_FINFO   5
114 #define DIRPBIT_LNAME   6
115 #define DIRPBIT_SNAME   7
116 #define DIRPBIT_DID     8
117 #define DIRPBIT_OFFCNT  9
118 #define DIRPBIT_UID     10
119 #define DIRPBIT_GID     11
120 #define DIRPBIT_ACCESS  12
121 #define DIRPBIT_PDINFO  13         /* ProDOS Info */
122 #define DIRPBIT_UNIXPR  15
123
124 #define FILDIRBIT_ISDIR        (1 << 7) /* is a directory */
125 #define FILDIRBIT_ISFILE       (0)      /* is a file */
126
127 /* reserved directory id's */
128 #define DIRDID_ROOT_PARENT    htonl(1)  /* parent directory of root */
129 #define DIRDID_ROOT           htonl(2)  /* root directory */
130
131 /* file/directory ids. what a mess. we scramble things in a vain attempt
132  * to get something meaningful */
133 #ifndef AFS
134
135 #if 0
136 #define CNID_XOR(a)  (((a) >> 16) ^ (a))
137 #define CNID_DEV(a)   ((((CNID_XOR(major((a)->st_dev)) & 0xf) << 3) | \
138         (CNID_XOR(minor((a)->st_dev)) & 0x7)) << 24)
139 #define CNID_INODE(a) (((a)->st_ino ^ (((a)->st_ino & 0xff000000) >> 8)) \
140                                        & 0x00ffffff)
141 #define CNID_FILE(a)  (((a) & 0x1) << 31)
142 #define CNID(a,b)     (CNID_DEV(a) | CNID_INODE(a) | CNID_FILE(b))
143 #endif
144
145 #define CNID(a,b)     ((a)->st_ino & 0xffffffff)
146
147 #else /* AFS */
148 #define CNID(a,b)     (((a)->st_ino & 0x7fffffff) | CNID_FILE(b))
149 #endif /* AFS */
150
151
152 struct maccess {
153     u_char      ma_user;
154     u_char      ma_world;
155     u_char      ma_group;
156     u_char      ma_owner;
157 };
158
159 #define AR_USEARCH      (1<<0)
160 #define AR_UREAD        (1<<1)
161 #define AR_UWRITE       (1<<2)
162 #define AR_UOWN         (1<<7)
163
164 extern struct dir       *dirnew __P((const char *, const char *));
165 extern void             dirfreename __P((struct dir *));
166 extern void             dirfree __P((struct dir *));
167 extern struct dir       *dirsearch __P((const struct vol *, u_int32_t));
168 extern struct dir       *dirlookup __P((const struct vol *, u_int32_t));
169 extern struct dir       *dirsearch_byname __P((const struct vol *, struct dir *,char *));
170
171 extern struct dir       *adddir __P((struct vol *, struct dir *, 
172                                                struct path *));
173
174 extern int              movecwd __P((const struct vol *, struct dir *));
175 extern int              deletecurdir __P((const struct vol *));
176 extern struct path      *cname __P((const struct vol *, struct dir *,
177                              char **));
178 extern mode_t           mtoumode __P((struct maccess *));
179 extern void             utommode __P((struct stat *, struct maccess *));
180 extern int getdirparams __P((const struct vol *, u_int16_t, struct path *,
181                                  struct dir *, char *, int *));
182 extern int setdirparams __P((const struct vol *, struct path *, u_int16_t, char *));
183 extern int renamedir __P((const struct vol *, char *, char *, struct dir *,
184                               struct dir *, char *));
185 extern int path_error __P((struct path *, int error));
186
187 extern void setdiroffcnt __P((struct dir *dir, struct stat *st,  u_int32_t count));
188 extern int dirreenumerate __P((struct dir *dir, struct stat *st));
189
190 typedef int (*dir_loop)(struct dirent *, char *, void *);
191
192 extern int  for_each_dirent __P((const struct vol *, char *, dir_loop , void *));
193
194 extern int  check_access __P((char *name , int mode));
195 extern int file_access   __P((struct path *path, int mode));
196
197 extern int netatalk_rmdir __P((const char *name));
198 extern int netatalk_unlink __P((const char *name));
199
200 extern int caseenumerate __P((const struct vol *, struct path *, struct dir *));
201
202 extern hash_t *dirhash __P((void));
203 /* from enumerate.c */
204 extern char *check_dirent __P((const struct vol *, char *));
205
206 /* FP functions */
207 extern int      afp_createdir __P((AFPObj *, char *, int, char *, int *));
208 extern int      afp_opendir __P((AFPObj *, char *, int, char *, int *));
209 extern int      afp_setdirparams __P((AFPObj *, char *, int, char *, int *));
210 extern int      afp_closedir __P((AFPObj *, char *, int, char *, int *));
211 extern int      afp_mapid __P((AFPObj *, char *, int, char *, int *));
212 extern int      afp_mapname __P((AFPObj *, char *, int, char *, int *));
213 extern int      afp_syncdir __P((AFPObj *, char *, int, char *, int *));
214
215 /* from enumerate.c */
216 extern int      afp_enumerate __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
217 extern int      afp_enumerate_ext __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
218 extern int      afp_enumerate_ext2 __P((AFPObj *, char *, unsigned int, char *, unsigned int *));
219
220 /* from catsearch.c */
221 extern int      afp_catsearch __P((AFPObj *, char *, int, char *, int *));
222 extern int      afp_catsearch_ext __P((AFPObj *, char *, int, char *, int *));
223
224 #endif