3 * Coda: an Experimental Distributed File System
6 * Copyright (c) 1987-1998 Carnegie Mellon University
9 * Permission to use, copy, modify and distribute this software and its
10 * documentation is hereby granted, provided that both the copyright
11 * notice and this permission notice appear in all copies of the
12 * software, derivative works or modified versions, and any portions
13 * thereof, and that both notices appear in supporting documentation, and
14 * that credit is given to Carnegie Mellon University in all documents
15 * and publicity pertaining to direct or indirect use of this code or its
18 * CODA IS AN EXPERIMENTAL SOFTWARE SYSTEM AND IS KNOWN TO HAVE BUGS,
19 * SOME OF WHICH MAY HAVE SERIOUS CONSEQUENCES. CARNEGIE MELLON ALLOWS
20 * FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION. CARNEGIE MELLON
21 * DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER
22 * RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OF THIS SOFTWARE OR OF
23 * ANY DERIVATIVE WORK.
25 * Carnegie Mellon encourages users of this software to return any
26 * improvements or extensions that they make, and to grant Carnegie
27 * Mellon the rights to redistribute these changes without encumbrance.
29 * @(#) src/sys/coda/coda.h,v 1.1.1.1 1998/08/29 21:14:52 rvb Exp $
30 * $FreeBSD: src/sys/coda/coda.h,v 1.9 1999/12/29 04:54:30 peter Exp $
31 * $DragonFly: src/sys/vfs/coda/Attic/coda.h,v 1.4 2006/01/13 21:09:26 swildner Exp $
38 * Based on cfs.h from Mach, but revamped for increased simplicity.
39 * Linux modifications by Peter Braam, Aug 1996
47 /* Catch new _KERNEL defn for NetBSD */
49 #include <sys/types.h>
52 #ifndef CODA_MAXSYMLINKS
53 #define CODA_MAXSYMLINKS 10
56 #if defined(DJGPP) || defined(__CYGWIN32__)
58 typedef unsigned long u_long;
59 typedef unsigned int u_int;
60 typedef unsigned short u_short;
63 typedef void * caddr_t;
65 typedef unsigned __int64 u_quad_t;
67 typedef unsigned long long u_quad_t;
76 #else /* DJGPP but not _KERNEL */
77 #include <sys/types.h>
79 typedef unsigned long long u_quad_t;
84 #if defined(__linux__)
85 #define cdev_t u_quad_t
86 #if !defined(_UQUAD_T_) && (!defined(__GLIBC__) || __GLIBC__ < 2)
88 typedef unsigned long long u_quad_t;
95 typedef unsigned char u_int8_t;
97 time_t tv_sec; /* seconds */
98 long tv_nsec; /* nanoseconds */
106 #define CODA_MAXNAMLEN 255
107 #define CODA_MAXPATHLEN 1024
108 #define CODA_MAXSYMLINK 10
110 /* these are Coda's version of O_RDONLY etc combinations
111 * to deal with VFS open modes
113 #define C_O_READ 0x001
114 #define C_O_WRITE 0x002
115 #define C_O_TRUNC 0x010
116 #define C_O_EXCL 0x100
117 #define C_O_CREAT 0x200
119 /* these are to find mode bits in Venus */
120 #define C_M_READ 00400
121 #define C_M_WRITE 00200
123 /* for access Venus will use */
124 #define C_A_C_OK 8 /* Test for writing upon create. */
125 #define C_A_R_OK 4 /* Test for read permission. */
126 #define C_A_W_OK 2 /* Test for write permission. */
127 #define C_A_X_OK 1 /* Test for execute permission. */
128 #define C_A_F_OK 0 /* Test for existence. */
132 #ifndef _VENUS_DIRENT_T_
133 #define _VENUS_DIRENT_T_ 1
134 struct venus_dirent {
135 unsigned long d_fileno; /* file number of entry */
136 unsigned short d_reclen; /* length of this record */
137 char d_type; /* file type, see below */
138 char d_namlen; /* length of string in d_name */
139 char d_name[CODA_MAXNAMLEN + 1];/* name must be no longer than this */
142 #define DIRSIZ(dp) ((sizeof (struct venus_dirent) - (CODA_MAXNAMLEN+1)) + \
143 (((dp)->d_namlen+1 + 3) &~ 3))
148 #define CDT_UNKNOWN 0
159 * Convert between stat structure types and directory types.
161 #define IFTOCDT(mode) (((mode) & 0170000) >> 12)
162 #define CDTTOIF(dirtype) ((dirtype) << 12)
168 typedef u_long VolumeId;
169 typedef u_long VnodeId;
170 typedef u_long Unique_t;
171 typedef u_long FileVersion;
175 #define _VICEFID_T_ 1
176 typedef struct ViceFid {
185 static __inline__ ino_t
186 coda_f2i(struct ViceFid *fid)
190 if (fid->Vnode == 0xfffffffe || fid->Vnode == 0xffffffff)
191 return ((fid->Volume << 20) | (fid->Unique & 0xfffff));
193 return (fid->Unique + (fid->Vnode<<10) + (fid->Volume<<20));
197 #define coda_f2i(fid)\
198 ((fid) ? ((fid)->Unique + ((fid)->Vnode<<10) + ((fid)->Volume<<20)) : 0)
202 #ifndef __BIT_TYPES_DEFINED__
203 #define u_int32_t unsigned int
209 typedef u_int32_t vuid_t;
210 typedef u_int32_t vgid_t;
216 vuid_t cr_uid, cr_euid, cr_suid, cr_fsuid; /* Real, efftve, set, fs uid*/
217 vgid_t cr_groupid, cr_egid, cr_sgid, cr_fsgid; /* same for groups */
221 #ifndef _VENUS_VATTR_T_
222 #define _VENUS_VATTR_T_
224 * Vnode types. VNON means no type.
226 enum coda_vtype { C_VNON, C_VREG, C_VDIR, C_VBLK, C_VCHR, C_VLNK, C_VSOCK, C_VFIFO, C_VBAD };
229 int va_type; /* vnode type (for create) */
230 nlink_t va_nlink; /* number of references to file */
231 u_short va_mode; /* files access mode and type */
232 vuid_t va_uid; /* owner user id */
233 vgid_t va_gid; /* owner group id */
234 long va_fileid; /* file id */
235 u_quad_t va_size; /* file size in bytes */
236 long va_blocksize; /* blocksize preferred for i/o */
237 struct timespec va_atime; /* time of last access */
238 struct timespec va_mtime; /* time of last modification */
239 struct timespec va_ctime; /* time file changed */
240 u_long va_gen; /* generation number of file */
241 u_long va_flags; /* flags defined for file */
242 cdev_t va_rdev; /* device special file represents */
243 u_quad_t va_bytes; /* bytes of disk space held by file */
244 u_quad_t va_filerev; /* file modification number */
250 * Kernel <--> Venus communications.
258 #define CODA_GETATTR 7
259 #define CODA_SETATTR 8
260 #define CODA_ACCESS 9
261 #define CODA_LOOKUP 10
262 #define CODA_CREATE 11
263 #define CODA_REMOVE 12
265 #define CODA_RENAME 14
266 #define CODA_MKDIR 15
267 #define CODA_RMDIR 16
268 #define CODA_READDIR 17
269 #define CODA_SYMLINK 18
270 #define CODA_READLINK 19
271 #define CODA_FSYNC 20
272 #define CODA_INACTIVE 21
274 #define CODA_SIGNAL 23
275 #define CODA_REPLACE 24
276 #define CODA_FLUSH 25
277 #define CODA_PURGEUSER 26
278 #define CODA_ZAPFILE 27
279 #define CODA_ZAPDIR 28
280 #define CODA_PURGEFID 30
281 #define CODA_OPEN_BY_PATH 31
282 #define CODA_RESOLVE 32
283 #define CODA_REINTEGRATE 33
284 #define CODA_NCALLS 34
286 #define DOWNCALL(opcode) (opcode >= CODA_REPLACE && opcode <= CODA_PURGEFID)
288 #define VC_MAXDATASIZE 8192
289 #define VC_MAXMSGSIZE sizeof(union inputArgs)+sizeof(union outputArgs) +\
292 #define CIOC_KERNEL_VERSION _IOWR('c', 10, sizeof (int))
294 /* don't care about kernel version number */
295 #define CODA_KERNEL_VERSION 0
296 /* The old venus 4.6 compatible interface */
297 #define CODA_KERNEL_VERSION 1
299 /* venus_lookup gets an extra parameter to aid windows.*/
300 #define CODA_KERNEL_VERSION 2
303 * Venus <-> Coda RPC arguments
306 unsigned long opcode;
307 unsigned long unique; /* Keep multiple outstanding msgs distinct */
308 u_short pid; /* Common to all */
309 u_short pgid; /* Common to all */
310 u_short sid; /* Common to all */
311 struct coda_cred cred; /* Common to all */
314 /* Really important that opcode and unique are 1st two fields! */
315 struct coda_out_hdr {
316 unsigned long opcode;
317 unsigned long unique;
318 unsigned long result;
321 /* coda_root: NO_IN */
322 struct coda_root_out {
323 struct coda_out_hdr oh;
327 struct coda_root_in {
328 struct coda_in_hdr in;
332 /* Nothing needed for coda_sync */
335 struct coda_open_in {
336 struct coda_in_hdr ih;
341 struct coda_open_out {
342 struct coda_out_hdr oh;
349 struct coda_close_in {
350 struct coda_in_hdr ih;
355 struct coda_close_out {
356 struct coda_out_hdr out;
360 struct coda_ioctl_in {
361 struct coda_in_hdr ih;
366 char *data; /* Place holder for data. */
369 struct coda_ioctl_out {
370 struct coda_out_hdr oh;
372 caddr_t data; /* Place holder for data. */
377 struct coda_getattr_in {
378 struct coda_in_hdr ih;
382 struct coda_getattr_out {
383 struct coda_out_hdr oh;
384 struct coda_vattr attr;
388 /* coda_setattr: NO_OUT */
389 struct coda_setattr_in {
390 struct coda_in_hdr ih;
392 struct coda_vattr attr;
395 struct coda_setattr_out {
396 struct coda_out_hdr out;
399 /* coda_access: NO_OUT */
400 struct coda_access_in {
401 struct coda_in_hdr ih;
406 struct coda_access_out {
407 struct coda_out_hdr out;
412 #define CLU_CASE_SENSITIVE 0x01
413 #define CLU_CASE_INSENSITIVE 0x02
416 struct coda_lookup_in {
417 struct coda_in_hdr ih;
419 int name; /* Place holder for data. */
423 struct coda_lookup_out {
424 struct coda_out_hdr oh;
431 struct coda_create_in {
432 struct coda_in_hdr ih;
434 struct coda_vattr attr;
437 int name; /* Place holder for data. */
440 struct coda_create_out {
441 struct coda_out_hdr oh;
443 struct coda_vattr attr;
447 /* coda_remove: NO_OUT */
448 struct coda_remove_in {
449 struct coda_in_hdr ih;
451 int name; /* Place holder for data. */
454 struct coda_remove_out {
455 struct coda_out_hdr out;
458 /* coda_link: NO_OUT */
459 struct coda_link_in {
460 struct coda_in_hdr ih;
461 ViceFid sourceFid; /* cnode to link *to* */
462 ViceFid destFid; /* Directory in which to place link */
463 int tname; /* Place holder for data. */
466 struct coda_link_out {
467 struct coda_out_hdr out;
471 /* coda_rename: NO_OUT */
472 struct coda_rename_in {
473 struct coda_in_hdr ih;
480 struct coda_rename_out {
481 struct coda_out_hdr out;
485 struct coda_mkdir_in {
486 struct coda_in_hdr ih;
488 struct coda_vattr attr;
489 int name; /* Place holder for data. */
492 struct coda_mkdir_out {
493 struct coda_out_hdr oh;
495 struct coda_vattr attr;
499 /* coda_rmdir: NO_OUT */
500 struct coda_rmdir_in {
501 struct coda_in_hdr ih;
503 int name; /* Place holder for data. */
506 struct coda_rmdir_out {
507 struct coda_out_hdr out;
511 struct coda_readdir_in {
512 struct coda_in_hdr ih;
518 struct coda_readdir_out {
519 struct coda_out_hdr oh;
521 caddr_t data; /* Place holder for data. */
524 /* coda_symlink: NO_OUT */
525 struct coda_symlink_in {
526 struct coda_in_hdr ih;
527 ViceFid VFid; /* Directory to put symlink in */
529 struct coda_vattr attr;
533 struct coda_symlink_out {
534 struct coda_out_hdr out;
538 struct coda_readlink_in {
539 struct coda_in_hdr ih;
543 struct coda_readlink_out {
544 struct coda_out_hdr oh;
546 caddr_t data; /* Place holder for data. */
550 /* coda_fsync: NO_OUT */
551 struct coda_fsync_in {
552 struct coda_in_hdr ih;
556 struct coda_fsync_out {
557 struct coda_out_hdr out;
560 /* coda_inactive: NO_OUT */
561 struct coda_inactive_in {
562 struct coda_in_hdr ih;
567 struct coda_vget_in {
568 struct coda_in_hdr ih;
572 struct coda_vget_out {
573 struct coda_out_hdr oh;
579 /* CODA_SIGNAL is out-of-band, doesn't need data. */
580 /* CODA_INVALIDATE is a venus->kernel call */
581 /* CODA_FLUSH is a venus->kernel call */
583 /* coda_purgeuser: */
584 /* CODA_PURGEUSER is a venus->kernel call */
585 struct coda_purgeuser_out {
586 struct coda_out_hdr oh;
587 struct coda_cred cred;
591 /* CODA_ZAPFILE is a venus->kernel call */
592 struct coda_zapfile_out {
593 struct coda_out_hdr oh;
598 /* CODA_ZAPDIR is a venus->kernel call */
599 struct coda_zapdir_out {
600 struct coda_out_hdr oh;
605 /* CODA_ZAPVNODE is a venus->kernel call */
606 struct coda_zapvnode_out {
607 struct coda_out_hdr oh;
608 struct coda_cred cred;
613 /* CODA_PURGEFID is a venus->kernel call */
614 struct coda_purgefid_out {
615 struct coda_out_hdr oh;
620 struct coda_rdwr_in {
621 struct coda_in_hdr ih;
627 caddr_t data; /* Place holder for data. */
630 struct coda_rdwr_out {
631 struct coda_out_hdr oh;
634 caddr_t data; /* Place holder for data. */
639 /* CODA_REPLACE is a venus->kernel call */
640 struct coda_replace_out { /* coda_replace is a venus->kernel call */
641 struct coda_out_hdr oh;
646 /* coda_open_by_path: */
647 struct coda_open_by_path_in {
648 struct coda_in_hdr ih;
653 struct coda_open_by_path_out {
654 struct coda_out_hdr oh;
659 * Occasionally, we don't cache the fid returned by CODA_LOOKUP.
660 * For instance, if the fid is inconsistent.
661 * This case is handled by setting the top bit of the type result parameter.
663 #define CODA_NOCACHE 0x80000000
666 struct coda_in_hdr ih; /* NB: every struct below begins with an ih */
667 struct coda_open_in coda_open;
668 struct coda_close_in coda_close;
669 struct coda_ioctl_in coda_ioctl;
670 struct coda_getattr_in coda_getattr;
671 struct coda_setattr_in coda_setattr;
672 struct coda_access_in coda_access;
673 struct coda_lookup_in coda_lookup;
674 struct coda_create_in coda_create;
675 struct coda_remove_in coda_remove;
676 struct coda_link_in coda_link;
677 struct coda_rename_in coda_rename;
678 struct coda_mkdir_in coda_mkdir;
679 struct coda_rmdir_in coda_rmdir;
680 struct coda_readdir_in coda_readdir;
681 struct coda_symlink_in coda_symlink;
682 struct coda_readlink_in coda_readlink;
683 struct coda_fsync_in coda_fsync;
684 struct coda_inactive_in coda_inactive;
685 struct coda_vget_in coda_vget;
686 struct coda_rdwr_in coda_rdwr;
687 struct coda_open_by_path_in coda_open_by_path;
691 struct coda_out_hdr oh; /* NB: every struct below begins with an oh */
692 struct coda_root_out coda_root;
693 struct coda_open_out coda_open;
694 struct coda_ioctl_out coda_ioctl;
695 struct coda_getattr_out coda_getattr;
696 struct coda_lookup_out coda_lookup;
697 struct coda_create_out coda_create;
698 struct coda_mkdir_out coda_mkdir;
699 struct coda_readdir_out coda_readdir;
700 struct coda_readlink_out coda_readlink;
701 struct coda_vget_out coda_vget;
702 struct coda_purgeuser_out coda_purgeuser;
703 struct coda_zapfile_out coda_zapfile;
704 struct coda_zapdir_out coda_zapdir;
705 struct coda_zapvnode_out coda_zapvnode;
706 struct coda_purgefid_out coda_purgefid;
707 struct coda_rdwr_out coda_rdwr;
708 struct coda_replace_out coda_replace;
709 struct coda_open_by_path_out coda_open_by_path;
712 union coda_downcalls {
713 /* CODA_INVALIDATE is a venus->kernel call */
714 /* CODA_FLUSH is a venus->kernel call */
715 struct coda_purgeuser_out purgeuser;
716 struct coda_zapfile_out zapfile;
717 struct coda_zapdir_out zapdir;
718 struct coda_zapvnode_out zapvnode;
719 struct coda_purgefid_out purgefid;
720 struct coda_replace_out replace;
725 * Used for identifying usage of "Control" and pioctls
728 #define PIOCPARM_MASK 0x0000ffff
730 caddr_t in, out; /* Data to be transferred in, or out */
731 short in_size; /* Size of input buffer <= 2K */
732 short out_size; /* Maximum size of output buffer, <= 2K */
735 #if defined(__CYGWIN32__) || defined(DJGPP)
750 #define CODA_CONTROL ".CONTROL"
751 #define CODA_CONTROLLEN 8
756 #define CTL_FILE "/coda/.CONTROL"
759 #define IS_CTL_FID(fidp) ((fidp)->Volume == CTL_VOL &&\
760 (fidp)->Vnode == CTL_VNO &&\
761 (fidp)->Unique == CTL_UNI)