e599bda515b610c342dfb27d8088a470c9ad4dce
[openafs.git] / src / config / afs_args.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 /*
11  * AFS system call opcodes
12  */
13
14 #ifndef _AFS_ARGS_H_
15 #define _AFS_ARGS_H_
16
17 #define AFSOP_START_RXCALLBACK    0     /* no aux parms */
18 #define AFSOP_START_AFS           1     /* no aux parms */
19 #define AFSOP_START_BKG           2     /* no aux parms */
20 #define AFSOP_START_TRUNCDAEMON   3     /* no aux parms */
21 #define AFSOP_START_CS            4     /* no aux parms */
22
23 #define AFSOP_ADDCELL             5     /* parm 2 = cell str */
24 #define AFSOP_CACHEINIT           6     /* parms 2-4 -> cache sizes */
25 #define AFSOP_CACHEINFO           7     /* the cacheinfo file */
26 #define AFSOP_VOLUMEINFO          8     /* the volumeinfo file */
27 #define AFSOP_CACHEFILE           9     /* a random cache file (V*) */
28 #define AFSOP_CACHEINODE         10     /* random cache file by inode */
29 #define AFSOP_AFSLOG             11     /* output log file */
30 #define AFSOP_ROOTVOLUME         12     /* non-standard root volume name */
31 #define AFSOP_STARTLOG           14     /* temporary: Start afs logging */
32 #define AFSOP_ENDLOG             15     /* temporary: End afs logging */
33 #define AFSOP_AFS_VFSMOUNT       16     /* vfsmount cover for hpux */
34 #define AFSOP_ADVISEADDR         17     /* to init rx cid generator */
35 #define AFSOP_CLOSEWAIT          18     /* make all closes synchronous */
36 #define AFSOP_RXEVENT_DAEMON     19     /* rxevent daemon */
37 #define AFSOP_GETMTU             20     /* stand-in for SIOCGIFMTU, for now */
38 #define AFSOP_GETIFADDRS         21     /* get machine's ethernet interfaces */
39
40 #define AFSOP_ADDCELL2           29     /* 2nd add cell protocol interface */
41 #define AFSOP_AFSDB_HANDLER      30     /* userspace AFSDB lookup handler */
42 #define AFSOP_SET_DYNROOT        31     /* enable/disable dynroot support */
43 #define AFSOP_ADDCELLALIAS       32     /* create alias for existing cell */
44 #define AFSOP_SET_FAKESTAT       33     /* enable/disable fakestat support */
45 #define AFSOP_CELLINFO           34     /* set the cellinfo file name */
46 #define AFSOP_SET_THISCELL       35     /* set the primary cell */
47 #define AFSOP_BASIC_INIT         36     /* used to be part of START_AFS */
48 #define AFSOP_SET_BACKUPTREE     37     /* enable backup tree support */
49 #define AFSOP_SET_RXPCK          38     /* set rx_extraPackets*/
50 #define AFSOP_BUCKETPCT          39     /* bucket percentage */
51 #define AFSOP_SET_RXMAXMTU       40     /* set rx_MyMaxSendSize,rx_maxReceiveSizeUser,rx_maxReceiveSize */  
52
53 /* The range 20-30 is reserved for AFS system offsets in the afs_syscall */
54 #define AFSCALL_PIOCTL          20
55 #define AFSCALL_SETPAG          21
56 #define AFSCALL_IOPEN           22
57 #define AFSCALL_ICREATE         23
58 #define AFSCALL_IREAD           24
59 #define AFSCALL_IWRITE          25
60 #define AFSCALL_IINC            26
61 #define AFSCALL_IDEC            27
62 #define AFSCALL_CALL            28
63
64 #define AFSCALL_ICL             30
65
66 /* 64 bit versions of inode system calls. */
67 #define AFSCALL_IOPEN64         41
68 #define AFSCALL_ICREATE64       42
69 #define AFSCALL_IINC64          43
70 #define AFSCALL_IDEC64          44
71 #define AFSCALL_ILISTINODE64    45      /* Used by ListViceInodes */
72 #define AFSCALL_ICREATENAME64   46      /* pass in platform specific pointer
73                                          * used to create a name in in a
74                                          * directory.
75                                          */
76 #ifdef AFS_SGI_VNODE_GLUE
77 #define AFSCALL_INIT_KERNEL_CONFIG 47   /* set vnode glue ops. */
78 #endif
79
80 #ifdef  AFS_SGI53_ENV
81 #define AFSOP_NFSSTATICADDR      32     /* to contents addr of nfs kernel addr */
82 #define AFSOP_NFSSTATICADDRPTR   33     /* pass addr of variable containing 
83                                          * address into kernel. */
84 #define AFSOP_NFSSTATICADDR2     34     /* pass address in as hyper. */
85 #define AFSOP_SBLOCKSTATICADDR2  35     /* for sblock and sbunlock */
86 #endif
87 #define AFSOP_GETMASK            42     /* stand-in for SIOCGIFNETMASK */
88 /* For SGI, this can't interfere with any of the 64 bit inode calls. */
89 #define AFSOP_RXLISTENER_DAEMON  48     /* starts kernel RX listener */
90
91 /* skip 64 bit calls */
92 #define AFSOP_CACHEBASEDIR       50     /* cache base dir */
93 #define AFSOP_CACHEDIRS          51     /* number of files per dir */
94 #define AFSOP_CACHEFILES         52     /* number of files */
95
96 #define AFSOP_SETINT             60     /* we should just set key/value pairs 
97                                           for things which are just ints */
98
99 /* these are for initialization flags */
100
101 #define AFSCALL_INIT_MEMCACHE 0x1
102 #define AFSCALL_INIT_MEMCACHE_SLEEP 0x2 /* Use osi_Alloc to allocate memcache
103                                          * instead of osi_Alloc_NoSleep */
104
105 /* flags for rxstats pioctl */
106
107 #define AFSCALL_RXSTATS_MASK    0x7     /* Valid flag bits */
108 #define AFSCALL_RXSTATS_ENABLE  0x1     /* Enable RX stats */
109 #define AFSCALL_RXSTATS_DISABLE 0x2     /* Disable RX stats */
110 #define AFSCALL_RXSTATS_CLEAR   0x4     /* Clear RX stats */
111
112 #define AFSOP_GO                100     /* whether settime is being done */
113 /* not for initialization: debugging assist */
114 #define AFSOP_CHECKLOCKS        200     /* dump lock state */
115 #define AFSOP_SHUTDOWN          201     /* Totally shutdown afs (deallocate all) */
116
117 /* The following aren't used by afs_initState but by afs_termState! */
118 #define AFSOP_STOP_RXCALLBACK   210     /* Stop CALLBACK process */
119 #define AFSOP_STOP_AFS          211     /* Stop AFS process */
120 #define AFSOP_STOP_CS           216     /* Stop CheckServer daemon. */
121 #define AFSOP_STOP_BKG          212     /* Stop BKG process */
122 #define AFSOP_STOP_TRUNCDAEMON  213     /* Stop cache truncate daemon */
123 /* #define AFSOP_STOP_RXEVENT   214     defined in osi.h              */
124 /* #define AFSOP_STOP_COMPLETE     215  defined in osi.h              */
125 /* #define AFSOP_STOP_RXK_LISTENER   217     defined in osi.h         */
126 #define AFSOP_STOP_AFSDB        218     /* Stop AFSDB handler */
127 #define AFSOP_STOP_NETIF        219     /* Stop Netif poller */
128
129 /* Main afs syscall entry; this number may vary per system (i.e. defined in afs/param.h) */
130 #ifndef AFS_SYSCALL
131 #define AFS_SYSCALL             31
132 #endif
133
134 /* arguments passed by afsd */
135 struct afs_cacheParams {
136     afs_int32 cacheScaches;
137     afs_int32 cacheFiles;
138     afs_int32 cacheBlocks;
139     afs_int32 cacheDcaches;
140     afs_int32 cacheVolumes;
141     afs_int32 chunkSize;
142     afs_int32 setTimeFlag;
143     afs_int32 memCacheFlag;
144     afs_int32 inodes;
145     afs_int32 users;
146     afs_int32 dynamic_vcaches;
147 };
148
149 /*
150  * Note that the AFS_*ALLOCSIZ values should be multiples of sizeof(void*) to
151  * accomodate pointer alignment.
152  */
153 /* Used in rx.c as well as afs directory. */
154 #if     defined(AFS_AIX32_ENV) || defined(AFS_HPUX_ENV)
155 /* XXX Because of rxkad_cprivate... XXX */
156 #define AFS_MDALLOCSIZ  (127*sizeof(void *))    /* "Medium" allocated size */
157 #define AFS_MALLOC_LOW_WATER    50      /* Min free blocks before allocating more */
158 #define AFS_SMALLOCSIZ  (38*sizeof(void *))     /* "Small" allocated size */
159 #else
160 #define AFS_SMALLOCSIZ  (64*sizeof(void *))     /*  "Small" allocated size */
161 #endif
162
163 /* Cache configuration available through the client callback interface */
164 typedef struct cm_initparams_v1 {
165     afs_uint32 nChunkFiles;
166     afs_uint32 nStatCaches;
167     afs_uint32 nDataCaches;
168     afs_uint32 nVolumeCaches;
169     afs_uint32 firstChunkSize;
170     afs_uint32 otherChunkSize;
171     afs_uint32 cacheSize;
172     afs_uint32 setTime;
173     afs_uint32 memCache;
174 } cm_initparams_v1;
175
176 /*
177  * If you need to change afs_cacheParams, you should probably create a brand
178  * new structure.  Keeping the old structure will allow backwards compatibility
179  * with old clients (even if it is only used to calculate allocation size).
180  * If you do change the size or the format, you'll need to bump
181  * AFS_CLIENT_CONFIG_RETRIEVAL_VERSION.  This allows some primitive form
182  * of versioning a la rxdebug.
183  */
184
185 #define AFS_CLIENT_RETRIEVAL_VERSION            1       /* latest version */
186 #define AFS_CLIENT_RETRIEVAL_FIRST_EDITION      1       /* first version */
187
188 /* Defines and structures for the AFS proc replacement layer for the original syscall (AFS_SYSCALL) strategy */
189
190 #ifdef AFS_LINUX20_ENV
191  
192 #define PROC_FSDIRNAME "openafs"
193 #define PROC_SYSCALL_NAME "afs_ioctl"
194 #define PROC_SYSCALL_FNAME "/proc/fs/openafs/afs_ioctl"
195 #define PROC_SYSCALL_ARLA_FNAME "/proc/fs/nnpfs/afs_ioctl"
196 #define PROC_CELLSERVDB_NAME "CellServDB"
197 #define PROC_PEER_NAME "rx_peer"
198 #define PROC_CONN_NAME "rx_conn"
199 #define PROC_CALL_NAME "rx_call"
200 #define PROC_RX_NAME "rx"
201 #define PROC_SERVICES_NAME "rx_services"
202 #define PROC_RXSTATS_NAME "rx_stats"
203 #define VIOC_SYSCALL_TYPE 'C' 
204 #define VIOC_SYSCALL _IOW(VIOC_SYSCALL_TYPE,1,void *)
205 #define VIOC_SYSCALL32 _IOW(VIOC_SYSCALL_TYPE,1,int)
206  
207 struct afsprocdata {
208   long param4;
209   long param3;
210   long param2;
211   long param1;
212   long syscall;
213 };
214
215 struct afsprocdata32 {
216   unsigned int param4;
217   unsigned int param3;
218   unsigned int param2;
219   unsigned int param1;
220   unsigned int syscall;
221 };
222  
223 #endif
224
225 #ifdef AFS_DARWIN80_ENV
226 struct afssysargs {
227      unsigned long syscall;
228      unsigned long param1;
229      unsigned long param2;
230      unsigned long param3;
231      unsigned long param4;
232      unsigned long param5;
233      unsigned long param6;
234      unsigned long retval;
235 };
236 #define VIOC_SYSCALL_TYPE 'C' 
237 #define VIOC_SYSCALL _IOWR(VIOC_SYSCALL_TYPE,1,struct afssysargs)
238 #define SYSCALL_DEV_FNAME "/dev/openafs_ioctl"
239 #endif
240
241 #ifdef AFS_CACHE_VNODE_PATH
242 #define AFS_CACHE_CELLS_INODE -2
243 #define AFS_CACHE_ITEMS_INODE -3
244 #define AFS_CACHE_VOLUME_INODE -4
245 #endif
246
247 #endif /* _AFS_ARGS_H_ */