Ok. I didn't make 2.4.0 in 2000. Tough. I tried, but we had some
[davej-history.git] / include / linux / coda.h
blobd9ab68c3541ccde952e836beef91b22569376c97
1 /*
2 You may distribute this file under either of the two licenses that
3 follow at your discretion.
4 */
6 /* BLURB lgpl
8 Coda File System
9 Release 5
11 Copyright (c) 1987-1999 Carnegie Mellon University
12 Additional copyrights listed below
14 This code is distributed "AS IS" without warranty of any kind under
15 the terms of the GNU Library General Public Licence Version 2, as
16 shown in the file LICENSE, or under the license shown below. The
17 technical and financial contributors to Coda are listed in the file
18 CREDITS.
20 Additional copyrights
25 Coda: an Experimental Distributed File System
26 Release 4.0
28 Copyright (c) 1987-1999 Carnegie Mellon University
29 All Rights Reserved
31 Permission to use, copy, modify and distribute this software and its
32 documentation is hereby granted, provided that both the copyright
33 notice and this permission notice appear in all copies of the
34 software, derivative works or modified versions, and any portions
35 thereof, and that both notices appear in supporting documentation, and
36 that credit is given to Carnegie Mellon University in all documents
37 and publicity pertaining to direct or indirect use of this code or its
38 derivatives.
40 CODA IS AN EXPERIMENTAL SOFTWARE SYSTEM AND IS KNOWN TO HAVE BUGS,
41 SOME OF WHICH MAY HAVE SERIOUS CONSEQUENCES. CARNEGIE MELLON ALLOWS
42 FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION. CARNEGIE MELLON
43 DISCLAIMS ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER
44 RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OF THIS SOFTWARE OR OF
45 ANY DERIVATIVE WORK.
47 Carnegie Mellon encourages users of this software to return any
48 improvements or extensions that they make, and to grant Carnegie
49 Mellon the rights to redistribute these changes without encumbrance.
54 * Based on cfs.h from Mach, but revamped for increased simplicity.
55 * Linux modifications by
56 * Peter Braam, Aug 1996
59 #ifndef _CODA_HEADER_
60 #define _CODA_HEADER_
64 /* Catch new _KERNEL defn for NetBSD and DJGPP/__CYGWIN32__ */
65 #if defined(__NetBSD__) || \
66 ((defined(DJGPP) || defined(__CYGWIN32__)) && !defined(KERNEL))
67 #include <sys/types.h>
68 #endif
70 #ifndef CODA_MAXSYMLINKS
71 #define CODA_MAXSYMLINKS 10
72 #endif
74 #if defined(DJGPP) || defined(__CYGWIN32__)
75 #ifdef KERNEL
76 typedef unsigned long u_long;
77 typedef unsigned int u_int;
78 typedef unsigned short u_short;
79 typedef u_long ino_t;
80 typedef u_long dev_t;
81 typedef void * caddr_t;
82 #ifdef DOS
83 typedef unsigned __int64 u_quad_t;
84 #else
85 typedef unsigned long long u_quad_t;
86 #endif
88 #define inline
90 struct timespec {
91 long ts_sec;
92 long ts_nsec;
94 #else /* DJGPP but not KERNEL */
95 #include <sys/time.h>
96 typedef unsigned long long u_quad_t;
97 #endif /* !KERNEL */
98 #endif /* !DJGPP */
101 #if defined(__linux__)
102 #define cdev_t u_quad_t
103 #ifndef __KERNEL__
104 #if !defined(_UQUAD_T_) && (!defined(__GLIBC__) || __GLIBC__ < 2)
105 #define _UQUAD_T_ 1
106 typedef unsigned long long u_quad_t;
107 #endif
108 #else /*__KERNEL__ */
109 typedef unsigned long long u_quad_t;
110 #endif /* __KERNEL__ */
111 #else
112 #define cdev_t dev_t
113 #endif
115 #ifdef __CYGWIN32__
116 struct timespec {
117 time_t tv_sec; /* seconds */
118 long tv_nsec; /* nanoseconds */
120 #endif
122 #ifndef __BIT_TYPES_DEFINED__
123 #define __BIT_TYPES_DEFINED__
124 typedef signed char int8_t;
125 typedef unsigned char u_int8_t;
126 typedef short int16_t;
127 typedef unsigned short u_int16_t;
128 typedef int int32_t;
129 typedef unsigned int u_int32_t;
130 #endif
134 * Cfs constants
136 #define CODA_MAXNAMLEN 255
137 #define CODA_MAXPATHLEN 1024
138 #define CODA_MAXSYMLINK 10
140 /* these are Coda's version of O_RDONLY etc combinations
141 * to deal with VFS open modes
143 #define C_O_READ 0x001
144 #define C_O_WRITE 0x002
145 #define C_O_TRUNC 0x010
146 #define C_O_EXCL 0x100
147 #define C_O_CREAT 0x200
149 /* these are to find mode bits in Venus */
150 #define C_M_READ 00400
151 #define C_M_WRITE 00200
153 /* for access Venus will use */
154 #define C_A_C_OK 8 /* Test for writing upon create. */
155 #define C_A_R_OK 4 /* Test for read permission. */
156 #define C_A_W_OK 2 /* Test for write permission. */
157 #define C_A_X_OK 1 /* Test for execute permission. */
158 #define C_A_F_OK 0 /* Test for existence. */
162 #ifndef _VENUS_DIRENT_T_
163 #define _VENUS_DIRENT_T_ 1
164 struct venus_dirent {
165 unsigned long d_fileno; /* file number of entry */
166 unsigned short d_reclen; /* length of this record */
167 unsigned char d_type; /* file type, see below */
168 unsigned char d_namlen; /* length of string in d_name */
169 char d_name[CODA_MAXNAMLEN + 1];/* name must be no longer than this */
171 #undef DIRSIZ
172 #define DIRSIZ(dp) ((sizeof (struct venus_dirent) - (CODA_MAXNAMLEN+1)) + \
173 (((dp)->d_namlen+1 + 3) &~ 3))
176 * File types
178 #define CDT_UNKNOWN 0
179 #define CDT_FIFO 1
180 #define CDT_CHR 2
181 #define CDT_DIR 4
182 #define CDT_BLK 6
183 #define CDT_REG 8
184 #define CDT_LNK 10
185 #define CDT_SOCK 12
186 #define CDT_WHT 14
189 * Convert between stat structure types and directory types.
191 #define IFTOCDT(mode) (((mode) & 0170000) >> 12)
192 #define CDTTOIF(dirtype) ((dirtype) << 12)
194 #endif
196 #ifndef _FID_T_
197 #define _FID_T_ 1
198 typedef u_long VolumeId;
199 typedef u_long VnodeId;
200 typedef u_long Unique_t;
201 typedef u_long FileVersion;
202 #endif
204 #ifndef _VICEFID_T_
205 #define _VICEFID_T_ 1
206 typedef struct ViceFid {
207 VolumeId Volume;
208 VnodeId Vnode;
209 Unique_t Unique;
210 } ViceFid;
211 #endif /* VICEFID */
214 #ifdef __linux__
215 static __inline__ ino_t coda_f2i(struct ViceFid *fid)
217 if ( ! fid )
218 return 0;
219 if (fid->Vnode == 0xfffffffe || fid->Vnode == 0xffffffff)
220 return ((fid->Volume << 20) | (fid->Unique & 0xfffff));
221 else
222 return (fid->Unique + (fid->Vnode<<10) + (fid->Volume<<20));
225 #else
226 #define coda_f2i(fid)\
227 ((fid) ? ((fid)->Unique + ((fid)->Vnode<<10) + ((fid)->Volume<<20)) : 0)
228 #endif
231 #ifndef _VUID_T_
232 #define _VUID_T_
233 typedef u_int32_t vuid_t;
234 typedef u_int32_t vgid_t;
235 #endif /*_VUID_T_ */
237 #ifndef _CODACRED_T_
238 #define _CODACRED_T_
239 struct coda_cred {
240 vuid_t cr_uid, cr_euid, cr_suid, cr_fsuid; /* Real, efftve, set, fs uid*/
241 vgid_t cr_groupid, cr_egid, cr_sgid, cr_fsgid; /* same for groups */
243 #endif
245 #ifndef _VENUS_VATTR_T_
246 #define _VENUS_VATTR_T_
248 * Vnode types. VNON means no type.
250 enum coda_vtype { C_VNON, C_VREG, C_VDIR, C_VBLK, C_VCHR, C_VLNK, C_VSOCK, C_VFIFO, C_VBAD };
252 struct coda_vattr {
253 long va_type; /* vnode type (for create) */
254 u_short va_mode; /* files access mode and type */
255 short va_nlink; /* number of references to file */
256 vuid_t va_uid; /* owner user id */
257 vgid_t va_gid; /* owner group id */
258 long va_fileid; /* file id */
259 u_quad_t va_size; /* file size in bytes */
260 long va_blocksize; /* blocksize preferred for i/o */
261 struct timespec va_atime; /* time of last access */
262 struct timespec va_mtime; /* time of last modification */
263 struct timespec va_ctime; /* time file changed */
264 u_long va_gen; /* generation number of file */
265 u_long va_flags; /* flags defined for file */
266 cdev_t va_rdev; /* device special file represents */
267 u_quad_t va_bytes; /* bytes of disk space held by file */
268 u_quad_t va_filerev; /* file modification number */
271 #endif
273 /* structure used by CODA_STATFS for getting cache information from venus */
274 struct coda_statfs {
275 int32_t f_blocks;
276 int32_t f_bfree;
277 int32_t f_bavail;
278 int32_t f_files;
279 int32_t f_ffree;
283 * Kernel <--> Venus communications.
286 #define CODA_ROOT 2
287 #define CODA_OPEN_BY_FD 3
288 #define CODA_OPEN 4
289 #define CODA_CLOSE 5
290 #define CODA_IOCTL 6
291 #define CODA_GETATTR 7
292 #define CODA_SETATTR 8
293 #define CODA_ACCESS 9
294 #define CODA_LOOKUP 10
295 #define CODA_CREATE 11
296 #define CODA_REMOVE 12
297 #define CODA_LINK 13
298 #define CODA_RENAME 14
299 #define CODA_MKDIR 15
300 #define CODA_RMDIR 16
301 #define CODA_SYMLINK 18
302 #define CODA_READLINK 19
303 #define CODA_FSYNC 20
304 #define CODA_VGET 22
305 #define CODA_SIGNAL 23
306 #define CODA_REPLACE 24 /* DOWNCALL */
307 #define CODA_FLUSH 25 /* DOWNCALL */
308 #define CODA_PURGEUSER 26 /* DOWNCALL */
309 #define CODA_ZAPFILE 27 /* DOWNCALL */
310 #define CODA_ZAPDIR 28 /* DOWNCALL */
311 #define CODA_PURGEFID 30 /* DOWNCALL */
312 #define CODA_OPEN_BY_PATH 31
313 #define CODA_RESOLVE 32
314 #define CODA_REINTEGRATE 33
315 #define CODA_STATFS 34
316 #define CODA_NCALLS 35
318 #define DOWNCALL(opcode) (opcode >= CODA_REPLACE && opcode <= CODA_PURGEFID)
320 #define VC_MAXDATASIZE 8192
321 #define VC_MAXMSGSIZE sizeof(union inputArgs)+sizeof(union outputArgs) +\
322 VC_MAXDATASIZE
324 #define CIOC_KERNEL_VERSION _IOWR('c', 10, sizeof (int))
326 #if 0
327 #define CODA_KERNEL_VERSION 0 /* don't care about kernel version number */
328 #define CODA_KERNEL_VERSION 1 /* The old venus 4.6 compatible interface */
329 #endif
330 #define CODA_KERNEL_VERSION 2 /* venus_lookup gets an extra parameter */
333 * Venus <-> Coda RPC arguments
335 struct coda_in_hdr {
336 unsigned long opcode;
337 unsigned long unique; /* Keep multiple outstanding msgs distinct */
338 u_short pid; /* Common to all */
339 u_short pgid; /* Common to all */
340 u_short sid; /* Common to all */
341 struct coda_cred cred; /* Common to all */
344 /* Really important that opcode and unique are 1st two fields! */
345 struct coda_out_hdr {
346 unsigned long opcode;
347 unsigned long unique;
348 unsigned long result;
351 /* coda_root: NO_IN */
352 struct coda_root_out {
353 struct coda_out_hdr oh;
354 ViceFid VFid;
357 struct coda_root_in {
358 struct coda_in_hdr in;
361 /* coda_open: */
362 struct coda_open_in {
363 struct coda_in_hdr ih;
364 ViceFid VFid;
365 int flags;
368 struct coda_open_out {
369 struct coda_out_hdr oh;
370 cdev_t dev;
371 ino_t inode;
375 /* coda_close: */
376 struct coda_close_in {
377 struct coda_in_hdr ih;
378 ViceFid VFid;
379 int flags;
382 struct coda_close_out {
383 struct coda_out_hdr out;
386 /* coda_ioctl: */
387 struct coda_ioctl_in {
388 struct coda_in_hdr ih;
389 ViceFid VFid;
390 int cmd;
391 int len;
392 int rwflag;
393 char *data; /* Place holder for data. */
396 struct coda_ioctl_out {
397 struct coda_out_hdr oh;
398 int len;
399 caddr_t data; /* Place holder for data. */
403 /* coda_getattr: */
404 struct coda_getattr_in {
405 struct coda_in_hdr ih;
406 ViceFid VFid;
409 struct coda_getattr_out {
410 struct coda_out_hdr oh;
411 struct coda_vattr attr;
415 /* coda_setattr: NO_OUT */
416 struct coda_setattr_in {
417 struct coda_in_hdr ih;
418 ViceFid VFid;
419 struct coda_vattr attr;
422 struct coda_setattr_out {
423 struct coda_out_hdr out;
426 /* coda_access: NO_OUT */
427 struct coda_access_in {
428 struct coda_in_hdr ih;
429 ViceFid VFid;
430 int flags;
433 struct coda_access_out {
434 struct coda_out_hdr out;
438 /* lookup flags */
439 #define CLU_CASE_SENSITIVE 0x01
440 #define CLU_CASE_INSENSITIVE 0x02
442 /* coda_lookup: */
443 struct coda_lookup_in {
444 struct coda_in_hdr ih;
445 ViceFid VFid;
446 int name; /* Place holder for data. */
447 int flags;
450 struct coda_lookup_out {
451 struct coda_out_hdr oh;
452 ViceFid VFid;
453 int vtype;
457 /* coda_create: */
458 struct coda_create_in {
459 struct coda_in_hdr ih;
460 ViceFid VFid;
461 struct coda_vattr attr;
462 int excl;
463 int mode;
464 int name; /* Place holder for data. */
467 struct coda_create_out {
468 struct coda_out_hdr oh;
469 ViceFid VFid;
470 struct coda_vattr attr;
474 /* coda_remove: NO_OUT */
475 struct coda_remove_in {
476 struct coda_in_hdr ih;
477 ViceFid VFid;
478 int name; /* Place holder for data. */
481 struct coda_remove_out {
482 struct coda_out_hdr out;
485 /* coda_link: NO_OUT */
486 struct coda_link_in {
487 struct coda_in_hdr ih;
488 ViceFid sourceFid; /* cnode to link *to* */
489 ViceFid destFid; /* Directory in which to place link */
490 int tname; /* Place holder for data. */
493 struct coda_link_out {
494 struct coda_out_hdr out;
498 /* coda_rename: NO_OUT */
499 struct coda_rename_in {
500 struct coda_in_hdr ih;
501 ViceFid sourceFid;
502 int srcname;
503 ViceFid destFid;
504 int destname;
507 struct coda_rename_out {
508 struct coda_out_hdr out;
511 /* coda_mkdir: */
512 struct coda_mkdir_in {
513 struct coda_in_hdr ih;
514 ViceFid VFid;
515 struct coda_vattr attr;
516 int name; /* Place holder for data. */
519 struct coda_mkdir_out {
520 struct coda_out_hdr oh;
521 ViceFid VFid;
522 struct coda_vattr attr;
526 /* coda_rmdir: NO_OUT */
527 struct coda_rmdir_in {
528 struct coda_in_hdr ih;
529 ViceFid VFid;
530 int name; /* Place holder for data. */
533 struct coda_rmdir_out {
534 struct coda_out_hdr out;
537 /* coda_symlink: NO_OUT */
538 struct coda_symlink_in {
539 struct coda_in_hdr ih;
540 ViceFid VFid; /* Directory to put symlink in */
541 int srcname;
542 struct coda_vattr attr;
543 int tname;
546 struct coda_symlink_out {
547 struct coda_out_hdr out;
550 /* coda_readlink: */
551 struct coda_readlink_in {
552 struct coda_in_hdr ih;
553 ViceFid VFid;
556 struct coda_readlink_out {
557 struct coda_out_hdr oh;
558 int count;
559 caddr_t data; /* Place holder for data. */
563 /* coda_fsync: NO_OUT */
564 struct coda_fsync_in {
565 struct coda_in_hdr ih;
566 ViceFid VFid;
569 struct coda_fsync_out {
570 struct coda_out_hdr out;
573 /* coda_vget: */
574 struct coda_vget_in {
575 struct coda_in_hdr ih;
576 ViceFid VFid;
579 struct coda_vget_out {
580 struct coda_out_hdr oh;
581 ViceFid VFid;
582 int vtype;
586 /* CODA_SIGNAL is out-of-band, doesn't need data. */
587 /* CODA_INVALIDATE is a venus->kernel call */
588 /* CODA_FLUSH is a venus->kernel call */
590 /* coda_purgeuser: */
591 /* CODA_PURGEUSER is a venus->kernel call */
592 struct coda_purgeuser_out {
593 struct coda_out_hdr oh;
594 struct coda_cred cred;
597 /* coda_zapfile: */
598 /* CODA_ZAPFILE is a venus->kernel call */
599 struct coda_zapfile_out {
600 struct coda_out_hdr oh;
601 ViceFid CodaFid;
604 /* coda_zapdir: */
605 /* CODA_ZAPDIR is a venus->kernel call */
606 struct coda_zapdir_out {
607 struct coda_out_hdr oh;
608 ViceFid CodaFid;
611 /* coda_zapnode: */
612 /* CODA_ZAPVNODE is a venus->kernel call */
613 struct coda_zapvnode_out {
614 struct coda_out_hdr oh;
615 struct coda_cred cred;
616 ViceFid VFid;
619 /* coda_purgefid: */
620 /* CODA_PURGEFID is a venus->kernel call */
621 struct coda_purgefid_out {
622 struct coda_out_hdr oh;
623 ViceFid CodaFid;
626 /* coda_replace: */
627 /* CODA_REPLACE is a venus->kernel call */
628 struct coda_replace_out { /* coda_replace is a venus->kernel call */
629 struct coda_out_hdr oh;
630 ViceFid NewFid;
631 ViceFid OldFid;
634 /* coda_open_by_fd: */
635 struct coda_open_by_fd_in {
636 struct coda_in_hdr ih;
637 ViceFid VFid;
638 int flags;
641 struct coda_open_by_fd_out {
642 struct coda_out_hdr oh;
643 int fd;
646 /* coda_open_by_path: */
647 struct coda_open_by_path_in {
648 struct coda_in_hdr ih;
649 ViceFid VFid;
650 int flags;
653 struct coda_open_by_path_out {
654 struct coda_out_hdr oh;
655 int path;
658 /* coda_statfs: NO_IN */
659 struct coda_statfs_in {
660 struct coda_in_hdr in;
663 struct coda_statfs_out {
664 struct coda_out_hdr oh;
665 struct coda_statfs stat;
669 * Occasionally, we don't cache the fid returned by CODA_LOOKUP.
670 * For instance, if the fid is inconsistent.
671 * This case is handled by setting the top bit of the type result parameter.
673 #define CODA_NOCACHE 0x80000000
675 union inputArgs {
676 struct coda_in_hdr ih; /* NB: every struct below begins with an ih */
677 struct coda_open_in coda_open;
678 struct coda_close_in coda_close;
679 struct coda_ioctl_in coda_ioctl;
680 struct coda_getattr_in coda_getattr;
681 struct coda_setattr_in coda_setattr;
682 struct coda_access_in coda_access;
683 struct coda_lookup_in coda_lookup;
684 struct coda_create_in coda_create;
685 struct coda_remove_in coda_remove;
686 struct coda_link_in coda_link;
687 struct coda_rename_in coda_rename;
688 struct coda_mkdir_in coda_mkdir;
689 struct coda_rmdir_in coda_rmdir;
690 struct coda_symlink_in coda_symlink;
691 struct coda_readlink_in coda_readlink;
692 struct coda_fsync_in coda_fsync;
693 struct coda_vget_in coda_vget;
694 struct coda_open_by_fd_in coda_open_by_fd;
695 struct coda_open_by_path_in coda_open_by_path;
696 struct coda_statfs_in coda_statfs;
699 union outputArgs {
700 struct coda_out_hdr oh; /* NB: every struct below begins with an oh */
701 struct coda_root_out coda_root;
702 struct coda_open_out coda_open;
703 struct coda_ioctl_out coda_ioctl;
704 struct coda_getattr_out coda_getattr;
705 struct coda_lookup_out coda_lookup;
706 struct coda_create_out coda_create;
707 struct coda_mkdir_out coda_mkdir;
708 struct coda_readlink_out coda_readlink;
709 struct coda_vget_out coda_vget;
710 struct coda_purgeuser_out coda_purgeuser;
711 struct coda_zapfile_out coda_zapfile;
712 struct coda_zapdir_out coda_zapdir;
713 struct coda_zapvnode_out coda_zapvnode;
714 struct coda_purgefid_out coda_purgefid;
715 struct coda_replace_out coda_replace;
716 struct coda_open_by_fd_out coda_open_by_fd;
717 struct coda_open_by_path_out coda_open_by_path;
718 struct coda_statfs_out coda_statfs;
721 union coda_downcalls {
722 /* CODA_INVALIDATE is a venus->kernel call */
723 /* CODA_FLUSH is a venus->kernel call */
724 struct coda_purgeuser_out purgeuser;
725 struct coda_zapfile_out zapfile;
726 struct coda_zapdir_out zapdir;
727 struct coda_zapvnode_out zapvnode;
728 struct coda_purgefid_out purgefid;
729 struct coda_replace_out replace;
734 * Used for identifying usage of "Control" and pioctls
737 #define PIOCPARM_MASK 0x0000ffff
738 struct ViceIoctl {
739 caddr_t in, out; /* Data to be transferred in, or out */
740 short in_size; /* Size of input buffer <= 2K */
741 short out_size; /* Maximum size of output buffer, <= 2K */
744 struct PioctlData {
745 const char *path;
746 int follow;
747 struct ViceIoctl vi;
750 #define CODA_CONTROL ".CONTROL"
751 #define CODA_CONTROLLEN 8
752 #define CTL_VOL -1
753 #define CTL_VNO -1
754 #define CTL_UNI -1
755 #define CTL_INO -1
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)
763 /* Data passed to mount */
765 #define CODA_MOUNT_VERSION 1
767 struct coda_mount_data {
768 int version;
769 int fd; /* Opened device */
772 #endif