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