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