README

   1 Copyright 2000, International Business Machines Corporation and others.
   2 All Rights Reserved.
   3
   4 This software has been released under the terms of the IBM Public
   5 License.  For details, see the LICENSE file in the top-level source
   6 directory or online at http://www.openafs.org/dl/license10.html
   7
   8 Short instructions for sites upgrading from a previous version of AFS:
   9 % ./configure --enable-transarc-paths
  10 % make
  11 % make dest
  12
  13 will create a Transarc-style dest tree in ${SYS_NAME}/dest where
  14 ${SYS_NAME} is the AFS sysname of the system you built for.
  15 This assumes if you're building for Linux that your kernel source is
  16 in /usr/src/linux.
  17
  18 Otherwise, please read on.
  19
  20 Building OpenAFS on UNIX and LINUX
  21 ----------------------------------
  22
  23 A. Creating the proper directory structure.
  24
  25    Uncompress the source into a directory of your choice. A directory
  26    in afs space is also valid. In the directory that you uncompressed the
  27    source in, you will only have an src/ directory.
  28
  29    1. Pick a system to build for, and note its default AFS sys_name.
  30       A directory will be automatically created for binaries to be written
  31       into with this name when you build.
  32
  33       alpha_dux40
  34       alpha_dux50 (only tested on 5.0A, does not work with 5.1)
  35       i386_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
  36          i386_fbsd_46, i386_fbsd_47, i386_fbsd_50, i386_fbsd_51,
  37          i386_fbsd_52, i386_fbsd_53, i386_fbsd_60, i386_fbsd_61
  38          (client does not work)
  39       i386_linux22, i386_linux24, i386_linux26
  40       i386_umlinux22, i386_umlinux24
  41       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
  42          i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39
  43       rs_aix42
  44       sgi_65 (file server not tested)
  45       sun4_413 (No client support, no fileserver support, db servers only)
  46       sun4x_56, sun4x_57, sun4x_58, sun4x_59, sun4x_510,
  47       sunx86_57, sunx86_58, sunx86_59, sunx86_510 (logging UFS not supported
  48          for mixed-use partitions containing client cache)
  49       ppc_darwin_70
  50       ppc_linux22, ppc_linux24
  51       alpha_linux22, alpha_linux24
  52       ia64_linux24, ia64_linux26
  53       sparc_linux22, sparc_linux24
  54       sparc64_linux22, sparc64_linux24
  55       hp_ux11i, hp_ux110 (See notes below for information on getting
  56          missing header)
  57       hp_ux102 (Client port possible, but db servers and utilities work)
  58
  59    2. Using configure in the top level directory, configure for your
  60       AFS system type, providing the necessary flags:
  61       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
  62
  63       If you do not have the "configure" script you can re-create it by
  64       running regen.sh.  You will need autoconf to do this.
  65
  66       For some systems you need also provide the path in which your kernel
  67       headers for your configured kernel can be found.  See the
  68       system-specific Notes sections below for details.
  69
  70       There is an option to control whether or not binaries are stripped
  71       of their symbol table information.  All binaries, except for the
  72       'fileserver' and 'volserver' executables, are stripped by default.
  73
  74       To prevent stripping, specify the '--disable-strip-binaries' option on
  75       the ./configure command line.
  76
  77       This option works alongside the existing --enable-debug option to
  78       control how binaries are produced.  When --enable-debug is specified,
  79       binaries will not be stripped.  This behavior can be modified by
  80       using different combinations of --enable-debug and --enable (or
  81       --disable)-strip-binaries.  One can, for example, compile binaries for
  82       debug and strip them anyway.  Alternatively, one can compile without
  83       debug and force the binaries to not be stripped.  Note that these
  84       combinations are not necessarily useful.
  85
  86       If neither of these options is specified, the default will be to build
  87       non-debug binaries that are stripped (with the exceptions noted above,
  88       which are never stripped at present).  Specifying --enable-debug also
  89       turns on --disable-strip-binaries.  These are the most useful settings.
  90
  91       The two binaries noted above, 'fileserver' and 'volserver' will never
  92       be stripped, regardless of any options given to configure.
  93
  94   There are two modes for directory path handling: "Transarc mode" and "default mode":
  95   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
  96     by putting client configuaration files in /usr/vice/etc, and server
  97     files in /usr/afs under the traditional directory layout.
  98   - In default mode, files are located in standardized locations, usually
  99     under $(prefix).
 100   - Client programs, libraries, and related files always go in standard
 101     directories under $(prefix).  This rule covers things that would go
 102     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
 103   - Other files get located in the following places:
 104
 105     Directory     Transarc Mode              Default Mode
 106     ============  =========================  ==============================
 107     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
 108     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
 109     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
 110     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
 111     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
 112     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
 113     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
 114     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
 115
 116
 117     The Demand Attach Fileserver (DAFS), is built by providing the
 118     --enable_demand_attach_fs argument to configure.  Note that the
 119     bosserver must be built with DAFS in order to be able to create
 120     the dafs instance, which will be used in place of the fs instance.  In
 121     addition, the fileserver, volserver, salvager, salvage, and salvageserver
 122     binaries must be built for DAFS.
 123
 124 B  Building
 125
 126    1. Now, you can build OpenAFS.
 127
 128       % make
 129
 130    2. Install your build using either "make install" to install
 131       into the current system (you will need to be root, and files
 132       will be placed as appropriate for Transarc or standard paths),
 133       "make install DESTDIR=/some/path" to install into an alternate
 134       directory tree, or if you configured with --enable-transarc-paths
 135       make dest to create a complete binary tree in the dest directory
 136       under the directory named for the sys_name you built for,
 137       e.g. sun4x_57/dest or i386_linux22/dest
 138
 139    2. As appropriate you can clean up or, if you're using Linux, build for
 140       another kernel version.
 141       To clean up:
 142          % make clean
 143
 144 C  Problems
 145
 146    If you have a problem building this source, you may want to visit
 147    http://www.openafs.org/ to see if any problems have been reported
 148    or to find out how to get more help.
 149
 150    Mailing lists have been set up to help; More details can be found
 151    on the openafs.org site.
 152
 153 D  Linux Notes
 154
 155    For Linux systems you need also provide the path in which your
 156    kernel headers for your configured kernel can be found. This should
 157    be the path of the directory containing a child directory named
 158    "include". So if your version file was
 159    /usr/src/linux/include/linux/version.h you would invoke:
 160    % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
 161
 162    Currently you can build for only one Linux kernel at a time,
 163    and the version is extracted from the kernel headers in the root
 164    you specify.
 165
 166    To build for another Linux kernel version:
 167    the system type defined in step A1.
 168       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
 169       % make
 170
 171    Your dest tree will now include an additional kernel module for your
 172    additional kernel headers. Be aware that if the kernel version string
 173    which UTS_RELEASE is defined to in include/linux/version.h matches the
 174    last kernel you built for, the previous kernel module will be
 175    overwritten.
 176
 177 E  HP-UX 11.0 Notes
 178
 179    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
 180    web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
 181    To navigate down from the top level of the portal, one would do
 182
 183         www.hp.com/dspp -> i want to... -> download software -> operating systems
 184
 185    to get to the same page.
 186
 187 F  OpenBSD Notes
 188
 189    If you need to run regen.sh to make the configure script, you should
 190    first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
 191
 192    You need kernel source installed to build OpenAFS.  Use the
 193    --with-bsd-kernel-headers= configure option if your kernel source is not
 194    in /usr/src/sys.
 195
 196    If you want to build src/aklog, add the following options to your
 197    configure.  Note that you shouldn't need aklog because heimdal afslog
 198    does (almost) the same thing.
 199      --with-krb5 KRB5CFLAGS=-I/usr/include/kerberosV KRB5LIBS=-lcrypto
 200
 201    src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing the
 202    client.  There is no server package, but I am told that "make install"
 203    will put server binaries in /usr/afs.
 204
 205    Your kernel may panic when you try to shutdown after running the OpenAFS
 206    client.  To prevent this, change the "dangling vnode" panic in
 207    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
 208
 209    You can't run arla and OpenAFS at the same time.
 210
 211 G  FreeBSD Notes
 212
 213    The FreeBSD client does not currently work.  The remaining problems
 214    mostly have to do with locking, vnode refcounting, and packaging.  The
 215    server should work.
 216
 217    You need kernel source installed to build OpenAFS.  Use the
 218    --with-bsd-kernel-headers= configure option if your kernel source is not
 219    in /usr/src/sys.
 220
 221    You also need access to your kernel build directory for the opt_global.h
 222    include file.  Use the --with-bsd-kernel-build= configure option if your
 223    kernel build is not GENERIC in the standard place.
 224
 225    There is no server package, but I am told that "make install" will put
 226    server binaries in /usr/afs.
 227
 228    You can't run arla and OpenAFS at the same time.