3 <li><a href="#PSetACL">PSetACL</a></li>
4 <li><a href="#PGetACL">PGetACL</a></li>
5 <li><a href="#PSetTokens">PSetTokens</a></li>
6 <li><a href="#PGetVolumeStatus">PGetVolumeStatus</a></li>
7 <li><a href="#PSetVolumeStatus">PSetVolumeStatus</a></li>
8 <li><a href="#PFlush">PFlush</a></li>
9 <li><a href="#PBogus PNoop">PBogus & PNoop</a></li>
10 <li><a href="#PGetTokens">PGetTokens</a></li>
11 <li><a href="#PUnlog">PUnlog</a></li>
12 <li><a href="#PCheckServers">PCheckServers</a></li>
13 <li><a href="#PCheckVolNames">PCheckVolNames</a></li>
14 <li><a href="#PCheckAuth">PCheckAuth</a></li>
15 <li><a href="#PFindVolume">PFindVolume</a></li>
16 <li><a href="#PViceAccess">PViceAccess</a></li>
17 <li><a href="#PGetFID">PGetFID</a></li>
18 <li><a href="#PSetCacheSize">PSetCacheSize</a></li>
19 <li><a href="#PRemoveCallback">PRemoveCallback</a></li>
20 <li><a href="#PNewCell">PNewCell</a></li>
21 <li><a href="#PListCells">PListCells</a></li>
22 <li><a href="#PRemoveMount">PRemoveMount</a></li>
23 <li><a href="#PNewStatMount">PNewStatMount</a></li>
24 <li><a href="#PGetFileCell">PGetFileCell</a></li>
25 <li><a href="#PGetWSCell">PGetWSCell</a></li>
26 <li><a href="#PMariner">PMariner</a></li>
27 <li><a href="#PGetUserCell">PGetUserCell</a></li>
28 <li><a href="#PVenusLogging">PVenusLogging</a></li>
29 <li><a href="#PGetCellStatus">PGetCellStatus</a></li>
30 <li><a href="#PSetCellStatus">PSetCellStatus</a></li>
31 <li><a href="#PFlushVolumeData">PFlushVolumeData</a></li>
32 <li><a href="#PSetSysName">PSetSysName</a></li>
33 <li><a href="#PExportAfs">PExportAfs</a></li>
34 <li><a href="#PGetCacheSize">PGetCacheSize</a></li>
35 <li><a href="#PGetVnodeXStatus">PGetVnodeXStatus</a></li>
36 <li><a href="#PSetSPrefs33">PSetSPrefs33</a></li>
37 <li><a href="#PGetSPrefs">PGetSPrefs</a></li>
38 <li><a href="#PGag">PGag</a></li>
39 <li><a href="#PTwiddleRx">PTwiddleRx</a></li>
40 <li><a href="#PSetSPrefs">PSetSPrefs</a></li>
41 <li><a href="#PStoreBehind">PStoreBehind</a></li>
42 <li><a href="#PGCPAGs">PGCPAGs</a></li>
43 <li><a href="#PGetInitParams">PGetInitParams</a></li>
44 <li><a href="#PGetCPrefs">PGetCPrefs</a></li>
45 <li><a href="#PSetCPrefs">PSetCPrefs</a></li>
46 <li><a href="#PFlushMount">PFlushMount</a></li>
47 <li><a href="#PRxStatProc">PRxStatProc</a></li>
48 <li><a href="#PRxStatPeer">PRxStatPeer</a></li>
49 <li><a href="#PGetRxkcrypt">PGetRxkcrypt</a></li>
50 <li><a href="#PSetRxkcrypt">PSetRxkcrypt</a></li>
51 <li><a href="#PSetClientContext">PSetClientContext</a></li>
55 ## <a name="PSetACL"></a> [[PSetACL]]
58 <dt><strong>Group</strong></dt>
60 <dt><strong>Function</strong></dt>
61 <dd> VIOCSETAL (1) - Set access control list </dd>
62 <dt><strong>Arguments</strong></dt>
63 <dd> the ACL being set </dd>
64 <dt><strong>Outcome</strong></dt>
65 <dd> Changed ACL, via direct writing to the wire </dd>
70 - EINVAL - if some of the standard arguments aren't set
73 <dt><strong>Side Effects</strong></dt>
74 <dd> none listed </dd>
77 ## <a name="PGetACL"></a> [[PGetACL]]
80 <dt><strong>Group</strong></dt>
82 <dt><strong>Function</strong></dt>
83 <dd> VIOCGETAL (2) - Get access control list </dd>
84 <dt><strong>Arguments</strong></dt>
86 <dt><strong>Outcome</strong></dt>
87 <dd> Obtain the ACL, based on file ID </dd>
92 - EINVAL - if some of the standard arguments aren't set
93 - ERANGE - if the vnode of the file id is too large
94 - return -1 - if getting the ACL failed
97 <dt><strong>Side Effects</strong></dt>
98 <dd> none listed, although there is a hack to tell which type of ACL is being returned, checks the top 2-bytes to judge what type of ACL is it, only for dfs xlator ACLs </dd>
101 ## <a name="PSetTokens"></a> [[PSetTokens]]
104 <dt><strong>Group</strong></dt>
106 <dt><strong>Function</strong></dt>
107 <dd> VIOCSETTOK (3) - Set authentication tokens </dd>
108 <dt><strong>Arguments</strong></dt>
109 <dd> the krb tickets from which to set the afs tokens </dd>
110 <dt><strong>Outcome</strong></dt>
111 <dd> Set the Tokens for a specific cell name, unless there is none set, then default to primary </dd>
116 - EINVAL - if the ticket is either too long or too short
117 - EIO - if the AFS initState is below 101
118 - ESRCH - if the cell for which the Token is being set can't be found
121 <dt><strong>Side Effects</strong></dt>
122 <dd> none listed </dd>
125 ## <a name="PGetVolumeStatus"></a> [[PGetVolumeStatus]]
128 <dt><strong>Group</strong></dt>
130 <dt><strong>Function</strong></dt>
131 <dd> VIOCGETVOLSTAT (4) - Get volume status </dd>
132 <dt><strong>Arguments</strong></dt>
134 <dt><strong>Outcome</strong></dt>
135 <dd> The staus of a volume(based on the FID of the volume), or an offline message/motd </dd>
140 - EINVAL: if some of the default arguments don't exist
143 <dt><strong>Side Effects</strong></dt>
144 <dd> none listed </dd>
147 ## <a name="PSetVolumeStatus"></a> [[PSetVolumeStatus]]
150 <dt><strong>Group</strong></dt>
152 <dt><strong>Function</strong></dt>
153 <dd> VIOCSETVOLSTAT (5) - Set volume status </dd>
154 <dt><strong>Arguments</strong></dt>
155 <dd> values to set the status at, offline message, message of the day, volume name, minimum quota, maximum quota </dd>
156 <dt><strong>Outcome</strong></dt>
157 <dd> Set the status of a volume, including any offline messages, a minimum quota, and a maximum quota </dd>
162 - EINVAL - if some of the default arguments don't exist
163 - EROFS - if the volume is read only, or a backup volume
164 - ENODEV - if the volume can't be accessed
165 - [[E2BIG]] - if the volume name, offline message, and motd are too big
168 <dt><strong>Side Effects</strong></dt>
169 <dd> none listed </dd>
172 ## <a name="PFlush"></a> PFlush
175 <dt><strong>Group</strong></dt>
177 <dt><strong>Function</strong></dt>
178 <dd> VIOCFLUSH (6) - Invalidate cache entry </dd>
179 <dt><strong>Arguments</strong></dt>
181 <dt><strong>Outcome</strong></dt>
182 <dd> Flush any information the cache manager has on an entry </dd>
187 - EINVAL - if some of the initial arguments don't exist
190 <dt><strong>Side Effects</strong></dt>
191 <dd> none listed </dd>
194 ## <a name="PBogus PNoop"></a> PBogus & PNoop
197 <dt><strong>Group</strong></dt>
199 <dt><strong>Function</strong></dt>
200 <dd> VIOCSTAT (7) - Get file status </dd>
206 <dt><strong>Group</strong></dt>
208 <dt><strong>Function</strong></dt>
209 <dd> VIOCGETTIME (13) - Make gettime call (historic) </dd>
215 <dt><strong>Group</strong></dt>
217 <dt><strong>Function</strong></dt>
218 <dd> VIOCPREFETCH (15) - Pre-fetch a file </dd>
224 <dt><strong>Group</strong></dt>
226 <dt><strong>Function</strong></dt>
227 <dd> VIOCNOP (16) - No-op (historic) </dd>
233 <dt><strong>Group</strong></dt>
235 <dt><strong>Function</strong></dt>
236 <dd> VIOCENGROUP (17) - Enable group access (historic) </dd>
242 <dt><strong>Group</strong></dt>
244 <dt><strong>Function</strong></dt>
245 <dd> VIOCDISGROUP (18) - Disable group access (historic) </dd>
251 <dt><strong>Group</strong></dt>
253 <dt><strong>Function</strong></dt>
254 <dd> VIOCLISTGROUPS (19) - List enabled and disabled groups (historic) </dd>
260 <dt><strong>Group</strong></dt>
262 <dt><strong>Function</strong></dt>
263 <dd> VIOC_FPRIOSTATUS (57) - arla: set file 'prio' </dd>
269 <dt><strong>Group</strong></dt>
271 <dt><strong>Function</strong></dt>
272 <dd> VIOC_FHGET (58) - arla: fallback getfh </dd>
278 <dt><strong>Group</strong></dt>
280 <dt><strong>Function</strong></dt>
281 <dd> VIOC_FHOPEN (59) - arla: fallback fhopen </dd>
287 <dt><strong>Group</strong></dt>
289 <dt><strong>Function</strong></dt>
290 <dd> VIOC_XFSDEBUG (60) - arla: controls xfsdebug </dd>
296 <dt><strong>Group</strong></dt>
298 <dt><strong>Function</strong></dt>
299 <dd> VIOC_ARLADEBUG (61) - arla: controls arla debug </dd>
305 <dt><strong>Group</strong></dt>
307 <dt><strong>Function</strong></dt>
308 <dd> VIOC_AVIATOR (62) - arla: debug interfac </dd>
314 <dt><strong>Group</strong></dt>
316 <dt><strong>Function</strong></dt>
317 <dd> VIOC_XFSDEBUG_PRINT (63) - arla: print xfs status </dd>
323 <dt><strong>Group</strong></dt>
325 <dt><strong>Function</strong></dt>
326 <dd> VIOC_CALCULATE_CACHE (64) - arla: force cache check </dd>
332 <dt><strong>Group</strong></dt>
334 <dt><strong>Function</strong></dt>
335 <dd> VIOC_BREAKCELLBACK (65) - arla: break callback </dd>
341 <dt><strong>Group</strong></dt>
343 <dt><strong>Function</strong></dt>
344 <dd> VIOCWAITFOREVER (23) - Wait for dead servers forever (historic) </dd>
347 ## <a name="PGetTokens"></a> [[PGetTokens]]
350 <dt><strong>Group</strong></dt>
352 <dt><strong>Function</strong></dt>
353 <dd> VIOCGETTOK (8) - Get authentication tokens </dd>
354 <dt><strong>Arguments</strong></dt>
355 <dd> An integer that corresponds to a user id, which in turn corresponds to a token </dd>
356 <dt><strong>Outcome</strong></dt>
357 <dd> If the the input parameter exists, get the token that corresponds to the parameter value, if there is no token at this value, get the token for the first cell </dd>
362 - EIO - if the afs daemon hasn't started yet
363 - EDOM - if the input parameter is out of the bounds of the available tokens
364 - ENOTCONN - if there aren't tokens for this cell
367 <dt><strong>Side Effects</strong></dt>
368 <dd> none listed, although it's a weird interface (from comments in code) </dd>
371 ## <a name="PUnlog"></a> PUnlog
374 <dt><strong>Group</strong></dt>
376 <dt><strong>Function</strong></dt>
377 <dd> VIOCUNLOG (9) - Invalidate tokens </dd>
378 <dt><strong>Arguments</strong></dt>
380 <dt><strong>Outcome</strong></dt>
381 <dd> remove tokens from a user, specified by a user id </dd>
386 - EIO - if the afs daemon hasn't started yet
389 <dt> $ <strong>Side Effects</strong></dt>
390 <dd> set's the token's time to 0, which then causes it to be removed </dd>
393 //////////////////////////////////////////
396 <dt><strong>Group</strong></dt>
398 <dt><strong>Function</strong></dt>
399 <dd> VIOCUNPAG (21) - Invalidate PAG </dd>
402 ///////////////////////////////////////// Unlog is the same as un-pag in [[OpenAFS]]
404 ## <a name="PCheckServers"></a> [[PCheckServers]]
407 <dt><strong>Group</strong></dt>
409 <dt><strong>Function</strong></dt>
410 <dd> VIOCCKSERV (10) - Check that servers are up </dd>
411 <dt><strong>Arguments</strong></dt>
412 <dd> The name of the cell that the servers will be a part of. </dd>
413 <dt><strong>Outcome</strong></dt>
414 <dd> Either a fast check (where it doesn't contact servers) or a local check (checks local cell only) </dd>
419 - EIO - if the afs daemon hasn't started yet
420 - EACCES - if the user doesn't have super-user credentials
421 - ENOENT - if we are unable to obtain the cell
424 <dt><strong>Side Effects</strong></dt>
425 <dd> none listed </dd>
428 ## <a name="PCheckVolNames"></a> [[PCheckVolNames]]
431 <dt><strong>Group</strong></dt>
433 <dt><strong>Function</strong></dt>
434 <dd> VIOCCKBACK (11) - Check backup volume mappings </dd>
435 <dt><strong>Arguments</strong></dt>
437 <dt><strong>Outcome</strong></dt>
438 <dd> Check the root volume, and then check the names if the volume check variable is set to force, has expired, is busy, or if the mount points variable is set </dd>
443 - EIO - if the afs daemon hasn't started yet
446 <dt><strong>Side Effects</strong></dt>
447 <dd> none listed </dd>
450 ## <a name="PCheckAuth"></a> [[PCheckAuth]]
453 <dt><strong>Group</strong></dt>
455 <dt><strong>Function</strong></dt>
456 <dd> VIOCCKCONN (12) - Check connections for a user </dd>
457 <dt><strong>Arguments</strong></dt>
459 <dt><strong>Outcome</strong></dt>
460 <dd> check to see if a user has the correct authentication. If so, allow access </dd>
465 - EACCES - if no user is specified
466 - EACCES - if the user has no tokens set
467 - EACCES - if the users tokens are bad
470 <dt><strong>Side Effects</strong></dt>
471 <dd> check the connections to all the servers specified </dd>
474 ## <a name="PFindVolume"></a> [[PFindVolume]]
477 <dt><strong>Group</strong></dt>
479 <dt><strong>Function</strong></dt>
480 <dd> VIOCWHEREIS (14) - Find out where a volume is located </dd>
481 <dt><strong>Arguments</strong></dt>
483 <dt><strong>Outcome</strong></dt>
484 <dd> find a volume, based on a volume file id </dd>
489 - EINVAL - if some of the default arguments don't exist
490 - ENODEV - if there is no such volume
493 <dt><strong>Side Effects</strong></dt>
494 <dd> check each of the servers specified </dd>
497 ## <a name="PViceAccess"></a> [[PViceAccess]]
500 <dt><strong>Group</strong></dt>
502 <dt><strong>Function</strong></dt>
503 <dd> VIOCACCESS (20) - Access using PRS_FS bits </dd>
504 <dt><strong>Arguments</strong></dt>
506 <dt><strong>Outcome</strong></dt>
507 <dd> check to make sure access is allowed </dd>
512 - EINVAL - if some of the initial arguments aren't set
513 - EACCES - if access is denied
516 <dt><strong>Side Effects</strong></dt>
517 <dd> none listed </dd>
520 ## <a name="PGetFID"></a> [[PGetFID]]
523 <dt><strong>Group</strong></dt>
525 <dt><strong>Function</strong></dt>
526 <dd> VIOCETFID (22) - Get file ID quickly </dd>
527 <dt><strong>Arguments</strong></dt>
529 <dt><strong>Outcome</strong></dt>
530 <dd> get the file id of some file </dd>
535 - EINVAL - if some fo the initial arguments aren't set
538 <dt><strong>Side Effects</strong></dt>
539 <dd> none listed </dd>
542 ## <a name="PSetCacheSize"></a> [[PSetCacheSize]]
545 <dt><strong>Group</strong></dt>
547 <dt><strong>Function</strong></dt>
548 <dd> VIOCSETCACHESIZE (24) - Set venus cache size in 1000 units </dd>
549 <dt><strong>Arguments</strong></dt>
550 <dd> The size the venus cache should be set to </dd>
551 <dt><strong>Outcome</strong></dt>
552 <dd> Set the cache size based on user intput. If no size is given, set it to the default [[Main/OpenAFS]] cache size </dd>
557 - EACCES - if the user doen't have super-user credentials
558 - EROFS - if the cache is set to be in memory
561 <dt><strong>Side Effects</strong></dt>
562 <dd> recompute the general cache parameters for every single block allocated </dd>
565 ## <a name="PRemoveCallback"></a> [[PRemoveCallback]]
568 <dt><strong>Group</strong></dt>
570 <dt><strong>Function</strong></dt>
571 <dd> VIOCFLUSHCB (25) - Flush callback only </dd>
572 <dt><strong>Arguments</strong></dt>
574 <dt><strong>Outcome</strong></dt>
575 <dd> Flushes callbacks, by setting the length of callbacks to one, setting the next callback to be sent to the CB_DROPPED value, and then dequeue's everything else </dd>
580 - EINVAL - if some of the initial default arguments aren't set return's 0 - if the volume is set to read-only
583 <dt><strong>Side Effects</strong></dt>
584 <dd> none listed </dd>
587 ## <a name="PNewCell"></a> [[PNewCell]]
590 <dt><strong>Group</strong></dt>
592 <dt><strong>Function</strong></dt>
593 <dd> VIOCNEWCELL (26) - Configure new cell </dd>
594 <dt><strong>Arguments</strong></dt>
595 <dd> the name of the cell, the hosts that will be a part of the cell, whether or not it's linked with another cell, the other cel it's linked with, the file server port, and the volume server port </dd>
596 <dt><strong>Outcome</strong></dt>
597 <dd> creates a new cell </dd>
602 - EIO - if the afs daemon hasn't started yet
603 - EACCES - if the user doesn't have super-user credentials
604 - EINVAL - if some 'magic' var doesn't have a certain bit set
607 <dt><strong>Side Effects</strong></dt>
608 <dd> none listed </dd>
611 ## <a name="PListCells"></a> [[PListCells]]
614 <dt><strong>Group</strong></dt>
616 <dt><strong>Function</strong></dt>
617 <dd> VIOCGETCELL (27) - Get cell info </dd>
618 <dt><strong>Arguments</strong></dt>
619 <dd> The cell index of a specific cell </dd>
620 <dt><strong>Outcome</strong></dt>
621 <dd> Lists the cells server names and addresses </dd>
626 - EIO - if the afs daemon hasn't started yet
627 - EDOM - if there is no cell asked about
630 <dt><strong>Side Effects</strong></dt>
631 <dd> none listed </dd>
634 ## <a name="PRemoveMount"></a> [[PRemoveMount]]
637 <dt><strong>Group</strong></dt>
639 <dt><strong>Function</strong></dt>
640 <dd> VIOC_AFS_DELETE_MT_PT (28) - Delete mount point </dd>
641 <dt><strong>Arguments</strong></dt>
642 <dd> none // I DON'T THINK </dd>
643 <dt><strong>Outcome</strong></dt>
644 <dd> Ensure that everything is ok, before deleting the mountpoint. If not, don't delete. Delete a mount point based on a file id </dd>
649 - EINVAL - if some of default arguments don't exist
650 - ENOTDIR - if the argument to remove is not a directory
651 - ENOENT - if there is no cache to remove the mount point from
652 - ENOENT - if a vcache doesn't exist
655 <dt><strong>Side Effects</strong></dt>
656 <dd> none listed </dd>
659 ## <a name="PNewStatMount"></a> [[PNewStatMount]]
662 <dt><strong>Group</strong></dt>
664 <dt><strong>Function</strong></dt>
665 <dd> VIOC_AFS_STAT_MT_PT (29) - Stat mount point </dd>
666 <dt><strong>Arguments</strong></dt>
667 <dd> the last component in a path, related to mountpoint that we're looking for information about </dd>
668 <dt><strong>Outcome</strong></dt>
669 <dd> get the volume, and cell, as well as the link data for a mount point </dd>
674 - EINVAL - if some of the default initial arguments aren't set
675 - ENOTDIR - if the 'mount point' argument isn't a directory
676 - EIO - if the link data can't be accessed
679 <dt><strong>Side Effects</strong></dt>
680 <dd> none listed </dd>
683 ## <a name="PGetFileCell"></a> [[PGetFileCell]]
686 <dt><strong>Group</strong></dt>
688 <dt><strong>Function</strong></dt>
689 <dd> VIOC_FILE_CELL_NAME (30) - Get cell in which file lives </dd>
690 <dt><strong>Arguments</strong></dt>
692 <dt><strong>Outcome</strong></dt>
693 <dd> Get a cell based on a passed in on a passed in file id </dd>
698 - EINVAL - if someo f the default initial arguments aren't set
699 - ESRCH - if the file isn't part of a cell
702 <dt><strong>Side Effects</strong></dt>
703 <dd> none listed </dd>
706 ## <a name="PGetWSCell"></a> [[PGetWSCell]]
709 <dt><strong>Group</strong></dt>
711 <dt><strong>Function</strong></dt>
712 <dd> VIOC_GET_WS_CELL (31) - Get cell in which workstation lives </dd>
713 <dt><strong>Arguments</strong></dt>
715 <dt><strong>Outcome</strong></dt>
716 <dd> Get the primary cell that the machine is a part of </dd>
721 - EIO - if the afs daemon hasn't started yet
722 - ESRCH - if the machine isn't part of a cell, for whatever reason
725 <dt><strong>Side Effects</strong></dt>
726 <dd> none listed </dd>
729 ## <a name="PMariner"></a> PMariner
732 <dt><strong>Group</strong></dt>
734 <dt><strong>Function</strong></dt>
735 <dd> VIOC_AFS_MARINER_HOST (32) - Get/set mariner (cache manager monitor) host </dd>
736 <dt><strong>Arguments</strong></dt>
738 <dt><strong>Outcome</strong></dt>
739 <dd> depending on what whether or not a variable is set, either get the host for the cache manager monitor, or set the old address, and give it a new address </dd>
742 **Errors** turn off mariner
745 <dt><strong>Side Effects</strong></dt>
746 <dd> none listed </dd>
749 ## <a name="PGetUserCell"></a> [[PGetUserCell]]
752 <dt><strong>Group</strong></dt>
754 <dt><strong>Function</strong></dt>
755 <dd> VIOC_GET_PRIMARY_CELL (33) - Get primary cell for caller </dd>
756 <dt><strong>Arguments</strong></dt>
758 <dt><strong>Outcome</strong></dt>
759 <dd> get the primary cell for a certain user, based on the user's uid </dd>
764 - ESRCH - if the user corresponding to the uid doesn't have a primary cell specified
767 <dt><strong>Side Effects</strong></dt>
768 <dd> none listed </dd>
771 ## <a name="PVenusLogging"></a> [[PVenusLogging]]
774 <dt><strong>Group</strong></dt>
776 <dt><strong>Function</strong></dt>
777 <dd> VIOC_VENUSLOG (34) - Enable/Disable venus logging </dd>
778 <dt><strong>Arguments</strong></dt>
780 <dt><strong>Outcome</strong></dt>
781 <dd> obsoleted, perhaps should be PBogus </dd>
786 - EINVAL - this is all the function does, perhaps this pioctl should be PBogus
789 <dt><strong>Side Effects</strong></dt>
790 <dd> always throws an error </dd>
793 ## <a name="PGetCellStatus"></a> [[PGetCellStatus]]
796 <dt><strong>Group</strong></dt>
798 <dt><strong>Function</strong></dt>
799 <dd> VIOC_GETCELLSTATUS (35) - Get cell status info </dd>
800 <dt><strong>Arguments</strong></dt>
801 <dd> the cell you want status information on </dd>
802 <dt><strong>Outcome</strong></dt>
803 <dd> returns the state of the cell as defined in a struct cell </dd>
808 - EIO - the afs daemon hasn't started yet
809 - ENOENT - the cell doesn't exist
812 <dt><strong>Side Effects</strong></dt>
813 <dd> none listed </dd>
816 ## <a name="PSetCellStatus"></a> [[PSetCellStatus]]
819 <dt><strong>Group</strong></dt>
821 <dt><strong>Function</strong></dt>
822 <dd> VIOC_SETCELLSTATUS (36) - Set corresponding info </dd>
823 <dt><strong>Arguments</strong></dt>
824 <dd> The cell you want to set information about, and the values you want to set </dd>
825 <dt><strong>Outcome</strong></dt>
826 <dd> Set the state of the cell in a defined struct cell, based on whether or not [[Main/SetUID]] is allowed </dd>
831 - EIO - the afs daemon hasn't started yet
832 - EACCES - the user does not have super-user credentials
835 <dt><strong>Side Effects</strong></dt>
836 <dd> none listed </dd>
839 ## <a name="PFlushVolumeData"></a> [[PFlushVolumeData]]
842 <dt><strong>Group</strong></dt>
844 <dt><strong>Function</strong></dt>
845 <dd> VIOC_FLUSHVOLUME (37) - Flush whole volume's data </dd>
846 <dt><strong>Arguments</strong></dt>
847 <dd> none //ALTHOUGH MAYBE A VCACHE CONTAINING WHICH VOLUME </dd>
848 <dt><strong>Outcome</strong></dt>
849 <dd> Wipe everything on the volume. Dependent on which platform this is is for, as to how it's done </dd>
854 - EINVAL - some of the initial default arguments aren't set
855 - EIO - the afs daemon hasn't started yet
858 <dt><strong>Side Effects</strong></dt>
859 <dd> Does not flush a file that a user has open and is using, because it will be re-created on next write. Also purges the dnlc, because things are screwed up </dd>
862 ## <a name="PSetSysName"></a> [[PSetSysName]]
865 <dt><strong>Group</strong></dt>
867 <dt><strong>Function</strong></dt>
868 <dd> VIOC_AFS_SYSNAME (38) - Change @sys value </dd>
869 <dt><strong>Arguments</strong></dt>
870 <dd> a new value for @sys </dd>
871 <dt><strong>Outcome</strong></dt>
872 <dd> Set the value of @sys if these things work: if the input isn't too long or if input doesn't start with .0 or ..0 </dd>
877 - EINVAL - if afsd isn't runing
878 - EINVAL - if the new sysname is too large
879 - EINVAL - if the new sysname causes issues(starts with a .0 or a ..0
880 - EINVAL - if there is no PAG set in the credentials
881 - EINVAL - if the user of a PAG can't be found
882 - EINVAL - if (!(exporter = au->exporter)) // NOT SURE ON THIS
883 - ENODEV - if there isn't already a system named that //I THINK
884 - EACCES - if the user doesn't have super-user credentials
887 <dt><strong>Side Effects</strong></dt>
888 <dd> local user needs root, remote user does not (because remote user ids aren't trusted) </dd>
891 ## <a name="PExportAfs"></a> [[PExportAfs]]
894 <dt><strong>Group</strong></dt>
896 <dt><strong>Function</strong></dt>
897 <dd> VIOC_EXPORTAFS (39) - Export afs to nfs clients </dd>
898 <dt><strong>Arguments</strong></dt>
899 <dd> A struct Vic * EIOctl containing export values needed to change between nfs and afs </dd>
900 <dt><strong>Outcome</strong></dt>
901 <dd> //REALLY NOT SURE ON THIS... INPUT WOULD BE NICE </dd>
906 - ENODEV - if the exporter doesn't exist
907 - EACCES - if the user doesn't have super-user credentials $ **Side Effects**:none listed
909 ## <a name="PGetCacheSize"></a> [[PGetCacheSize]]
912 <dt><strong>Group</strong></dt>
914 <dt><strong>Function</strong></dt>
915 <dd> VIOCGETCACHEPARMS (40) - Get cache stats </dd>
916 <dt><strong>Arguments</strong></dt>
918 <dt><strong>Outcome</strong></dt>
919 <dd> Get the cache blocks, and how many of the cache blocks there are </dd>
927 <dt><strong>Side Effects</strong></dt>
928 <dd> none listed </dd>
931 ## <a name="PGetVnodeXStatus"></a> [[PGetVnodeXStatus]]
934 <dt><strong>Group</strong></dt>
936 <dt><strong>Function</strong></dt>
937 <dd> VIOCGETVCXSTATUS (41) - ??? </dd>
938 <dt><strong>Arguments</strong></dt>
940 <dt><strong>Outcome</strong></dt>
941 <dd> get's the fid, the data version, any lock, the parent vnode, the parent unique identifier, the truncation position, the callback, cbExpires(probably when the callback expires), if any access is being made, if any files are open, any users executing or writing, the 'flock' count, the states, and the move statistic </dd>
946 - EINVAL - if some of the initial default arguments aren't set
947 - EACCES - if access to check the mode bits is denied
950 <dt><strong>Side Effects</strong></dt>
951 <dd> none listed </dd>
954 ## <a name="PSetSPrefs33"></a> [[PSetSPrefs33]]
957 <dt><strong>Group</strong></dt>
959 <dt><strong>Function</strong></dt>
960 <dd> VIOC_SETPREFS33 (42) - Set server ranks (deprecated) </dd>
961 <dt><strong>Arguments</strong></dt>
962 <dd> the server preferences to be set </dd>
963 <dt><strong>Outcome</strong></dt>
964 <dd> set the server preferences, calling a function </dd>
972 <dt><strong>Side Effects</strong></dt>
973 <dd> none listed </dd>
976 ## <a name="PGetSPrefs"></a> [[PGetSPrefs]]
979 <dt><strong>Group</strong></dt>
981 <dt><strong>Function</strong></dt>
982 <dd> VIOC_GETSPREFS (43) - Get server ranks </dd>
983 <dt><strong>Arguments</strong></dt>
985 <dt><strong>Outcome</strong></dt>
986 <dd> Get the sprefs </dd>
991 - EIO - if the afs daemon hasn't started yet
992 - ENOENT - is the sprefrequest is too large
995 <dt><strong>Side Effects</strong></dt>
996 <dd> none listed </dd>
999 ## <a name="PGag"></a> PGag
1002 <dt><strong>Group</strong></dt>
1004 <dt><strong>Function</strong></dt>
1005 <dd> VIOC_GAG (44) - Silence Cache Manager </dd>
1006 <dt><strong>Arguments</strong></dt>
1007 <dd> The flags to either gag or de-gag the cache manager </dd>
1008 <dt><strong>Outcome</strong></dt>
1009 <dd> set the gag flags, then show these flags </dd>
1014 - EACCES - if the user doesn't have super-user credentials
1017 <dt><strong>Side Effects</strong></dt>
1018 <dd> none listed </dd>
1021 ## <a name="PTwiddleRx"></a> [[PTwiddleRx]]
1024 <dt><strong>Group</strong></dt>
1026 <dt><strong>Function</strong></dt>
1027 <dd> VIOC_TWIDDLE (45) - Adjust RX knobs </dd>
1028 <dt><strong>Arguments</strong></dt>
1029 <dd> the previous settings of the 'knobs' </dd>
1030 <dt><strong>Outcome</strong></dt>
1031 <dd> build out the struct rxp, from a struct rx </dd>
1036 - EACCES - if the user doesn't have super-user credentials
1039 <dt><strong>Side Effects</strong></dt>
1040 <dd> none listed </dd>
1043 ## <a name="PSetSPrefs"></a> [[PSetSPrefs]]
1046 <dt><strong>Group</strong></dt>
1048 <dt><strong>Function</strong></dt>
1049 <dd> VIOC_SETPREFS (46) - Set server ranks </dd>
1050 <dt><strong>Arguments</strong></dt>
1051 <dd> the sprefs value to want the sprefs set to </dd>
1052 <dt><strong>Outcome</strong></dt>
1053 <dd> set the sprefs using the afs_setsprefs() function </dd>
1058 - EIO - if the afs daemon hasn't started yet
1059 - EACCES - if the user doesn't have super-user credentials
1060 - EINVAL - if the struct setsprefs is too large
1061 - EINVAL - if the struct setsprefs multiplied by the number of servers is too large
1064 <dt><strong>Side Effects</strong></dt>
1065 <dd> none listed </dd>
1068 ## <a name="PStoreBehind"></a> [[PStoreBehind]]
1071 <dt><strong>Group</strong></dt>
1073 <dt><strong>Function</strong></dt>
1074 <dd> VIOC_STORBEHIND (47) Adjust store asynchrony </dd>
1075 <dt><strong>Arguments</strong></dt>
1076 <dd> sets the sbstruct </dd>
1077 <dt><strong>Outcome</strong></dt>
1078 <dd> set asynchrony based on a file, from a struct sbstruct //I THINK </dd>
1083 - EPERM - if the user doesn't have super-user credentials
1084 - EACCES - if there isn't enough access to not check the mode bits
1087 <dt><strong>Side Effects</strong></dt>
1088 <dd> none listed </dd>
1091 ## <a name="PGCPAGs"></a> PGCPAGs
1094 <dt><strong>Group</strong></dt>
1096 <dt><strong>Function</strong></dt>
1097 <dd> VIOC_GCPAGS (48) - Disable automatic PAG gc'ing </dd>
1098 <dt><strong>Arguments</strong></dt>
1100 <dt><strong>Outcome</strong></dt>
1101 <dd> set the gcpags to GCPAGS_USERDISABLED </dd>
1106 - EACCES - if the user doesn't have super-user credentials
1109 <dt><strong>Side Effects</strong></dt>
1110 <dd> none listed </dd>
1113 ## <a name="PGetInitParams"></a> [[PGetInitParams]]
1116 <dt><strong>Group</strong></dt>
1118 <dt><strong>Function</strong></dt>
1119 <dd> VIOC_GETINITPARAMS (49) - Get initial cache manager parameters </dd>
1120 <dt><strong>Arguments</strong></dt>
1122 <dt><strong>Outcome</strong></dt>
1123 <dd> return the initial cache manager parameters </dd>
1128 - [[E2BIG]] - if the initial parameters are bigger than some PIGGYSIZE
1131 <dt><strong>Side Effects</strong></dt>
1132 <dd> none listed </dd>
1135 ## <a name="PGetCPrefs"></a> [[PGetCPrefs]]
1138 <dt><strong>Group</strong></dt>
1140 <dt><strong>Function</strong></dt>
1141 <dd> VIOC_GETCPREFS (50) - Get client interface </dd>
1142 <dt><strong>Arguments</strong></dt>
1144 <dt><strong>Outcome</strong></dt>
1145 <dd> get the information about the client interface </dd>
1150 - - EIO - the afs daemon hasn't started yet
1151 - EINVAL - if the request is too large for the struct that will be holding it
1154 <dt><strong>Side Effects</strong></dt>
1155 <dd> none listed </dd>
1158 ## <a name="PSetCPrefs"></a> [[PSetCPrefs]]
1161 <dt><strong>Group</strong></dt>
1163 <dt><strong>Function</strong></dt>
1164 <dd> VIOC_SETCPREFS (51) - Set client interface </dd>
1165 <dt><strong>Arguments</strong></dt>
1166 <dd> The interfaces you want set </dd>
1167 <dt><strong>Outcome</strong></dt>
1168 <dd> set the callback interfaces addresses to those of the hosts </dd>
1173 - EIO - the afs daemon hasn't started yet
1174 - EINVAL - the input is too large for the struct
1175 - ENOMEM - if there are too many servers
1178 <dt><strong>Side Effects</strong></dt>
1179 <dd> none listed </dd>
1182 ## <a name="PFlushMount"></a> [[PFlushMount]]
1185 <dt><strong>Group</strong></dt>
1187 <dt><strong>Function</strong></dt>
1188 <dd> VIOC_AFS_FLUSHMOUNT (52) - Flush mount symlink data </dd>
1189 <dt><strong>Arguments</strong></dt>
1190 <dd> The last part of a path to a mount point, which tells us what to flush </dd>
1191 <dt><strong>Outcome</strong></dt>
1192 <dd> remove all of the mount data from the dcache regarding a certain mount point </dd>
1197 - EINVAL - if some of the initial arguments aren't set
1198 - ENOTDIR - if the initial argument for the mount point isn't a directory
1199 - ENOENT - if the dcache entry isn't set
1201 ## <a name="PRxStatProc"></a> [[PRxStatProc]]
1204 <dt><strong>Group</strong></dt>
1206 <dt><strong>Function</strong></dt>
1207 <dd> VIOC_RXSTAT_PROC (53) - Control process RX statistics </dd>
1208 <dt><strong>Arguments</strong></dt>
1209 <dd> The flags that control which statistics to use </dd>
1210 <dt><strong>Outcome</strong></dt>
1211 <dd> either enable process RPCStats, disable process RPCStats, or clear the process RPCStats </dd>
1216 - EACCES - if the user doesn't have super-user credentials
1217 - EINVAL - if the flag input is too long
1220 <dt><strong>Side Effects</strong></dt>
1221 <dd> none listed </dd>
1224 ## <a name="PRxStatPeer"></a> [[PRxStatPeer]]
1227 <dt><strong>Group</strong></dt>
1229 <dt><strong>Function</strong></dt>
1230 <dd> VIOC_RXSTAT_PEER (54) - Control peer RX statistics </dd>
1231 <dt><strong>Arguments</strong></dt>
1232 <dd> The flags that control which statistics to use </dd>
1233 <dt><strong>Outcome</strong></dt>
1234 <dd> either enable peer RPCStats, disable peer RPCStats, or clear the peer RPCStats </dd>
1239 - EACCES - if the user doesn't have super-user credentials
1240 - EINVAL - if the flag input is too long
1243 <dt><strong>Side Effects</strong></dt>
1244 <dd> none listed </dd>
1247 ## <a name="PGetRxkcrypt"></a> [[PGetRxkcrypt]]
1250 <dt><strong>Group</strong></dt>
1252 <dt><strong>Function</strong></dt>
1253 <dd> VIOC_GETRXKCRYPT (55) - Get rxkad encryption flag </dd>
1254 <dt><strong>Arguments</strong></dt>
1256 <dt><strong>Outcome</strong></dt>
1257 <dd> get the value of cryptall(presumably whether or not things should be encrypted </dd>
1265 <dt><strong>Side Effects</strong></dt>
1266 <dd> none listed </dd>
1269 ## <a name="PSetRxkcrypt"></a> [[PSetRxkcrypt]]
1272 <dt><strong>Group</strong></dt>
1274 <dt><strong>Function</strong></dt>
1275 <dd> VIOC_SETRXKCRYPT (56) - Set rxkad encryption flag </dd>
1276 <dt><strong>Arguments</strong></dt>
1277 <dd> the argument whether or not things should be encrypted </dd>
1278 <dt><strong>Outcome</strong></dt>
1279 <dd> set whether or not things should be encrypted </dd>
1284 - EPERM - if the user doesn't have super-user credentials
1285 - EINVAL - if the input is too big, or if the input is outside the bounds of what it can be set to
1288 <dt><strong>Side Effects</strong></dt>
1289 <dd> none really, but may need to be modified at a later date to take into account other values for cryptall(beyond true and false) </dd>
1292 ## <a name="PSetClientContext"></a> [[PSetClientContext]]
1295 <dt><strong>Group</strong></dt>
1297 <dt><strong>Function</strong></dt>
1298 <dd>[[Main/PsetClientContext]] (99) - NFS-PAG pioctl (for knfs/rmtsysd) </dd>
1299 <dt><strong>Arguments</strong></dt>
1301 <dt><strong>Outcome</strong></dt>
1302 <dd> Setup caller's credentials, dependent on an AIX 64-bit kernel, HPUX, SUN57 64-bit kernel, SGI 64-mips, or a need for a 32-bit ioctl </dd>
1310 <dt><strong>Side Effects</strong></dt>
1311 <dd> none listed </dd>
1314 //WASN'T SURE WHAT TO DO ABOUT THESE, ALSO NOTE THAT THE ABOVE ARE JUST THE V GROUP PIOCTL()s, I CAN DOCUMENT THE C GROUP, MOST OF WHICH ARE PBogus
1317 <dt><strong>Group</strong></dt>
1319 <dt><strong>Function</strong></dt>
1320 <dd><strong>*reserved*</strong> (239) - Reserved for code expansion </dd>
1326 <dt><strong>Group</strong></dt>
1328 <dt><strong>Function</strong></dt>
1329 <dd> VIOC_SITE1 (240) - Reserved for site-specific extensions </dd>
1335 <dt><strong>Group</strong></dt>
1337 <dt><strong>Function</strong></dt>
1338 <dd> VIOC_STIE2 (241) - Reserved for site-specific extensions </dd>
1344 <dt><strong>Group</strong></dt>
1346 <dt><strong>Function</strong></dt>
1347 <dd> VIOC_SITE3 (242) - Reserved for site-specific extensions </dd>
1353 <dt><strong>Group</strong></dt>
1355 <dt><strong>Function</strong></dt>
1356 <dd> VIOC_SITE4 (243) - Reserved for site-specific extensions </dd>
1362 <dt><strong>Group</strong></dt>
1364 <dt><strong>Function</strong></dt>
1365 <dd> VIOC_SITE5 (244) - Reserved for site-specific extensions </dd>
1371 <dt><strong>Group</strong></dt>
1373 <dt><strong>Function</strong></dt>
1374 <dd> VIOC_SITE6 (245) - Reserved for site-specific extensions </dd>
1380 <dt><strong>Group</strong></dt>
1382 <dt><strong>Function</strong></dt>
1383 <dd> VIOC_SITE7 (246) - Reserved for site-specific extensions </dd>
1389 <dt><strong>Group</strong></dt>
1391 <dt><strong>Function</strong></dt>
1392 <dd> VIOC_SITE8 (247) - Reserved for site-specific extensions </dd>
1398 <dt><strong>Group</strong></dt>
1400 <dt><strong>Function</strong></dt>
1401 <dd> VIOC_PRIVATE1 (248) - Reserved for implementation use </dd>
1407 <dt><strong>Group</strong></dt>
1409 <dt><strong>Function</strong></dt>
1410 <dd> VIOC_PRIVATE2 (249) - Reserved for implementation use </dd>
1416 <dt><strong>Group</strong></dt>
1418 <dt><strong>Function</strong></dt>
1419 <dd> VIOC_PRIVATE3 (250) - Reserved for implementation use </dd>
1425 <dt><strong>Group</strong></dt>
1427 <dt><strong>Function</strong></dt>
1428 <dd> VIOC_PRIVATE4 (251) - Reserved for implementation use </dd>
1434 <dt><strong>Group</strong></dt>
1436 <dt><strong>Function</strong></dt>
1437 <dd> VIOC_PRIVATE5 (252) - Reserved for implementation use </dd>
1443 <dt><strong>Group</strong></dt>
1445 <dt><strong>Function</strong></dt>
1446 <dd> VIOC_PRIVATE6 (253) - Reserved for implementation use </dd>
1452 <dt><strong>Group</strong></dt>
1454 <dt><strong>Function</strong></dt>
1455 <dd> VIOC_PRIVATE7 (254) - Reserved for implementation use </dd>
1461 <dt><strong>Group</strong></dt>
1463 <dt><strong>Function</strong></dt>
1464 <dd> VIOC_PRIVATE8 (255) - Reserved for implementation use </dd>