doc/arla.texi

   1 \input texinfo @c -*- texinfo -*-
   2 @c Copyright (c) 1998 - 2005 Kungliga Tekniska Högskolan
   3 @c (Royal Institute of Technology, Stockholm, Sweden).
   4 @c All rights reserved.
   5
   6 @c %**start of header
   7 @c $Id$
   8 @setfilename arla.info
   9 @settitle ARLA
  10 @iftex
  11 @afourpaper
  12 @end iftex
  13 @c some sensible characters, please?
  14 @tex
  15 \input latin1.tex
  16 @end tex
  17 @setchapternewpage on
  18 @syncodeindex pg cp
  19 @c %**end of header
  20
  21 @ifinfo
  22 @dircategory Arla
  23 @direntry
  24 * Arla: (arla).           Arla - A Free AFS Implementation
  25 @end direntry
  26 @end ifinfo
  27
  28 @c title page
  29 @titlepage
  30 @iftex
  31 @image{arla-logo}
  32 @sp 5
  33 @end iftex
  34
  35 @ifnottex
  36 @title Arla
  37 @end ifnottex
  38
  39 @subtitle A Free AFS implementation from KTH
  40 @subtitle Edition 0.3, for version 0.36
  41 @subtitle 1999 - 2002
  42
  43 @author Love Hörnquist-Åstrand
  44 @author Assar Westerlund
  45 @author Harald Barth
  46 @author last updated $Date$
  47
  48 @comment This text will show up in the output of texi2html
  49 @def@fnotsupported{THIS TEXT MAY CONTAIN GARBLED OUTPUT BECAUSE THIS VIEW FORMAT DOES NOT SUPPORT TEXI FUNCTIONS}
  50
  51 @def@copynext{@vskip 20pt plus 1fil@penalty-1000}
  52 @def@copyrightstart{}
  53 @def@copyrightend{}
  54
  55 @page
  56 @copyrightstart
  57 @example
  58
  59 Copyright (c) 1995 - 2006 Kungliga Tekniska Högskolan
  60 (Royal Institute of Technology, Stockholm, Sweden).
  61 All rights reserved.
  62
  63 Redistribution and use in source and binary forms, with or without
  64 modification, are permitted provided that the following conditions
  65 are met:
  66
  67 1. Redistributions of source code must retain the above copyright
  68    notice, this list of conditions and the following disclaimer.
  69
  70 2. Redistributions in binary form must reproduce the above copyright
  71    notice, this list of conditions and the following disclaimer in the
  72    documentation and/or other materials provided with the distribution.
  73
  74 3. Neither the name of the Institute nor the names of its contributors
  75    may be used to endorse or promote products derived from this software
  76    without specific prior written permission.
  77
  78 THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
  79 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  80 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  81 ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
  82 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  83 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  84 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  85 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  86 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  87 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  88 SUCH DAMAGE.
  89
  90 @end example
  91
  92 @copynext
  93 @example
  94 /*
  95  * Copyright (c) 2002 - 2006 Stockholms Universitet
  96  * (Stockholm University, Stockholm Sweden)
  97  * All rights reserved.
  98  *
  99  * Redistribution and use in source and binary forms, with or without
 100  * modification, are permitted provided that the following conditions
 101  * are met:
 102  *
 103  * 1. Redistributions of source code must retain the above copyright
 104  *    notice, this list of conditions and the following disclaimer.
 105  *
 106  * 2. Redistributions in binary form must reproduce the above copyright
 107  *    notice, this list of conditions and the following disclaimer in the
 108  *    documentation and/or other materials provided with the distribution.
 109  *
 110  * 3. Neither the name of the university nor the names of its contributors
 111  *    may be used to endorse or promote products derived from this software
 112  *    without specific prior written permission.
 113  *
 114  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 115  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 116  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 117  * ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 118  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 119  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 120  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 121  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 122  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 123  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 124  * POSSIBILITY OF SUCH DAMAGE.
 125  */
 126 @end example
 127
 128 @copynext
 129 @example
 130
 131 Copyright (c) 1988, 1990, 1993
 132      The Regents of the University of California.  All rights reserved.
 133
 134 Redistribution and use in source and binary forms, with or without
 135 modification, are permitted provided that the following conditions
 136 are met:
 137
 138 1. Redistributions of source code must retain the above copyright
 139    notice, this list of conditions and the following disclaimer.
 140
 141 2. Redistributions in binary form must reproduce the above copyright
 142    notice, this list of conditions and the following disclaimer in the
 143    documentation and/or other materials provided with the distribution.
 144
 145 3. All advertising materials mentioning features or use of this software
 146    must display the following acknowledgement:
 147      This product includes software developed by the University of
 148      California, Berkeley and its contributors.
 149
 150 4. Neither the name of the University nor the names of its contributors
 151    may be used to endorse or promote products derived from this software
 152    without specific prior written permission.
 153
 154 THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 155 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 156 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 157 ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 158 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 159 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 160 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 161 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 162 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 163 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 164 SUCH DAMAGE.
 165
 166 @end example
 167 @copynext
 168 @example
 169
 170 Copyright 1992 Simmule Turner and Rich Salz.  All rights reserved.
 171
 172 This software is not subject to any license of the American Telephone
 173 and Telegraph Company or of the Regents of the University of California.
 174
 175 Permission is granted to anyone to use this software for any purpose on
 176 any computer system, and to alter it and redistribute it freely, subject
 177 to the following restrictions:
 178
 179 1. The authors are not responsible for the consequences of use of this
 180    software, no matter how awful, even if they arise from flaws in it.
 181
 182 2. The origin of this software must not be misrepresented, either by
 183    explicit claim or by omission.  Since few users ever read sources,
 184    credits must appear in the documentation.
 185
 186 3. Altered versions must be plainly marked as such, and must not be
 187    misrepresented as being the original software.  Since few users
 188    ever read sources, credits must appear in the documentation.
 189
 190 4. This notice may not be removed or altered.
 191
 192
 193 @end example
 194 @copynext
 195 @example
 196
 197 COPYRIGHT  (C)  1998
 198 THE REGENTS OF THE UNIVERSITY OF MICHIGAN
 199 ALL RIGHTS RESERVED
 200
 201 PERMISSION IS GRANTED TO USE, COPY, CREATE DERIVATIVE WORKS
 202 AND REDISTRIBUTE THIS SOFTWARE AND SUCH DERIVATIVE WORKS
 203 FOR ANY PURPOSE, SO LONG AS THE NAME OF THE UNIVERSITY OF
 204 MICHIGAN IS NOT USED IN ANY ADVERTISING OR PUBLICITY
 205 PERTAINING TO THE USE OR DISTRIBUTION OF THIS SOFTWARE
 206 WITHOUT SPECIFIC, WRITTEN PRIOR AUTHORIZATION.  IF THE
 207 ABOVE COPYRIGHT NOTICE OR ANY OTHER IDENTIFICATION OF THE
 208 UNIVERSITY OF MICHIGAN IS INCLUDED IN ANY COPY OF ANY
 209 PORTION OF THIS SOFTWARE, THEN THE DISCLAIMER BELOW MUST
 210 ALSO BE INCLUDED.
 211
 212 THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION
 213 FROM THE UNIVERSITY OF MICHIGAN AS TO ITS FITNESS FOR ANY
 214 PURPOSE, AND WITHOUT WARRANTY BY THE UNIVERSITY OF
 215 MICHIGAN OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
 216 WITHOUT LIMITATION THE IMPLIED WARRANTIES OF
 217 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
 218 REGENTS OF THE UNIVERSITY OF MICHIGAN SHALL NOT BE LIABLE
 219 FOR ANY DAMAGES, INCLUDING SPECIAL, INDIRECT, INCIDENTAL, OR
 220 CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM ARISING
 221 OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN
 222 IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF
 223 SUCH DAMAGES.
 224
 225 @end example
 226 @copynext
 227 @example
 228
 229 /*
 230 ****************************************************************************
 231 *        Copyright IBM Corporation 1988, 1989 - All Rights Reserved        *
 232 *                                                                          *
 233 * Permission to use, copy, modify, and distribute this software and its    *
 234 * documentation for any purpose and without fee is hereby granted,         *
 235 * provided that the above copyright notice appear in all copies and        *
 236 * that both that copyright notice and this permission notice appear in     *
 237 * supporting documentation, and that the name of IBM not be used in        *
 238 * advertising or publicity pertaining to distribution of the software      *
 239 * without specific, written prior permission.                              *
 240 *                                                                          *
 241 * IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL *
 242 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL IBM *
 243 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY      *
 244 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER  *
 245 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING   *
 246 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.    *
 247 ****************************************************************************
 248 */
 249
 250 @end example
 251 @copynext
 252 @example
 253
 254 /*
 255  * Copyright (c) 2004 Dale Rahn. All rights reserved.
 256  *
 257  * Redistribution and use in source and binary forms, with or without
 258  * modification, are permitted provided that the following conditions
 259  * are met:
 260  * 1. Redistributions of source code must retain the above copyright
 261  *    notice, this list of conditions and the following disclaimer.
 262  * 2. Redistributions in binary form must reproduce the above copyright
 263  *    notice, this list of conditions and the following disclaimer in the
 264  *    documentation and/or other materials provided with the distribution.
 265  *
 266  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 267  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 268  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 269  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 270  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 271  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 272  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 273  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 274  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 275  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 276  */
 277
 278 @end example
 279 @copynext
 280 @example
 281
 282 /*
 283  * Copyright (c) 2004, Miodrag Vallat.
 284  *
 285  * Redistribution and use in source and binary forms, with or without
 286  * modification, are permitted provided that the following conditions
 287  * are met:
 288  * 1. Redistributions of source code must retain the above copyright
 289  *    notice, this list of conditions and the following disclaimer.
 290  * 2. Redistributions in binary form must reproduce the above copyright
 291  *    notice, this list of conditions and the following disclaimer in the
 292  *    documentation and/or other materials provided with the distribution.
 293  *
 294  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 295  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 296  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 297  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 298  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 299  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 300  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 301  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 302  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 303  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 304  * POSSIBILITY OF SUCH DAMAGE.
 305  */
 306
 307 @end example
 308 @copynext
 309 @example
 310
 311 /*
 312  * Copyright (c) 2006 Theo de Raadt
 313  *
 314  * Redistribution and use in source and binary forms, with or without
 315  * modification, are permitted provided that the following conditions
 316  * are met:
 317  * 1. Redistributions of source code must retain the above copyright
 318  *    notice, this list of conditions and the following disclaimer.
 319  * 2. Redistributions in binary form must reproduce the above copyright
 320  *    notice, this list of conditions and the following disclaimer in the
 321  *    documentation and/or other materials provided with the distribution.
 322  *
 323  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 324  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 325  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 326  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 327  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 328  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 329  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 330  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 331  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 332  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 333  * POSSIBILITY OF SUCH DAMAGE.
 334  */
 335 @end example
 336
 337 @copyrightend
 338 @end titlepage
 339
 340 @c Less filling! Tastes great!
 341 @iftex
 342 @parindent=0pt
 343 @global@parskip 6pt plus 1pt
 344 @global@chapheadingskip = 15pt plus 4pt minus 2pt
 345 @global@secheadingskip = 12pt plus 3pt minus 2pt
 346 @global@subsecheadingskip = 9pt plus 2pt minus 2pt
 347 @end iftex
 348 @ifinfo
 349 @paragraphindent 0
 350 @end ifinfo
 351
 352 @ifinfo
 353 @node Top,  , (dir), (dir)
 354 @comment  node-name,  next,  previous,  up
 355 @top Arla
 356
 357 Arla is a free AFS implementation from KTH.
 358
 359 Please send comments (and fixes) on this manual and the arla programs to
 360 @email{arla-drinkers@@stacken.kth.se}.
 361
 362 @end ifinfo
 363
 364 @menu
 365 * Introduction::                Introduction to Arla.
 366 * AFS infrastructure::          A description of the afs infrastructure.
 367 * Organization of data::        How different data is organized in AFS.
 368 * AFS and the real world::      Common problems and their solutions.
 369 * Parts of Arla::               Description of different parts of arla.
 370 * Debugging::                   How to debug arla when its not working.
 371 * Porting::                     That you need to know to port arla.
 372 * Programming::                 Programming documentation of arla.
 373 * Oddities::                    Strange things that did happen to us.
 374 * Arla timeline::               Short timeline of arla.
 375 * Authors::                     The authors of arla.
 376 * Acknowledgments::             People that have helped us.
 377 * Index::                       Index.
 378 @c * Building and Installing::
 379 @c * Unreleased parts of the arla suite::
 380
 381 @detailmenu
 382
 383  --- The Detailed Node Listing ---
 384
 385 * Introduction::
 386 * AFS infrastructure::
 387
 388 How data and servers are organized in AFS.
 389
 390 * Requirements::
 391 * Data organization::
 392 * Callbacks::
 393 * Volume management::
 394 * Relationship between pts uid and unix uid::
 395
 396 How to cope with reality
 397
 398 * NAT::
 399 * Samba::
 400 * Integration with Kerberos::
 401 * Kerberos tickets and AFS tokens::
 402
 403 The parts of arla
 404
 405 * How arla works::
 406 * The relation between Arlad and NNPFS::
 407 * The life of a file::
 408 * Tools and libs::
 409 * The files in arlad/::
 410 * pioctl and kafs::
 411
 412 How to debug arla when its not working
 413
 414 * Arlad::
 415 * Debugging LWP with GDB::
 416 * nnpfs::
 417 * nnpfs on linux::
 418 * Debugging techniques::
 419 * Kernel debuggers::
 420 * Darwin/MacOS X::
 421
 422 Porting arla
 423
 424 * Porting::
 425 * Porting user-space::
 426 * Porting NNPFS::
 427
 428 Programming
 429
 430 * Programming::
 431 * Disco with arla::
 432 * afsUUID::
 433 @c * NNPFS interface::
 434
 435 Odd stuff you find when looking around
 436
 437 * Oddities::
 438
 439 Miscellaneous
 440
 441 * Arla timeline::
 442 * Authors::
 443 * Acknowledgments::
 444
 445 * Index::
 446
 447 @end detailmenu
 448 @end menu
 449
 450 @contents
 451
 452 @include intro.texi
 453 @c @include install.texi
 454 @include afs-basics.texi
 455 @include storage.texi
 456 @include real-world.texi
 457 @include partsofarla.texi
 458 @include debugging.texi
 459 @include porting.texi
 460 @include prog.texi
 461 @include oddities.texi
 462 @include timeline.texi
 463 @include authors.texi
 464 @include ack.texi
 465 @include index.texi
 466
 467 @bye