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