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