cd6907fcae89d24c36975d0a711fae29d3ac0780
[openafs.git] / src / afs / afs_pioctl.c
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 #include <afsconfig.h>
11 #include "afs/param.h"
12
13
14 #include "afs/sysincludes.h"    /* Standard vendor system headers */
15 #ifdef AFS_OBSD_ENV
16 #include "h/syscallargs.h"
17 #endif
18 #ifdef AFS_FBSD_ENV
19 #include "h/sysproto.h"
20 #endif
21 #ifdef AFS_NBSD40_ENV
22 #include <sys/ioctl.h>
23 #include <sys/ioccom.h>
24 #endif
25 #include "afsincludes.h"        /* Afs-based standard headers */
26 #include "afs/afs_stats.h"      /* afs statistics */
27 #include "afs/vice.h"
28 #include "afs/afs_bypasscache.h"
29 #include "rx/rx_globals.h"
30 #include "token.h"
31
32 extern int afs_rmtsys_enable;
33 struct VenusFid afs_rootFid;
34 afs_int32 afs_waitForever = 0;
35 short afs_waitForeverCount = 0;
36 afs_int32 afs_showflags = GAGUSER | GAGCONSOLE; /* show all messages */
37
38 afs_int32 afs_is_disconnected;
39 afs_int32 afs_is_discon_rw;
40 /* On reconnection, turn this knob on until it finishes,
41  * then turn it off.
42  */
43 afs_int32 afs_in_sync = 0;
44
45 struct afs_pdata {
46     char *ptr;
47     size_t remaining;
48 };
49
50 /*
51  * A set of handy little functions for encoding and decoding
52  * pioctls without losing your marbles, or memory integrity
53  */
54
55 static_inline int
56 afs_pd_alloc(struct afs_pdata *apd, size_t size)
57 {
58     /* Ensure that we give caller at least one trailing guard byte
59      * for the NUL terminator. */
60     if (size >= AFS_LRALLOCSIZ)
61         apd->ptr = osi_Alloc(size + 1);
62     else
63         apd->ptr = osi_AllocLargeSpace(AFS_LRALLOCSIZ);
64
65     if (apd->ptr == NULL)
66         return ENOMEM;
67
68     /* Clear it all now, including the guard byte. */
69     if (size >= AFS_LRALLOCSIZ)
70         memset(apd->ptr, 0, size + 1);
71     else
72         memset(apd->ptr, 0, AFS_LRALLOCSIZ);
73
74     /* Don't tell the caller about the guard byte. */
75     apd->remaining = size;
76
77     return 0;
78 }
79
80 static_inline void
81 afs_pd_free(struct afs_pdata *apd)
82 {
83     if (apd->ptr == NULL)
84         return;
85
86     if (apd->remaining >= AFS_LRALLOCSIZ)
87         osi_Free(apd->ptr, apd->remaining + 1);
88     else
89         osi_FreeLargeSpace(apd->ptr);
90
91     apd->ptr = NULL;
92     apd->remaining = 0;
93 }
94
95 static_inline char *
96 afs_pd_where(struct afs_pdata *apd)
97 {
98     return apd ? apd->ptr : NULL;
99 }
100
101 static_inline size_t
102 afs_pd_remaining(struct afs_pdata *apd)
103 {
104     return apd ? apd->remaining : 0;
105 }
106
107 static_inline int
108 afs_pd_skip(struct afs_pdata *apd, size_t skip)
109 {
110     if (apd == NULL || apd->remaining < skip)
111         return EINVAL;
112     apd->remaining -= skip;
113     apd->ptr += skip;
114
115     return 0;
116 }
117
118 static_inline int
119 afs_pd_getBytes(struct afs_pdata *apd, void *dest, size_t bytes)
120 {
121     if (apd == NULL || apd->remaining < bytes)
122         return EINVAL;
123     apd->remaining -= bytes;
124     memcpy(dest, apd->ptr, bytes);
125     apd->ptr += bytes;
126     return 0;
127 }
128
129 static_inline int
130 afs_pd_getInt(struct afs_pdata *apd, afs_int32 *val)
131 {
132     return afs_pd_getBytes(apd, val, sizeof(*val));
133 }
134
135 static_inline int
136 afs_pd_getUint(struct afs_pdata *apd, afs_uint32 *val)
137 {
138     return afs_pd_getBytes(apd, val, sizeof(*val));
139 }
140
141 static_inline void *
142 afs_pd_inline(struct afs_pdata *apd, size_t bytes)
143 {
144     void *ret;
145
146     if (apd == NULL || apd->remaining < bytes)
147         return NULL;
148
149     ret = apd->ptr;
150
151     apd->remaining -= bytes;
152     apd->ptr += bytes;
153
154     return ret;
155 }
156
157 static_inline void
158 afs_pd_xdrStart(struct afs_pdata *apd, XDR *xdrs, enum xdr_op op) {
159     xdrmem_create(xdrs, apd->ptr, apd->remaining, op);
160 }
161
162 static_inline void
163 afs_pd_xdrEnd(struct afs_pdata *apd, XDR *xdrs) {
164     size_t pos;
165
166     pos = xdr_getpos(xdrs);
167     apd->ptr += pos;
168     apd->remaining -= pos;
169     xdr_destroy(xdrs);
170 }
171
172
173
174 static_inline int
175 afs_pd_getString(struct afs_pdata *apd, char *str, size_t maxLen)
176 {
177     size_t len;
178
179     if (apd == NULL || apd->remaining <= 0)
180         return EINVAL;
181     len = strlen(apd->ptr) + 1;
182     if (len > maxLen)
183         return E2BIG;
184     memcpy(str, apd->ptr, len);
185     apd->ptr += len;
186     apd->remaining -= len;
187     return 0;
188 }
189
190 static_inline int
191 afs_pd_getStringPtr(struct afs_pdata *apd, char **str)
192 {
193     size_t len;
194
195     if (apd == NULL || apd->remaining <= 0)
196         return EINVAL;
197     len = strlen(apd->ptr) + 1;
198     *str = apd->ptr;
199     apd->ptr += len;
200     apd->remaining -= len;
201     return 0;
202 }
203
204 static_inline int
205 afs_pd_putBytes(struct afs_pdata *apd, const void *bytes, size_t len)
206 {
207     if (apd == NULL || apd->remaining < len)
208         return E2BIG;
209     memcpy(apd->ptr, bytes, len);
210     apd->ptr += len;
211     apd->remaining -= len;
212     return 0;
213 }
214
215 static_inline int
216 afs_pd_putInt(struct afs_pdata *apd, afs_int32 val)
217 {
218     return afs_pd_putBytes(apd, &val, sizeof(val));
219 }
220
221 static_inline int
222 afs_pd_putString(struct afs_pdata *apd, char *str) {
223
224     /* Add 1 so we copy the NULL too */
225     return afs_pd_putBytes(apd, str, strlen(str) +1);
226 }
227
228 /*!
229  * \defgroup pioctl Path IOCTL functions
230  *
231  * DECL_PIOCTL is a macro defined to contain the following parameters for functions:
232  *
233  * \param[in] avc
234  *      the AFS vcache structure in use by pioctl
235  * \param[in] afun
236  *      not in use
237  * \param[in] areq
238  *      the AFS vrequest structure
239  * \param[in] ain
240  *      an afs_pdata block describing the data received from the caller
241  * \param[in] aout
242  *      an afs_pdata block describing a pre-allocated block for output
243  * \param[in] acred
244  *      UNIX credentials structure underlying the operation
245  */
246
247 #define DECL_PIOCTL(x) \
248         static int x(struct vcache *avc, int afun, struct vrequest *areq, \
249                      struct afs_pdata *ain, struct afs_pdata *aout, \
250                      afs_ucred_t **acred)
251
252 /* Prototypes for pioctl routines */
253 DECL_PIOCTL(PGetFID);
254 DECL_PIOCTL(PSetAcl);
255 DECL_PIOCTL(PStoreBehind);
256 DECL_PIOCTL(PGCPAGs);
257 DECL_PIOCTL(PGetAcl);
258 DECL_PIOCTL(PNoop);
259 DECL_PIOCTL(PBogus);
260 DECL_PIOCTL(PGetFileCell);
261 DECL_PIOCTL(PGetWSCell);
262 DECL_PIOCTL(PGetUserCell);
263 DECL_PIOCTL(PSetTokens);
264 DECL_PIOCTL(PSetTokens2);
265 DECL_PIOCTL(PGetVolumeStatus);
266 DECL_PIOCTL(PSetVolumeStatus);
267 DECL_PIOCTL(PFlush);
268 DECL_PIOCTL(PNewStatMount);
269 DECL_PIOCTL(PGetTokens);
270 DECL_PIOCTL(PGetTokens2);
271 DECL_PIOCTL(PUnlog);
272 DECL_PIOCTL(PMariner);
273 DECL_PIOCTL(PCheckServers);
274 DECL_PIOCTL(PCheckVolNames);
275 DECL_PIOCTL(PCheckAuth);
276 DECL_PIOCTL(PFindVolume);
277 DECL_PIOCTL(PViceAccess);
278 DECL_PIOCTL(PSetCacheSize);
279 DECL_PIOCTL(PGetCacheSize);
280 DECL_PIOCTL(PRemoveCallBack);
281 DECL_PIOCTL(PNewCell);
282 DECL_PIOCTL(PNewAlias);
283 DECL_PIOCTL(PListCells);
284 DECL_PIOCTL(PListAliases);
285 DECL_PIOCTL(PRemoveMount);
286 DECL_PIOCTL(PGetCellStatus);
287 DECL_PIOCTL(PSetCellStatus);
288 DECL_PIOCTL(PFlushVolumeData);
289 DECL_PIOCTL(PFlushAllVolumeData);
290 DECL_PIOCTL(PGetVnodeXStatus);
291 DECL_PIOCTL(PGetVnodeXStatus2);
292 DECL_PIOCTL(PSetSysName);
293 DECL_PIOCTL(PSetSPrefs);
294 DECL_PIOCTL(PSetSPrefs33);
295 DECL_PIOCTL(PGetSPrefs);
296 DECL_PIOCTL(PExportAfs);
297 DECL_PIOCTL(PGag);
298 DECL_PIOCTL(PTwiddleRx);
299 DECL_PIOCTL(PGetInitParams);
300 DECL_PIOCTL(PGetRxkcrypt);
301 DECL_PIOCTL(PSetRxkcrypt);
302 DECL_PIOCTL(PGetCPrefs);
303 DECL_PIOCTL(PSetCPrefs);
304 DECL_PIOCTL(PFlushMount);
305 DECL_PIOCTL(PRxStatProc);
306 DECL_PIOCTL(PRxStatPeer);
307 DECL_PIOCTL(PPrefetchFromTape);
308 DECL_PIOCTL(PFsCmd);
309 DECL_PIOCTL(PCallBackAddr);
310 DECL_PIOCTL(PDiscon);
311 DECL_PIOCTL(PNFSNukeCreds);
312 DECL_PIOCTL(PNewUuid);
313 DECL_PIOCTL(PPrecache);
314 DECL_PIOCTL(PGetPAG);
315 #if defined(AFS_CACHE_BYPASS) && defined(AFS_LINUX24_ENV)
316 DECL_PIOCTL(PSetCachingThreshold);
317 #endif
318
319 /*
320  * A macro that says whether we're going to need HandleClientContext().
321  * This is currently used only by the nfs translator.
322  */
323 #if !defined(AFS_NONFSTRANS) || defined(AFS_AIX_IAUTH_ENV)
324 #define AFS_NEED_CLIENTCONTEXT
325 #endif
326
327 /* Prototypes for private routines */
328 #ifdef AFS_NEED_CLIENTCONTEXT
329 static int HandleClientContext(struct afs_ioctl *ablob, int *com,
330                                afs_ucred_t **acred,
331                                afs_ucred_t *credp);
332 #endif
333 int HandleIoctl(struct vcache *avc, afs_int32 acom,
334                 struct afs_ioctl *adata);
335 int afs_HandlePioctl(struct vnode *avp, afs_int32 acom,
336                      struct afs_ioctl *ablob, int afollow,
337                      afs_ucred_t **acred);
338 static int Prefetch(uparmtype apath, struct afs_ioctl *adata, int afollow,
339                     afs_ucred_t *acred);
340
341 typedef int (*pioctlFunction) (struct vcache *, int, struct vrequest *,
342                                struct afs_pdata *, struct afs_pdata *,
343                                afs_ucred_t **);
344
345 static pioctlFunction VpioctlSw[] = {
346     PBogus,                     /* 0 */
347     PSetAcl,                    /* 1 */
348     PGetAcl,                    /* 2 */
349     PSetTokens,                 /* 3 */
350     PGetVolumeStatus,           /* 4 */
351     PSetVolumeStatus,           /* 5 */
352     PFlush,                     /* 6 */
353     PBogus,                     /* 7 */
354     PGetTokens,                 /* 8 */
355     PUnlog,                     /* 9 */
356     PCheckServers,              /* 10 */
357     PCheckVolNames,             /* 11 */
358     PCheckAuth,                 /* 12 */
359     PBogus,                     /* 13 -- used to be quick check time */
360     PFindVolume,                /* 14 */
361     PBogus,                     /* 15 -- prefetch is now special-cased; see pioctl code! */
362     PBogus,                     /* 16 -- used to be testing code */
363     PNoop,                      /* 17 -- used to be enable group */
364     PNoop,                      /* 18 -- used to be disable group */
365     PBogus,                     /* 19 -- used to be list group */
366     PViceAccess,                /* 20 */
367     PUnlog,                     /* 21 -- unlog *is* unpag in this system */
368     PGetFID,                    /* 22 -- get file ID */
369     PBogus,                     /* 23 -- used to be waitforever */
370     PSetCacheSize,              /* 24 */
371     PRemoveCallBack,            /* 25 -- flush only the callback */
372     PNewCell,                   /* 26 */
373     PListCells,                 /* 27 */
374     PRemoveMount,               /* 28 -- delete mount point */
375     PNewStatMount,              /* 29 -- new style mount point stat */
376     PGetFileCell,               /* 30 -- get cell name for input file */
377     PGetWSCell,                 /* 31 -- get cell name for workstation */
378     PMariner,                   /* 32 - set/get mariner host */
379     PGetUserCell,               /* 33 -- get cell name for user */
380     PBogus,                     /* 34 -- Enable/Disable logging */
381     PGetCellStatus,             /* 35 */
382     PSetCellStatus,             /* 36 */
383     PFlushVolumeData,           /* 37 -- flush all data from a volume */
384     PSetSysName,                /* 38 - Set system name */
385     PExportAfs,                 /* 39 - Export Afs to remote nfs clients */
386     PGetCacheSize,              /* 40 - get cache size and usage */
387     PGetVnodeXStatus,           /* 41 - get vcache's special status */
388     PSetSPrefs33,               /* 42 - Set CM Server preferences... */
389     PGetSPrefs,                 /* 43 - Get CM Server preferences... */
390     PGag,                       /* 44 - turn off/on all CM messages */
391     PTwiddleRx,                 /* 45 - adjust some RX params       */
392     PSetSPrefs,                 /* 46 - Set CM Server preferences... */
393     PStoreBehind,               /* 47 - set degree of store behind to be done */
394     PGCPAGs,                    /* 48 - disable automatic pag gc-ing */
395     PGetInitParams,             /* 49 - get initial cm params */
396     PGetCPrefs,                 /* 50 - get client interface addresses */
397     PSetCPrefs,                 /* 51 - set client interface addresses */
398     PFlushMount,                /* 52 - flush mount symlink data */
399     PRxStatProc,                /* 53 - control process RX statistics */
400     PRxStatPeer,                /* 54 - control peer RX statistics */
401     PGetRxkcrypt,               /* 55 -- Get rxkad encryption flag */
402     PSetRxkcrypt,               /* 56 -- Set rxkad encryption flag */
403     PBogus,                     /* 57 -- arla: set file prio */
404     PBogus,                     /* 58 -- arla: fallback getfh */
405     PBogus,                     /* 59 -- arla: fallback fhopen */
406     PBogus,                     /* 60 -- arla: controls xfsdebug */
407     PBogus,                     /* 61 -- arla: controls arla debug */
408     PBogus,                     /* 62 -- arla: debug interface */
409     PBogus,                     /* 63 -- arla: print xfs status */
410     PBogus,                     /* 64 -- arla: force cache check */
411     PBogus,                     /* 65 -- arla: break callback */
412     PPrefetchFromTape,          /* 66 -- MR-AFS: prefetch file from tape */
413     PFsCmd,                     /* 67 -- RXOSD: generic commnd interface */
414     PBogus,                     /* 68 -- arla: fetch stats */
415     PGetVnodeXStatus2,          /* 69 - get caller access and some vcache status */
416 };
417
418 static pioctlFunction CpioctlSw[] = {
419     PBogus,                     /* 0 */
420     PNewAlias,                  /* 1 -- create new cell alias */
421     PListAliases,               /* 2 -- list cell aliases */
422     PCallBackAddr,              /* 3 -- request addr for callback rxcon */
423     PBogus,                     /* 4 */
424     PDiscon,                    /* 5 -- get/set discon mode */
425     PBogus,                     /* 6 */
426     PGetTokens2,                /* 7 */
427     PSetTokens2,                /* 8 */
428     PNewUuid,                   /* 9 */
429     PBogus,                     /* 10 */
430     PBogus,                     /* 11 */
431     PPrecache,                  /* 12 */
432     PGetPAG,                    /* 13 */
433     PFlushAllVolumeData,        /* 14 */
434 };
435
436 static pioctlFunction OpioctlSw[]  = {
437     PBogus,                     /* 0 */
438     PNFSNukeCreds,              /* 1 -- nuke all creds for NFS client */
439 #if defined(AFS_CACHE_BYPASS) && defined(AFS_LINUX24_ENV)
440     PSetCachingThreshold        /* 2 -- get/set cache-bypass size threshold */
441 #else
442     PNoop                       /* 2 -- get/set cache-bypass size threshold */
443 #endif
444 };
445
446 #define PSetClientContext 99    /*  Special pioctl to setup caller's creds  */
447 int afs_nobody = NFS_NOBODY;
448
449 int
450 HandleIoctl(struct vcache *avc, afs_int32 acom,
451             struct afs_ioctl *adata)
452 {
453     afs_int32 code;
454
455     code = 0;
456     AFS_STATCNT(HandleIoctl);
457
458     switch (acom & 0xff) {
459     case 1:
460         avc->f.states |= CSafeStore;
461         avc->asynchrony = 0;
462         /* SXW - Should we force a MetaData flush for this flag setting */
463         break;
464
465         /* case 2 used to be abort store, but this is no longer provided,
466          * since it is impossible to implement under normal Unix.
467          */
468
469     case 3:{
470             /* return the name of the cell this file is open on */
471             struct cell *tcell;
472             afs_int32 i;
473
474             tcell = afs_GetCell(avc->f.fid.Cell, READ_LOCK);
475             if (tcell) {
476                 i = strlen(tcell->cellName) + 1;        /* bytes to copy out */
477
478                 if (i > adata->out_size) {
479                     /* 0 means we're not interested in the output */
480                     if (adata->out_size != 0)
481                         code = EFAULT;
482                 } else {
483                     /* do the copy */
484                     AFS_COPYOUT(tcell->cellName, adata->out, i, code);
485                 }
486                 afs_PutCell(tcell, READ_LOCK);
487             } else
488                 code = ENOTTY;
489         }
490         break;
491
492     case 49:                    /* VIOC_GETINITPARAMS */
493         if (adata->out_size < sizeof(struct cm_initparams)) {
494             code = EFAULT;
495         } else {
496             AFS_COPYOUT(&cm_initParams, adata->out,
497                         sizeof(struct cm_initparams), code);
498         }
499         break;
500
501     default:
502
503         code = EINVAL;
504 #ifdef AFS_AIX51_ENV
505         code = ENOSYS;
506 #endif
507         break;
508     }
509     return code;                /* so far, none implemented */
510 }
511
512 #ifdef AFS_AIX_ENV
513 /* For aix we don't temporarily bypass ioctl(2) but rather do our
514  * thing directly in the vnode layer call, VNOP_IOCTL; thus afs_ioctl
515  * is now called from afs_gn_ioctl.
516  */
517 int
518 afs_ioctl(struct vcache *tvc, int cmd, int arg)
519 {
520     struct afs_ioctl data;
521     int error = 0;
522
523     AFS_STATCNT(afs_ioctl);
524     if (((cmd >> 8) & 0xff) == 'V') {
525         /* This is a VICEIOCTL call */
526         AFS_COPYIN(arg, (caddr_t) & data, sizeof(data), error);
527         if (error)
528             return (error);
529         error = HandleIoctl(tvc, cmd, &data);
530         return (error);
531     } else {
532         /* No-op call; just return. */
533         return (ENOTTY);
534     }
535 }
536 # if defined(AFS_AIX32_ENV)
537 #  if defined(AFS_AIX51_ENV)
538 #   ifdef __64BIT__
539 int
540 kioctl(int fdes, int com, caddr_t arg, caddr_t ext, caddr_t arg2,
541            caddr_t arg3)
542 #   else /* __64BIT__ */
543 int
544 kioctl32(int fdes, int com, caddr_t arg, caddr_t ext, caddr_t arg2,
545              caddr_t arg3)
546 #   endif /* __64BIT__ */
547 #  else
548 int
549 kioctl(int fdes, int com, caddr_t arg, caddr_t ext)
550 #  endif /* AFS_AIX51_ENV */
551 {
552     struct a {
553         int fd, com;
554         caddr_t arg, ext;
555 #  ifdef AFS_AIX51_ENV
556         caddr_t arg2, arg3;
557 #  endif
558     } u_uap, *uap = &u_uap;
559     struct file *fd;
560     struct vcache *tvc;
561     int ioctlDone = 0, code = 0;
562
563     AFS_STATCNT(afs_xioctl);
564     uap->fd = fdes;
565     uap->com = com;
566     uap->arg = arg;
567 #  ifdef AFS_AIX51_ENV
568     uap->arg2 = arg2;
569     uap->arg3 = arg3;
570 #  endif
571     if (setuerror(getf(uap->fd, &fd))) {
572         return -1;
573     }
574     if (fd->f_type == DTYPE_VNODE) {
575         /* good, this is a vnode; next see if it is an AFS vnode */
576         tvc = VTOAFS(fd->f_vnode);      /* valid, given a vnode */
577         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
578             /* This is an AFS vnode */
579             if (((uap->com >> 8) & 0xff) == 'V') {
580                 struct afs_ioctl *datap;
581                 AFS_GLOCK();
582                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
583                 code=copyin_afs_ioctl((char *)uap->arg, datap);
584                 if (code) {
585                     osi_FreeSmallSpace(datap);
586                     AFS_GUNLOCK();
587 #  if defined(AFS_AIX41_ENV)
588                     ufdrele(uap->fd);
589 #  endif
590                     return (setuerror(code), code);
591                 }
592                 code = HandleIoctl(tvc, uap->com, datap);
593                 osi_FreeSmallSpace(datap);
594                 AFS_GUNLOCK();
595                 ioctlDone = 1;
596 #  if defined(AFS_AIX41_ENV)
597                 ufdrele(uap->fd);
598 #  endif
599              }
600         }
601     }
602     if (!ioctlDone) {
603 #  if defined(AFS_AIX41_ENV)
604         ufdrele(uap->fd);
605 #   if defined(AFS_AIX51_ENV)
606 #    ifdef __64BIT__
607         code = okioctl(fdes, com, arg, ext, arg2, arg3);
608 #    else /* __64BIT__ */
609         code = okioctl32(fdes, com, arg, ext, arg2, arg3);
610 #    endif /* __64BIT__ */
611 #   else /* !AFS_AIX51_ENV */
612         code = okioctl(fdes, com, arg, ext);
613 #   endif /* AFS_AIX51_ENV */
614         return code;
615 #  elif defined(AFS_AIX32_ENV)
616         okioctl(fdes, com, arg, ext);
617 #  endif
618     }
619 #  if defined(KERNEL_HAVE_UERROR)
620     if (!getuerror())
621         setuerror(code);
622 #   if !defined(AFS_AIX41_ENV)
623     return (getuerror()? -1 : u.u_ioctlrv);
624 #   else
625     return getuerror()? -1 : 0;
626 #   endif
627 #  endif
628     return 0;
629 }
630 # endif
631
632 #elif defined(AFS_SGI_ENV)
633 # if defined(AFS_SGI65_ENV)
634 afs_ioctl(OSI_VN_DECL(tvc), int cmd, void *arg, int flag, cred_t * cr,
635           rval_t * rvalp, struct vopbd * vbds)
636 # else
637 afs_ioctl(OSI_VN_DECL(tvc), int cmd, void *arg, int flag, cred_t * cr,
638           rval_t * rvalp, struct vopbd * vbds)
639 # endif
640 {
641     struct afs_ioctl data;
642     int error = 0;
643     int locked;
644
645     OSI_VN_CONVERT(tvc);
646
647     AFS_STATCNT(afs_ioctl);
648     if (((cmd >> 8) & 0xff) == 'V') {
649         /* This is a VICEIOCTL call */
650         error = copyin_afs_ioctl(arg, &data);
651         if (error)
652             return (error);
653         locked = ISAFS_GLOCK();
654         if (!locked)
655             AFS_GLOCK();
656         error = HandleIoctl(tvc, cmd, &data);
657         if (!locked)
658             AFS_GUNLOCK();
659         return (error);
660     } else {
661         /* No-op call; just return. */
662         return (ENOTTY);
663     }
664 }
665 #elif defined(AFS_SUN5_ENV)
666 struct afs_ioctl_sys {
667     int fd;
668     int com;
669     int arg;
670 };
671
672 int
673 afs_xioctl(struct afs_ioctl_sys *uap, rval_t *rvp)
674 {
675     struct file *fd;
676     struct vcache *tvc;
677     int ioctlDone = 0, code = 0;
678
679     AFS_STATCNT(afs_xioctl);
680     fd = getf(uap->fd);
681     if (!fd)
682         return (EBADF);
683     if (fd->f_vnode->v_type == VREG || fd->f_vnode->v_type == VDIR) {
684         tvc = VTOAFS(fd->f_vnode);      /* valid, given a vnode */
685         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
686             /* This is an AFS vnode */
687             if (((uap->com >> 8) & 0xff) == 'V') {
688                 struct afs_ioctl *datap;
689                 AFS_GLOCK();
690                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
691                 code=copyin_afs_ioctl((char *)uap->arg, datap);
692                 if (code) {
693                     osi_FreeSmallSpace(datap);
694                     AFS_GUNLOCK();
695                     releasef(uap->fd);
696                     return (EFAULT);
697                 }
698                 code = HandleIoctl(tvc, uap->com, datap);
699                 osi_FreeSmallSpace(datap);
700                 AFS_GUNLOCK();
701                 ioctlDone = 1;
702             }
703         }
704     }
705     releasef(uap->fd);
706     if (!ioctlDone)
707         code = ioctl(uap, rvp);
708
709     return (code);
710 }
711 #elif defined(AFS_LINUX22_ENV)
712 struct afs_ioctl_sys {
713     unsigned int com;
714     unsigned long arg;
715 };
716 int
717 afs_xioctl(struct inode *ip, struct file *fp, unsigned int com,
718            unsigned long arg)
719 {
720     struct afs_ioctl_sys ua, *uap = &ua;
721     struct vcache *tvc;
722     int code = 0;
723
724     AFS_STATCNT(afs_xioctl);
725     ua.com = com;
726     ua.arg = arg;
727
728     tvc = VTOAFS(ip);
729     if (tvc && IsAfsVnode(AFSTOV(tvc))) {
730         /* This is an AFS vnode */
731         if (((uap->com >> 8) & 0xff) == 'V') {
732             struct afs_ioctl *datap;
733             AFS_GLOCK();
734             datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
735             code = copyin_afs_ioctl((char *)uap->arg, datap);
736             if (code) {
737                 osi_FreeSmallSpace(datap);
738                 AFS_GUNLOCK();
739                 return -code;
740             }
741             code = HandleIoctl(tvc, uap->com, datap);
742             osi_FreeSmallSpace(datap);
743             AFS_GUNLOCK();
744         }
745         else
746             code = EINVAL;
747     }
748     return -code;
749 }
750 #elif defined(AFS_DARWIN_ENV) && !defined(AFS_DARWIN80_ENV)
751 struct ioctl_args {
752     int fd;
753     u_long com;
754     caddr_t arg;
755 };
756
757 int
758 afs_xioctl(afs_proc_t *p, struct ioctl_args *uap, register_t *retval)
759 {
760     struct file *fd;
761     struct vcache *tvc;
762     int ioctlDone = 0, code = 0;
763
764     AFS_STATCNT(afs_xioctl);
765     if ((code = fdgetf(p, uap->fd, &fd)))
766         return code;
767     if (fd->f_type == DTYPE_VNODE) {
768         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
769         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
770             /* This is an AFS vnode */
771             if (((uap->com >> 8) & 0xff) == 'V') {
772                 struct afs_ioctl *datap;
773                 AFS_GLOCK();
774                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
775                 code = copyin_afs_ioctl((char *)uap->arg, datap);
776                 if (code) {
777                     osi_FreeSmallSpace(datap);
778                     AFS_GUNLOCK();
779                     return code;
780                 }
781                 code = HandleIoctl(tvc, uap->com, datap);
782                 osi_FreeSmallSpace(datap);
783                 AFS_GUNLOCK();
784                 ioctlDone = 1;
785             }
786         }
787     }
788
789     if (!ioctlDone)
790         return ioctl(p, uap, retval);
791
792     return (code);
793 }
794 #elif defined(AFS_XBSD_ENV)
795 # if defined(AFS_FBSD_ENV)
796 #  define arg data
797 int
798 afs_xioctl(struct thread *td, struct ioctl_args *uap,
799            register_t *retval)
800 {
801     afs_proc_t *p = td->td_proc;
802 # elif defined(AFS_NBSD_ENV)
803 int
804 afs_xioctl(afs_proc_t *p, const struct sys_ioctl_args *uap, register_t *retval)
805 {
806 # else
807 struct ioctl_args {
808     int fd;
809     u_long com;
810     caddr_t arg;
811 };
812
813 int
814 afs_xioctl(afs_proc_t *p, const struct ioctl_args *uap, register_t *retval)
815 {
816 # endif
817     struct filedesc *fdp;
818     struct vcache *tvc;
819     int ioctlDone = 0, code = 0;
820     struct file *fd;
821
822     AFS_STATCNT(afs_xioctl);
823 #if defined(AFS_NBSD40_ENV)
824     fdp = p->l_proc->p_fd;
825 #else
826     fdp = p->p_fd;
827 #endif
828 #if defined(AFS_NBSD50_ENV)
829     if ((fd = fd_getfile(SCARG(uap, fd))) == NULL)
830         return (EBADF);
831 #elif defined(AFS_FBSD100_ENV)
832     if ((uap->fd >= fdp->fd_nfiles)
833         || ((fd = fdp->fd_ofiles[uap->fd].fde_file) == NULL))
834         return EBADF;
835 #else
836     if ((uap->fd >= fdp->fd_nfiles)
837         || ((fd = fdp->fd_ofiles[uap->fd]) == NULL))
838         return EBADF;
839 #endif
840     if ((fd->f_flag & (FREAD | FWRITE)) == 0)
841         return EBADF;
842     /* first determine whether this is any sort of vnode */
843     if (fd->f_type == DTYPE_VNODE) {
844         /* good, this is a vnode; next see if it is an AFS vnode */
845 # if defined(AFS_OBSD_ENV)
846         tvc =
847             IsAfsVnode((struct vnode *)fd->
848                        f_data) ? VTOAFS((struct vnode *)fd->f_data) : NULL;
849 # else
850         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
851 # endif
852         if (tvc && IsAfsVnode((struct vnode *)fd->f_data)) {
853             /* This is an AFS vnode */
854 #if defined(AFS_NBSD50_ENV)
855             if (((SCARG(uap, com) >> 8) & 0xff) == 'V') {
856 #else
857             if (((uap->com >> 8) & 0xff) == 'V') {
858 #endif
859                 struct afs_ioctl *datap;
860                 AFS_GLOCK();
861                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
862 #if defined(AFS_NBSD50_ENV)
863                 code = copyin_afs_ioctl(SCARG(uap, data), datap);
864 #else
865                 code = copyin_afs_ioctl((char *)uap->arg, datap);
866 #endif
867                 if (code) {
868                     osi_FreeSmallSpace(datap);
869                     AFS_GUNLOCK();
870                     return code;
871                 }
872 #if defined(AFS_NBSD50_ENV)
873                 code = HandleIoctl(tvc, SCARG(uap, com), datap);
874 #else
875                 code = HandleIoctl(tvc, uap->com, datap);
876 #endif
877                 osi_FreeSmallSpace(datap);
878                 AFS_GUNLOCK();
879                 ioctlDone = 1;
880             }
881         }
882     }
883
884 #if defined(AFS_NBSD50_ENV)
885     fd_putfile(SCARG(uap, fd));
886 #endif
887
888     if (!ioctlDone) {
889 # if defined(AFS_FBSD_ENV)
890 #  if (__FreeBSD_version >= 900044)
891         return sys_ioctl(td, uap);
892 #  else
893         return ioctl(td, uap);
894 #  endif
895 # elif defined(AFS_OBSD_ENV)
896         code = sys_ioctl(p, uap, retval);
897 # elif defined(AFS_NBSD_ENV)
898         code = sys_ioctl(p, uap, retval);
899 # endif
900     }
901
902     return (code);
903 }
904 #elif defined(UKERNEL)
905 int
906 afs_xioctl(void)
907 {
908     struct a {
909         int fd;
910         int com;
911         caddr_t arg;
912     } *uap = (struct a *)get_user_struct()->u_ap;
913     struct file *fd;
914     struct vcache *tvc;
915     int ioctlDone = 0, code = 0;
916
917     AFS_STATCNT(afs_xioctl);
918
919     fd = getf(uap->fd);
920     if (!fd)
921         return (EBADF);
922     /* first determine whether this is any sort of vnode */
923     if (fd->f_type == DTYPE_VNODE) {
924         /* good, this is a vnode; next see if it is an AFS vnode */
925         tvc = VTOAFS((struct vnode *)fd->f_data);       /* valid, given a vnode */
926         if (tvc && IsAfsVnode(AFSTOV(tvc))) {
927             /* This is an AFS vnode */
928             if (((uap->com >> 8) & 0xff) == 'V') {
929                 struct afs_ioctl *datap;
930                 AFS_GLOCK();
931                 datap = osi_AllocSmallSpace(AFS_SMALLOCSIZ);
932                 code=copyin_afs_ioctl((char *)uap->arg, datap);
933                 if (code) {
934                     osi_FreeSmallSpace(datap);
935                     AFS_GUNLOCK();
936
937                     return (setuerror(code), code);
938                 }
939                 code = HandleIoctl(tvc, uap->com, datap);
940                 osi_FreeSmallSpace(datap);
941                 AFS_GUNLOCK();
942                 ioctlDone = 1;
943             }
944         }
945     }
946
947     if (!ioctlDone) {
948         ioctl();
949     }
950
951     return 0;
952 }
953 #endif /* AFS_HPUX102_ENV */
954
955 #if defined(AFS_SGI_ENV)
956   /* "pioctl" system call entry point; just pass argument to the parameterized
957    * call below */
958 struct pioctlargs {
959     char *path;
960     sysarg_t cmd;
961     caddr_t cmarg;
962     sysarg_t follow;
963 };
964 int
965 afs_pioctl(struct pioctlargs *uap, rval_t * rvp)
966 {
967     int code;
968
969     AFS_STATCNT(afs_pioctl);
970     AFS_GLOCK();
971     code = afs_syscall_pioctl(uap->path, uap->cmd, uap->cmarg, uap->follow);
972     AFS_GUNLOCK();
973 # ifdef AFS_SGI64_ENV
974     return code;
975 # else
976     return u.u_error;
977 # endif
978 }
979
980 #elif defined(AFS_FBSD_ENV)
981 int
982 afs_pioctl(struct thread *td, void *args, int *retval)
983 {
984     struct a {
985         char *path;
986         int cmd;
987         caddr_t cmarg;
988         int follow;
989     } *uap = (struct a *)args;
990
991     AFS_STATCNT(afs_pioctl);
992     return (afs_syscall_pioctl
993             (uap->path, uap->cmd, uap->cmarg, uap->follow, td->td_ucred));
994 }
995
996 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
997 int
998 afs_pioctl(afs_proc_t *p, void *args, int *retval)
999 {
1000     struct a {
1001         char *path;
1002         int cmd;
1003         caddr_t cmarg;
1004         int follow;
1005     } *uap = (struct a *)args;
1006
1007     AFS_STATCNT(afs_pioctl);
1008 # if defined(AFS_DARWIN80_ENV) || defined(AFS_NBSD40_ENV)
1009     return (afs_syscall_pioctl
1010             (uap->path, uap->cmd, uap->cmarg, uap->follow,
1011              kauth_cred_get()));
1012 # else
1013     return (afs_syscall_pioctl
1014             (uap->path, uap->cmd, uap->cmarg, uap->follow,
1015 #  if defined(AFS_FBSD_ENV)
1016              td->td_ucred));
1017 #  else
1018              p->p_cred->pc_ucred));
1019 #  endif
1020 # endif
1021 }
1022
1023 #endif
1024
1025 /* macro to avoid adding any more #ifdef's to pioctl code. */
1026 #if defined(AFS_LINUX22_ENV) || defined(AFS_AIX41_ENV)
1027 #define PIOCTL_FREE_CRED() crfree(credp)
1028 #else
1029 #define PIOCTL_FREE_CRED()
1030 #endif
1031
1032 int
1033 #ifdef  AFS_SUN5_ENV
1034 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow,
1035                    rval_t *vvp, afs_ucred_t *credp)
1036 #else
1037 #ifdef AFS_DARWIN100_ENV
1038 afs_syscall64_pioctl(user_addr_t path, unsigned int com, user_addr_t cmarg,
1039                    int follow, afs_ucred_t *credp)
1040 #elif defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1041 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow,
1042                    afs_ucred_t *credp)
1043 #else
1044 afs_syscall_pioctl(char *path, unsigned int com, caddr_t cmarg, int follow)
1045 #endif
1046 #endif
1047 {
1048     struct afs_ioctl data;
1049 #ifdef AFS_NEED_CLIENTCONTEXT
1050     afs_ucred_t *tmpcred = NULL;
1051 #endif
1052 #if defined(AFS_NEED_CLIENTCONTEXT) || defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1053     afs_ucred_t *foreigncreds = NULL;
1054 #endif
1055     afs_int32 code = 0;
1056     struct vnode *vp = NULL;
1057 #ifdef  AFS_AIX41_ENV
1058     struct ucred *credp = crref();      /* don't free until done! */
1059 #endif
1060 #ifdef AFS_LINUX22_ENV
1061     cred_t *credp = crref();    /* don't free until done! */
1062     struct dentry *dp;
1063 #endif
1064
1065     AFS_STATCNT(afs_syscall_pioctl);
1066     if (follow)
1067         follow = 1;             /* compat. with old venus */
1068     code = copyin_afs_ioctl(cmarg, &data);
1069     if (code) {
1070         PIOCTL_FREE_CRED();
1071 #if defined(KERNEL_HAVE_UERROR)
1072         setuerror(code);
1073 #endif
1074         return (code);
1075     }
1076     if ((com & 0xff) == PSetClientContext) {
1077 #ifdef AFS_NEED_CLIENTCONTEXT
1078 #if defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV)
1079         code = HandleClientContext(&data, &com, &foreigncreds, credp);
1080 #else
1081         code = HandleClientContext(&data, &com, &foreigncreds, osi_curcred());
1082 #endif
1083         if (code) {
1084             if (foreigncreds) {
1085                 crfree(foreigncreds);
1086             }
1087             PIOCTL_FREE_CRED();
1088 #if defined(KERNEL_HAVE_UERROR)
1089             return (setuerror(code), code);
1090 #else
1091             return (code);
1092 #endif
1093         }
1094 #else /* AFS_NEED_CLIENTCONTEXT */
1095         return EINVAL;
1096 #endif /* AFS_NEED_CLIENTCONTEXT */
1097     }
1098 #ifdef AFS_NEED_CLIENTCONTEXT
1099     if (foreigncreds) {
1100         /*
1101          * We could have done without temporary setting the u.u_cred below
1102          * (foreigncreds could be passed as param the pioctl modules)
1103          * but calls such as afs_osi_suser() doesn't allow that since it
1104          * references u.u_cred directly.  We could, of course, do something
1105          * like afs_osi_suser(cred) which, I think, is better since it
1106          * generalizes and supports multi cred environments...
1107          */
1108 #if defined(AFS_SUN5_ENV) || defined(AFS_LINUX22_ENV)
1109         tmpcred = credp;
1110         credp = foreigncreds;
1111 #elif defined(AFS_AIX41_ENV)
1112         tmpcred = crref();      /* XXX */
1113         crset(foreigncreds);
1114 #elif defined(AFS_HPUX101_ENV)
1115         tmpcred = p_cred(u.u_procp);
1116         set_p_cred(u.u_procp, foreigncreds);
1117 #elif defined(AFS_SGI_ENV)
1118         tmpcred = OSI_GET_CURRENT_CRED();
1119         OSI_SET_CURRENT_CRED(foreigncreds);
1120 #else
1121         tmpcred = u.u_cred;
1122         u.u_cred = foreigncreds;
1123 #endif
1124     }
1125 #endif /* AFS_NEED_CLIENTCONTEXT */
1126     if ((com & 0xff) == 15) {
1127         /* special case prefetch so entire pathname eval occurs in helper process.
1128          * otherwise, the pioctl call is essentially useless */
1129 #if     defined(AFS_SUN5_ENV) || defined(AFS_AIX41_ENV) || defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1130         code =
1131             Prefetch(path, &data, follow,
1132                      foreigncreds ? foreigncreds : credp);
1133 #else
1134         code = Prefetch(path, &data, follow, osi_curcred());
1135 #endif
1136         vp = NULL;
1137 #if defined(KERNEL_HAVE_UERROR)
1138         setuerror(code);
1139 #endif
1140         goto rescred;
1141     }
1142     if (path) {
1143         AFS_GUNLOCK();
1144 #ifdef  AFS_AIX41_ENV
1145         code =
1146             lookupname(path, USR, follow, NULL, &vp,
1147                        foreigncreds ? foreigncreds : credp);
1148 #else
1149 #ifdef AFS_LINUX22_ENV
1150         code = gop_lookupname_user(path, AFS_UIOUSER, follow, &dp);
1151         if (!code)
1152             vp = (struct vnode *)dp->d_inode;
1153 #else
1154         code = gop_lookupname_user(path, AFS_UIOUSER, follow, &vp);
1155 #endif /* AFS_LINUX22_ENV */
1156 #endif /* AFS_AIX41_ENV */
1157         AFS_GLOCK();
1158         if (code) {
1159             vp = NULL;
1160 #if defined(KERNEL_HAVE_UERROR)
1161             setuerror(code);
1162 #endif
1163             goto rescred;
1164         }
1165     } else
1166         vp = NULL;
1167
1168 #if defined(AFS_SUN510_ENV)
1169     if (vp && !IsAfsVnode(vp)) {
1170         struct vnode *realvp;
1171         if
1172 #ifdef AFS_SUN511_ENV
1173           (VOP_REALVP(vp, &realvp, NULL) == 0)
1174 #else
1175           (VOP_REALVP(vp, &realvp) == 0)
1176 #endif
1177 {
1178             struct vnode *oldvp = vp;
1179
1180             VN_HOLD(realvp);
1181             vp = realvp;
1182             AFS_RELE(oldvp);
1183         }
1184     }
1185 #endif
1186     /* now make the call if we were passed no file, or were passed an AFS file */
1187     if (!vp || IsAfsVnode(vp)) {
1188 #if defined(AFS_SUN5_ENV)
1189         code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1190 #elif defined(AFS_AIX41_ENV)
1191         {
1192             struct ucred *cred1, *cred2;
1193
1194             if (foreigncreds) {
1195                 cred1 = cred2 = foreigncreds;
1196             } else {
1197                 cred1 = cred2 = credp;
1198             }
1199             code = afs_HandlePioctl(vp, com, &data, follow, &cred1);
1200             if (cred1 != cred2) {
1201                 /* something changed the creds */
1202                 crset(cred1);
1203             }
1204         }
1205 #elif defined(AFS_HPUX101_ENV)
1206         {
1207             struct ucred *cred = p_cred(u.u_procp);
1208             code = afs_HandlePioctl(vp, com, &data, follow, &cred);
1209         }
1210 #elif defined(AFS_SGI_ENV)
1211         {
1212             struct cred *credp;
1213             credp = OSI_GET_CURRENT_CRED();
1214             code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1215         }
1216 #elif defined(AFS_LINUX22_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1217         code = afs_HandlePioctl(vp, com, &data, follow, &credp);
1218 #elif defined(UKERNEL)
1219         code = afs_HandlePioctl(vp, com, &data, follow,
1220                                 &(get_user_struct()->u_cred));
1221 #else
1222         code = afs_HandlePioctl(vp, com, &data, follow, &u.u_cred);
1223 #endif
1224     } else {
1225 #if defined(KERNEL_HAVE_UERROR)
1226         setuerror(EINVAL);
1227 #else
1228         code = EINVAL;          /* not in /afs */
1229 #endif
1230     }
1231
1232   rescred:
1233 #if defined(AFS_NEED_CLIENTCONTEXT)
1234     if (foreigncreds) {
1235 #ifdef  AFS_AIX41_ENV
1236         crset(tmpcred);         /* restore original credentials */
1237 #else
1238 #if     defined(AFS_HPUX101_ENV)
1239         set_p_cred(u.u_procp, tmpcred); /* restore original credentials */
1240 #elif   defined(AFS_SGI_ENV)
1241         OSI_SET_CURRENT_CRED(tmpcred);  /* restore original credentials */
1242 #elif   defined(AFS_SUN5_ENV) || defined(AFS_LINUX22_ENV)
1243         credp = tmpcred;                /* restore original credentials */
1244 #else
1245         osi_curcred() = tmpcred;        /* restore original credentials */
1246 #endif /* AFS_HPUX101_ENV */
1247         crfree(foreigncreds);
1248 #endif /* AIX41 */
1249     }
1250 #endif /* AFS_NEED_CLIENTCONTEXT */
1251     if (vp) {
1252 #ifdef AFS_LINUX22_ENV
1253         /*
1254          * Holding the global lock when calling dput can cause a deadlock
1255          * when the kernel calls back into afs_dentry_iput
1256          */
1257         AFS_GUNLOCK();
1258         dput(dp);
1259         AFS_GLOCK();
1260 #else
1261 #if defined(AFS_FBSD80_ENV)
1262     if (VOP_ISLOCKED(vp))
1263         VOP_UNLOCK(vp, 0);
1264 #endif /* AFS_FBSD80_ENV */
1265         AFS_RELE(vp);           /* put vnode back */
1266 #endif
1267     }
1268     PIOCTL_FREE_CRED();
1269 #if defined(KERNEL_HAVE_UERROR)
1270     if (!getuerror())
1271         setuerror(code);
1272     return (getuerror());
1273 #else
1274     return (code);
1275 #endif
1276 }
1277
1278 #ifdef AFS_DARWIN100_ENV
1279 int
1280 afs_syscall_pioctl(char * path, unsigned int com, caddr_t cmarg,
1281                    int follow, afs_ucred_t *credp)
1282 {
1283     return afs_syscall64_pioctl(CAST_USER_ADDR_T(path), com,
1284                                 CAST_USER_ADDR_T((unsigned int)cmarg), follow,
1285                                 credp);
1286 }
1287 #endif
1288
1289 #define MAXPIOCTLTOKENLEN \
1290 (3*sizeof(afs_int32)+MAXKTCTICKETLEN+sizeof(struct ClearToken)+MAXKTCREALMLEN)
1291
1292 int
1293 afs_HandlePioctl(struct vnode *avp, afs_int32 acom,
1294                  struct afs_ioctl *ablob, int afollow,
1295                  afs_ucred_t **acred)
1296 {
1297     struct vcache *avc;
1298     struct vrequest *treq = NULL;
1299     afs_int32 code;
1300     afs_int32 function, device;
1301     struct afs_pdata input, output;
1302     struct afs_pdata copyInput, copyOutput;
1303     size_t outSize;
1304     pioctlFunction *pioctlSw;
1305     int pioctlSwSize;
1306     struct afs_fakestat_state fakestate;
1307
1308     memset(&input, 0, sizeof(input));
1309     memset(&output, 0, sizeof(output));
1310
1311     avc = avp ? VTOAFS(avp) : NULL;
1312     afs_Trace3(afs_iclSetp, CM_TRACE_PIOCTL, ICL_TYPE_INT32, acom & 0xff,
1313                ICL_TYPE_POINTER, avc, ICL_TYPE_INT32, afollow);
1314     AFS_STATCNT(HandlePioctl);
1315
1316     code = afs_CreateReq(&treq, *acred);
1317     if (code)
1318         return code;
1319
1320     afs_InitFakeStat(&fakestate);
1321     if (avc) {
1322         code = afs_EvalFakeStat(&avc, &fakestate, treq);
1323         if (code)
1324             goto out;
1325     }
1326     device = (acom & 0xff00) >> 8;
1327     switch (device) {
1328     case 'V':                   /* Original pioctls */
1329         pioctlSw = VpioctlSw;
1330         pioctlSwSize = sizeof(VpioctlSw);
1331         break;
1332     case 'C':                   /* Coordinated/common pioctls */
1333         pioctlSw = CpioctlSw;
1334         pioctlSwSize = sizeof(CpioctlSw);
1335         break;
1336     case 'O':                   /* Coordinated/common pioctls */
1337         pioctlSw = OpioctlSw;
1338         pioctlSwSize = sizeof(OpioctlSw);
1339         break;
1340     default:
1341         code = EINVAL;
1342         goto out;
1343     }
1344     function = acom & 0xff;
1345     if (function >= (pioctlSwSize / sizeof(char *))) {
1346         code = EINVAL;
1347         goto out;
1348     }
1349
1350     /* Do all range checking before continuing */
1351     if (ablob->in_size > MAXPIOCTLTOKENLEN ||
1352         ablob->in_size < 0 || ablob->out_size < 0) {
1353         code = EINVAL;
1354         goto out;
1355     }
1356
1357     code = afs_pd_alloc(&input, ablob->in_size);
1358     if (code)
1359         goto out;
1360
1361     if (ablob->in_size > 0) {
1362         AFS_COPYIN(ablob->in, input.ptr, ablob->in_size, code);
1363         input.ptr[input.remaining] = '\0';
1364     }
1365     if (code)
1366         goto out;
1367
1368     if ((function == 8 && device == 'V') ||
1369        (function == 7 && device == 'C')) {      /* PGetTokens */
1370         code = afs_pd_alloc(&output, MAXPIOCTLTOKENLEN);
1371     } else {
1372         code = afs_pd_alloc(&output, AFS_LRALLOCSIZ);
1373     }
1374     if (code)
1375         goto out;
1376
1377     copyInput = input;
1378     copyOutput = output;
1379
1380     code =
1381         (*pioctlSw[function]) (avc, function, treq, &copyInput,
1382                                &copyOutput, acred);
1383
1384     outSize = copyOutput.ptr - output.ptr;
1385
1386     if (code == 0 && ablob->out_size > 0) {
1387         if (outSize > ablob->out_size) {
1388             code = E2BIG;       /* data wont fit in user buffer */
1389         } else if (outSize) {
1390             AFS_COPYOUT(output.ptr, ablob->out, outSize, code);
1391         }
1392     }
1393
1394 out:
1395     afs_pd_free(&input);
1396     afs_pd_free(&output);
1397
1398     afs_PutFakeStat(&fakestate);
1399     code = afs_CheckCode(code, treq, 41);
1400     afs_DestroyReq(treq);
1401     return code;
1402 }
1403
1404 /*!
1405  * VIOCGETFID (22) - Get file ID quickly
1406  *
1407  * \ingroup pioctl
1408  *
1409  * \param[in] ain       not in use
1410  * \param[out] aout     fid of requested file
1411  *
1412  * \retval EINVAL       Error if some of the initial arguments aren't set
1413  *
1414  * \post get the file id of some file
1415  */
1416 DECL_PIOCTL(PGetFID)
1417 {
1418     AFS_STATCNT(PGetFID);
1419     if (!avc)
1420         return EINVAL;
1421     if (afs_pd_putBytes(aout, &avc->f.fid, sizeof(struct VenusFid)) != 0)
1422         return EINVAL;
1423     return 0;
1424 }
1425
1426 /*!
1427  * VIOCSETAL (1) - Set access control list
1428  *
1429  * \ingroup pioctl
1430  *
1431  * \param[in] ain       the ACL being set
1432  * \param[out] aout     the ACL being set returned
1433  *
1434  * \retval EINVAL       Error if some of the standard args aren't set
1435  *
1436  * \post Changed ACL, via direct writing to the wire
1437  */
1438 int
1439 dummy_PSetAcl(char *ain, char *aout)
1440 {
1441     return 0;
1442 }
1443
1444 DECL_PIOCTL(PSetAcl)
1445 {
1446     afs_int32 code;
1447     struct afs_conn *tconn;
1448     struct AFSOpaque acl;
1449     struct AFSVolSync tsync;
1450     struct AFSFetchStatus OutStatus;
1451     struct rx_connection *rxconn;
1452     XSTATS_DECLS;
1453
1454     AFS_STATCNT(PSetAcl);
1455     if (!avc)
1456         return EINVAL;
1457
1458     if (afs_pd_getStringPtr(ain, &acl.AFSOpaque_val) != 0)
1459         return EINVAL;
1460     acl.AFSOpaque_len = strlen(acl.AFSOpaque_val) + 1;
1461     if (acl.AFSOpaque_len > 1024)
1462         return EINVAL;
1463
1464     do {
1465         tconn = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
1466         if (tconn) {
1467             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_STOREACL);
1468             RX_AFS_GUNLOCK();
1469             code =
1470                 RXAFS_StoreACL(rxconn, (struct AFSFid *)&avc->f.fid.Fid,
1471                                &acl, &OutStatus, &tsync);
1472             RX_AFS_GLOCK();
1473             XSTATS_END_TIME;
1474         } else
1475             code = -1;
1476     } while (afs_Analyze
1477              (tconn, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_STOREACL,
1478               SHARED_LOCK, NULL));
1479
1480     /* now we've forgotten all of the access info */
1481     afs_StaleVCacheFlags(avc, AFS_STALEVC_CLEARCB, CUnique);
1482
1483     /* SXW - Should we flush metadata here? */
1484
1485     return code;
1486 }
1487
1488 int afs_defaultAsynchrony = 0;
1489
1490 /*!
1491  * VIOC_STOREBEHIND (47) Adjust store asynchrony
1492  *
1493  * \ingroup pioctl
1494  *
1495  * \param[in] ain       sbstruct (store behind structure) input
1496  * \param[out] aout     resulting sbstruct
1497  *
1498  * \retval EPERM
1499  *      Error if the user doesn't have super-user credentials
1500  * \retval EACCES
1501  *      Error if there isn't enough access to not check the mode bits
1502  *
1503  * \post
1504  *      Changes either the default asynchrony (the amount of data that
1505  *      can remain to be written when the cache manager returns control
1506  *      to the user), or the asyncrony for the specified file.
1507  */
1508 DECL_PIOCTL(PStoreBehind)
1509 {
1510     struct sbstruct sbr;
1511
1512     if (afs_pd_getBytes(ain, &sbr, sizeof(struct sbstruct)) != 0)
1513         return EINVAL;
1514
1515     if (sbr.sb_default != -1) {
1516         if (afs_osi_suser(*acred))
1517             afs_defaultAsynchrony = sbr.sb_default;
1518         else
1519             return EPERM;
1520     }
1521
1522     if (avc && (sbr.sb_thisfile != -1)) {
1523         if (afs_AccessOK
1524             (avc, PRSFS_WRITE | PRSFS_ADMINISTER, areq, DONT_CHECK_MODE_BITS))
1525             avc->asynchrony = sbr.sb_thisfile;
1526         else
1527             return EACCES;
1528     }
1529
1530     memset(&sbr, 0, sizeof(sbr));
1531     sbr.sb_default = afs_defaultAsynchrony;
1532     if (avc) {
1533         sbr.sb_thisfile = avc->asynchrony;
1534     }
1535
1536     return afs_pd_putBytes(aout, &sbr, sizeof(sbr));
1537 }
1538
1539 /*!
1540  * VIOC_GCPAGS (48) - Disable automatic PAG gc'ing
1541  *
1542  * \ingroup pioctl
1543  *
1544  * \param[in] ain       not in use
1545  * \param[out] aout     not in use
1546  *
1547  * \retval EACCES       Error if the user doesn't have super-user credentials
1548  *
1549  * \post set the gcpags to GCPAGS_USERDISABLED
1550  */
1551 DECL_PIOCTL(PGCPAGs)
1552 {
1553     if (!afs_osi_suser(*acred)) {
1554         return EACCES;
1555     }
1556     afs_gcpags = AFS_GCPAGS_USERDISABLED;
1557     return 0;
1558 }
1559
1560 /*!
1561  * VIOCGETAL (2) - Get access control list
1562  *
1563  * \ingroup pioctl
1564  *
1565  * \param[in] ain       not in use
1566  * \param[out] aout     the ACL
1567  *
1568  * \retval EINVAL       Error if some of the standard args aren't set
1569  * \retval ERANGE       Error if the vnode of the file id is too large
1570  * \retval -1           Error if getting the ACL failed
1571  *
1572  * \post Obtain the ACL, based on file ID
1573  *
1574  * \notes
1575  *      There is a hack to tell which type of ACL is being returned, checks
1576  *      the top 2-bytes of the input size to judge what type of ACL it is,
1577  *      only for dfs xlator ACLs
1578  */
1579 DECL_PIOCTL(PGetAcl)
1580 {
1581     struct AFSOpaque acl;
1582     struct AFSVolSync tsync;
1583     struct AFSFetchStatus OutStatus;
1584     afs_int32 code;
1585     struct afs_conn *tconn;
1586     struct AFSFid Fid;
1587     struct rx_connection *rxconn;
1588     XSTATS_DECLS;
1589
1590     AFS_STATCNT(PGetAcl);
1591     if (!avc)
1592         return EINVAL;
1593     Fid.Volume = avc->f.fid.Fid.Volume;
1594     Fid.Vnode = avc->f.fid.Fid.Vnode;
1595     Fid.Unique = avc->f.fid.Fid.Unique;
1596     if (avc->f.states & CForeign) {
1597         /*
1598          * For a dfs xlator acl we have a special hack so that the
1599          * xlator will distinguish which type of acl will return. So
1600          * we currently use the top 2-bytes (vals 0-4) to tell which
1601          * type of acl to bring back. Horrible hack but this will
1602          * cause the least number of changes to code size and interfaces.
1603          */
1604         if (Fid.Vnode & 0xc0000000)
1605             return ERANGE;
1606         Fid.Vnode |= (ain->remaining << 30);
1607     }
1608     acl.AFSOpaque_val = aout->ptr;
1609     do {
1610         tconn = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
1611         if (tconn) {
1612             acl.AFSOpaque_val[0] = '\0';
1613             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_FETCHACL);
1614             RX_AFS_GUNLOCK();
1615             code = RXAFS_FetchACL(rxconn, &Fid, &acl, &OutStatus, &tsync);
1616             RX_AFS_GLOCK();
1617             XSTATS_END_TIME;
1618         } else
1619             code = -1;
1620     } while (afs_Analyze
1621              (tconn, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_FETCHACL,
1622               SHARED_LOCK, NULL));
1623
1624     if (code == 0) {
1625         if (acl.AFSOpaque_len == 0)
1626             afs_pd_skip(aout, 1); /* leave the NULL */
1627         else
1628             afs_pd_skip(aout, acl.AFSOpaque_len); /* Length of the ACL */
1629     }
1630     return code;
1631 }
1632
1633 /*!
1634  * PNoop returns success.  Used for functions which are not implemented
1635  * or are no longer in use.
1636  *
1637  * \ingroup pioctl
1638  *
1639  * \retval Always returns success
1640  *
1641  * \notes
1642  *      Functions involved in this:
1643  *      17 (VIOCENGROUP) -- used to be enable group;
1644  *      18 (VIOCDISGROUP) -- used to be disable group;
1645  *      2 (?) -- get/set cache-bypass size threshold
1646  */
1647 DECL_PIOCTL(PNoop)
1648 {
1649     AFS_STATCNT(PNoop);
1650     return 0;
1651 }
1652
1653 /*!
1654  * PBogus returns fail.  Used for functions which are not implemented or
1655  * are no longer in use.
1656  *
1657  * \ingroup pioctl
1658  *
1659  * \retval EINVAL       Always returns this value
1660  *
1661  * \notes
1662  *      Functions involved in this:
1663  *      0 (?);
1664  *      4 (?);
1665  *      6 (?);
1666  *      7 (VIOCSTAT);
1667  *      8 (?);
1668  *      13 (VIOCGETTIME) -- used to be quick check time;
1669  *      15 (VIOCPREFETCH) -- prefetch is now special-cased; see pioctl code!;
1670  *      16 (VIOCNOP) -- used to be testing code;
1671  *      19 (VIOCLISTGROUPS) -- used to be list group;
1672  *      23 (VIOCWAITFOREVER) -- used to be waitforever;
1673  *      57 (VIOC_FPRIOSTATUS) -- arla: set file prio;
1674  *      58 (VIOC_FHGET) -- arla: fallback getfh;
1675  *      59 (VIOC_FHOPEN) -- arla: fallback fhopen;
1676  *      60 (VIOC_XFSDEBUG) -- arla: controls xfsdebug;
1677  *      61 (VIOC_ARLADEBUG) -- arla: controls arla debug;
1678  *      62 (VIOC_AVIATOR) -- arla: debug interface;
1679  *      63 (VIOC_XFSDEBUG_PRINT) -- arla: print xfs status;
1680  *      64 (VIOC_CALCULATE_CACHE) -- arla: force cache check;
1681  *      65 (VIOC_BREAKCELLBACK) -- arla: break callback;
1682  *      68 (?) -- arla: fetch stats;
1683  */
1684 DECL_PIOCTL(PBogus)
1685 {
1686     AFS_STATCNT(PBogus);
1687     return EINVAL;
1688 }
1689
1690 /*!
1691  * VIOC_FILE_CELL_NAME (30) - Get cell in which file lives
1692  *
1693  * \ingroup pioctl
1694  *
1695  * \param[in] ain       not in use (avc used to pass in file id)
1696  * \param[out] aout     cell name
1697  *
1698  * \retval EINVAL       Error if some of the standard args aren't set
1699  * \retval ESRCH        Error if the file isn't part of a cell
1700  *
1701  * \post Get a cell based on a passed in file id
1702  */
1703 DECL_PIOCTL(PGetFileCell)
1704 {
1705     struct cell *tcell;
1706
1707     AFS_STATCNT(PGetFileCell);
1708     if (!avc)
1709         return EINVAL;
1710     tcell = afs_GetCell(avc->f.fid.Cell, READ_LOCK);
1711     if (!tcell)
1712         return ESRCH;
1713
1714     if (afs_pd_putString(aout, tcell->cellName) != 0)
1715         return EINVAL;
1716
1717     afs_PutCell(tcell, READ_LOCK);
1718     return 0;
1719 }
1720
1721 /*!
1722  * VIOC_GET_WS_CELL (31) - Get cell in which workstation lives
1723  *
1724  * \ingroup pioctl
1725  *
1726  * \param[in] ain       not in use
1727  * \param[out] aout     cell name
1728  *
1729  * \retval EIO
1730  *      Error if the afs daemon hasn't started yet
1731  * \retval ESRCH
1732  *      Error if the machine isn't part of a cell, for whatever reason
1733  *
1734  * \post Get the primary cell that the machine is a part of.
1735  */
1736 DECL_PIOCTL(PGetWSCell)
1737 {
1738     struct cell *tcell = NULL;
1739
1740     AFS_STATCNT(PGetWSCell);
1741     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
1742         return EIO;             /* Inappropriate ioctl for device */
1743
1744     tcell = afs_GetPrimaryCell(READ_LOCK);
1745     if (!tcell)                 /* no primary cell? */
1746         return ESRCH;
1747
1748     if (afs_pd_putString(aout, tcell->cellName) != 0)
1749         return EINVAL;
1750     afs_PutCell(tcell, READ_LOCK);
1751     return 0;
1752 }
1753
1754 /*!
1755  * VIOC_GET_PRIMARY_CELL (33) - Get primary cell for caller
1756  *
1757  * \ingroup pioctl
1758  *
1759  * \param[in] ain       not in use (user id found via areq)
1760  * \param[out] aout     cell name
1761  *
1762  * \retval ESRCH
1763  *      Error if the user id doesn't have a primary cell specified
1764  *
1765  * \post Get the primary cell for a certain user, based on the user's uid
1766  */
1767 DECL_PIOCTL(PGetUserCell)
1768 {
1769     afs_int32 i;
1770     struct unixuser *tu;
1771     struct cell *tcell;
1772
1773     AFS_STATCNT(PGetUserCell);
1774     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
1775         return EIO;             /* Inappropriate ioctl for device */
1776
1777     /* return the cell name of the primary cell for this user */
1778     i = UHash(areq->uid);
1779     ObtainWriteLock(&afs_xuser, 224);
1780     for (tu = afs_users[i]; tu; tu = tu->next) {
1781         if (tu->uid == areq->uid && (tu->states & UPrimary)) {
1782             tu->refCount++;
1783             ReleaseWriteLock(&afs_xuser);
1784             afs_LockUser(tu, READ_LOCK, 0);
1785             break;
1786         }
1787     }
1788     if (tu) {
1789         tcell = afs_GetCell(tu->cell, READ_LOCK);
1790         afs_PutUser(tu, READ_LOCK);
1791         if (!tcell)
1792             return ESRCH;
1793         else {
1794             if (afs_pd_putString(aout, tcell->cellName) != 0)
1795                 return E2BIG;
1796             afs_PutCell(tcell, READ_LOCK);
1797         }
1798     } else {
1799         ReleaseWriteLock(&afs_xuser);
1800     }
1801     return 0;
1802 }
1803
1804 /* Work out which cell we're changing tokens for */
1805 static_inline int
1806 _settok_tokenCell(char *cellName, int *cellNum, int *primary) {
1807     int t1;
1808     struct cell *cell;
1809
1810     if (primary) {
1811         *primary = 0;
1812     }
1813
1814     if (cellName && strlen(cellName) > 0) {
1815         cell = afs_GetCellByName(cellName, READ_LOCK);
1816     } else {
1817         cell = afs_GetPrimaryCell(READ_LOCK);
1818         if (primary)
1819             *primary = 1;
1820     }
1821     if (!cell) {
1822         t1 = afs_initState;
1823         if (t1 < 101)
1824             return EIO;
1825         else
1826             return ESRCH;
1827     }
1828     *cellNum = cell->cellNum;
1829     afs_PutCell(cell, READ_LOCK);
1830
1831     return 0;
1832 }
1833
1834
1835 static_inline int
1836 _settok_setParentPag(afs_ucred_t **cred) {
1837     afs_uint32 pag;
1838 #if defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
1839     char procname[256];
1840     osi_procname(procname, 256);
1841     afs_warnuser("Process %d (%s) tried to change pags in PSetTokens\n",
1842                  MyPidxx2Pid(MyPidxx), procname);
1843     return setpag(osi_curproc(), cred, -1, &pag, 1);
1844 #else
1845     return setpag(cred, -1, &pag, 1);
1846 #endif
1847 }
1848
1849 /*!
1850  * VIOCSETTOK (3) - Set authentication tokens
1851  *
1852  * \ingroup pioctl
1853  *
1854  * \param[in] ain       the krb tickets from which to set the afs tokens
1855  * \param[out] aout     not in use
1856  *
1857  * \retval EINVAL
1858  *      Error if the ticket is either too long or too short
1859  * \retval EIO
1860  *      Error if the AFS initState is below 101
1861  * \retval ESRCH
1862  *      Error if the cell for which the Token is being set can't be found
1863  *
1864  * \post
1865  *      Set the Tokens for a specific cell name, unless there is none set,
1866  *      then default to primary
1867  *
1868  */
1869 DECL_PIOCTL(PSetTokens)
1870 {
1871     afs_int32 cellNum;
1872     afs_int32 size;
1873     afs_int32 code;
1874     struct unixuser *tu;
1875     struct ClearToken clear;
1876     char *stp;
1877     char *cellName;
1878     int stLen;
1879     struct vrequest *treq = NULL;
1880     afs_int32 flag, set_parent_pag = 0;
1881
1882     AFS_STATCNT(PSetTokens);
1883     if (!afs_resourceinit_flag) {
1884         return EIO;
1885     }
1886
1887     if (afs_pd_getInt(ain, &stLen) != 0)
1888         return EINVAL;
1889
1890     stp = afs_pd_where(ain);    /* remember where the ticket is */
1891     if (stLen < 0 || stLen > MAXKTCTICKETLEN)
1892         return EINVAL;          /* malloc may fail */
1893     if (afs_pd_skip(ain, stLen) != 0)
1894         return EINVAL;
1895
1896     if (afs_pd_getInt(ain, &size) != 0)
1897         return EINVAL;
1898     if (size != sizeof(struct ClearToken))
1899         return EINVAL;
1900
1901     if (afs_pd_getBytes(ain, &clear, sizeof(struct ClearToken)) !=0)
1902         return EINVAL;
1903
1904     if (clear.AuthHandle == -1)
1905         clear.AuthHandle = 999; /* more rxvab compat stuff */
1906
1907     if (afs_pd_remaining(ain) != 0) {
1908         /* still stuff left?  we've got primary flag and cell name.
1909          * Set these */
1910
1911         if (afs_pd_getInt(ain, &flag) != 0)
1912             return EINVAL;
1913
1914         /* some versions of gcc appear to need != 0 in order to get this
1915          * right */
1916         if ((flag & 0x8000) != 0) {     /* XXX Use Constant XXX */
1917             flag &= ~0x8000;
1918             set_parent_pag = 1;
1919         }
1920
1921         if (afs_pd_getStringPtr(ain, &cellName) != 0)
1922             return EINVAL;
1923
1924         code = _settok_tokenCell(cellName, &cellNum, NULL);
1925         if (code)
1926             return code;
1927     } else {
1928         /* default to primary cell, primary id */
1929         code = _settok_tokenCell(NULL, &cellNum, &flag);
1930         if (code)
1931             return code;
1932     }
1933
1934     if (set_parent_pag) {
1935         if (_settok_setParentPag(acred) == 0) {
1936             code = afs_CreateReq(&treq, *acred);
1937             if (code) {
1938                 return code;
1939             }
1940             areq = treq;
1941         }
1942     }
1943
1944     /* now we just set the tokens */
1945     tu = afs_GetUser(areq->uid, cellNum, WRITE_LOCK);
1946     /* Set tokens destroys any that are already there */
1947     afs_FreeTokens(&tu->tokens);
1948     afs_AddRxkadToken(&tu->tokens, stp, stLen, &clear);
1949 #ifndef AFS_NOSTATS
1950     afs_stats_cmfullperf.authent.TicketUpdates++;
1951     afs_ComputePAGStats();
1952 #endif /* AFS_NOSTATS */
1953     tu->states |= UHasTokens;
1954     tu->states &= ~UTokensBad;
1955     afs_SetPrimary(tu, flag);
1956     tu->tokenTime = osi_Time();
1957     afs_ResetUserConns(tu);
1958     afs_NotifyUser(tu, UTokensObtained);
1959     afs_PutUser(tu, WRITE_LOCK);
1960     afs_DestroyReq(treq);
1961
1962     return 0;
1963 }
1964
1965 /*!
1966  * VIOCGETVOLSTAT (4) - Get volume status
1967  *
1968  * \ingroup pioctl
1969  *
1970  * \param[in] ain       not in use
1971  * \param[out] aout     status of the volume
1972  *
1973  * \retval EINVAL       Error if some of the standard args aren't set
1974  *
1975  * \post
1976  *      The status of a volume (based on the FID of the volume), or an
1977  *      offline message /motd
1978  */
1979 DECL_PIOCTL(PGetVolumeStatus)
1980 {
1981     char volName[32];
1982     char *offLineMsg = afs_osi_Alloc(256);
1983     char *motd = afs_osi_Alloc(256);
1984     struct afs_conn *tc;
1985     afs_int32 code = 0;
1986     struct AFSFetchVolumeStatus volstat;
1987     char *Name;
1988     struct rx_connection *rxconn;
1989     XSTATS_DECLS;
1990
1991     osi_Assert(offLineMsg != NULL);
1992     osi_Assert(motd != NULL);
1993     AFS_STATCNT(PGetVolumeStatus);
1994     if (!avc) {
1995         code = EINVAL;
1996         goto out;
1997     }
1998     Name = volName;
1999     do {
2000         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
2001         if (tc) {
2002             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_GETVOLUMESTATUS);
2003             RX_AFS_GUNLOCK();
2004             code =
2005                 RXAFS_GetVolumeStatus(rxconn, avc->f.fid.Fid.Volume, &volstat,
2006                                       &Name, &offLineMsg, &motd);
2007             RX_AFS_GLOCK();
2008             XSTATS_END_TIME;
2009         } else
2010             code = -1;
2011     } while (afs_Analyze
2012              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_GETVOLUMESTATUS,
2013               SHARED_LOCK, NULL));
2014
2015     if (code)
2016         goto out;
2017     /* Copy all this junk into msg->im_data, keeping track of the lengths. */
2018     if (afs_pd_putBytes(aout, &volstat, sizeof(VolumeStatus)) != 0)
2019         return E2BIG;
2020     if (afs_pd_putString(aout, volName) != 0)
2021         return E2BIG;
2022     if (afs_pd_putString(aout, offLineMsg) != 0)
2023         return E2BIG;
2024     if (afs_pd_putString(aout, motd) != 0)
2025         return E2BIG;
2026   out:
2027     afs_osi_Free(offLineMsg, 256);
2028     afs_osi_Free(motd, 256);
2029     return code;
2030 }
2031
2032 /*!
2033  * VIOCSETVOLSTAT (5) - Set volume status
2034  *
2035  * \ingroup pioctl
2036  *
2037  * \param[in] ain
2038  *      values to set the status at, offline message, message of the day,
2039  *      volume name, minimum quota, maximum quota
2040  * \param[out] aout
2041  *      status of a volume, offlines messages, minimum quota, maximumm quota
2042  *
2043  * \retval EINVAL
2044  *      Error if some of the standard args aren't set
2045  * \retval EROFS
2046  *      Error if the volume is read only, or a backup volume
2047  * \retval ENODEV
2048  *      Error if the volume can't be accessed
2049  * \retval E2BIG
2050  *      Error if the volume name, offline message, and motd are too big
2051  *
2052  * \post
2053  *      Set the status of a volume, including any offline messages,
2054  *      a minimum quota, and a maximum quota
2055  */
2056 DECL_PIOCTL(PSetVolumeStatus)
2057 {
2058     char *volName;
2059     char *offLineMsg;
2060     char *motd;
2061     struct afs_conn *tc;
2062     afs_int32 code = 0;
2063     struct AFSFetchVolumeStatus volstat;
2064     struct AFSStoreVolumeStatus storeStat;
2065     struct volume *tvp;
2066     struct rx_connection *rxconn;
2067     XSTATS_DECLS;
2068
2069     AFS_STATCNT(PSetVolumeStatus);
2070     if (!avc)
2071         return EINVAL;
2072     memset(&storeStat, 0, sizeof(storeStat));
2073
2074     tvp = afs_GetVolume(&avc->f.fid, areq, READ_LOCK);
2075     if (tvp) {
2076         if (tvp->states & (VRO | VBackup)) {
2077             afs_PutVolume(tvp, READ_LOCK);
2078             return EROFS;
2079         }
2080         afs_PutVolume(tvp, READ_LOCK);
2081     } else
2082         return ENODEV;
2083
2084
2085     if (afs_pd_getBytes(ain, &volstat, sizeof(AFSFetchVolumeStatus)) != 0)
2086         return EINVAL;
2087
2088     if (afs_pd_getStringPtr(ain, &volName) != 0)
2089         return EINVAL;
2090     if (strlen(volName) > 32)
2091         return E2BIG;
2092
2093     if (afs_pd_getStringPtr(ain, &offLineMsg) != 0)
2094         return EINVAL;
2095     if (strlen(offLineMsg) > 256)
2096         return E2BIG;
2097
2098     if (afs_pd_getStringPtr(ain, &motd) != 0)
2099         return EINVAL;
2100     if (strlen(motd) > 256)
2101         return E2BIG;
2102
2103     /* Done reading ... */
2104
2105     storeStat.Mask = 0;
2106     if (volstat.MinQuota != -1) {
2107         storeStat.MinQuota = volstat.MinQuota;
2108         storeStat.Mask |= AFS_SETMINQUOTA;
2109     }
2110     if (volstat.MaxQuota != -1) {
2111         storeStat.MaxQuota = volstat.MaxQuota;
2112         storeStat.Mask |= AFS_SETMAXQUOTA;
2113     }
2114     do {
2115         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
2116         if (tc) {
2117             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_SETVOLUMESTATUS);
2118             RX_AFS_GUNLOCK();
2119             code =
2120                 RXAFS_SetVolumeStatus(rxconn, avc->f.fid.Fid.Volume, &storeStat,
2121                                       volName, offLineMsg, motd);
2122             RX_AFS_GLOCK();
2123             XSTATS_END_TIME;
2124         } else
2125             code = -1;
2126     } while (afs_Analyze
2127              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_SETVOLUMESTATUS,
2128               SHARED_LOCK, NULL));
2129
2130     if (code)
2131         return code;
2132     /* we are sending parms back to make compat. with prev system.  should
2133      * change interface later to not ask for current status, just set new
2134      * status */
2135
2136     if (afs_pd_putBytes(aout, &volstat, sizeof(VolumeStatus)) != 0)
2137         return EINVAL;
2138     if (afs_pd_putString(aout, volName) != 0)
2139         return EINVAL;
2140     if (afs_pd_putString(aout, offLineMsg) != 0)
2141         return EINVAL;
2142     if (afs_pd_putString(aout, motd) != 0)
2143         return EINVAL;
2144
2145     return code;
2146 }
2147
2148 /*!
2149  * VIOCFLUSH (6) - Invalidate cache entry
2150  *
2151  * \ingroup pioctl
2152  *
2153  * \param[in] ain       not in use
2154  * \param[out] aout     not in use
2155  *
2156  * \retval EINVAL       Error if some of the standard args aren't set
2157  *
2158  * \post Flush any information the cache manager has on an entry
2159  */
2160 DECL_PIOCTL(PFlush)
2161 {
2162     AFS_STATCNT(PFlush);
2163     if (!avc)
2164         return EINVAL;
2165     ObtainWriteLock(&avc->lock, 225);
2166     afs_ResetVCache(avc, *acred, 0);
2167     ReleaseWriteLock(&avc->lock);
2168     return 0;
2169 }
2170
2171 /*!
2172  * VIOC_AFS_STAT_MT_PT (29) - Stat mount point
2173  *
2174  * \ingroup pioctl
2175  *
2176  * \param[in] ain
2177  *      the last component in a path, related to mountpoint that we're
2178  *      looking for information about
2179  * \param[out] aout
2180  *      volume, cell, link data
2181  *
2182  * \retval EINVAL       Error if some of the standard args aren't set
2183  * \retval ENOTDIR      Error if the 'mount point' argument isn't a directory
2184  * \retval EIO          Error if the link data can't be accessed
2185  *
2186  * \post Get the volume, and cell, as well as the link data for a mount point
2187  */
2188 DECL_PIOCTL(PNewStatMount)
2189 {
2190     afs_int32 code;
2191     struct vcache *tvc;
2192     struct dcache *tdc;
2193     struct VenusFid tfid;
2194     char *bufp;
2195     char *name;
2196     struct sysname_info sysState;
2197     afs_size_t offset, len;
2198
2199     AFS_STATCNT(PNewStatMount);
2200     if (!avc)
2201         return EINVAL;
2202
2203     if (afs_pd_getStringPtr(ain, &name) != 0)
2204         return EINVAL;
2205
2206     code = afs_VerifyVCache(avc, areq);
2207     if (code)
2208         return code;
2209     if (vType(avc) != VDIR) {
2210         return ENOTDIR;
2211     }
2212     tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 1);
2213     if (!tdc)
2214         return EIO;
2215     Check_AtSys(avc, name, &sysState, areq);
2216     ObtainReadLock(&tdc->lock);
2217     do {
2218         code = afs_dir_Lookup(tdc, sysState.name, &tfid.Fid);
2219     } while (code == ENOENT && Next_AtSys(avc, areq, &sysState));
2220     ReleaseReadLock(&tdc->lock);
2221     afs_PutDCache(tdc);         /* we're done with the data */
2222     bufp = sysState.name;
2223     if (code) {
2224         goto out;
2225     }
2226     tfid.Cell = avc->f.fid.Cell;
2227     tfid.Fid.Volume = avc->f.fid.Fid.Volume;
2228     if (!tfid.Fid.Unique && (avc->f.states & CForeign)) {
2229         tvc = afs_LookupVCache(&tfid, areq, NULL, avc, bufp);
2230     } else {
2231         tvc = afs_GetVCache(&tfid, areq, NULL, NULL);
2232     }
2233     if (!tvc) {
2234         code = EIO;
2235         goto out;
2236     }
2237     if (tvc->mvstat != AFS_MVSTAT_MTPT) {
2238         afs_PutVCache(tvc);
2239         code = EINVAL;
2240         goto out;
2241     }
2242     ObtainWriteLock(&tvc->lock, 226);
2243     code = afs_HandleLink(tvc, areq);
2244     if (code == 0) {
2245         if (tvc->linkData) {
2246             if ((tvc->linkData[0] != '#') && (tvc->linkData[0] != '%'))
2247                 code = EINVAL;
2248             else {
2249                 /* we have the data */
2250                 if (afs_pd_putString(aout, tvc->linkData) != 0)
2251                     code = EINVAL;
2252             }
2253         } else
2254             code = EIO;
2255     }
2256     ReleaseWriteLock(&tvc->lock);
2257     afs_PutVCache(tvc);
2258   out:
2259     if (sysState.allocked)
2260         osi_FreeLargeSpace(bufp);
2261     return code;
2262 }
2263
2264 /*!
2265  * A helper function to get the n'th cell which a particular user has tokens
2266  * for. This is racy. If new tokens are added whilst we're iterating, then
2267  * we may return some cells twice. If tokens expire mid run, then we'll
2268  * miss some cells from our output. So, could be better, but that would
2269  * require an interface change.
2270  */
2271
2272 static struct unixuser *
2273 getNthCell(afs_int32 uid, afs_int32 iterator) {
2274     int i;
2275     struct unixuser *tu = NULL;
2276
2277     if (iterator > afs_cellindex)
2278         return NULL;            /* no point in looking */
2279
2280     i = UHash(uid);
2281     ObtainReadLock(&afs_xuser);
2282     for (tu = afs_users[i]; tu; tu = tu->next) {
2283         if (tu->uid == uid && (tu->states & UHasTokens)) {
2284             if (iterator-- == 0)
2285             break;      /* are we done yet? */
2286         }
2287     }
2288     if (tu) {
2289         tu->refCount++;
2290     }
2291     ReleaseReadLock(&afs_xuser);
2292     if (tu) {
2293         afs_LockUser(tu, READ_LOCK, 0);
2294     }
2295
2296
2297     return tu;
2298 }
2299 /*!
2300  * VIOCGETTOK (8) - Get authentication tokens
2301  *
2302  * \ingroup pioctl
2303  *
2304  * \param[in] ain       cellid to return tokens for
2305  * \param[out] aout     token
2306  *
2307  * \retval EIO
2308  *      Error if the afs daemon hasn't started yet
2309  * \retval EDOM
2310  *      Error if the input parameter is out of the bounds of the available
2311  *      tokens
2312  * \retval ENOTCONN
2313  *      Error if there aren't tokens for this cell
2314  *
2315  * \post
2316  *      If the input paramater exists, get the token that corresponds to
2317  *      the parameter value, if there is no token at this value, get the
2318  *      token for the first cell
2319  *
2320  * \notes "it's a weird interface (from comments in the code)"
2321  */
2322
2323 DECL_PIOCTL(PGetTokens)
2324 {
2325     struct cell *tcell;
2326     struct unixuser *tu = NULL;
2327     union tokenUnion *token;
2328     afs_int32 iterator = 0;
2329     int newStyle;
2330     int cellNum;
2331     int code = E2BIG;
2332
2333     AFS_STATCNT(PGetTokens);
2334     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2335         return EIO;             /* Inappropriate ioctl for device */
2336
2337     /* weird interface.  If input parameter is present, it is an integer and
2338      * we're supposed to return the parm'th tokens for this unix uid.
2339      * If not present, we just return tokens for cell 1.
2340      * If counter out of bounds, return EDOM.
2341      * If no tokens for the particular cell, return ENOTCONN.
2342      * Also, if this mysterious parm is present, we return, along with the
2343      * tokens, the primary cell indicator (an afs_int32 0) and the cell name
2344      * at the end, in that order.
2345      */
2346     newStyle = (afs_pd_remaining(ain) > 0);
2347     if (newStyle) {
2348         if (afs_pd_getInt(ain, &iterator) != 0)
2349             return EINVAL;
2350     }
2351     if (newStyle) {
2352         tu = getNthCell(areq->uid, iterator);
2353     } else {
2354         cellNum = afs_GetPrimaryCellNum();
2355         if (cellNum)
2356             tu = afs_FindUser(areq->uid, cellNum, READ_LOCK);
2357     }
2358     if (!tu) {
2359         return EDOM;
2360     }
2361     if (!(tu->states & UHasTokens)
2362         || !afs_HasUsableTokens(tu->tokens, osi_Time())) {
2363         tu->states |= (UTokensBad | UNeedsReset);
2364         afs_NotifyUser(tu, UTokensDropped);
2365         afs_PutUser(tu, READ_LOCK);
2366         return ENOTCONN;
2367     }
2368     token = afs_FindToken(tu->tokens, RX_SECIDX_KAD);
2369
2370     /* If they don't have an RXKAD token, but do have other tokens,
2371      * then sadly there's nothing this interface can do to help them. */
2372     if (token == NULL)
2373         return ENOTCONN;
2374
2375     /* for compat, we try to return 56 byte tix if they fit */
2376     iterator = token->rxkad.ticketLen;
2377     if (iterator < 56)
2378         iterator = 56;          /* # of bytes we're returning */
2379
2380     if (afs_pd_putInt(aout, iterator) != 0)
2381         goto out;
2382     if (afs_pd_putBytes(aout, token->rxkad.ticket, token->rxkad.ticketLen) != 0)
2383         goto out;
2384     if (token->rxkad.ticketLen < 56) {
2385         /* Tokens are always 56 bytes or larger */
2386         if (afs_pd_skip(aout, iterator - token->rxkad.ticketLen) != 0) {
2387             goto out;
2388         }
2389     }
2390
2391     if (afs_pd_putInt(aout, sizeof(struct ClearToken)) != 0)
2392         goto out;
2393     if (afs_pd_putBytes(aout, &token->rxkad.clearToken,
2394                         sizeof(struct ClearToken)) != 0)
2395         goto out;
2396
2397     if (newStyle) {
2398         /* put out primary id and cell name, too */
2399         iterator = (tu->states & UPrimary ? 1 : 0);
2400         if (afs_pd_putInt(aout, iterator) != 0)
2401             goto out;
2402         tcell = afs_GetCell(tu->cell, READ_LOCK);
2403         if (tcell) {
2404             if (afs_pd_putString(aout, tcell->cellName) != 0)
2405                 goto out;
2406             afs_PutCell(tcell, READ_LOCK);
2407         } else
2408             if (afs_pd_putString(aout, "") != 0)
2409                 goto out;
2410     }
2411     /* Got here, all is good */
2412     code = 0;
2413 out:
2414     afs_PutUser(tu, READ_LOCK);
2415     return code;
2416 }
2417
2418 /*!
2419  * VIOCUNLOG (9) - Invalidate tokens
2420  *
2421  * \ingroup pioctl
2422  *
2423  * \param[in] ain       not in use
2424  * \param[out] aout     not in use
2425  *
2426  * \retval EIO  Error if the afs daemon hasn't been started yet
2427  *
2428  * \post remove tokens from a user, specified by the user id
2429  *
2430  * \notes sets the token's time to 0, which then causes it to be removed
2431  * \notes Unlog is the same as un-pag in OpenAFS
2432  */
2433 DECL_PIOCTL(PUnlog)
2434 {
2435     afs_int32 i;
2436     struct unixuser *tu;
2437
2438     AFS_STATCNT(PUnlog);
2439     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2440         return EIO;             /* Inappropriate ioctl for device */
2441
2442     i = UHash(areq->uid);
2443     ObtainWriteLock(&afs_xuser, 227);
2444     for (tu = afs_users[i]; tu; tu = tu->next) {
2445         if (tu->uid == areq->uid) {
2446             tu->refCount++;
2447             ReleaseWriteLock(&afs_xuser);
2448
2449             afs_LockUser(tu, WRITE_LOCK, 366);
2450
2451             tu->states &= ~UHasTokens;
2452             afs_FreeTokens(&tu->tokens);
2453             afs_NotifyUser(tu, UTokensDropped);
2454             /* We have to drop the lock over the call to afs_ResetUserConns,
2455              * since it obtains the afs_xvcache lock.  We could also keep
2456              * the lock, and modify ResetUserConns to take parm saying we
2457              * obtained the lock already, but that is overkill.  By keeping
2458              * the "tu" pointer held over the released lock, we guarantee
2459              * that we won't lose our place, and that we'll pass over
2460              * every user conn that existed when we began this call.
2461              */
2462             afs_ResetUserConns(tu);
2463             afs_PutUser(tu, WRITE_LOCK);
2464             ObtainWriteLock(&afs_xuser, 228);
2465 #ifdef UKERNEL
2466             /* set the expire times to 0, causes
2467              * afs_GCUserData to remove this entry
2468              */
2469             tu->tokenTime = 0;
2470 #endif /* UKERNEL */
2471         }
2472     }
2473     ReleaseWriteLock(&afs_xuser);
2474     return 0;
2475 }
2476
2477 /*!
2478  * VIOC_AFS_MARINER_HOST (32) - Get/set mariner (cache manager monitor) host
2479  *
2480  * \ingroup pioctl
2481  *
2482  * \param[in] ain       host address to be set
2483  * \param[out] aout     old host address
2484  *
2485  * \post
2486  *      depending on whether or not a variable is set, either get the host
2487  *      for the cache manager monitor, or set the old address and give it
2488  *      a new address
2489  *
2490  * \notes Errors turn off mariner
2491  */
2492 DECL_PIOCTL(PMariner)
2493 {
2494     afs_int32 newHostAddr;
2495     afs_int32 oldHostAddr;
2496
2497     AFS_STATCNT(PMariner);
2498     if (afs_mariner)
2499         memcpy((char *)&oldHostAddr, (char *)&afs_marinerHost,
2500                sizeof(afs_int32));
2501     else
2502         oldHostAddr = 0xffffffff;       /* disabled */
2503
2504     if (afs_pd_getInt(ain, &newHostAddr) != 0)
2505         return EINVAL;
2506
2507     if (newHostAddr == 0xffffffff) {
2508         /* disable mariner operations */
2509         afs_mariner = 0;
2510     } else if (newHostAddr) {
2511         afs_mariner = 1;
2512         afs_marinerHost = newHostAddr;
2513     }
2514
2515     if (afs_pd_putInt(aout, oldHostAddr) != 0)
2516         return E2BIG;
2517
2518     return 0;
2519 }
2520
2521 /*!
2522  * VIOCCKSERV (10) - Check that servers are up
2523  *
2524  * \ingroup pioctl
2525  *
2526  * \param[in] ain       name of the cell
2527  * \param[out] aout     current down server list
2528  *
2529  * \retval EIO          Error if the afs daemon hasn't started yet
2530  * \retval EACCES       Error if the user doesn't have super-user credentials
2531  * \retval ENOENT       Error if we are unable to obtain the cell
2532  *
2533  * \post
2534  *      Either a fast check (where it doesn't contact servers) or a
2535  *      local check (checks local cell only)
2536  */
2537 DECL_PIOCTL(PCheckServers)
2538 {
2539     int i;
2540     struct server *ts;
2541     afs_int32 temp;
2542     char *cellName = NULL;
2543     struct cell *cellp;
2544     struct chservinfo *pcheck;
2545
2546     AFS_STATCNT(PCheckServers);
2547
2548     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2549         return EIO;             /* Inappropriate ioctl for device */
2550
2551     /* This is tricky, because we need to peak at the datastream to see
2552      * what we're getting. For now, let's cheat. */
2553
2554     /* ain contains either an int32 or a string */
2555     if (ain->remaining == 0)
2556         return EINVAL;
2557
2558     if (*(afs_int32 *)ain->ptr == 0x12345678) { /* For afs3.3 version */
2559         pcheck = afs_pd_inline(ain, sizeof(*pcheck));
2560         if (pcheck == NULL)
2561             return EINVAL;
2562
2563         if (pcheck->tinterval >= 0) {
2564             if (afs_pd_putInt(aout, afs_probe_interval) != 0)
2565                 return E2BIG;
2566             if (pcheck->tinterval > 0) {
2567                 if (!afs_osi_suser(*acred))
2568                     return EACCES;
2569                 afs_probe_interval = pcheck->tinterval;
2570             }
2571             return 0;
2572         }
2573         temp = pcheck->tflags;
2574         if (pcheck->tsize)
2575             cellName = pcheck->tbuffer;
2576     } else {                    /* For pre afs3.3 versions */
2577         if (afs_pd_getInt(ain, &temp) != 0)
2578             return EINVAL;
2579         if (afs_pd_remaining(ain) > 0) {
2580             if (afs_pd_getStringPtr(ain, &cellName) != 0)
2581                 return EINVAL;
2582         }
2583     }
2584
2585     /*
2586      * 1: fast check, don't contact servers.
2587      * 2: local cell only.
2588      */
2589     if (cellName) {
2590         /* have cell name, too */
2591         cellp = afs_GetCellByName(cellName, READ_LOCK);
2592         if (!cellp)
2593             return ENOENT;
2594     } else
2595         cellp = NULL;
2596     if (!cellp && (temp & 2)) {
2597         /* use local cell */
2598         cellp = afs_GetPrimaryCell(READ_LOCK);
2599     }
2600     if (!(temp & 1)) {          /* if not fast, call server checker routine */
2601         afs_CheckServers(1, cellp);     /* check down servers */
2602         afs_CheckServers(0, cellp);     /* check up servers */
2603     }
2604     /* now return the current down server list */
2605     ObtainReadLock(&afs_xserver);
2606     for (i = 0; i < NSERVERS; i++) {
2607         for (ts = afs_servers[i]; ts; ts = ts->next) {
2608             if (cellp && ts->cell != cellp)
2609                 continue;       /* cell spec'd and wrong */
2610             if ((ts->flags & SRVR_ISDOWN)
2611                 && ts->addr->sa_portal != ts->cell->vlport) {
2612                 afs_pd_putInt(aout, ts->addr->sa_ip);
2613             }
2614         }
2615     }
2616     ReleaseReadLock(&afs_xserver);
2617     if (cellp)
2618         afs_PutCell(cellp, READ_LOCK);
2619     return 0;
2620 }
2621
2622 /*!
2623  * VIOCCKBACK (11) - Check backup volume mappings
2624  *
2625  * \ingroup pioctl
2626  *
2627  * \param[in] ain       not in use
2628  * \param[out] aout     not in use
2629  *
2630  * \retval EIO          Error if the afs daemon hasn't started yet
2631  *
2632  * \post
2633  *      Check the root volume, and then check the names if the volume
2634  *      check variable is set to force, has expired, is busy, or if
2635  *      the mount points variable is set
2636  */
2637 DECL_PIOCTL(PCheckVolNames)
2638 {
2639     AFS_STATCNT(PCheckVolNames);
2640     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2641         return EIO;             /* Inappropriate ioctl for device */
2642
2643     afs_CheckRootVolume();
2644     afs_CheckVolumeNames(AFS_VOLCHECK_FORCE | AFS_VOLCHECK_EXPIRED |
2645                          AFS_VOLCHECK_BUSY | AFS_VOLCHECK_MTPTS);
2646     return 0;
2647 }
2648
2649 /*!
2650  * VIOCCKCONN (12) - Check connections for a user
2651  *
2652  * \ingroup pioctl
2653  *
2654  * \param[in] ain       not in use
2655  * \param[out] aout     not in use
2656  *
2657  * \retval EACCESS
2658  *      Error if no user is specififed, the user has no tokens set,
2659  *      or if the user's tokens are bad
2660  *
2661  * \post
2662  *      check to see if a user has the correct authentication.
2663  *      If so, allow access.
2664  *
2665  * \notes Check the connections to all the servers specified
2666  */
2667 DECL_PIOCTL(PCheckAuth)
2668 {
2669     int i;
2670     struct srvAddr *sa;
2671     struct sa_conn_vector *tcv;
2672     struct unixuser *tu;
2673     afs_int32 retValue;
2674
2675     AFS_STATCNT(PCheckAuth);
2676     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
2677         return EIO;             /* Inappropriate ioctl for device */
2678
2679     retValue = 0;
2680     tu = afs_GetUser(areq->uid, 1, READ_LOCK);  /* check local cell authentication */
2681     if (!tu)
2682         retValue = EACCES;
2683     else {
2684         /* we have a user */
2685         ObtainReadLock(&afs_xsrvAddr);
2686         ObtainReadLock(&afs_xconn);
2687
2688         /* any tokens set? */
2689         if ((tu->states & UHasTokens) == 0)
2690             retValue = EACCES;
2691         /* all connections in cell 1 working? */
2692         for (i = 0; i < NSERVERS; i++) {
2693             for (sa = afs_srvAddrs[i]; sa; sa = sa->next_bkt) {
2694                 for (tcv = sa->conns; tcv; tcv = tcv->next) {
2695                     if (tcv->user == tu && (tu->states & UTokensBad))
2696                         retValue = EACCES;
2697                 }
2698             }
2699         }
2700         ReleaseReadLock(&afs_xsrvAddr);
2701         ReleaseReadLock(&afs_xconn);
2702         afs_PutUser(tu, READ_LOCK);
2703     }
2704     if (afs_pd_putInt(aout, retValue) != 0)
2705         return E2BIG;
2706     return 0;
2707 }
2708
2709 static int
2710 Prefetch(uparmtype apath, struct afs_ioctl *adata, int afollow,
2711          afs_ucred_t *acred)
2712 {
2713     char *tp;
2714     afs_int32 code;
2715 #if defined(AFS_SGI61_ENV) || defined(AFS_SUN5_ENV) || defined(AFS_DARWIN_ENV) || defined(AFS_XBSD_ENV)
2716     size_t bufferSize;
2717 #else
2718     u_int bufferSize;
2719 #endif
2720
2721     AFS_STATCNT(Prefetch);
2722     if (!apath)
2723         return EINVAL;
2724     tp = osi_AllocLargeSpace(1024);
2725     AFS_COPYINSTR(apath, tp, 1024, &bufferSize, code);
2726     if (code) {
2727         osi_FreeLargeSpace(tp);
2728         return code;
2729     }
2730     if (afs_BBusy()) {          /* do this as late as possible */
2731         osi_FreeLargeSpace(tp);
2732         return EWOULDBLOCK;     /* pretty close */
2733     }
2734     afs_BQueue(BOP_PATH, (struct vcache *)0, 0, 0, acred, (afs_size_t) 0,
2735                (afs_size_t) 0, tp, (void *)0, (void *)0);
2736     return 0;
2737 }
2738
2739 /*!
2740  * VIOCWHEREIS (14) - Find out where a volume is located
2741  *
2742  * \ingroup pioctl
2743  *
2744  * \param[in] ain       not in use
2745  * \param[out] aout     volume location
2746  *
2747  * \retval EINVAL       Error if some of the default arguments don't exist
2748  * \retval ENODEV       Error if there is no such volume
2749  *
2750  * \post fine a volume, based on a volume file id
2751  *
2752  * \notes check each of the servers specified
2753  */
2754 DECL_PIOCTL(PFindVolume)
2755 {
2756     struct volume *tvp;
2757     struct server *ts;
2758     afs_int32 i;
2759     int code = 0;
2760
2761     AFS_STATCNT(PFindVolume);
2762     if (!avc)
2763         return EINVAL;
2764     tvp = afs_GetVolume(&avc->f.fid, areq, READ_LOCK);
2765     if (!tvp)
2766         return ENODEV;
2767
2768     for (i = 0; i < AFS_MAXHOSTS; i++) {
2769         ts = tvp->serverHost[i];
2770         if (!ts)
2771             break;
2772         if (afs_pd_putInt(aout, ts->addr->sa_ip) != 0) {
2773             code = E2BIG;
2774             goto out;
2775         }
2776     }
2777     if (i < AFS_MAXHOSTS) {
2778         /* still room for terminating NULL, add it on */
2779         if (afs_pd_putInt(aout, 0) != 0) {
2780             code = E2BIG;
2781             goto out;
2782         }
2783     }
2784 out:
2785     afs_PutVolume(tvp, READ_LOCK);
2786     return code;
2787 }
2788
2789 /*!
2790  * VIOCACCESS (20) - Access using PRS_FS bits
2791  *
2792  * \ingroup pioctl
2793  *
2794  * \param[in] ain       PRS_FS bits
2795  * \param[out] aout     not in use
2796  *
2797  * \retval EINVAL       Error if some of the initial arguments aren't set
2798  * \retval EACCES       Error if access is denied
2799  *
2800  * \post check to make sure access is allowed
2801  */
2802 DECL_PIOCTL(PViceAccess)
2803 {
2804     afs_int32 code;
2805     afs_int32 temp;
2806
2807     AFS_STATCNT(PViceAccess);
2808     if (!avc)
2809         return EINVAL;
2810
2811     code = afs_VerifyVCache(avc, areq);
2812     if (code)
2813         return code;
2814
2815     if (afs_pd_getInt(ain, &temp) != 0)
2816         return EINVAL;
2817
2818     code = afs_AccessOK(avc, temp, areq, CHECK_MODE_BITS);
2819     if (code)
2820         return 0;
2821     else
2822         return EACCES;
2823 }
2824
2825 /*!
2826  * VIOC_GETPAG (13) - Get PAG value
2827  *
2828  * \ingroup pioctl
2829  *
2830  * \param[in] ain       not in use
2831  * \param[out] aout     PAG value or NOPAG
2832  *
2833  * \post get PAG value for the caller's cred
2834  */
2835 DECL_PIOCTL(PGetPAG)
2836 {
2837     afs_int32 pag;
2838
2839     pag = PagInCred(*acred);
2840
2841     return afs_pd_putInt(aout, pag);
2842 }
2843
2844 DECL_PIOCTL(PPrecache)
2845 {
2846     afs_int32 newValue;
2847
2848     /*AFS_STATCNT(PPrecache);*/
2849     if (!afs_osi_suser(*acred))
2850         return EACCES;
2851
2852     if (afs_pd_getInt(ain, &newValue) != 0)
2853         return EINVAL;
2854
2855     afs_preCache = newValue*1024;
2856     return 0;
2857 }
2858
2859 /*!
2860  * VIOCSETCACHESIZE (24) - Set venus cache size in 1000 units
2861  *
2862  * \ingroup pioctl
2863  *
2864  * \param[in] ain       the size the venus cache should be set to
2865  * \param[out] aout     not in use
2866  *
2867  * \retval EACCES       Error if the user doesn't have super-user credentials
2868  * \retval EROFS        Error if the cache is set to be in memory
2869  *
2870  * \post
2871  *      Set the cache size based on user input.  If no size is given,
2872  *      set it to the default OpenAFS cache size.
2873  *
2874  * \notes
2875  *      recompute the general cache parameters for every single block allocated
2876  */
2877 DECL_PIOCTL(PSetCacheSize)
2878 {
2879     afs_int32 newValue;
2880     int waitcnt = 0;
2881
2882     AFS_STATCNT(PSetCacheSize);
2883
2884     if (!afs_osi_suser(*acred))
2885         return EACCES;
2886     /* too many things are setup initially in mem cache version */
2887     if (cacheDiskType == AFS_FCACHE_TYPE_MEM)
2888         return EROFS;
2889     if (afs_pd_getInt(ain, &newValue) != 0)
2890         return EINVAL;
2891     if (newValue == 0)
2892         afs_cacheBlocks = afs_stats_cmperf.cacheBlocksOrig;
2893     else {
2894         if (newValue < afs_min_cache)
2895             afs_cacheBlocks = afs_min_cache;
2896         else
2897             afs_cacheBlocks = newValue;
2898     }
2899     afs_stats_cmperf.cacheBlocksTotal = afs_cacheBlocks;
2900     afs_ComputeCacheParms();    /* recompute basic cache parameters */
2901     afs_MaybeWakeupTruncateDaemon();
2902     while (waitcnt++ < 100 && afs_cacheBlocks < afs_blocksUsed) {
2903         afs_osi_Wait(1000, 0, 0);
2904         afs_MaybeWakeupTruncateDaemon();
2905     }
2906     return 0;
2907 }
2908
2909 #define MAXGCSTATS      16
2910 /*!
2911  * VIOCGETCACHEPARMS (40) - Get cache stats
2912  *
2913  * \ingroup pioctl
2914  *
2915  * \param[in] ain       afs index flags
2916  * \param[out] aout     cache blocks, blocks used, blocks files (in an array)
2917  *
2918  * \post Get the cache blocks, and how many of the cache blocks there are
2919  */
2920 DECL_PIOCTL(PGetCacheSize)
2921 {
2922     afs_int32 results[MAXGCSTATS];
2923     afs_int32 flags;
2924     struct dcache * tdc;
2925     int i;
2926
2927     AFS_STATCNT(PGetCacheSize);
2928
2929     if (afs_pd_remaining(ain) == sizeof(afs_int32)) {
2930         afs_pd_getInt(ain, &flags); /* can't error, we just checked size */
2931     } else if (afs_pd_remaining(ain) == 0) {
2932         flags = 0;
2933     } else {
2934         return EINVAL;
2935     }
2936
2937     memset(results, 0, sizeof(results));
2938     results[0] = afs_cacheBlocks;
2939     results[1] = afs_blocksUsed;
2940     results[2] = afs_cacheFiles;
2941
2942     if (1 == flags){
2943         for (i = 0; i < afs_cacheFiles; i++) {
2944             if (afs_indexFlags[i] & IFFree) results[3]++;
2945         }
2946     } else if (2 == flags){
2947         for (i = 0; i < afs_cacheFiles; i++) {
2948             if (afs_indexFlags[i] & IFFree) results[3]++;
2949             if (afs_indexFlags[i] & IFEverUsed) results[4]++;
2950             if (afs_indexFlags[i] & IFDataMod) results[5]++;
2951             if (afs_indexFlags[i] & IFDirtyPages) results[6]++;
2952             if (afs_indexFlags[i] & IFAnyPages) results[7]++;
2953             if (afs_indexFlags[i] & IFDiscarded) results[8]++;
2954
2955             tdc = afs_indexTable[i];
2956             if (tdc){
2957                 afs_size_t size = tdc->validPos;
2958
2959                 results[9]++;
2960                 if ( 0 <= size && size < (1<<12) ) results[10]++;
2961                 else if (size < (1<<14) ) results[11]++;
2962                 else if (size < (1<<16) ) results[12]++;
2963                 else if (size < (1<<18) ) results[13]++;
2964                 else if (size < (1<<20) ) results[14]++;
2965                 else if (size >= (1<<20) ) results[15]++;
2966             }
2967         }
2968     }
2969     return afs_pd_putBytes(aout, results, sizeof(results));
2970 }
2971
2972 /*!
2973  * VIOCFLUSHCB (25) - Flush callback only
2974  *
2975  * \ingroup pioctl
2976  *
2977  * \param[in] ain       not in use
2978  * \param[out] aout     not in use
2979  *
2980  * \retval EINVAL       Error if some of the standard args aren't set
2981  * \retval 0            0 returned if the volume is set to read-only
2982  *
2983  * \post
2984  *      Flushes callbacks, by setting the length of callbacks to one,
2985  *      setting the next callback to be sent to the CB_DROPPED value,
2986  *      and then dequeues everything else.
2987  */
2988 DECL_PIOCTL(PRemoveCallBack)
2989 {
2990     struct afs_conn *tc;
2991     afs_int32 code = 0;
2992     struct AFSCallBack CallBacks_Array[1];
2993     struct AFSCBFids theFids;
2994     struct AFSCBs theCBs;
2995     struct rx_connection *rxconn;
2996     XSTATS_DECLS;
2997
2998     AFS_STATCNT(PRemoveCallBack);
2999     if (!avc)
3000         return EINVAL;
3001     if (avc->f.states & CRO)
3002         return 0;               /* read-only-ness can't change */
3003     ObtainWriteLock(&avc->lock, 229);
3004     theFids.AFSCBFids_len = 1;
3005     theCBs.AFSCBs_len = 1;
3006     theFids.AFSCBFids_val = (struct AFSFid *)&avc->f.fid.Fid;
3007     theCBs.AFSCBs_val = CallBacks_Array;
3008     CallBacks_Array[0].CallBackType = CB_DROPPED;
3009     if (avc->callback) {
3010         do {
3011             tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
3012             if (tc) {
3013                 XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_GIVEUPCALLBACKS);
3014                 RX_AFS_GUNLOCK();
3015                 code = RXAFS_GiveUpCallBacks(rxconn, &theFids, &theCBs);
3016                 RX_AFS_GLOCK();
3017                 XSTATS_END_TIME;
3018             }
3019             /* don't set code on failure since we wouldn't use it */
3020         } while (afs_Analyze
3021                  (tc, rxconn, code, &avc->f.fid, areq,
3022                   AFS_STATS_FS_RPCIDX_GIVEUPCALLBACKS, SHARED_LOCK, NULL));
3023
3024         afs_StaleVCacheFlags(avc, AFS_STALEVC_CLEARCB, CUnique);
3025     }
3026     ReleaseWriteLock(&avc->lock);
3027     return 0;
3028 }
3029
3030 /*!
3031  * VIOCNEWCELL (26) - Configure new cell
3032  *
3033  * \ingroup pioctl
3034  *
3035  * \param[in] ain
3036  *      the name of the cell, the hosts that will be a part of the cell,
3037  *      whether or not it's linked with another cell, the other cell it's
3038  *      linked with, the file server port, and the volume server port
3039  * \param[out] aout
3040  *      not in use
3041  *
3042  * \retval EIO          Error if the afs daemon hasn't started yet
3043  * \retval EACCES       Error if the user doesn't have super-user cedentials
3044  * \retval EINVAL       Error if some 'magic' var doesn't have a certain bit set
3045  *
3046  * \post creates a new cell
3047  */
3048 DECL_PIOCTL(PNewCell)
3049 {
3050     afs_int32 cellHosts[AFS_MAXCELLHOSTS], magic = 0;
3051     char *newcell = NULL;
3052     char *linkedcell = NULL;
3053     afs_int32 code, ls;
3054     afs_int32 linkedstate = 0;
3055     afs_int32 fsport = 0, vlport = 0;
3056     int skip;
3057
3058     AFS_STATCNT(PNewCell);
3059     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3060         return EIO;             /* Inappropriate ioctl for device */
3061
3062     if (!afs_osi_suser(*acred))
3063         return EACCES;
3064
3065     if (afs_pd_getInt(ain, &magic) != 0)
3066         return EINVAL;
3067     if (magic != 0x12345678)
3068         return EINVAL;
3069
3070     /* A 3.4 fs newcell command will pass an array of AFS_MAXCELLHOSTS
3071      * server addresses while the 3.5 fs newcell command passes
3072      * AFS_MAXHOSTS. To figure out which is which, check if the cellname
3073      * is good.
3074      *
3075      * This whole logic is bogus, because it relies on the newer command
3076      * sending its 12th address as 0.
3077      */
3078     if (afs_pd_remaining(ain) < (AFS_MAXCELLHOSTS + 3) * sizeof(afs_int32))
3079         return EINVAL;
3080
3081     newcell = afs_pd_where(ain) + (AFS_MAXCELLHOSTS + 3) * sizeof(afs_int32);
3082     if (newcell[0] != '\0') {
3083         skip = 0;
3084     } else {
3085         skip = AFS_MAXHOSTS - AFS_MAXCELLHOSTS;
3086     }
3087
3088     /* AFS_MAXCELLHOSTS (=8) is less than AFS_MAXHOSTS (=13) */
3089     if (afs_pd_getBytes(ain, &cellHosts,
3090                         AFS_MAXCELLHOSTS * sizeof(afs_int32)) != 0)
3091         return EINVAL;
3092     if (afs_pd_skip(ain, skip * sizeof(afs_int32)) !=0)
3093         return EINVAL;
3094
3095     if (afs_pd_getInt(ain, &fsport) != 0)
3096         return EINVAL;
3097     if (fsport < 1024)
3098         fsport = 0;             /* Privileged ports not allowed */
3099
3100     if (afs_pd_getInt(ain, &vlport) != 0)
3101         return EINVAL;
3102     if (vlport < 1024)
3103         vlport = 0;             /* Privileged ports not allowed */
3104
3105     if (afs_pd_getInt(ain, &ls) != 0)
3106         return EINVAL;
3107
3108     if (afs_pd_getStringPtr(ain, &newcell) != 0)
3109         return EINVAL;
3110
3111     if (ls & 1) {
3112         if (afs_pd_getStringPtr(ain, &linkedcell) != 0)
3113             return EINVAL;
3114         linkedstate |= CLinkedCell;
3115     }
3116
3117     linkedstate |= CNoSUID;     /* setuid is disabled by default for fs newcell */
3118     code =
3119         afs_NewCell(newcell, cellHosts, linkedstate, linkedcell, fsport,
3120                     vlport, (int)0);
3121     return code;
3122 }
3123
3124 DECL_PIOCTL(PNewAlias)
3125 {
3126     /* create a new cell alias */
3127     char *realName, *aliasName;
3128
3129     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3130         return EIO;             /* Inappropriate ioctl for device */
3131
3132     if (!afs_osi_suser(*acred))
3133         return EACCES;
3134
3135     if (afs_pd_getStringPtr(ain, &aliasName) != 0)
3136         return EINVAL;
3137     if (afs_pd_getStringPtr(ain, &realName) != 0)
3138         return EINVAL;
3139
3140     return afs_NewCellAlias(aliasName, realName);
3141 }
3142
3143 /*!
3144  * VIOCGETCELL (27) - Get cell info
3145  *
3146  * \ingroup pioctl
3147  *
3148  * \param[in] ain       The cell index of a specific cell
3149  * \param[out] aout     list of servers in the cell
3150  *
3151  * \retval EIO          Error if the afs daemon hasn't started yet
3152  * \retval EDOM         Error if there is no cell asked about
3153  *
3154  * \post Lists the cell's server names and and addresses
3155  */
3156 DECL_PIOCTL(PListCells)
3157 {
3158     afs_int32 whichCell;
3159     struct cell *tcell = 0;
3160     afs_int32 i;
3161     int code;
3162
3163     AFS_STATCNT(PListCells);
3164     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3165         return EIO;             /* Inappropriate ioctl for device */
3166
3167     if (afs_pd_getInt(ain, &whichCell) != 0)
3168         return EINVAL;
3169
3170     tcell = afs_GetCellByIndex(whichCell, READ_LOCK);
3171     if (!tcell)
3172         return EDOM;
3173
3174     code = E2BIG;
3175
3176     for (i = 0; i < AFS_MAXCELLHOSTS; i++) {
3177         if (tcell->cellHosts[i] == 0)
3178             break;
3179         if (afs_pd_putInt(aout, tcell->cellHosts[i]->addr->sa_ip) != 0)
3180             goto out;
3181     }
3182     for (;i < AFS_MAXCELLHOSTS; i++) {
3183         if (afs_pd_putInt(aout, 0) != 0)
3184             goto out;
3185     }
3186     if (afs_pd_putString(aout, tcell->cellName) != 0)
3187         goto out;
3188     code = 0;
3189
3190 out:
3191     afs_PutCell(tcell, READ_LOCK);
3192     return code;
3193 }
3194
3195 DECL_PIOCTL(PListAliases)
3196 {
3197     afs_int32 whichAlias;
3198     struct cell_alias *tcalias = 0;
3199     int code;
3200
3201     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3202         return EIO;             /* Inappropriate ioctl for device */
3203
3204     if (afs_pd_getInt(ain, &whichAlias) != 0)
3205         return EINVAL;
3206
3207     tcalias = afs_GetCellAlias(whichAlias);
3208     if (tcalias == NULL)
3209         return EDOM;
3210
3211     code = E2BIG;
3212     if (afs_pd_putString(aout, tcalias->alias) != 0)
3213         goto out;
3214     if (afs_pd_putString(aout, tcalias->cell) != 0)
3215         goto out;
3216
3217     code = 0;
3218 out:
3219     afs_PutCellAlias(tcalias);
3220     return code;
3221 }
3222
3223 /*!
3224  * VIOC_AFS_DELETE_MT_PT (28) - Delete mount point
3225  *
3226  * \ingroup pioctl
3227  *
3228  * \param[in] ain       the name of the file in this dir to remove
3229  * \param[out] aout     not in use
3230  *
3231  * \retval EINVAL
3232  *      Error if some of the standard args aren't set
3233  * \retval ENOTDIR
3234  *      Error if the argument to remove is not a directory
3235  * \retval ENOENT
3236  *      Error if there is no cache to remove the mount point from or
3237  *      if a vcache doesn't exist
3238  *
3239  * \post
3240  *      Ensure that everything is OK before deleting the mountpoint.
3241  *      If not, don't delete.  Delete a mount point based on a file id.
3242  */
3243 DECL_PIOCTL(PRemoveMount)
3244 {
3245     afs_int32 code;
3246     char *bufp;
3247     char *name;
3248     struct sysname_info sysState;
3249     afs_size_t offset, len;
3250     struct afs_conn *tc;
3251     struct dcache *tdc;
3252     struct vcache *tvc;
3253     struct AFSFetchStatus OutDirStatus;
3254     struct VenusFid tfid;
3255     struct AFSVolSync tsync;
3256     struct rx_connection *rxconn;
3257     XSTATS_DECLS;
3258
3259     /* "ain" is the name of the file in this dir to remove */
3260
3261     AFS_STATCNT(PRemoveMount);
3262     if (!avc)
3263         return EINVAL;
3264     if (afs_pd_getStringPtr(ain, &name) != 0)
3265         return EINVAL;
3266
3267     code = afs_VerifyVCache(avc, areq);
3268     if (code)
3269         return code;
3270     if (vType(avc) != VDIR)
3271         return ENOTDIR;
3272
3273     tdc = afs_GetDCache(avc, (afs_size_t) 0, areq, &offset, &len, 1);   /* test for error below */
3274     if (!tdc)
3275         return EIO;
3276     Check_AtSys(avc, name, &sysState, areq);
3277     ObtainReadLock(&tdc->lock);
3278     do {
3279         code = afs_dir_Lookup(tdc, sysState.name, &tfid.Fid);
3280     } while (code == ENOENT && Next_AtSys(avc, areq, &sysState));
3281     ReleaseReadLock(&tdc->lock);
3282     bufp = sysState.name;
3283     if (code) {
3284         afs_PutDCache(tdc);
3285         goto out;
3286     }
3287     tfid.Cell = avc->f.fid.Cell;
3288     tfid.Fid.Volume = avc->f.fid.Fid.Volume;
3289     if (!tfid.Fid.Unique && (avc->f.states & CForeign)) {
3290         tvc = afs_LookupVCache(&tfid, areq, NULL, avc, bufp);
3291     } else {
3292         tvc = afs_GetVCache(&tfid, areq, NULL, NULL);
3293     }
3294     if (!tvc) {
3295         code = EIO;
3296         afs_PutDCache(tdc);
3297         goto out;
3298     }
3299     if (tvc->mvstat != AFS_MVSTAT_MTPT) {
3300         afs_PutDCache(tdc);
3301         afs_PutVCache(tvc);
3302         code = EINVAL;
3303         goto out;
3304     }
3305     ObtainWriteLock(&tvc->lock, 230);
3306     code = afs_HandleLink(tvc, areq);
3307     if (!code) {
3308         if (tvc->linkData) {
3309             if ((tvc->linkData[0] != '#') && (tvc->linkData[0] != '%'))
3310                 code = EINVAL;
3311         } else
3312             code = EIO;
3313     }
3314     ReleaseWriteLock(&tvc->lock);
3315     osi_dnlc_purgedp(tvc);
3316     afs_PutVCache(tvc);
3317     if (code) {
3318         afs_PutDCache(tdc);
3319         goto out;
3320     }
3321     ObtainWriteLock(&avc->lock, 231);
3322     osi_dnlc_remove(avc, bufp, tvc);
3323     do {
3324         tc = afs_Conn(&avc->f.fid, areq, SHARED_LOCK, &rxconn);
3325         if (tc) {
3326             XSTATS_START_TIME(AFS_STATS_FS_RPCIDX_REMOVEFILE);
3327             RX_AFS_GUNLOCK();
3328             code =
3329                 RXAFS_RemoveFile(rxconn, (struct AFSFid *)&avc->f.fid.Fid, bufp,
3330                                  &OutDirStatus, &tsync);
3331             RX_AFS_GLOCK();
3332             XSTATS_END_TIME;
3333         } else
3334             code = -1;
3335     } while (afs_Analyze
3336              (tc, rxconn, code, &avc->f.fid, areq, AFS_STATS_FS_RPCIDX_REMOVEFILE,
3337               SHARED_LOCK, NULL));
3338
3339     if (code) {
3340         if (tdc)
3341             afs_PutDCache(tdc);
3342         ReleaseWriteLock(&avc->lock);
3343         goto out;
3344     }
3345     if (tdc) {
3346         /* we have the thing in the cache */
3347         ObtainWriteLock(&tdc->lock, 661);
3348         if (afs_LocalHero(avc, tdc, &OutDirStatus, 1)) {
3349             /* we can do it locally */
3350             code = afs_dir_Delete(tdc, bufp);
3351             if (code) {
3352                 ZapDCE(tdc);    /* surprise error -- invalid value */
3353                 DZap(tdc);
3354             }
3355         }
3356         ReleaseWriteLock(&tdc->lock);
3357         afs_PutDCache(tdc);     /* drop ref count */
3358     }
3359     avc->f.states &= ~CUnique;  /* For the dfs xlator */
3360     ReleaseWriteLock(&avc->lock);
3361     code = 0;
3362   out:
3363     if (sysState.allocked)
3364         osi_FreeLargeSpace(bufp);
3365     return code;
3366 }
3367
3368 /*!
3369  * VIOC_GETCELLSTATUS (35) - Get cell status info
3370  *
3371  * \ingroup pioctl
3372  *
3373  * \param[in] ain       The cell you want status information on
3374  * \param[out] aout     cell state (as a struct)
3375  *
3376  * \retval EIO          Error if the afs daemon hasn't started yet
3377  * \retval ENOENT       Error if the cell doesn't exist
3378  *
3379  * \post Returns the state of the cell as defined in a struct cell
3380  */
3381 DECL_PIOCTL(PGetCellStatus)
3382 {
3383     struct cell *tcell;
3384     char *cellName;
3385     afs_int32 temp;
3386
3387     AFS_STATCNT(PGetCellStatus);
3388     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3389         return EIO;             /* Inappropriate ioctl for device */
3390
3391     if (afs_pd_getStringPtr(ain, &cellName) != 0)
3392         return EINVAL;
3393
3394     tcell = afs_GetCellByName(cellName, READ_LOCK);
3395     if (!tcell)
3396         return ENOENT;
3397     temp = tcell->states;
3398     afs_PutCell(tcell, READ_LOCK);
3399
3400     return afs_pd_putInt(aout, temp);
3401 }
3402
3403 /*!
3404  * VIOC_SETCELLSTATUS (36) - Set corresponding info
3405  *
3406  * \ingroup pioctl
3407  *
3408  * \param[in] ain
3409  *      The cell you want to set information about, and the values you
3410  *      want to set
3411  * \param[out] aout
3412  *      not in use
3413  *
3414  * \retval EIO          Error if the afs daemon hasn't started yet
3415  * \retval EACCES       Error if the user doesn't have super-user credentials
3416  *
3417  * \post
3418  *      Set the state of the cell in a defined struct cell, based on
3419  *      whether or not SetUID is allowed
3420  */
3421 DECL_PIOCTL(PSetCellStatus)
3422 {
3423     struct cell *tcell;
3424     char *cellName;
3425     afs_int32 flags0, flags1;
3426
3427     if (!afs_osi_suser(*acred))
3428         return EACCES;
3429     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3430         return EIO;             /* Inappropriate ioctl for device */
3431
3432     if (afs_pd_getInt(ain, &flags0) != 0)
3433         return EINVAL;
3434     if (afs_pd_getInt(ain, &flags1) != 0)
3435         return EINVAL;
3436     if (afs_pd_getStringPtr(ain, &cellName) != 0)
3437         return EINVAL;
3438
3439     tcell = afs_GetCellByName(cellName, WRITE_LOCK);
3440     if (!tcell)
3441         return ENOENT;
3442     if (flags0 & CNoSUID)
3443         tcell->states |= CNoSUID;
3444     else
3445         tcell->states &= ~CNoSUID;
3446     afs_PutCell(tcell, WRITE_LOCK);
3447     return 0;
3448 }
3449
3450 static int
3451 FlushVolumeData(struct VenusFid *afid, afs_ucred_t * acred)
3452 {
3453     afs_int32 i;
3454     struct dcache *tdc;
3455     struct vcache *tvc;
3456     struct volume *tv;
3457     afs_int32 all = 0;
3458     afs_int32 cell = 0;
3459     afs_int32 volume = 0;
3460     struct afs_q *tq, *uq;
3461     int code = 0;
3462 #ifdef AFS_DARWIN80_ENV
3463     vnode_t vp;
3464 #endif
3465
3466     if (!afid) {
3467         all = 1;
3468     } else {
3469         volume = afid->Fid.Volume;      /* who to zap */
3470         cell = afid->Cell;
3471     }
3472
3473     /*
3474      * Clear stat'd flag from all vnodes from this volume; this will
3475      * invalidate all the vcaches associated with the volume.
3476      */
3477  loop:
3478     ObtainReadLock(&afs_xvcache);
3479     for (i = (afid ? VCHashV(afid) : 0); i < VCSIZE; i = (afid ? VCSIZE : i+1)) {
3480         for (tq = afs_vhashTV[i].prev; tq != &afs_vhashTV[i]; tq = uq) {
3481             uq = QPrev(tq);
3482             tvc = QTOVH(tq);
3483             if (all || (tvc->f.fid.Fid.Volume == volume && tvc->f.fid.Cell == cell)) {
3484                 if (tvc->f.states & CVInit) {
3485                     ReleaseReadLock(&afs_xvcache);
3486                     afs_osi_Sleep(&tvc->f.states);
3487                     goto loop;
3488                 }
3489 #ifdef AFS_DARWIN80_ENV
3490                 if (tvc->f.states & CDeadVnode) {
3491                     ReleaseReadLock(&afs_xvcache);
3492                     afs_osi_Sleep(&tvc->f.states);
3493                     goto loop;
3494                 }
3495                 vp = AFSTOV(tvc);
3496                 if (vnode_get(vp))
3497                     continue;
3498                 if (vnode_ref(vp)) {
3499                     AFS_GUNLOCK();
3500                     vnode_put(vp);
3501                     AFS_GLOCK();
3502                     continue;
3503                 }
3504 #else
3505                 AFS_FAST_HOLD(tvc);
3506 #endif
3507                 ReleaseReadLock(&afs_xvcache);
3508                 ObtainWriteLock(&tvc->lock, 232);
3509                 afs_ResetVCache(tvc, acred, 1);
3510                 ReleaseWriteLock(&tvc->lock);
3511 #ifdef AFS_DARWIN80_ENV
3512                 vnode_put(AFSTOV(tvc));
3513 #endif
3514                 ObtainReadLock(&afs_xvcache);
3515                 uq = QPrev(tq);
3516                 /* our tvc ptr is still good until now */
3517                 AFS_FAST_RELE(tvc);
3518             }
3519         }
3520     }
3521     ReleaseReadLock(&afs_xvcache);
3522
3523
3524     ObtainWriteLock(&afs_xdcache, 328); /* needed to flush any stuff */
3525     for (i = 0; i < afs_cacheFiles; i++) {
3526         if (!(afs_indexFlags[i] & IFEverUsed))
3527             continue;           /* never had any data */
3528         tdc = afs_GetValidDSlot(i);
3529         if (!tdc) {
3530             code = EIO;
3531             break;
3532         }
3533         if (tdc->refCount <= 1) {    /* too high, in use by running sys call */
3534             ReleaseReadLock(&tdc->tlock);
3535             if (all || (tdc->f.fid.Fid.Volume == volume && tdc->f.fid.Cell == cell)) {
3536                 if (!(afs_indexFlags[i] & (IFDataMod | IFFree | IFDiscarded))) {
3537                     /* if the file is modified, but has a ref cnt of only 1,
3538                      * then someone probably has the file open and is writing
3539                      * into it. Better to skip flushing such a file, it will be
3540                      * brought back immediately on the next write anyway.
3541                      *
3542                      * Skip if already freed.
3543                      *
3544                      * If we *must* flush, then this code has to be rearranged
3545                      * to call afs_storeAllSegments() first */
3546                     afs_FlushDCache(tdc);
3547                 }
3548             }
3549         } else {
3550             ReleaseReadLock(&tdc->tlock);
3551         }
3552         afs_PutDCache(tdc);     /* bumped by getdslot */
3553     }
3554     ReleaseWriteLock(&afs_xdcache);
3555
3556     ObtainReadLock(&afs_xvolume);
3557     for (i = all ? 0 : VHash(volume); i < NVOLS; i++) {
3558         for (tv = afs_volumes[i]; tv; tv = tv->next) {
3559             if (all || tv->volume == volume) {
3560                 afs_ResetVolumeInfo(tv);
3561                 if (!all)
3562                     goto last;
3563             }
3564         }
3565     }
3566  last:
3567     ReleaseReadLock(&afs_xvolume);
3568
3569     /* probably, a user is doing this, probably, because things are screwed up.
3570      * maybe it's the dnlc's fault? */
3571     osi_dnlc_purge();
3572     return code;
3573 }
3574
3575 /*!
3576  * VIOC_FLUSHVOLUME (37) - Flush whole volume's data
3577  *
3578  * \ingroup pioctl
3579  *
3580  * \param[in] ain       not in use (args in avc)
3581  * \param[out] aout     not in use
3582  *
3583  * \retval EINVAL       Error if some of the standard args aren't set
3584  * \retval EIO          Error if the afs daemon hasn't started yet
3585  *
3586  * \post
3587  *      Flush all cached contents of a volume.  Exactly what stays and what
3588  *      goes depends on the platform.
3589  *
3590  * \notes
3591  *      Does not flush a file that a user has open and is using, because
3592  *      it will be re-created on next write.  Also purges the dnlc,
3593  *      because things are screwed up.
3594  */
3595 DECL_PIOCTL(PFlushVolumeData)
3596 {
3597     AFS_STATCNT(PFlushVolumeData);
3598     if (!avc)
3599         return EINVAL;
3600     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3601         return EIO;             /* Inappropriate ioctl for device */
3602
3603     return FlushVolumeData(&avc->f.fid, *acred);
3604 }
3605
3606 /*!
3607  * VIOC_FLUSHALL (14) - Flush whole volume's data for all volumes
3608  *
3609  * \ingroup pioctl
3610  *
3611  * \param[in] ain       not in use
3612  * \param[out] aout     not in use
3613  *
3614  * \retval EINVAL       Error if some of the standard args aren't set
3615  * \retval EIO          Error if the afs daemon hasn't started yet
3616  *
3617  * \post
3618  *      Flush all cached contents.  Exactly what stays and what
3619  *      goes depends on the platform.
3620  *
3621  * \notes
3622  *      Does not flush a file that a user has open and is using, because
3623  *      it will be re-created on next write.  Also purges the dnlc,
3624  *      because things are screwed up.
3625  */
3626 DECL_PIOCTL(PFlushAllVolumeData)
3627 {
3628     AFS_STATCNT(PFlushAllVolumeData);
3629
3630     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
3631         return EIO;             /* Inappropriate ioctl for device */
3632
3633     return FlushVolumeData(NULL, *acred);
3634 }
3635
3636 /*!
3637  * VIOCGETVCXSTATUS (41) - gets vnode x status
3638  *
3639  * \ingroup pioctl
3640  *
3641  * \param[in] ain
3642  *      not in use (avc used)
3643  * \param[out] aout
3644  *      vcxstat: the file id, the data version, any lock, the parent vnode,
3645  *      the parent unique id, the trunc position, the callback, cbExpires,
3646  *      what access is being made, what files are open,
3647  *      any users executing/writing, the flock count, the states,
3648  *      the move stat
3649  *
3650  * \retval EINVAL
3651  *      Error if some of the initial default arguments aren't set
3652  * \retval EACCES
3653  *      Error if access to check the mode bits is denied
3654  *
3655  * \post
3656  *      gets stats for the vnode, a struct listed in vcxstat
3657  */
3658 DECL_PIOCTL(PGetVnodeXStatus)
3659 {
3660     afs_int32 code;
3661     struct vcxstat stat;
3662     afs_int32 mode, i;
3663
3664 /*  AFS_STATCNT(PGetVnodeXStatus); */
3665     if (!avc)
3666         return EINVAL;
3667     code = afs_VerifyVCache(avc, areq);
3668     if (code)
3669         return code;
3670     if (vType(avc) == VDIR)
3671         mode = PRSFS_LOOKUP;
3672     else
3673         mode = PRSFS_READ;
3674     if (!afs_AccessOK(avc, mode, areq, CHECK_MODE_BITS))
3675         return EACCES;
3676
3677     memset(&stat, 0, sizeof(struct vcxstat));
3678     stat.fid = avc->f.fid;
3679     hset32(stat.DataVersion, hgetlo(avc->f.m.DataVersion));
3680     stat.lock = avc->lock;
3681     stat.parentVnode = avc->f.parent.vnode;
3682     stat.parentUnique = avc->f.parent.unique;
3683     hset(stat.flushDV, avc->flushDV);
3684     hset(stat.mapDV, avc->mapDV);
3685     stat.truncPos = avc->f.truncPos;
3686     {                   /* just grab the first two - won't break anything... */
3687         struct axscache *ac;
3688
3689         for (i = 0, ac = avc->Access; ac && i < CPSIZE; i++, ac = ac->next) {
3690             stat.randomUid[i] = ac->uid;
3691             stat.randomAccess[i] = ac->axess;
3692         }
3693     }
3694     stat.callback = afs_data_pointer_to_int32(avc->callback);
3695     stat.cbExpires = avc->cbExpires;
3696     stat.anyAccess = avc->f.anyAccess;
3697     stat.opens = avc->opens;
3698     stat.execsOrWriters = avc->execsOrWriters;
3699     stat.flockCount = avc->flockCount;
3700     stat.mvstat = avc->mvstat;
3701     stat.states = avc->f.states;
3702     return afs_pd_putBytes(aout, &stat, sizeof(struct vcxstat));
3703 }
3704
3705
3706 DECL_PIOCTL(PGetVnodeXStatus2)
3707 {
3708     afs_int32 code;
3709     struct vcxstat2 stat;
3710     afs_int32 mode;
3711
3712     if (!avc)
3713         return EINVAL;
3714     code = afs_VerifyVCache(avc, areq);
3715     if (code)
3716         return code;
3717     if (vType(avc) == VDIR)
3718         mode = PRSFS_LOOKUP;
3719     else
3720         mode = PRSFS_READ;
3721     if (!afs_AccessOK(avc, mode, areq, CHECK_MODE_BITS))
3722         return EACCES;
3723
3724     memset(&stat, 0, sizeof(struct vcxstat2));
3725
3726     stat.cbExpires = avc->cbExpires;
3727     stat.anyAccess = avc->f.anyAccess;
3728     stat.mvstat = avc->mvstat;
3729     stat.callerAccess = afs_GetAccessBits(avc, ~0, areq);
3730
3731     return afs_pd_putBytes(aout, &stat, sizeof(struct vcxstat2));
3732 }
3733
3734
3735 /*!
3736  * VIOC_AFS_SYSNAME (38) - Change @sys value
3737  *
3738  * \ingroup pioctl
3739  *
3740  * \param[in] ain       new value for @sys
3741  * \param[out] aout     count, entry, list (debug values?)
3742  *
3743  * \retval EINVAL
3744  *      Error if afsd isn't running, the new sysname is too large,
3745  *      the new sysname causes issues (starts with a . or ..),
3746  *      there is no PAG set in the credentials, or the user of a PAG
3747  *      can't be found
3748  * \retval EACCES
3749  *      Error if the user doesn't have super-user credentials
3750  *
3751  * \post
3752  *      Set the value of @sys if these things work: if the input isn't
3753  *      too long or if input doesn't start with . or ..
3754  *
3755  * \notes
3756  *      We require root for local sysname changes, but not for remote
3757  *      (since we don't really believe remote uids anyway)
3758  *      outname[] shouldn't really be needed- this is left as an
3759  *      exercise for the reader.
3760  */
3761 DECL_PIOCTL(PSetSysName)
3762 {
3763     char *inname = NULL;
3764     char outname[MAXSYSNAME];
3765     afs_int32 setsysname;
3766     int foundname = 0;
3767     struct afs_exporter *exporter;
3768     struct unixuser *au;
3769     afs_int32 pag, error;
3770     int t, count, num = 0, allpags = 0;
3771     char **sysnamelist;
3772     struct afs_pdata validate;
3773
3774     AFS_STATCNT(PSetSysName);
3775     if (!afs_globalVFS) {
3776         /* Afsd is NOT running; disable it */
3777 #if defined(KERNEL_HAVE_UERROR)
3778         return (setuerror(EINVAL), EINVAL);
3779 #else
3780         return (EINVAL);
3781 #endif
3782     }
3783     if (afs_pd_getInt(ain, &setsysname) != 0)
3784         return EINVAL;
3785     if (setsysname & 0x8000) {
3786         allpags = 1;
3787         setsysname &= ~0x8000;
3788     }
3789     if (setsysname) {
3790
3791         /* Check my args */
3792         if (setsysname < 0 || setsysname > MAXNUMSYSNAMES)
3793             return EINVAL;
3794         validate = *ain;
3795         for (count = 0; count < setsysname; count++) {
3796             if (afs_pd_getStringPtr(&validate, &inname) != 0)
3797                 return EINVAL;
3798             t = strlen(inname);
3799             if (t >= MAXSYSNAME || t <= 0)
3800                 return EINVAL;
3801             /* check for names that can shoot us in the foot */
3802             if (inname[0] == '.' && (inname[1] == 0
3803                 || (inname[1] == '.' && inname[2] == 0)))
3804                 return EINVAL;
3805         }
3806         /* args ok, so go back to the beginning of that section */
3807
3808         if (afs_pd_getStringPtr(ain, &inname) != 0)
3809             return EINVAL;
3810         num = count;
3811     }
3812     if (afs_rmtsys_enable && (afs_cr_gid(*acred) == RMTUSER_REQ ||
3813         afs_cr_gid(*acred) == RMTUSER_REQ_PRIV)) {   /* Handles all exporters */
3814         if (allpags && afs_cr_gid(*acred) != RMTUSER_REQ_PRIV) {
3815             return EPERM;
3816         }
3817         pag = PagInCred(*acred);
3818         if (pag == NOPAG) {
3819             return EINVAL;      /* Better than panicing */
3820         }
3821         if (!(au = afs_FindUser(pag, -1, READ_LOCK))) {
3822             return EINVAL;      /* Better than panicing */
3823         }
3824         if (!(exporter = au->exporter)) {
3825             afs_PutUser(au, READ_LOCK);
3826             return EINVAL;      /* Better than panicing */
3827         }
3828         error = EXP_SYSNAME(exporter, inname, &sysnamelist,
3829                             &num, allpags);
3830         if (error) {
3831             if (error == ENODEV)
3832                 foundname = 0;  /* sysname not set yet! */
3833             else {
3834                 afs_PutUser(au, READ_LOCK);
3835                 return error;
3836             }
3837         } else {
3838             foundname = num;
3839             strcpy(outname, sysnamelist[0]);
3840         }
3841         afs_PutUser(au, READ_LOCK);
3842         if (setsysname)
3843             afs_sysnamegen++;
3844     } else {
3845         /* Not xlating, so local case */
3846         if (!afs_sysname)
3847             osi_Panic("PSetSysName: !afs_sysname\n");
3848         if (!setsysname) {      /* user just wants the info */
3849             strcpy(outname, afs_sysname);
3850             foundname = afs_sysnamecount;
3851             sysnamelist = afs_sysnamelist;
3852         } else {                /* Local guy; only root can change sysname */
3853             if (!afs_osi_suser(*acred))
3854                 return EACCES;
3855
3856             /* allpags makes no sense for local use */
3857             if (allpags)
3858                 return EINVAL;
3859
3860             /* clear @sys entries from the dnlc, once afs_lookup can
3861              * do lookups of @sys entries and thinks it can trust them */
3862             /* privs ok, store the entry, ... */
3863
3864             if (strlen(inname) >= MAXSYSNAME-1)
3865                 return EINVAL;
3866             strcpy(afs_sysname, inname);
3867
3868             if (setsysname > 1) {       /* ... or list */
3869                 for (count = 1; count < setsysname; ++count) {
3870                     if (!afs_sysnamelist[count])
3871                         osi_Panic
3872                            ("PSetSysName: no afs_sysnamelist entry to write\n");
3873                     if (afs_pd_getString(ain, afs_sysnamelist[count],
3874                                          MAXSYSNAME) != 0)
3875                         return EINVAL;
3876                 }
3877             }
3878             afs_sysnamecount = setsysname;
3879             afs_sysnamegen++;
3880         }
3881     }
3882     if (!setsysname) {
3883         if (afs_pd_putInt(aout, foundname) != 0)
3884             return E2BIG;
3885         if (foundname) {
3886             if (afs_pd_putString(aout, outname) != 0)
3887                 return E2BIG;
3888             for (count = 1; count < foundname; ++count) {    /* ... or list. */
3889                 if (!sysnamelist[count])
3890                     osi_Panic
3891                         ("PSetSysName: no afs_sysnamelist entry to read\n");
3892                 t = strlen(sysnamelist[count]);
3893                 if (t >= MAXSYSNAME)
3894                     osi_Panic("PSetSysName: sysname entry garbled\n");
3895                 if (afs_pd_putString(aout, sysnamelist[count]) != 0)
3896                     return E2BIG;
3897             }
3898         }
3899     }
3900     return 0;
3901 }
3902
3903 /* sequential search through the list of touched cells is not a good
3904  * long-term solution here. For small n, though, it should be just
3905  * fine.  Should consider special-casing the local cell for large n.
3906  * Likewise for PSetSPrefs.
3907  *
3908  * s - number of ids in array l[] -- NOT index of last id
3909  * l - array of cell ids which have volumes that need to be sorted
3910  * vlonly - sort vl servers or file servers?
3911  */
3912 static void *
3913 ReSortCells_cb(struct cell *cell, void *arg)
3914 {
3915     afs_int32 *p = (afs_int32 *) arg;
3916     afs_int32 *l = p + 1;
3917     int i, s = p[0];
3918
3919     for (i = 0; i < s; i++) {
3920         if (l[i] == cell->cellNum) {
3921             ObtainWriteLock(&cell->lock, 690);
3922             afs_SortServers(cell->cellHosts, AFS_MAXCELLHOSTS);
3923             ReleaseWriteLock(&cell->lock);
3924         }
3925     }
3926
3927     return NULL;
3928 }
3929
3930 static void
3931 ReSortCells(int s, afs_int32 * l, int vlonly)
3932 {
3933     int i;
3934     struct volume *j;
3935     int k;
3936
3937     if (vlonly) {
3938         afs_int32 *p;
3939         p = afs_osi_Alloc(sizeof(afs_int32) * (s + 1));
3940         osi_Assert(p != NULL);
3941         p[0] = s;
3942         memcpy(p + 1, l, s * sizeof(afs_int32));
3943         afs_TraverseCells(&ReSortCells_cb, p);
3944         afs_osi_Free(p, sizeof(afs_int32) * (s + 1));
3945         return;
3946     }
3947
3948     ObtainReadLock(&afs_xvolume);
3949     for (i = 0; i < NVOLS; i++) {
3950         for (j = afs_volumes[i]; j; j = j->next) {
3951             for (k = 0; k < s; k++)
3952                 if (j->cell == l[k]) {
3953                     ObtainWriteLock(&j->lock, 233);
3954                     afs_SortServers(j->serverHost, AFS_MAXHOSTS);
3955                     ReleaseWriteLock(&j->lock);
3956                     break;
3957                 }
3958         }
3959     }
3960     ReleaseReadLock(&afs_xvolume);
3961 }
3962
3963
3964 static int debugsetsp = 0;
3965 static int
3966 afs_setsprefs(struct spref *sp, unsigned int num, unsigned int vlonly)
3967 {
3968     struct srvAddr *sa;
3969     int i, j, k, matches, touchedSize;
3970     struct server *srvr = NULL;
3971     afs_int32 touched[34];
3972     int isfs;
3973
3974     touchedSize = 0;
3975     for (k = 0; k < num; sp++, k++) {
3976         if (debugsetsp) {
3977             afs_warn("sp host=%x, rank=%d\n", sp->host.s_addr, sp->rank);
3978         }
3979         matches = 0;
3980         ObtainReadLock(&afs_xserver);
3981
3982         i = SHash(sp->host.s_addr);
3983         for (sa = afs_srvAddrs[i]; sa; sa = sa->next_bkt) {
3984             if (sa->sa_ip == sp->host.s_addr) {
3985                 srvr = sa->server;
3986                 isfs = (srvr->cell && (sa->sa_portal == srvr->cell->fsport))
3987                     || (sa->sa_portal == AFS_FSPORT);
3988                 if ((!vlonly && isfs) || (vlonly && !isfs)) {
3989                     matches++;
3990                     break;
3991                 }
3992             }
3993         }
3994
3995         if (sa && matches) {    /* found one! */
3996             if (debugsetsp) {
3997                 afs_warn("sa ip=%x, ip_rank=%d\n", sa->sa_ip, sa->sa_iprank);
3998             }
3999             sa->sa_iprank = sp->rank + afs_randomMod15();
4000             afs_SortOneServer(sa->server);
4001
4002             if (srvr->cell) {
4003                 /* if we don't know yet what cell it's in, this is moot */
4004                 for (j = touchedSize - 1;
4005                      j >= 0 && touched[j] != srvr->cell->cellNum; j--)
4006                     /* is it in our list of touched cells ?  */ ;
4007                 if (j < 0) {    /* no, it's not */
4008                     touched[touchedSize++] = srvr->cell->cellNum;
4009                     if (touchedSize >= 32) {    /* watch for ovrflow */
4010                         ReleaseReadLock(&afs_xserver);
4011                         ReSortCells(touchedSize, touched, vlonly);
4012                         touchedSize = 0;
4013                         ObtainReadLock(&afs_xserver);
4014                     }
4015                 }
4016             }
4017         }
4018
4019         ReleaseReadLock(&afs_xserver);
4020         /* if we didn't find one, start to create one. */
4021         /* Note that it doesn't have a cell yet...     */
4022         if (!matches) {
4023             afs_uint32 temp = sp->host.s_addr;
4024             srvr =
4025                 afs_GetServer(&temp, 1, 0, (vlonly ? AFS_VLPORT : AFS_FSPORT),
4026                               WRITE_LOCK, (afsUUID *) 0, 0, NULL);
4027             srvr->addr->sa_iprank = sp->rank + afs_randomMod15();
4028             afs_PutServer(srvr, WRITE_LOCK);
4029         }
4030     }                           /* for all cited preferences */
4031
4032     ReSortCells(touchedSize, touched, vlonly);
4033     return 0;
4034 }
4035
4036 /*!
4037  * VIOC_SETPREFS (46) - Set server ranks
4038  *
4039  * \param[in] ain       the sprefs value you want the sprefs to be set to
4040  * \param[out] aout     not in use
4041  *
4042  * \retval EIO
4043  *      Error if the afs daemon hasn't started yet
4044  * \retval EACCES
4045  *      Error if the user doesn't have super-user credentials
4046  * \retval EINVAL
4047  *      Error if the struct setsprefs is too large or if it multiplied
4048  *      by the number of servers is too large
4049  *
4050  * \post set the sprefs using the afs_setsprefs() function
4051  */
4052 DECL_PIOCTL(PSetSPrefs)
4053 {
4054     struct setspref *ssp;
4055     char *ainPtr;
4056     size_t ainSize;
4057
4058     AFS_STATCNT(PSetSPrefs);
4059
4060     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
4061         return EIO;             /* Inappropriate ioctl for device */
4062
4063     if (!afs_osi_suser(*acred))
4064         return EACCES;
4065
4066     /* The I/O handling here is ghastly, as it relies on overrunning the ends
4067      * of arrays. But, i'm not quite brave enough to change it yet. */
4068     ainPtr = ain->ptr;
4069     ainSize = ain->remaining;
4070
4071     if (ainSize < sizeof(struct setspref))
4072         return EINVAL;
4073
4074     ssp = (struct setspref *)ainPtr;
4075     if (ainSize < (sizeof(struct setspref)
4076                    + sizeof(struct spref) * (ssp->num_servers-1)))
4077         return EINVAL;
4078
4079     afs_setsprefs(&(ssp->servers[0]), ssp->num_servers,
4080                   (ssp->flags & DBservers));
4081     return 0;
4082 }
4083
4084 /*
4085  * VIOC_SETPREFS33 (42) - Set server ranks (deprecated)
4086  *
4087  * \param[in] ain       the server preferences to be set
4088  * \param[out] aout     not in use
4089  *
4090  * \retval EIO          Error if the afs daemon hasn't started yet
4091  * \retval EACCES       Error if the user doesn't have super-user credentials
4092  *
4093  * \post set the server preferences, calling a function
4094  *
4095  * \notes this may only be performed by the local root user.
4096  */
4097 DECL_PIOCTL(PSetSPrefs33)
4098 {
4099     AFS_STATCNT(PSetSPrefs);
4100     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
4101         return EIO;             /* Inappropriate ioctl for device */
4102
4103
4104     if (!afs_osi_suser(*acred))
4105         return EACCES;
4106
4107     afs_setsprefs((struct spref *)afs_pd_where(ain),
4108                   afs_pd_remaining(ain) / sizeof(struct spref),
4109                   0 /*!vlonly */ );
4110     return 0;
4111 }
4112
4113 /*
4114  * VIOC_GETSPREFS (43) - Get server ranks
4115  *
4116  * \ingroup pioctl
4117  *
4118  * \param[in] ain       the server preferences to get
4119  * \param[out] aout     the server preferences information
4120  *
4121  * \retval EIO          Error if the afs daemon hasn't started yet
4122  * \retval ENOENT       Error if the sprefrequest is too large
4123  *
4124  * \post Get the sprefs
4125  *
4126  * \notes
4127  *      in the hash table of server structs, all servers with the same
4128  *      IP address; will be on the same overflow chain; This could be
4129  *      sped slightly in some circumstances by having it cache the
4130  *      immediately previous slot in the hash table and some
4131  *      supporting information; Only reports file servers now.
4132  */
4133 DECL_PIOCTL(PGetSPrefs)
4134 {
4135     struct sprefrequest spin;   /* input */
4136     struct sprefinfo *spout;    /* output */
4137     struct spref *srvout;       /* one output component */
4138     int i, j;                   /* counters for hash table traversal */
4139     struct server *srvr;        /* one of CM's server structs */
4140     struct srvAddr *sa;
4141     int vlonly;                 /* just return vlservers ? */
4142     int isfs;
4143
4144     AFS_STATCNT(PGetSPrefs);
4145     if (!afs_resourceinit_flag) /* afs daemons haven't started yet */
4146         return EIO;             /* Inappropriate ioctl for device */
4147
4148     /* Work out from the size whether we've got a new, or old, style pioctl */
4149     if (afs_pd_remaining(ain) < sizeof(struct sprefrequest)) {
4150         if (afs_pd_getBytes(ain, &spin, sizeof(struct sprefrequest_33)) != 0)
4151            return ENOENT;
4152         vlonly = 0;
4153         spin.flags = 0;
4154     } else {
4155         if (afs_pd_getBytes(ain, &spin, sizeof(struct sprefrequest)) != 0)
4156            return EINVAL;
4157         vlonly = (spin.flags & DBservers);
4158     }
4159
4160     /* This code relies on overflowing arrays. It's ghastly, but I'm not
4161      * quite brave enough to tackle it yet ...
4162      */
4163
4164     /* struct sprefinfo includes 1 server struct...  that size gets added
4165      * in during the loop that follows.
4166      */
4167     spout = afs_pd_inline(aout,
4168                           sizeof(struct sprefinfo) - sizeof(struct spref));
4169     spout->next_offset = spin.offset;
4170     spout->num_servers = 0;
4171     srvout = spout->servers;
4172
4173     ObtainReadLock(&afs_xserver);
4174     for (i = 0, j = 0; j < NSERVERS; j++) {     /* sift through hash table */
4175         for (sa = afs_srvAddrs[j]; sa; sa = sa->next_bkt, i++) {
4176             if (spin.offset > (unsigned short)i) {
4177                 continue;       /* catch up to where we left off */
4178             }
4179             spout->next_offset++;
4180
4181             srvr = sa->server;
4182             isfs = (srvr->cell && (sa->sa_portal == srvr->cell->fsport))
4183                 || (sa->sa_portal == AFS_FSPORT);
4184
4185             if ((vlonly && isfs) || (!vlonly && !isfs)) {
4186                 /* only report ranks for vl servers */
4187                 continue;
4188             }
4189
4190             /* Check we've actually got the space we're about to use */
4191             if (afs_pd_inline(aout, sizeof(struct spref)) == NULL) {
4192                 ReleaseReadLock(&afs_xserver);  /* no more room! */
4193                 return 0;
4194             }
4195
4196             srvout->host.s_addr = sa->sa_ip;
4197             srvout->rank = sa->sa_iprank;
4198             spout->num_servers++;
4199             srvout++;
4200         }
4201     }
4202     ReleaseReadLock(&afs_xserver);
4203
4204     spout->next_offset = 0;     /* start over from the beginning next time */
4205
4206     return 0;
4207 }
4208
4209 /* Enable/Disable the specified exporter. Must be root to disable an exporter */
4210 int afs_NFSRootOnly = 1;
4211 /*!
4212  * VIOC_EXPORTAFS (39) - Export afs to nfs clients
4213  *
4214  * \ingroup pioctl
4215  *
4216  * \param[in] ain
4217  *      an integer containing the desired exportee flags
4218  * \param[out] aout
4219  *      an integer containing the current exporter flags
4220  *
4221  * \retval ENODEV       Error if the exporter doesn't exist
4222  * \retval EACCES       Error if the user doesn't have super-user credentials
4223  *
4224  * \post
4225  *      Changes the state of various values to reflect the change
4226  *      of the export values between nfs and afs.
4227  *
4228  * \notes Legacy code obtained from IBM.
4229  */
4230 DECL_PIOCTL(PExportAfs)
4231 {
4232     afs_int32 export, newint = 0;
4233     afs_int32 type, changestate, handleValue, convmode, pwsync, smounts;
4234     afs_int32 rempags = 0, pagcb = 0;
4235     struct afs_exporter *exporter;
4236
4237     AFS_STATCNT(PExportAfs);
4238     if (afs_pd_getInt(ain, &handleValue) != 0)
4239         return EINVAL;
4240     type = handleValue >> 24;
4241     if (type == 0x71) {
4242         newint = 1;
4243         type = 1;               /* nfs */
4244     }
4245     exporter = exporter_find(type);
4246     if (newint) {
4247         export = handleValue & 3;
4248         changestate = handleValue & 0xfff;
4249         smounts = (handleValue >> 2) & 3;
4250         pwsync = (handleValue >> 4) & 3;
4251         convmode = (handleValue >> 6) & 3;
4252         rempags = (handleValue >> 8) & 3;
4253         pagcb = (handleValue >> 10) & 3;
4254     } else {
4255         changestate = (handleValue >> 16) & 0x1;
4256         convmode = (handleValue >> 16) & 0x2;
4257         pwsync = (handleValue >> 16) & 0x4;
4258         smounts = (handleValue >> 16) & 0x8;
4259         export = handleValue & 0xff;
4260     }
4261     if (!exporter) {
4262         /*  Failed finding desired exporter; */
4263         return ENODEV;
4264     }
4265     if (!changestate) {
4266         handleValue = exporter->exp_states;
4267         if (afs_pd_putInt(aout, handleValue) != 0)
4268             return E2BIG;
4269     } else {
4270         if (!afs_osi_suser(*acred))
4271             return EACCES;      /* Only superuser can do this */
4272         if (newint) {
4273             if (export & 2) {
4274                 if (export & 1)
4275                     exporter->exp_states |= EXP_EXPORTED;
4276                 else
4277                     exporter->exp_states &= ~EXP_EXPORTED;
4278             }
4279             if (convmode & 2) {
4280                 if (convmode & 1)
4281                     exporter->exp_states |= EXP_UNIXMODE;
4282                 else
4283                     exporter->exp_states &= ~EXP_UNIXMODE;
4284             }
4285             if (pwsync & 2) {
4286                 if (pwsync & 1)
4287                     exporter->exp_states |= EXP_PWSYNC;
4288                 else
4289                     exporter->exp_states &= ~EXP_PWSYNC;
4290             }
4291             if (smounts & 2) {
4292                 if (smounts & 1) {
4293                     afs_NFSRootOnly = 0;
4294                     exporter->exp_states |= EXP_SUBMOUNTS;
4295                 } else {
4296                     afs_NFSRootOnly = 1;
4297                     exporter->exp_states &= ~EXP_SUBMOUNTS;
4298                 }
4299             }
4300             if (rempags & 2) {
4301                 if (rempags & 1)
4302                     exporter->exp_states |= EXP_CLIPAGS;
4303                 else
4304                     exporter->exp_states &= ~EXP_CLIPAGS;
4305             }
4306             if (pagcb & 2) {
4307                 if (pagcb & 1)
4308                     exporter->exp_states |= EXP_CALLBACK;
4309                 else
4310                     exporter->exp_states &= ~EXP_CALLBACK;
4311             }
4312             handleValue = exporter->exp_states;
4313             if (afs_pd_putInt(aout, handleValue) != 0)
4314                 return E2BIG;
4315         } else {
4316             if (export)
4317                 exporter->exp_states |= EXP_EXPORTED;
4318             else
4319                 exporter->exp_states &= ~EXP_EXPORTED;
4320             if (convmode)
4321                 exporter->exp_states |= EXP_UNIXMODE;
4322             else
4323                 exporter->exp_states &= ~EXP_UNIXMODE;
4324             if (pwsync)
4325                 exporter->exp_states |= EXP_PWSYNC;
4326             else
4327                 exporter->exp_states &= ~EXP_PWSYNC;
4328             if (smounts) {
4329                 afs_NFSRootOnly = 0;
4330                 exporter->exp_states |= EXP_SUBMOUNTS;
4331             } else {
4332                 afs_NFSRootOnly = 1;
4333                 exporter->exp_states &= ~EXP_SUBMOUNTS;
4334             }
4335         }
4336     }
4337
4338     return 0;
4339 }
4340
4341 /*!
4342  * VIOC_GAG (44) - Silence Cache Manager
4343  *
4344  * \ingroup pioctl
4345  *
4346  * \param[in] ain       the flags to either gag or de-gag the cache manager
4347  * \param[out] aout     not in use
4348  *
4349  * \retval EACCES       Error if the user doesn't have super-user credentials
4350  *
4351  * \post set the gag flags, then show these flags
4352  */
4353 DECL_PIOCTL(PGag)
4354 {
4355     struct gaginfo *gagflags;
4356
4357     if (!afs_osi_suser(*acred))
4358         return EACCES;
4359
4360     gagflags = afs_pd_inline(ain, sizeof(*gagflags));
4361     if (gagflags == NULL)
4362         return EINVAL;
4363     afs_showflags = gagflags->showflags;
4364
4365     return 0;
4366 }
4367
4368 /*!
4369  * VIOC_TWIDDLE (45) - Adjust RX knobs
4370  *
4371  * \ingroup pioctl
4372  *
4373  * \param[in] ain       the previous settings of the 'knobs'
4374  * \param[out] aout     not in use
4375  *
4376  * \retval EACCES       Error if the user doesn't have super-user credentials
4377  *
4378  * \post build out the struct rxp, from a struct rx
4379  */
4380 DECL_PIOCTL(PTwiddleRx)
4381 {
4382     struct rxparams *rxp;
4383
4384     if (!afs_osi_suser(*acred))
4385         return EACCES;
4386
4387     rxp = afs_pd_inline(ain, sizeof(*rxp));
4388     if (rxp == NULL)
4389         return EINVAL;
4390
4391     if (rxp->rx_initReceiveWindow)
4392         rx_initReceiveWindow = rxp->rx_initReceiveWindow;
4393     if (rxp->rx_maxReceiveWindow)
4394         rx_maxReceiveWindow = rxp->rx_maxReceiveWindow;
4395     if (rxp->rx_initSendWindow)
4396         rx_initSendWindow = rxp->rx_initSendWindow;
4397     if (rxp->rx_maxSendWindow)
4398         rx_maxSendWindow = rxp->rx_maxSendWindow;
4399     if (rxp->rxi_nSendFrags)
4400         rxi_nSendFrags = rxp->rxi_nSendFrags;
4401     if (rxp->rxi_nRecvFrags)
4402         rxi_nRecvFrags = rxp->rxi_nRecvFrags;
4403     if (rxp->rxi_OrphanFragSize)
4404         rxi_OrphanFragSize = rxp->rxi_OrphanFragSize;
4405     if (rxp->rx_maxReceiveSize) {
4406         rx_maxReceiveSize = rxp->rx_maxReceiveSize;
4407         rx_maxReceiveSizeUser = rxp->rx_maxReceiveSize;
4408     }
4409     if (rxp->rx_MyMaxSendSize)
4410         rx_MyMaxSendSize = rxp->rx_MyMaxSendSize;
4411
4412     return 0;
4413 }
4414
4415 /*!
4416  * VIOC_GETINITPARAMS (49) - Get initial cache manager parameters
4417  *
4418  * \ingroup pioctl
4419  *
4420  * \param[in] ain       not in use
4421  * \param[out] aout     initial cache manager params
4422  *
4423  * \retval E2BIG
4424  *      Error if the initial parameters are bigger than some PIGGYSIZE
4425  *
4426  * \post return the initial cache manager parameters
4427  */
4428 DECL_PIOCTL(PGetInitParams)
4429 {
4430     if (sizeof(struct cm_initparams) > PIGGYSIZE)
4431         return E2BIG;
4432
4433     return afs_pd_putBytes(aout, &cm_initParams,
4434                            sizeof(struct cm_initparams));
4435 }
4436
4437 #ifdef AFS_SGI65_ENV
4438 /* They took crget() from us, so fake it. */
4439 static cred_t *
4440 crget(void)
4441 {
4442     cred_t *cr;
4443     cr = crdup(get_current_cred());
4444     memset(cr, 0, sizeof(cred_t));
4445 #if CELL || CELL_PREPARE
4446     cr->cr_id = -1;
4447 #endif
4448     return cr;
4449 }
4450 #endif
4451
4452 /*!
4453  * VIOC_GETRXKCRYPT (55) - Get rxkad encryption flag
4454  *
4455  * \ingroup pioctl
4456  *
4457  * \param[in] ain       not in use
4458  * \param[out] aout     value of cryptall
4459  *
4460  * \post Turns on, or disables, rxkad encryption by setting the cryptall global
4461  */
4462 DECL_PIOCTL(PGetRxkcrypt)
4463 {
4464     return afs_pd_putInt(aout, cryptall);
4465 }
4466
4467 /*!
4468  * VIOC_SETRXKCRYPT (56) - Set rxkad encryption flag
4469  *
4470  * \ingroup pioctl
4471  *
4472  * \param[in] ain       the argument whether or not things should be encrypted
4473  * \param[out] aout     not in use
4474  *
4475  * \retval EPERM
4476  *      Error if the user doesn't have super-user credentials
4477  * \retval EINVAL
4478  *      Error if the input is too big, or if the input is outside the
4479  *      bounds of what it can be set to
4480  *
4481  * \post set whether or not things should be encrypted
4482  *