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 #define AFSOP_BKG_HANDLER        41     /* userspace-capable Bkg daemon */
  53 #define AFSOP_SET_RXMAXFRAGS     43     /* set rxi_nSendFrags, rxi_nRecvFrags */
  54 #define AFSOP_SET_RMTSYS_FLAG    44     /* set flag if rmtsys is enabled */
  55 #define AFSOP_SEED_ENTROPY       45     /* Give the kernel hcrypto entropy */
  56
  57 /* The range 20-30 is reserved for AFS system offsets in the afs_syscall */
  58 #define AFSCALL_PIOCTL          20
  59 #define AFSCALL_SETPAG          21
  60 #define AFSCALL_IOPEN           22
  61 #define AFSCALL_ICREATE         23
  62 #define AFSCALL_IREAD           24
  63 #define AFSCALL_IWRITE          25
  64 #define AFSCALL_IINC            26
  65 #define AFSCALL_IDEC            27
  66 #define AFSCALL_CALL            28
  67
  68 #define AFSCALL_ICL             30
  69
  70 /* 64 bit versions of inode system calls. */
  71 #define AFSCALL_IOPEN64         41
  72 #define AFSCALL_ICREATE64       42
  73 #define AFSCALL_IINC64          43
  74 #define AFSCALL_IDEC64          44
  75 #define AFSCALL_ILISTINODE64    45      /* Used by ListViceInodes */
  76 #define AFSCALL_ICREATENAME64   46      /* pass in platform specific pointer
  77                                          * used to create a name in in a
  78                                          * directory.
  79                                          */
  80 #ifdef AFS_SGI_VNODE_GLUE
  81 #define AFSCALL_INIT_KERNEL_CONFIG 47   /* set vnode glue ops. */
  82 #endif
  83
  84 #define AFSOP_GETMASK            42     /* stand-in for SIOCGIFNETMASK */
  85 /* For SGI, this can't interfere with any of the 64 bit inode calls. */
  86 #define AFSOP_RXLISTENER_DAEMON  48     /* starts kernel RX listener */
  87
  88 /* skip 64 bit calls */
  89 #define AFSOP_CACHEBASEDIR       50     /* cache base dir */
  90 #define AFSOP_CACHEDIRS          51     /* number of files per dir */
  91 #define AFSOP_CACHEFILES         52     /* number of files */
  92
  93 #define AFSOP_SETINT             60     /* we should just set key/value pairs
  94                                           for things which are just ints */
  95
  96 /* these are for initialization flags */
  97
  98 #define AFSCALL_INIT_MEMCACHE 0x1
  99
 100 /* flags for rxstats pioctl */
 101
 102 #define AFSCALL_RXSTATS_MASK    0x7     /* Valid flag bits */
 103 #define AFSCALL_RXSTATS_ENABLE  0x1     /* Enable RX stats */
 104 #define AFSCALL_RXSTATS_DISABLE 0x2     /* Disable RX stats */
 105 #define AFSCALL_RXSTATS_CLEAR   0x4     /* Clear RX stats */
 106
 107 #define AFSOP_GO                100     /* whether settime is being done */
 108 /* not for initialization: debugging assist */
 109 #define AFSOP_CHECKLOCKS        200     /* dump lock state */
 110 #define AFSOP_SHUTDOWN          201     /* Totally shutdown afs (deallocate all) */
 111
 112 /* The following aren't used by afs_initState but by afs_termState! */
 113 #define AFSOP_STOP_RXCALLBACK   210     /* Stop CALLBACK process */
 114 #define AFSOP_STOP_AFS          211     /* Stop AFS process */
 115 #define AFSOP_STOP_CS           216     /* Stop CheckServer daemon. */
 116 #define AFSOP_STOP_BKG          212     /* Stop BKG process */
 117 #define AFSOP_STOP_TRUNCDAEMON  213     /* Stop cache truncate daemon */
 118 /* #define AFSOP_STOP_RXEVENT   214     defined in osi.h              */
 119 /* #define AFSOP_STOP_COMPLETE     215  defined in osi.h              */
 120 /* #define AFSOP_STOP_RXK_LISTENER   217     defined in osi.h         */
 121 #define AFSOP_STOP_AFSDB        218     /* Stop AFSDB handler */
 122 #define AFSOP_STOP_NETIF        219     /* Stop Netif poller */
 123
 124 /* Main afs syscall entry; this number may vary per system (i.e. defined in afs/param.h) */
 125 #ifndef AFS_SYSCALL
 126 #define AFS_SYSCALL             31
 127 #endif
 128
 129 /* arguments passed by afsd */
 130 #define IDTYPE_UID 0
 131
 132 /* We don't necessarily have VenusFid here */
 133 struct afs_umv_param {
 134     afs_int32 id;
 135     afs_int32 idtype;
 136     afs_int32 sCell;
 137     afs_int32 sVolume;
 138     afs_int32 sVnode;
 139     afs_int32 sUnique;
 140     afs_int32 dCell;
 141     afs_int32 dVolume;
 142     afs_int32 dVnode;
 143     afs_int32 dUnique;
 144 };
 145
 146 #define AFS_USPC_UMV 1
 147
 148 struct afs_uspc_param {
 149     afs_int32 retval;
 150     afs_int32 ts; /* brequest ts - always unique */
 151     afs_int32 bufSz;
 152     afs_int32 reqtype;
 153     union {
 154         struct afs_umv_param umv;
 155     } req;
 156 };
 157
 158 struct afs_cacheParams {
 159     afs_int32 cacheScaches;
 160     afs_int32 cacheFiles;
 161     afs_int32 cacheBlocks;
 162     afs_int32 cacheDcaches;
 163     afs_int32 cacheVolumes;
 164     afs_int32 chunkSize;
 165     afs_int32 setTimeFlag;
 166     afs_int32 memCacheFlag;
 167     afs_int32 inodes;
 168     afs_int32 users;
 169     afs_int32 dynamic_vcaches;
 170 };
 171
 172 /*
 173  * Note that the AFS_*ALLOCSIZ values should be multiples of sizeof(void*) to
 174  * accomodate pointer alignment.
 175  */
 176 /* Used in rx.c as well as afs directory. */
 177 #if     defined(AFS_AIX32_ENV) || defined(AFS_HPUX_ENV)
 178 /* XXX Because of rxkad_cprivate... XXX */
 179 #define AFS_SMALLOCSIZ  (38*sizeof(void *))     /* "Small" allocated size */
 180 #else
 181 #define AFS_SMALLOCSIZ  (64*sizeof(void *))     /*  "Small" allocated size */
 182 #endif
 183 #define AFS_LRALLOCSIZ  4096    /* "Large" allocated size */
 184
 185 /* Cache configuration available through the client callback interface */
 186 typedef struct cm_initparams_v1 {
 187     afs_uint32 nChunkFiles;
 188     afs_uint32 nStatCaches;
 189     afs_uint32 nDataCaches;
 190     afs_uint32 nVolumeCaches;
 191     afs_uint32 firstChunkSize;
 192     afs_uint32 otherChunkSize;
 193     afs_uint32 cacheSize;
 194     afs_uint32 setTime;
 195     afs_uint32 memCache;
 196 } cm_initparams_v1;
 197
 198 /*
 199  * If you need to change afs_cacheParams, you should probably create a brand
 200  * new structure.  Keeping the old structure will allow backwards compatibility
 201  * with old clients (even if it is only used to calculate allocation size).
 202  * If you do change the size or the format, you'll need to bump
 203  * AFS_CLIENT_CONFIG_RETRIEVAL_VERSION.  This allows some primitive form
 204  * of versioning a la rxdebug.
 205  */
 206
 207 #define AFS_CLIENT_RETRIEVAL_VERSION            1       /* latest version */
 208 #define AFS_CLIENT_RETRIEVAL_FIRST_EDITION      1       /* first version */
 209
 210 /* Defines and structures for the AFS proc replacement layer for the original syscall (AFS_SYSCALL) strategy */
 211
 212 #ifdef AFS_LINUX20_ENV
 213
 214 #define PROC_FSDIRNAME "openafs"
 215 #define PROC_SYSCALL_NAME "afs_ioctl"
 216 #define PROC_SYSCALL_FNAME "/proc/fs/openafs/afs_ioctl"
 217 #define PROC_SYSCALL_ARLA_FNAME "/proc/fs/nnpfs/afs_ioctl"
 218 #define PROC_CELLSERVDB_NAME "CellServDB"
 219 #define PROC_PEER_NAME "rx_peer"
 220 #define PROC_CONN_NAME "rx_conn"
 221 #define PROC_CALL_NAME "rx_call"
 222 #define PROC_RX_NAME "rx"
 223 #define PROC_SERVICES_NAME "rx_services"
 224 #define PROC_RXSTATS_NAME "rx_stats"
 225 #define VIOC_SYSCALL_TYPE 'C'
 226 #define VIOC_SYSCALL _IOW(VIOC_SYSCALL_TYPE,1,void *)
 227 #define VIOC_SYSCALL32 _IOW(VIOC_SYSCALL_TYPE,1,int)
 228
 229 struct afsprocdata {
 230   long param4;
 231   long param3;
 232   long param2;
 233   long param1;
 234   long syscall;
 235 };
 236
 237 struct afsprocdata32 {
 238   unsigned int param4;
 239   unsigned int param3;
 240   unsigned int param2;
 241   unsigned int param1;
 242   unsigned int syscall;
 243 };
 244
 245 #endif
 246
 247 #ifdef AFS_DARWIN80_ENV
 248 struct afssysargs {
 249     unsigned int syscall;
 250     unsigned int param1;
 251     unsigned int param2;
 252     unsigned int param3;
 253     unsigned int param4;
 254     unsigned int param5;
 255     unsigned int param6;
 256     unsigned int retval;
 257 };
 258
 259 /* args reordered to avoid alignment issues */
 260 struct afssysargs64 {
 261     user_addr_t param1;
 262     user_addr_t param2;
 263     user_addr_t param3;
 264     user_addr_t param4;
 265     user_addr_t param5;
 266     user_addr_t param6;
 267     unsigned int syscall;
 268     unsigned int retval;
 269 };
 270 #define VIOC_SYSCALL_TYPE 'C'
 271 #define VIOC_SYSCALL _IOWR(VIOC_SYSCALL_TYPE,1,struct afssysargs)
 272 #define VIOC_SYSCALL64 _IOWR(VIOC_SYSCALL_TYPE,2,struct afssysargs64)
 273 #define SYSCALL_DEV_FNAME "/dev/openafs_ioctl"
 274 #endif
 275
 276 #ifdef AFS_SUN511_ENV
 277 # define VIOC_SYSCALL_TYPE 'C'
 278 # define VIOC_SYSCALL _IOW(VIOC_SYSCALL_TYPE, 1, struct afssysargs)
 279 # define VIOC_SYSCALL32 _IOW(VIOC_SYSCALL_TYPE, 2, struct afssysargs32)
 280 # define SYSCALL_DEV_FNAME "/dev/afs"
 281
 282 struct afssysargs {
 283     afs_uint64 param6;
 284     afs_uint64 param5;
 285     afs_uint64 param4;
 286     afs_uint64 param3;
 287     afs_uint64 param2;
 288     afs_uint64 param1;
 289     afs_uint32 syscall;
 290 };
 291
 292 struct afssysargs32 {
 293     afs_uint32 param6;
 294     afs_uint32 param5;
 295     afs_uint32 param4;
 296     afs_uint32 param3;
 297     afs_uint32 param2;
 298     afs_uint32 param1;
 299     afs_uint32 syscall;
 300 };
 301 #endif /* AFS_SUN511_ENV */
 302
 303 #ifdef AFS_CACHE_VNODE_PATH
 304 #define AFS_CACHE_CELLS_INODE -2
 305 #define AFS_CACHE_ITEMS_INODE -3
 306 #define AFS_CACHE_VOLUME_INODE -4
 307 #endif
 308
 309 #endif /* _AFS_ARGS_H_ */