http://www.dementia.org/twiki/bin/view/AFSLore The AFSLore web of TWiki. TWiki is a Web-Based Collaboration Platform for the Corporate World. en-us Copyright 2008 by contributing authors TWiki Administrator [shadow@dementia.org] TWiki Administrator [shadow@dementia.org] TWiki TWiki.AFSLore http://www.dementia.org/twiki/bin/view/AFSLore http://www.dementia.org/twiki/pub/TWiki/TWikiLogos/T-logo-140x40-t.gif http://www.dementia.org/twiki/bin/view/AFSLore/AddOnsToolsAndUtilities?t=2008-08-03T16:29Z &#37;TOC&#37; <p /> <nop><h1><a name="UNIX"></a> UNIX </h1> <nop><h2><a name="AFS_Backend"></a> AFS Backend </h2> <p /> Delegated administration of certain volumes. <p /> Available at <a target="_top" href="http://www.eyrie.org/~eagle/software/afs-backend/">http://www.eyrie.org/~eagle/software/afs-backend/</a> <p /> <nop><h2><a name="BackupPC4AFS"></a> <span class="twikiNewLink">BackupPC4AFS<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/BackupPC4AFS?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2> <p /> Backup <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFS">OpenAFS</a> volumes to a backup server's local disk or attached RAID. Supports full and multi-level incremental dumps, exponential expiry, and configuration via conf files or a web interface. <p /> Available at <a target="_top" href="http://backuppc4afs.sourceforge.net/">http://backuppc4afs.sourceforge.net/</a> <p /> <nop><h2><a name="Balancing"></a> Balancing </h2> <p /> Balance volumes, usage, and accesses among servers. <p /> Available at <a target="_top" href="http://www.eyrie.org/~eagle/software/afs-balance/">http://www.eyrie.org/~eagle/software/afs-balance/</a> <p /> <nop><h2><a name="Frak"></a> Frak </h2> <p /> Show differences between AFS file trees or volumes <p /> Available at <a target="_top" href="http://www.eyrie.org/~eagle/software/frak/">http://www.eyrie.org/~eagle/software/frak/</a> <p /> <nop><h2><a name="FSR"></a> FSR </h2> <p /> Recursive wrapper around fs directory commands <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/fsr/">http://www.eyrie.org/~eagle/software/fsr/</a> <p /> <nop><h2><a name="LSMounts"></a> LSMounts </h2> <p /> Search through a directory for mount points <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/lsmounts/">http://www.eyrie.org/~eagle/software/lsmounts/</a> <p /> <nop><h2><a name="Nagios_Monitoring"></a> Nagios Monitoring </h2> <p /> Nagios-compatible probes to monitor AFS <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/afs-monitor/">http://www.eyrie.org/~eagle/software/afs-monitor/</a> <p /> <nop><h2><a name="Mount_Points"></a> Mount Points </h2> <p /> Maintain a database of volume mount points <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/afs-mount/">http://www.eyrie.org/~eagle/software/afs-mount/</a> <p /> <nop><h2><a name="MVTO"></a> MVTO </h2> <p /> Smart vos move with usage balancing <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/mvto/">http://www.eyrie.org/~eagle/software/mvto/</a> <p /> <nop><h2><a name="Pam_AFS_Session"></a> Pam-AFS-Session </h2> <p /> AFS <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAG">PAG</a> and token <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAM">PAM</a> session module <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/pam-afs-session/">http://www.eyrie.org/~eagle/software/pam-afs-session/</a> <p /> <nop><h2><a name="Pam_KRB5"></a> Pam-KRB5 </h2> <p /> Kerberos v5 <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAM">PAM</a> module <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/pam-krb5/">http://www.eyrie.org/~eagle/software/pam-krb5/</a> <p /> <nop><h2><a name="Partinfo"></a> Partinfo </h2> <p /> Nicely formatted partition usage report <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/partinfo/">http://www.eyrie.org/~eagle/software/partinfo/</a> <p /> <nop><h2><a name="PHPafsfree"></a> PHPafsfree </h2> <p /> A PHP/GD AFS fileserver disk utilization grapher inspired by the original tcl/tk afsfree script. <p /> Available at: <a target="_top" href="http://www.physics.unc.edu/~stephen/phpafsfree/">http://www.physics.unc.edu/~stephen/phpafsfree/</a> <p /> <nop><h2><a name="Reporting_DB"></a> Reporting DB </h2> <p /> Load AFS metadata into a SQL database for reporting <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/afsdb/">http://www.eyrie.org/~eagle/software/afsdb/</a> <p /> <nop><h2><a name="VolCreate"></a> <span class="twikiNewLink">VolCreate<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/VolCreate?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2> <p /> Smart vos create with automatic volume placement <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/volcreate/">http://www.eyrie.org/~eagle/software/volcreate/</a> <p /> <nop><h2><a name="VolNuke"></a> <span class="twikiNewLink">VolNuke<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/VolNuke?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2> <p /> Smart vos remove that finds volume location <p /> Available at: <a target="_top" href="http://www.eyrie.org/~eagle/software/volnuke/">http://www.eyrie.org/~eagle/software/volnuke/</a> <p /> <nop><h1><a name="Linux"></a> Linux </h1> <nop><h2><a name="AFS_Tokens_GUI"></a> AFS Tokens GUI </h2> <p /> Obtain and delete your AFS tokens via Kerberos 5 login. Manage your group membership and owned groups. <p /> Source and binaries available at <a target="_top" href="https://forge.cornell.edu/sf/frs/do/viewSummary/projects.afs_tokens/frs">https://forge.cornell.edu/sf/frs/do/viewSummary/projects.afs_tokens/frs</a> <p /> <nop><h2><a name="Kvibille_Nautilus_Plugin"></a> Kvibille Nautilus Plugin </h2> <p /> Graphical editor for AFS access control lists (ACL). Works as a Nautilus plugin and as a standalone application. <p /> RHEL4 rpms (standalone app only), source and binary, available at /afs/cnf.cornell.edu/shares/public/outside_users/openafs/kvibille <p /> RHEL5 rpms available at <a target="_top" href="http://ayo.sys.kth.se/kth/linux/5/i386/misc/">http://ayo.sys.kth.se/kth/linux/5/i386/misc/</a> and <a target="_top" href="http://ayo.sys.kth.se/kth/linux/5/x86_64/misc/">http://ayo.sys.kth.se/kth/linux/5/x86_64/misc/</a> <p /> Main source tree available at <a target="_top" href="ftp://ftp.nada.kth.se/pub/hacks/kvibille/">ftp://ftp.nada.kth.se/pub/hacks/kvibille/</a> <p /> <nop><h2><a name="Nautilus_for_RHEL4"></a> Nautilus for RHEL4 </h2> <p /> The stock Nautilus with RHEL4, like the Mac OS X finder, attempts to "help" you by pre-determining access to AFS files and folders based on the unix permissions. This version has a small hack which will always return access allowed such that the access decision is made by AFS itself. <p /> Prior to 2.8.1-5.EL4, an additional hack was necessary for nautilus to respect the user's umask settings. <p /> RPMS available at /afs/cnf.cornell.edu/shares/public/outside_users/openafs/nautilus <p /> <nop><h1><a name="Macintosh"></a> Macintosh </h1> <nop><h2><a name="AFS_Tokens_GUI"></a> AFS Tokens GUI </h2> <p /> Obtain and delete your AFS tokens via Kerberos 5 login. Manage your group membership and owned groups. <p /> Source and binaries available at <a target="_top" href="https://forge.cornell.edu/sf/frs/do/viewSummary/projects.afs_tokens/frs">https://forge.cornell.edu/sf/frs/do/viewSummary/projects.afs_tokens/frs</a> <p /> <nop><h2><a name="AFS_Commander"></a> AFS Commander </h2> <p /> Afs Commander is the development version Apple OSX AFS Preference Pane, made for simplify the afs client administration and usability. <p /> Available at <a target="_top" href="http://www.lnf.infn.it/~bisegni/Main/Afs_Commander.html">http://www.lnf.infn.it/~bisegni/Main/Afs_Commander.html</a> <p /> <nop><h2><a name="Contextual_Menu_Plug_in_for_Find"></a> Contextual Menu Plug-in for Finder </h2> <p /> Provides access list and volume quota information. AFS access control lists can be added, modified, and deleted. Volume information on user quota and disk space usage are available. <p /> Available at <a target="_top" href="http://www.ncsu.edu/mac/pn/index.php?name=UpDownload&amp;req=viewdownloaddetails&amp;lid=10">http://www.ncsu.edu/mac/pn/index.php?name=UpDownload&amp;req=viewdownloaddetails&amp;lid=10</a> <p /> <p /> <p /> <p /> -- <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/RedFyre">RedFyre</a> - 01 Aug 2008 (last changed by StephenJ) 2008-08-03T16:29Z StephenJ 3 updated major http://www.dementia.org/twiki/bin/rdiff/AFSLore/AddOnsToolsAndUtilities http://www.dementia.org/twiki/bin/rdiff/AFSLore/AddOnsToolsAndUtilities http://www.dementia.org/twiki/bin/view/AFSLore/WebHome?t=2008-08-01T16:06Z Welcome to the home of <b>&#37;WIKITOOLNAME&#37;.AFSLore</b>. This is a web-based collaboration area for collecting, maintaining, and distributing information about the AFS distributed filesystem and related topics. Some of the things you'll find here (now or in the future)... <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WhatIsAFS">What is <nop>AFS?</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/GettingStarted">GettingStarted</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/CreatingANewCell">CreatingANewCell</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/AddOnsToolsAndUtilities">AddOnsToolsAndUtilities</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/AFSFrequentlyAskedQuestions">AFSFrequentlyAskedQuestions</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WhereToGetHelp">WhereToGetHelp</a></li><li> <nop>AFS3 <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/ProtocolInfo">ProtocolInfo</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/NewProjects">NewProjects</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/AncientHistory">AncientHistory</a> (once upon a time...)</li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/CodeArchitecture">CodeArchitecture</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/GateKeeping">GateKeeping</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/HowToBuildOpenAFSFromSource">How <nop>To <nop>Build <nop>OpenAFS from <nop>Source</a></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/DemandAttach">DemandAttach</a></li><li> <span class="twikiNewLink">Best <nop>Practices <nop>Workshop 2008 <nop>Notes<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/BestPracticesWorkshop2008Notes?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span></li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFSPioctlInterfaceDoc">OpenAFSPioctlInterfaceDoc</a></li></ul> <p /> Note: This area is about AFS, whose name is properly spelled in all uppercase. Unfortunately, this creates interesting challenges in coming up with appropriate <span class="twikiNewLink">WikiWords<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/TWIKIWEBWikiWord?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> for naming topics. Please bear with us -- or come up with better names! <p /> <nop><h2><a name="Maintenance_of_the_AFSLore_web"></a> Maintenance of the AFSLore web </h2> <form action="&#37;SCRIPTURLPATH&#37;/search&#37;SCRIPTSUFFIX&#37;/AFSLore/SearchResult"><ul><li> <input type="text" name="search" size="32" /> <input type="submit" value="Search" /> &nbsp;&nbsp; (More options in <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WebSearch">WebSearch</a>)</li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WebChanges">WebChanges</a>: Find out recent modifications to the &#37;WIKITOOLNAME&#37;.AFSLore web.</li><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WebTopicList">WebTopicList</a>: Display all &#37;WIKITOOLNAME&#37;.AFSLore topics in alphabetical order. </li><li> &#37;NOTIFYTOPIC&#37;: Subscribe to be automatically notified when something changes in the &#37;WIKITOOLNAME&#37;.AFSLore web.</li><li> &#37;STATISTICSTOPIC&#37;: View access statistics of the &#37;WIKITOOLNAME&#37;.AFSLore web.</li><li> &#37;WEBPREFSTOPIC&#37;: Preferences of the &#37;WIKITOOLNAME&#37;.AFSLore web.</li></ul> </form> <p /> <strong>Notes:</strong><ul><li> You are currently in the &#37;WIKITOOLNAME&#37;.AFSLore web. The color code for this web is a blue background, so you know where you are.</li><li> If you are not familiar with the &#37;WIKITOOLNAME&#37; collaboration tool, please visit &#37;TWIKIWEB&#37;.WelcomeGuest in the &#37;WIKITOOLNAME&#37;.&#37;TWIKIWEB&#37; web first.</li><li> If you are going to edit pages, please <span class="twikiNewLink">Register<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/TWIKIWEBTWikiRegistration?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> and <a href="https://&#37;HTTP_HOST&#37;&#37;SCRIPTURLPATH&#37;/view&#37;SCRIPTSUFFIX&#37;/&#37;TWIKIWEB&#37;/TWikiLogin?fromweb=AFSLore&amp;fromtopic=WebHome" target="_top">Login</a> first.</li></ul> <p /> &#37;INCLUDE{"&#37;TWIKIWEB&#37;.SiteMap"}&#37; (last changed by RedFyre) 2008-08-01T16:06Z RedFyre 34 updated major http://www.dementia.org/twiki/bin/rdiff/AFSLore/WebHome http://www.dementia.org/twiki/bin/rdiff/AFSLore/WebHome http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFSPioctlInterfaceDoc?t=2008-06-20T16:54Z &#37;TOC&#37; <nop><h2><a name="PSetACL"></a> <span class="twikiNewLink">PSetACL<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetACL?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCSETAL (1) - Set access control list</dd><dt> <strong>Arguments</strong> </dt><dd> the ACL being set</dd><dt> <strong>Outcome</strong> </dt><dd> Changed ACL, via direct writing to the wire</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the standard arguments aren't set</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetACL"></a> <span class="twikiNewLink">PGetACL<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetACL?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCGETAL (2) - Get access control list</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Obtain the ACL, based on file ID</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the standard arguments aren't set</li><li> ERANGE - if the vnode of the file id is too large</li><li> return -1 - if getting the ACL failed</li></ul><dl><dt> <strong>Side Effects</strong> </dt><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></dl> <p /> <nop><h2><a name="PSetTokens"></a> <span class="twikiNewLink">PSetTokens<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetTokens?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCSETTOK (3) - Set authentication tokens</dd><dt> <strong>Arguments</strong> </dt><dd> the krb tickets from which to set the afs tokens</dd><dt> <strong>Outcome</strong> </dt><dd> Set the Tokens for a specific cell name, unless there is none set, then default to primary</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if the ticket is either too long or too short</li><li> EIO - if the AFS initState is below 101</li><li> ESRCH - if the cell for which the Token is being set can't be found</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetVolumeStatus"></a> <span class="twikiNewLink">PGetVolumeStatus<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetVolumeStatus?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCGETVOLSTAT (4) - Get volume status</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> The staus of a volume(based on the FID of the volume), or an offline message/motd</dd></dl> <strong>Errors</strong><ul><li> EINVAL: if some of the default arguments don't exist</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetVolumeStatus"></a> <span class="twikiNewLink">PSetVolumeStatus<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetVolumeStatus?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCSETVOLSTAT (5) - Set volume status</dd><dt> <strong>Arguments</strong> </dt><dd> values to set the status at, offline message, message of the day, volume name, minimum quota, maximum quota</dd><dt> <strong>Outcome</strong> </dt><dd> Set the status of a volume, including any offline messages, a minimum quota, and a maximum quota</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the default arguments don't exist</li><li> EROFS - if the volume is read only, or a backup volume</li><li> ENODEV - if the volume can't be accessed</li><li> E2BIG - if the volume name, offline message, and motd are too big</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PFlush"></a> PFlush </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCFLUSH (6) - Invalidate cache entry</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Flush any information the cache manager has on an entry</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the initial arguments don't exist</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PBogus_PNoop"></a> PBogus &amp; PNoop </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCSTAT (7) - Get file status</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCGETTIME (13) - Make gettime call (historic)</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCPREFETCH (15) - Pre-fetch a file</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCNOP (16) - No-op (historic)</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCENGROUP (17) - Enable group access (historic)</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCDISGROUP (18) - Disable group access (historic)</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCLISTGROUPS (19) - List enabled and disabled groups (historic)</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_FPRIOSTATUS (57) - arla: set file 'prio'</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_FHGET (58) - arla: fallback getfh</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_FHOPEN (59) - arla: fallback fhopen</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_XFSDEBUG (60) - arla: controls xfsdebug</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_ARLADEBUG (61) - arla: controls arla debug</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_AVIATOR (62) - arla: debug interfac</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_XFSDEBUG_PRINT (63) - arla: print xfs status</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_CALCULATE_CACHE (64) - arla: force cache check</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_BREAKCELLBACK (65) - arla: break callback</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCWAITFOREVER (23) - Wait for dead servers forever (historic)</dd></dl> <p /> <nop><h2><a name="PGetTokens"></a> <span class="twikiNewLink">PGetTokens<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetTokens?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCGETTOK (8) - Get authentication tokens</dd><dt> <strong>Arguments</strong> </dt><dd> An integer that corresponds to a user id, which in turn corresponds to a token</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> EDOM - if the input parameter is out of the bounds of the available tokens</li><li> ENOTCONN - if there aren't tokens for this cell</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed, although it's a weird interface (from comments in code)</dd></dl> <p /> <nop><h2><a name="PUnlog"></a> PUnlog </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCUNLOG (9) - Invalidate tokens</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> remove tokens from a user, specified by a user id</dd></dl> <strong>Errors</strong> <ul><li> EIO - if the afs daemon hasn't started yet</li></ul><dl><dt> $ <strong>Side Effects</strong> </dt><dd> set's the token's time to 0, which then causes it to be removed</dd></dl> <p /> //////////////////////////////////////////<dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCUNPAG (21) - Invalidate <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAG">PAG</a></dd></dl> ///////////////////////////////////////// Unlog is the same as un-pag in <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFS">OpenAFS</a> <p /> <nop><h2><a name="PCheckServers"></a> <span class="twikiNewLink">PCheckServers<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PCheckServers?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCCKSERV (10) - Check that servers are up</dd><dt> <strong>Arguments</strong> </dt><dd> The name of the cell that the servers will be a part of.</dd><dt> <strong>Outcome</strong> </dt><dd> Either a fast check (where it doesn't contact servers) or a local check (checks local cell only)</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> EACCES - if the user doesn't have super-user credentials</li><li> ENOENT - if we are unable to obtain the cell</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PCheckVolNames"></a> <span class="twikiNewLink">PCheckVolNames<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PCheckVolNames?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCCKBACK (11) - Check backup volume mappings</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PCheckAuth"></a> <span class="twikiNewLink">PCheckAuth<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PCheckAuth?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCCKCONN (12) - Check connections for a user</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> check to see if a user has the correct authentication. If so, allow access</dd></dl> <strong>Errors</strong><ul><li> EACCES - if no user is specified</li><li> EACCES - if the user has no tokens set</li><li> EACCES - if the users tokens are bad</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> check the connections to all the servers specified</dd></dl> <p /> <nop><h2><a name="PFindVolume"></a> <span class="twikiNewLink">PFindVolume<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PFindVolume?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCWHEREIS (14) - Find out where a volume is located</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> find a volume, based on a volume file id</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the default arguments don't exist</li><li> ENODEV - if there is no such volume</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> check each of the servers specified</dd></dl> <p /> <nop><h2><a name="PViceAccess"></a> <span class="twikiNewLink">PViceAccess<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PViceAccess?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCACCESS (20) - Access using PRS_FS bits</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> check to make sure access is allowed</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the initial arguments aren't set</li><li> EACCES - if access is denied</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetFID"></a> <span class="twikiNewLink">PGetFID<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetFID?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCETFID (22) - Get file ID quickly</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> get the file id of some file</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some fo the initial arguments aren't set</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetCacheSize"></a> <span class="twikiNewLink">PSetCacheSize<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetCacheSize?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCSETCACHESIZE (24) - Set venus cache size in 1000 units</dd><dt> <strong>Arguments</strong> </dt><dd> The size the venus cache should be set to</dd><dt> <strong>Outcome</strong> </dt><dd> Set the cache size based on user intput. If no size is given, set it to the default <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFS">OpenAFS</a> cache size</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doen't have super-user credentials</li><li> EROFS - if the cache is set to be in memory</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> recompute the general cache parameters for every single block allocated</dd></dl> <p /> <nop><h2><a name="PRemoveCallback"></a> <span class="twikiNewLink">PRemoveCallback<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PRemoveCallback?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOCFLUSHCB (25) - Flush callback only</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the initial default arguments aren't set</li></ul> return's 0 - if the volume is set to read-only<dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PNewCell"></a> <span class="twikiNewLink">PNewCell<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PNewCell?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCNEWCELL (26) - Configure new cell</dd><dt> <strong>Arguments</strong> </dt><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><dt> <strong>Outcome</strong> </dt><dd> creates a new cell</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> EACCES - if the user doesn't have super-user credentials</li><li> EINVAL - if some 'magic' var doesn't have a certain bit set</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PListCells"></a> <span class="twikiNewLink">PListCells<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PListCells?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCGETCELL (27) - Get cell info</dd><dt> <strong>Arguments</strong> </dt><dd> The cell index of a specific cell</dd><dt> <strong>Outcome</strong> </dt><dd> Lists the cells server names and addresses</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> EDOM - if there is no cell asked about</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PRemoveMount"></a> <span class="twikiNewLink">PRemoveMount<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PRemoveMount?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_AFS_DELETE_MT_PT (28) - Delete mount point</dd><dt> <strong>Arguments</strong> </dt><dd> none // I DON'T THINK</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EINVAL - if some of default arguments don't exist</li><li> ENOTDIR - if the argument to remove is not a directory</li><li> ENOENT - if there is no cache to remove the mount point from</li><li> ENOENT - if a vcache doesn't exist</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PNewStatMount"></a> <span class="twikiNewLink">PNewStatMount<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PNewStatMount?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_AFS_STAT_MT_PT (29) - Stat mount point</dd><dt> <strong>Arguments</strong> </dt><dd> the last component in a path, related to mountpoint that we're looking for information about</dd><dt> <strong>Outcome</strong> </dt><dd> get the volume, and cell, as well as the link data for a mount point</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the default initial arguments aren't set</li><li> ENOTDIR - if the 'mount point' argument isn't a directory</li><li> EIO - if the link data can't be accessed</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetFileCell"></a> <span class="twikiNewLink">PGetFileCell<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetFileCell?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_FILE_CELL_NAME (30) - Get cell in which file lives</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Get a cell based on a passed in on a passed in file id</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if someo f the default initial arguments aren't set</li><li> ESRCH - if the file isn't part of a cell</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetWSCell"></a> <span class="twikiNewLink">PGetWSCell<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetWSCell?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GET_WS_CELL (31) - Get cell in which workstation lives</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Get the primary cell that the machine is a part of</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> ESRCH - if the machine isn't part of a cell, for whatever reason</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PMariner"></a> PMariner </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_AFS_MARINER_HOST (32) - Get/set mariner (cache manager monitor) host</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong> turn off mariner<dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetUserCell"></a> <span class="twikiNewLink">PGetUserCell<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetUserCell?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GET_PRIMARY_CELL (33) - Get primary cell for caller</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> get the primary cell for a certain user, based on the user's uid</dd></dl> <strong>Errors</strong><ul><li> ESRCH - if the user corresponding to the uid doesn't have a primary cell specified</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PVenusLogging"></a> <span class="twikiNewLink">PVenusLogging<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PVenusLogging?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_VENUSLOG (34) - Enable/Disable venus logging</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> obsoleted, perhaps should be PBogus</dd></dl> <strong>Errors</strong><ul><li> EINVAL - this is all the function does, perhaps this pioctl should be PBogus</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> always throws an error</dd></dl> <p /> <nop><h2><a name="PGetCellStatus"></a> <span class="twikiNewLink">PGetCellStatus<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetCellStatus?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GETCELLSTATUS (35) - Get cell status info</dd><dt> <strong>Arguments</strong> </dt><dd> the cell you want status information on</dd><dt> <strong>Outcome</strong> </dt><dd> returns the state of the cell as defined in a struct cell</dd></dl> <strong>Errors</strong><ul><li> EIO - the afs daemon hasn't started yet</li><li> ENOENT - the cell doesn't exist</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetCellStatus"></a> <span class="twikiNewLink">PSetCellStatus<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetCellStatus?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SETCELLSTATUS (36) - Set corresponding info</dd><dt> <strong>Arguments</strong> </dt><dd> The cell you want to set information about, and the values you want to set</dd><dt> <strong>Outcome</strong> </dt><dd> Set the state of the cell in a defined struct cell, based on whether or not <span class="twikiNewLink">SetUID<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/SetUID?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> is allowed</dd></dl> <strong>Errors</strong><ul><li> EIO - the afs daemon hasn't started yet</li><li> EACCES - the user does not have super-user credentials</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PFlushVolumeData"></a> <span class="twikiNewLink">PFlushVolumeData<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PFlushVolumeData?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_FLUSHVOLUME (37) - Flush whole volume's data</dd><dt> <strong>Arguments</strong> </dt><dd> none //ALTHOUGH MAYBE A VCACHE CONTAINING WHICH VOLUME</dd><dt> <strong>Outcome</strong> </dt><dd> Wipe everything on the volume. Dependent on which platform this is is for, as to how it's done</dd></dl> <strong>Errors</strong><ul><li> EINVAL - some of the initial default arguments aren't set</li><li> EIO - the afs daemon hasn't started yet</li></ul><dl><dt> <strong>Side Effects</strong> </dt><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></dl> <p /> <nop><h2><a name="PSetSysName"></a> <span class="twikiNewLink">PSetSysName<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetSysName?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_AFS_SYSNAME (38) - Change @sys value</dd><dt> <strong>Arguments</strong> </dt><dd> a new value for @sys</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EINVAL - if afsd isn't runing</li><li> EINVAL - if the new sysname is too large</li><li> EINVAL - if the new sysname causes issues(starts with a .0 or a ..0 </li><li> EINVAL - if there is no <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAG">PAG</a> set in the credentials</li><li> EINVAL - if the user of a <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAG">PAG</a> can't be found</li><li> EINVAL - if (!(exporter = au-&gt;exporter)) // NOT SURE ON THIS</li><li> ENODEV - if there isn't already a system named that //I THINK</li><li> EACCES - if the user doesn't have super-user credentials</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> local user needs root, remote user does not (because remote user ids aren't trusted)</dd></dl> <p /> <nop><h2><a name="PExportAfs"></a> <span class="twikiNewLink">PExportAfs<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PExportAfs?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_EXPORTAFS (39) - Export afs to nfs clients</dd><dt> <strong>Arguments</strong> </dt><dd> A struct Vic * EIOctl containing export values needed to change between nfs and afs</dd><dt> <strong>Outcome</strong> </dt><dd> //REALLY NOT SURE ON THIS... INPUT WOULD BE NICE</dd></dl> <strong>Errors</strong><ul><li> ENODEV - if the exporter doesn't exist</li><li> EACCES - if the user doesn't have super-user credentials</li></ul> $ <strong>Side Effects</strong>:none listed <p /> <nop><h2><a name="PGetCacheSize"></a> <span class="twikiNewLink">PGetCacheSize<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetCacheSize?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCGETCACHEPARMS (40) - Get cache stats</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Get the cache blocks, and how many of the cache blocks there are</dd></dl> <strong>Errors</strong> <ul><li> none, seemingly</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetVnodeXStatus"></a> <span class="twikiNewLink">PGetVnodeXStatus<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetVnodeXStatus?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOCGETVCXSTATUS (41) - ???</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the initial default arguments aren't set</li><li> EACCES - if access to check the mode bits is denied</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetSPrefs33"></a> <span class="twikiNewLink">PSetSPrefs33<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetSPrefs33?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SETPREFS33 (42) - Set server ranks (deprecated)</dd><dt> <strong>Arguments</strong> </dt><dd> the server preferences to be set</dd><dt> <strong>Outcome</strong> </dt><dd> set the server preferences, calling a function</dd></dl> <strong>Errors</strong> <ul><li> none</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetSPrefs"></a> <span class="twikiNewLink">PGetSPrefs<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetSPrefs?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GETSPREFS (43) - Get server ranks</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> Get the sprefs</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> ENOENT - is the sprefrequest is too large</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGag"></a> PGag </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GAG (44) - Silence Cache Manager</dd><dt> <strong>Arguments</strong> </dt><dd> The flags to either gag or de-gag the cache manager</dd><dt> <strong>Outcome</strong> </dt><dd> set the gag flags, then show these flags</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doesn't have super-user credentials</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PTwiddleRx"></a> <span class="twikiNewLink">PTwiddleRx<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PTwiddleRx?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_TWIDDLE (45) - Adjust RX knobs</dd><dt> <strong>Arguments</strong> </dt><dd> the previous settings of the 'knobs'</dd><dt> <strong>Outcome</strong> </dt><dd> build out the struct rxp, from a struct rx</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doesn't have super-user credentials</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetSPrefs"></a> <span class="twikiNewLink">PSetSPrefs<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetSPrefs?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_SETPREFS (46) - Set server ranks</dd><dt> <strong>Arguments</strong> </dt><dd> the sprefs value to want the sprefs set to</dd><dt> <strong>Outcome</strong> </dt><dd> set the sprefs using the afs_setsprefs() function</dd></dl> <strong>Errors</strong><ul><li> EIO - if the afs daemon hasn't started yet</li><li> EACCES - if the user doesn't have super-user credentials</li><li> EINVAL - if the struct setsprefs is too large</li><li> EINVAL - if the struct setsprefs multiplied by the number of servers is too large</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PStoreBehind"></a> <span class="twikiNewLink">PStoreBehind<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PStoreBehind?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_STORBEHIND (47) Adjust store asynchrony</dd><dt> <strong>Arguments</strong> </dt><dd> sets the sbstruct</dd><dt> <strong>Outcome</strong> </dt><dd> set asynchrony based on a file, from a struct sbstruct //I THINK</dd></dl> <strong>Errors</strong><ul><li> EPERM - if the user doesn't have super-user credentials</li><li> EACCES - if there isn't enough access to not check the mode bits</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGCPAGs"></a> PGCPAGs </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GCPAGS (48) - Disable automatic <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/PAG">PAG</a> gc'ing</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> set the gcpags to GCPAGS_USERDISABLED</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doesn't have super-user credentials</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetInitParams"></a> <span class="twikiNewLink">PGetInitParams<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetInitParams?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_GETINITPARAMS (49) - Get initial cache manager parameters</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> return the initial cache manager parameters</dd></dl> <strong>Errors</strong><ul><li> E2BIG - if the initial parameters are bigger than some PIGGYSIZE</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetCPrefs"></a> <span class="twikiNewLink">PGetCPrefs<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetCPrefs?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GETCPREFS (50) - Get client interface</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> get the information about the client interface</dd></dl> <strong>Errors</strong><ul><li><ul><li> EIO - the afs daemon hasn't started yet</li><li> EINVAL - if the request is too large for the struct that will be holding it</li></ul></li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetCPrefs"></a> <span class="twikiNewLink">PSetCPrefs<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetCPrefs?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_SETCPREFS (51) - Set client interface</dd><dt> <strong>Arguments</strong> </dt><dd> The interfaces you want set</dd><dt> <strong>Outcome</strong> </dt><dd> set the callback interfaces addresses to those of the hosts</dd></dl> <strong>Errors</strong><ul><li> EIO - the afs daemon hasn't started yet</li><li> EINVAL - the input is too large for the struct</li><li> ENOMEM - if there are too many servers</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PFlushMount"></a> <span class="twikiNewLink">PFlushMount<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PFlushMount?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_AFS_FLUSHMOUNT (52) - Flush mount symlink data</dd><dt> <strong>Arguments</strong> </dt><dd> The last part of a path to a mount point, which tells us what to flush</dd><dt> <strong>Outcome</strong> </dt><dd> remove all of the mount data from the dcache regarding a certain mount point</dd></dl> <strong>Errors</strong><ul><li> EINVAL - if some of the initial arguments aren't set</li><li> ENOTDIR - if the initial argument for the mount point isn't a directory</li><li> ENOENT - if the dcache entry isn't set</li></ul> <p /> <p /> <nop><h2><a name="PRxStatProc"></a> <span class="twikiNewLink">PRxStatProc<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PRxStatProc?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_RXSTAT_PROC (53) - Control process RX statistics</dd><dt> <strong>Arguments</strong> </dt><dd> The flags that control which statistics to use</dd><dt> <strong>Outcome</strong> </dt><dd> either enable process RPCStats, disable process RPCStats, or clear the process RPCStats</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doesn't have super-user credentials</li><li> EINVAL - if the flag input is too long</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PRxStatPeer"></a> <span class="twikiNewLink">PRxStatPeer<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PRxStatPeer?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> VIOC_RXSTAT_PEER (54) - Control peer RX statistics</dd><dt> <strong>Arguments</strong> </dt><dd> The flags that control which statistics to use</dd><dt> <strong>Outcome</strong> </dt><dd> either enable peer RPCStats, disable peer RPCStats, or clear the peer RPCStats</dd></dl> <strong>Errors</strong><ul><li> EACCES - if the user doesn't have super-user credentials</li><li> EINVAL - if the flag input is too long</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PGetRxkcrypt"></a> <span class="twikiNewLink">PGetRxkcrypt<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PGetRxkcrypt?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_GETRXKCRYPT (55) - Get rxkad encryption flag</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><dd> get the value of cryptall(presumably whether or not things should be encrypted</dd></dl> <strong>Errors</strong> <ul><li> none</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> <nop><h2><a name="PSetRxkcrypt"></a> <span class="twikiNewLink">PSetRxkcrypt<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetRxkcrypt?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SETRXKCRYPT (56) - Set rxkad encryption flag</dd><dt> <strong>Arguments</strong> </dt><dd> the argument whether or not things should be encrypted</dd><dt> <strong>Outcome</strong> </dt><dd> set whether or not things should be encrypted</dd></dl> <strong>Errors</strong><ul><li> EPERM - if the user doesn't have super-user credentials</li><li> EINVAL - if the input is too big, or if the input is outside the bounds of what it can be set to</li></ul><dl><dt> <strong>Side Effects</strong> </dt><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></dl> <p /> <nop><h2><a name="PSetClientContext"></a> <span class="twikiNewLink">PSetClientContext<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PSetClientContext?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> </h2><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> <span class="twikiNewLink">PsetClientContext<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/PsetClientContext?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> (99) - NFS-PAG pioctl (for knfs/rmtsysd)</dd><dt> <strong>Arguments</strong> </dt><dd> none</dd><dt> <strong>Outcome</strong> </dt><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></dl> <strong>Errors</strong><ul><li> none</li></ul><dl><dt> <strong>Side Effects</strong> </dt><dd> none listed</dd></dl> <p /> //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 <p /><dl><dt> <strong>Group</strong> </dt><dd> V </dd><dt> <strong>Function</strong> </dt><dd> <strong>*reserved*</strong> (239) - Reserved for code expansion</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE1 (240) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_STIE2 (241) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE3 (242) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE4 (243) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE5 (244) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE6 (245) - Reserved for site-specific extensions</dd></dl> <hr /> <dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE7 (246) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_SITE8 (247) - Reserved for site-specific extensions</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE1 (248) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE2 (249) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE3 (250) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE4 (251) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE5 (252) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE6 (253) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE7 (254) - Reserved for implementation use</dd></dl> <hr /><dl><dt> <strong>Group</strong> </dt><dd> V</dd><dt> <strong>Function</strong> </dt><dd> VIOC_PRIVATE8 (255) - Reserved for implementation use</dd></dl> (last changed by JacobThebaultSpieker) 2008-06-20T16:54Z JacobThebaultSpieker 1 updated major http://www.dementia.org/twiki/bin/rdiff/AFSLore/OpenAFSPioctlInterfaceDoc http://www.dementia.org/twiki/bin/rdiff/AFSLore/OpenAFSPioctlInterfaceDoc http://www.dementia.org/twiki/bin/view/AFSLore/AsyncRXProposal?t=2008-06-16T13:09Z <p /> -- <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/JeffreyAltman">JeffreyAltman</a> - 16 Jun 2008 <p /> The AFS File Server request throughput is limited by its current architecture which dedicates one thread per request for the lifetime of the request. Due to the fact that threads may become blocked on disk I/O and (more importantly) on Rx RPCs (VL_*, PR_*, RXAFSCB_*) the dedicated threads are frequently idle when they could be performing real work. The AFS File Server is therefore incapable of taking advantage of the CPU, disk I/O, and network I/O resources available to it. <p /> A more effective architecture is one that is event-driven (or work-flow based). In such an architecture, the File Server would queue requests that are likely to block on I/O or Rx RPCs. The processing thread would then be free to begin processing a new incoming Rx request or continue processing an existing Rx request that has returned to the ready state. <p /> This design is not currently possible because the Rx RPC application programming interfaces only provide for synchronous operations. The following is a proposal to add support for asynchronous requests. This proposal was developed in conjunction with Tom Keiser. <p /> <nop><h2><a name="Provide_an_infrastructure_for_ma"></a> Provide an infrastructure for making Rx event-driven. </h2> <p /> Most of Rx is geared towards a procedural paradigm. Extend Rx to provide several new primitives to allow for operations to be performed in an event-driven manner. Rx has a notion of events presently, but it is designed specifically to provide timeout-based event firing. <p /><ul><li> Generalize the existing rxevent data structure to support asynchronous events in addition to timeout events.</li></ul> <p /><ul><li> Provide a new API to create non-epoch event queues</li></ul> <p /><ul><li> Provide a new API to release events blocked on a queue</li></ul> <p /><ul><li> Provide a new API to block a call object on an Rx event queue</li></ul> <p /><ul><li> Presently, Rx worker threads dispatch <span class="twikiNewLink">RxRPC<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/RxRPC?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> call objects as they arrive. Generalize the worker thread dispatch interface to dispatch any arbitrary event when it becomes ready for processing.</li></ul> <p /><ul><li> The rx_call object will now contain a pointer to an event object. This will be used by asynchronous calls to permit rescheduling of long-lived RPCs.</li></ul> <p /><ul><li> When designing the new APIs, consider the work that was performed by SNA for the instrumentation framework so that future consolidation efforts require minimal effort.</li></ul> <p /><ul><li> New form event objects will have two methods of being processed. First, via a callback function pointer. Secondly, via a synchronous waiter interface.</li></ul> <p /> <p /> <nop><h2><a name="Add_Asynchronous_RX_RPC_server_i"></a> Add Asynchronous RX RPC server interface. </h2> <p /> The present design is completely procedural. When an RPC call is ready to be serviced, a server stub is called. This stub unmarshals the incoming call parameters. Once the parameters are ready, the actual function which services the RPC is called. Upon return of this function, out parameters are marshalled, and the response is sent to the caller. This mode of operation is not generic enough to deal with cases where an in-progress RPC must be suspended pending the result of a long-lived operation (such as an RPC call to the ptserver). This project phase will attempt to decouple these operations so that a server thread may be freed up during the execution of the latent operation. <p /><ul><li> When calls are ready to be serviced, an event object will be enqueued. This event object can be dispatched when a worker thread becomes available. Worker threads will use the synchronous waiter interface to block awaiting calls to service. This change in behavior will, in effect, unify the SQE and rxevent mechanisms.</li></ul> <p /><ul><li> A new "async" keyword will be added to Rxgen. When present, this will emit a special server-side RPC stub. The asynchronous server stub will not automatically marshal output upon return of the user-provided servicing routine. Instead, it will check the state of the event object bound to the Rx call </li></ul> object. If the event object is in the blocked state, then the subroutine will return immediately with no action. Otherwise, the the output arguments will be marshalled, and a response packet sent back to the caller. <p /> To do:<ul><li> add an async_done flag and a async_state integer to rx_call object; provide getter/setter interfaces</li><li> modify rxi_ServerProc() to check call-&gt;done before running after proc and ending call (otherwise assume call has been placed on a blocked queue by user)</li><li> add new rx interface to allow user to move an unblocked, partially finished call back onto the head of the sqe list</li><li> modify rxi_ReceivePacket() to initialize async_state to zero and async_done flag to 1 for new server call case (so that legacy synchronous calls continue to work without modification)</li></ul> <p /> <nop><h2><a name="Add_Asynchronous_RX_RPC_client_i"></a> Add Asynchronous RX RPC client interface. </h2> <p /> The rxgen procedure generator would be modified to optionally produce Asynchronous versions of the existing Synchronous procedure calls. Starting with the RXAFS_xxxx calls used for file server operations. The asynchronous calls would behave similar to the existing calls with the following changes: <p /><ul><li> Provide a non-blocking version of rx_NewCall() which returns an error code when all channels in a Rx connection object are in use.</li></ul> <p /><ul><li> After a message is XDR encoded, instead of calling rxi_EndCall() an asynchronous rxi_EndCallAsync() would be called. rxi_EndCallAsync() would send the message and either immediately return an error or would return a handle to the outstanding call.</li></ul> <p /><ul><li> A new rx_AsyncCallWait() function would be added to the RX library. This function would be passed an existing handle returned by</li></ul> rxi_EndCallAsync() and would permit the caller to check the return status and if desired to block on the response. On the backend, this will use the synchronous event waiter interface from Section 1. <p /><ul><li> A new rx_FetchCompletedCall() function would be added to the RX library. This function would be used to retrieve the next completed asynchronous call. This function will be used to feed a task to an idle worker thread. This function can include parameters that can be used to filter the responses based upon the type of call to permit specialized worker threads. A parameter determines whether or not the call should block or not.</li></ul> <p /><ul><li> Instead of waking up blocked threads when a response is received from a peer as is done for the existing synchronous call model, RX will queue completed asynchronous calls for later querying by rx_FetchCompletedCall().</li></ul> <p /><ul><li> Implement asynchronous versions of multi_RXAFS_xxx calls.</li></ul> <p /><ul><li> Develop asynchronous version of pr_GetCPS() and pr_GetHostCPS().</li></ul> <p /> To do:<ul><li> define an async event handler object and associated getter/setters [1]</li><li> add async event handler pointer to rx_call object; provide getter/setter interfaces</li><li> non-blocking version of rx_NewCall() and associated changes to rxi_NewCall()</li><li> modify rxi_ServerProc() to run callback function for client call types</li><li> run a server thread pool, even if we're just a client (as a convenient way to service async event callback functions)</li><li> make rx_NewCall take an rs_async_event object pointer (NULL value implying synchronous call)</li><li> modify rxgen to optionally emit async client stubs -- the async start stub will XDR encode and then calls rx_FlushWrite() [i <em>think</em> we can safely ignore blocking related to TQ_BUSY]; the async finish stub will XDR decode and <span class="twikiNewLink">EndCall<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/EndCall?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>.</li><li> modify call timeout event handler to call async event handler, if there is one</li></ul> <p /> [1] async event: <p /> rationale: make it future-proof, but only give one generalized option for now. <p /> typedef enum { RX_ASYNC_EVENT_DO_CALLBACK, RX_ASYNC_EVENT_DO_NIL, } rx_async_event_action_t; <p /> typedef enum { RX_ASYNC_EVENT_TYPE_DONE, RX_ASYNC_EVENT_TYPE_ERROR, RX_ASYNC_EVENT_TYPE_TIMEOUT } rx_async_event_type_t; <p /> typedef int rx_async_event_callback_func_t(struct rx_call *, rx_async_event_type_t, void *); <p /> typedef struct { rx_async_event_callback_func_t * fp; void * rock; } rx_async_event_callback_t; <p /> typedef struct { rx_async_event_action_t action; union { rx_async_event_callback_t callback; afs_uint32 pad[15]; /* simultaneously pad it on a typical cache line size, and make the struct large so we could extend in future without abi breakage */ } u; } rx_async_event_t; <p /> #define rx_async_event_SetupNil(event) (event)-&gt;action = RX_ASYNC_EVENT_DO_NIL <p /> #define rx_async_event_SetupCallback(event, func, rock) do { (event)-&gt;action = RX_ASYNC_EVENT_DO_CALLBACK; (event)-&gt;u.callback.fp = (func); (event)-&gt;u.callback.rock = (rock); while (0) <p /> <p /> <nop><h2><a name="Modify_the_File_Server_to_use_as"></a> Modify the File Server to use asynchronous RPCs. </h2> <p /><ul><li> Replace h_GetHost_r() <span class="twikiNewLink">WhoAreYou<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/WhoAreYou?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> probes with asynchronous version. This requires breaking up h_GetHost_r() into pieces that are compatible with the new state machine.</li></ul> <p /><ul><li> Re-write <span class="twikiNewLink">MultiBreakCallBackAlternateAddress<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/MultiBreakCallBackAlternateAddress?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>_r() to use asynchronous version of multi_RXAFSCB_CallBack()</li></ul> <p /><ul><li> Re-write <span class="twikiNewLink">MultiProbeAlternateAddress<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/MultiProbeAlternateAddress?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>_r() to use asynchronous version of multi_RXAFSCB_ProbeUuid()</li></ul> <p /><ul><li> Re-write calls to <span class="twikiNewLink">GetCPS<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/GetCPS?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> and <span class="twikiNewLink">GetHostCPS<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/GetHostCPS?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> to use asynchronous versions.</li></ul> <p /><ul><li> Construct daemon thread that calls rx_FetchCompletedCall() and thread pool of worker threads to which the tasks can be handed off for completion.</li></ul> <p /> To do:<ul><li> rework host holds as an integer refcount</li><li> decouple ubik client structs from threads; provide a global pool of them</li><li> modify call stack from service routine through <span class="twikiNewLink">CallPreamble<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/CallPreamble?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> down to h_GetHost_r to allow returning a flag which signifies call should be blocked pending <span class="twikiNewLink">TellMeAboutYourself<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/TellMeAboutYourself?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>/WhoAreYou completion</li><li> modify call stack from service routine through <span class="twikiNewLink">CallPreamble<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/CallPreamble?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> down to hpr_GetCPS to allow returning a flag which signifies call should be blocked pending ubik_pr_GetCPS completion</li><li> modify server stubs to deal with <span class="twikiNewLink">CallPreamble<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/CallPreamble?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> returning a special "not done" error code, which results in the routine returning immediately with call-&gt;async_done set to zero</li><li> modify server stubs, callpreamable, and relevant parts of host package to check async state value, and potentially jump to a specific line in function (probably with a select case type of construct)</li><li> rework <span class="twikiNewLink">MultiBreakCallBack<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/MultiBreakCallBack?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>_r use async client. initiate calls as quickly as possible; multi_error case and putconn can be handled by callback function</li></ul> <p /> <p /> <p /> <nop><h2><a name="Modify_host_callback_package_loc"></a> Modify host/callback package locking/threading model. </h2> <p /> The existing host/callback package design assumes that a given RPC call will be serviced on the same thread from start to finish. This assumption will no longer be true with asynchronous Rx. We must modify the design to accommodate this new dynamic. <p /><ul><li> Replace host holds bit vector with a reference count</li></ul> <p /><ul><li> per-thread ubik client object is no longer a feasible solution. Instead, we will provide a pool of ubik client objects. Threads will allocate a new object from the pool whenever a call needs to be made.</li></ul> <p /> <p /> <nop><h2><a name="Provide_a_high_level_Rx_session"></a><a name="Provide_a_high_level_Rx_session_"></a> Provide a high level Rx session object. </h2> <p /> Many parts of AFS are constrained by the lack of call parallelism provided with the Rx connection object (4 simultaneous calls). This proposal will provide a new generalized high-level connection handle (which will be called an Rx session for the purposes of this discussion). A session will be a container which contains: one Rx security object; one UUID to identify the peer; an arbitrary number of protocol addresses for the peer; and an arbitrary number of Rx connection objects. <p /><ul><li> design an Rx session data structure</li></ul> <p /><ul><li> Write an Rx session object allocator, deallocator, initializer, and finalizer routines</li></ul> <p /><ul><li> Use Rx session objects in the host/callback package to allow</li></ul> <p /> <p /> <nop><h2><a name="Provide_asynchronous_versions_of"></a> Provide asynchronous versions of rx_Read/rx_Write/rx_Readv/rx_Writev. </h2> <p /> At present, Rx data streaming operations are synchronous. This means that data read and write RPCs will block a thread from start to finish. Over highly latent links, this could become a performance issue. <p /> <nop><h2><a name="Add_asynchronous_support_to_Ubik"></a> Add asynchronous support to Ubik Client: </h2> <p /> To do: <p /><ul><li> add async event handler object pointer to ubik_client structure</li><li> rework rxgen ubik_client code to use async client stubs</li><li> create background thread(s) which handle ubik call timeouts</li><li> callback func checks return code; success can be processed inline; failures get pushed to ubik client background threads [i'm specifying background threads here in order to remove any danger of deadlock due to the fact that rx would be in the call stack twice]</li><li> background threads schedule new async calls against a different site, or against sync site depending on diagnosis of last call</li></ul> (last changed by JeffreyAltman) 2008-06-16T13:09Z JeffreyAltman 1 updated major http://www.dementia.org/twiki/bin/rdiff/AFSLore/AsyncRXProposal http://www.dementia.org/twiki/bin/rdiff/AFSLore/AsyncRXProposal http://www.dementia.org/twiki/bin/view/AFSLore/WindowsAFSServers?t=2008-06-16T03:11Z -- <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/JeffreyAltman">JeffreyAltman</a> - 14 Jun 2008 <p /> This page provides a partial list of the work that must be done to update the AFS Servers on the Microsoft Windows platform. <p /> <nop><h2><a name="NetRestrict_and_NetInfo_configur"></a> <span class="twikiNewLink">NetRestrict<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NetRestrict?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> and <span class="twikiNewLink">NetInfo<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NetInfo?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> configuration files </h2> <p /> The Windows AFS Servers (nor the client) has no support for the AFS <span class="twikiNewLink">NetRestrict<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NetRestrict?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> and <span class="twikiNewLink">NetInfo<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NetInfo?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> files. This makes it very difficult to deploy servers on Windows systems which often include a variety of network adapters beyond just the physical adapter. The location of AFSDIR_SERVER_NETRESTRICT_FILEPATH and AFSDIR_SERVER_NETINFO_FILEPATH have already been defined in src/util/dirpath_nt.h and src/util/dirpath.c. <p /> <nop><h2><a name="The_NT_vol_back_end"></a> The NT vol back end </h2> <p /> The NT vol back end (ntops.c) is based upon the <span class="twikiNewLink">NameI<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NameI?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> back end for UNIX but is designed to work with NTFS. Over the years the UNIX <span class="twikiNewLink">NameI<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NameI?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> back end has received a number of bug fixes and improvements. We need to verify that none of these changes must also be implemented for the NT back end. <a href="http://www.openafs.org/cgi-bin/cvsweb.cgi/openafs/src/vol/namei_ops.c?only_with_tag=MAIN" target="_top">link to namei_ops.c cvs history</a> <p /> Need to modify the mappings of vice partitions to NTFS disk locations. Would prefer to permit arbitrary paths to the current drive letter mapping. <p /> <nop><h2><a name="Missing_command_line_parameters"></a> Missing command line parameters </h2> <p /><ul><li> Enable --syslog option for Windows servers. Consider using a project like <a href="http://syslog-win32.sourceforge.net/" target="_top">http://syslog-win32.sourceforge.net/</a> for linking to the AFS Services. A syslog daemon product such as <a href="http://www.codeproject.com/KB/IP/Syslogd.aspx" target="_top">http://www.codeproject.com/KB/IP/Syslogd.aspx</a> can be used to collect the events.</li></ul> <p /><ul><li> Enable --auditlog option. Must add support for Windows named pipes instead of files.</li></ul> <p /><ul><li> Enable rx configuration options.</li></ul> <p /> <nop><h2><a name="Miscellaneous"></a> Miscellaneous </h2> <p /> There are a number of random comments in the code choosing arbitrary values for Windows. Must replace arbitrary decisions with values based upon the actual capabilities of the system. <p /> <nop><h2><a name="Ignore_kaserver"></a> Ignore kaserver </h2> <p /> Assume that kaserver does not exist. Instead, we will count on the presence of either Active Directory or some external krb5 kdc. <p /> <nop><h2><a name="Viced"></a> Viced </h2> <p /><ul><li> <span class="twikiNewLink">ProcessSize<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/ProcessSize?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> and STATS64_PROCESSSIZE should be set to the Private Bytes allocation for the current process. Use <span class="twikiNewLink">GetProcessMemoryInfo<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/GetProcessMemoryInfo?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>().</li></ul> <p /><ul><li> The arbitrary definiton of NT_OPEN_MAX should be replaced by an attempt to read the value of HKLM\Software\Microsoft\Windows NT\CurrentVersion\Windows\USERProcessHandleQuota which has a default value of 10,000 if the registry value is not present.</li></ul> (last changed by JeffreyAltman) 2008-06-16T03:11Z JeffreyAltman 3 updated major http://www.dementia.org/twiki/bin/rdiff/AFSLore/WindowsAFSServers http://www.dementia.org/twiki/bin/rdiff/AFSLore/WindowsAFSServers http://www.dementia.org/twiki/bin/view/AFSLore/NewProjects?t=2008-06-13T23:24Z <nop><h1><a name="Pending_and_Desired_OpenAFS_Proj"></a> Pending and Desired <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/OpenAFS">OpenAFS</a> Projects </h1> <p /> &#37;TOC&#37; <p /> <nop><h2><a name="Pending_Projects"></a> Pending Projects </h2> <p /> The following are items known to be in progress, and, where available, a point of contact. <p /><ul><li> <span class="twikiNewLink">WindowsIFS<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/WindowsIFS?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- Implement AFS as a Windows installable file system instead of as a virtual SMB server. In Progress. Contact <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/JeffreyAltman">JeffreyAltman</a></li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/WindowsAFSServers">WindowsAFSServers</a> - Stabilize the AFS Servers running on Microsoft Windows. Contact <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/JeffreyAltman">JeffreyAltman</a></li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/DisconnectedOperation">DisconnectedOperation</a> provides the ability to use AFS while not connected to a network.</li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/FreeBSDPort">FreeBSDPort</a> -- Server ported. Cache manager available, not stable yet.</li></ul> <p /><ul><li> <span class="twikiNewLink">HPUX11Port<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/HP-UX11Port?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- Missing RX code reconstructed. Header needed, available from HP. Available in 1.2.10. </li></ul> <p /><ul><li> <span class="twikiNewLink">NetBSDPort<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/NetBSDPort?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- No timeline available.</li></ul> <p /><ul><li> <span class="twikiNewLink">OpenBSDPort<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/OpenBSDPort?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- In progress. Cache manager available, not stable yet.</li></ul> <p /><ul><li> <span class="twikiNewLink">AutoConf<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/AutoConf?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> with automake too. In progress. Contact <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/DerrickBrashear">DerrickBrashear</a>.</li></ul> <p /><ul><li> <span class="twikiNewLink">AmandaBackup<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/AmandaBackup?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- Support for backup using <a href="http://www.amanda.org" target="_top">Amanda</a>. In progress. Contact <span class="twikiNewLink">MitchCollinsworth<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/Main/MitchCollinsworth?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span>.</li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/BetterDocumentation">BetterDocumentation</a> -- Contact <span class="twikiNewLink">RussAllbery<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/Main/RussAllbery?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span></li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/MaemoPort">MaemoPort</a> -- Porting to the Nokia N8x0 Internet Tablet. Contact <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/DerrickBrashear">DerrickBrashear</a> or <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/Main/JasonEdgecombe">JasonEdgecombe</a></li></ul> <p /> <nop><h2><a name="Proposed_Projects"></a> Proposed Projects </h2> <p /> The following are items which have been proposed, but which are not yet in progress. A point of contact is included where appropriate. <p /><ul><li> <span class="twikiNewLink">SupportIPv6<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/SupportIPv6?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span></li></ul> <p /><ul><li> <span class="twikiNewLink">MultipleClones<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/MultipleClones?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> provides support for more than one backup and read-only volume for a single read/write.</li></ul> <p /><ul><li> <a class="twikiLink" href="http://www.dementia.org/twiki/bin/view/AFSLore/SelectableUbikTieBreaker">SelectableUbikTieBreaker</a> -- proposes to change lowest IP metric to something administrator-selectable.</li></ul> <p /><ul><li> <span class="twikiNewLink">VolumeDumpEditor<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/VolumeDumpEditor?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> -- Need tool to allow editing volume dumps.</li></ul> <p /><ul><li> <span class="twikiNewLink">BetterServerPreferences<a rel="nofollow" href="http://www.dementia.org/twiki/bin/edit/AFSLore/BetterServerPreferences?topicparent=AFSLore.WebRss" title="Create this topic">^?</a></span> allow selectable continuous or on-demand&#