Linux 4.20: do_settimeofday is gone
[openafs.git] / INSTALL
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
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  Configuring
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_linux26
34       alpha_nbsd15, alpha_nbsd16
35       amd64_fbsd_80, amd64_fbsd_81, amd64_fbsd_82, amd64_fbsd_83,
36          amd64_fbsd_84, amd64_fbsd_90, amd64_fbsd_91, amd64_fbsd_92,
37          amd64_fbsd_93, amd64_fbsd_100, amd64_fbsd_101
38       amd64_linux26
39       amd64_nbsd20, amd64_nbsd30, amd64_nbsd40
40       arm_linux26, arm64_linux26
41       hp_ux11i, hp_ux110, hp_ux1123 (See notes below for information on
42          getting missing header)
43       hp_ux102 (Client port possible, but db servers and utilities work)
44       i386_fbsd_80, i386_fbsd_81, i386_fbsd_82, i386_fbsd_83,
45          i386_fbsd_84, i386_fbsd_90, i386_fbsd_91, i386_fbsd_92,
46          i386_fbsd_93, i386_fbsd_100, i386_fbsd_101
47       i386_linux26
48       i386_nbsd15, i386_nbsd16, i386_nbsd20, i386_nbsd21, i386_nbsd30,
49          i386_nbsd40
50       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
51          i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39, i386_obsd40,
52          i386_obsd41
53       i386_umlinux26
54       ia64_hpux1122, ia64_hpux1123
55       ia64_linux26
56       ppc64_linux26
57       ppc_darwin_12, ppc_darwin_13, ppc_darwin_14, ppc_darwin_60,
58          ppc_darwin_70, ppc_darwin_80, ppc_darwin_90
59       ppc_linux26
60       ppc_nbsd16, ppc_nbsd20
61       rs_aix42, rs_aix51, rs_aix52, rs_aix53, rs_aix61
62       s390_linux26
63       s390x_linux26
64       sgi_62, sgi_63, sgi_64, sgi_65 (file server not tested)
65       sparc64_linux26
66       sun4x_58, sun4x_59, sun4x_510, sun4x_511
67          (logging UFS not supported for mixed-use partitions containing
68          client cache)
69       sunx86_58, sunx86_59, sunx86_510, sunx86_511
70          (logging UFS not supported for mixed-use partitions containing
71          client cache)
72       x86_darwin_80, x86_darwin90
73
74    2. Using configure in the top level directory, configure for your
75       AFS system type, providing the necessary flags:
76
77       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
78
79       If you do not have the "configure" script, or if you modify the
80       source files, you can re-create it by running regen.sh.  You will
81       need autoconf to do this.
82
83       For some systems you need also provide the path in which your kernel
84       headers for your configured kernel can be found.  See the
85       system-specific Notes sections below for details.  If you want to
86       build only the user-space programs and servers and not the kernel
87       module, specify the --disable-kernel-module option on the
88       ./configure command line.
89
90       All binaries, except for the 'fileserver' and 'volserver'
91       executables and their 'da' variants, are stripped of their symbol
92       table information by default.  To enable a debugging build, specify
93       the --enable-debug option on the ./configure command line.  This
94       builds with debugging compiler options and disables stripping of
95       binaries.
96
97       You can also use different combinations of --enable-debug and
98       --enable (or --disable)-strip-binaries for finer control.  One can,
99       for example, compile binaries for debug and strip them anyway.
100       Alternatively, one can compile without debug and force the binaries
101       to not be stripped.  Note that these combinations are not
102       necessarily useful.
103
104       The binaries noted above, 'fileserver' and 'volserver' and their
105       'da' variants, will never be stripped, regardless of any options
106       given to configure.
107
108    There are two modes for directory path handling: "Transarc mode" and
109    "default mode":
110
111    - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
112      by putting client configuration files in /usr/vice/etc, and server
113      files in /usr/afs under the traditional directory layout.
114    - In default mode, files are located in standardized locations, usually
115      under $(prefix), which defaults to /usr/local.
116    - Client programs, libraries, and related files always go in standard
117      directories under $(prefix).  This rule covers things that would go
118      into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
119    - Other files get located in the following places:
120
121     Directory     Transarc Mode              Default Mode
122     ============  =========================  ==============================
123     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
124     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
125     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
126     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
127     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
128     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
129     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
130     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
131
132    In default mode, you can change all of the variables named above that
133    do not start with "afs" by passing the flags with the same name to
134    configure.  For example, if you want to install the server binaries in
135    /usr/local/lib/openafs instead of /usr/local/libexec/openafs, pass the
136    --libexecdir=/usr/local/lib flag to configure.
137
138    For additional options, see section I below.
139
140 B  Building
141
142    1. Now, you can build OpenAFS.
143
144       % make
145
146    2. Install your build using either "make install" to install
147       into the current system (you will need to be root, and files
148       will be placed as appropriate for Transarc or standard paths),
149       "make install DESTDIR=/some/path" to install into an alternate
150       directory tree, or if you configured with --enable-transarc-paths
151       make dest to create a complete binary tree in the dest directory
152       under the directory named for the sys_name you built for,
153       e.g. sun4x_57/dest or i386_linux26/dest
154
155    3. As appropriate you can clean up or, if you're using Linux, build for
156       another kernel version.
157
158       To clean up:
159
160       % make clean
161
162 C  Problems
163
164    If you have a problem building this source, you may want to visit
165    http://www.openafs.org/ to see if any problems have been reported
166    or to find out how to get more help.
167
168    Mailing lists have been set up to help; More details can be found
169    on the openafs.org site.
170
171 D  Linux Notes
172
173    With current Linux versions, the /lib/modules/`uname -r`/source symlink
174    will be used to locate the kernel headers, but you will need to have
175    the headers and build system for your kernel installed in order to
176    build the kernel module.  These are usually found in a separate package
177    from the kernel, often called something like linux-headers-<version>.
178
179    For older Linux systems, you may also need to provide the path in which
180    your kernel headers for your configured kernel can be found. This
181    should be the path of the directory containing a child directory named
182    "include". So if your version file were
183    /usr/src/linux/include/linux/version.h you would run:
184
185    % ./configure --with-afs-sysname=i386_linux26 \
186        --with-linux-kernel-headers=/usr/src/linux
187
188    Currently you can build for only one Linux kernel at a time, and the
189    version is extracted from the kernel headers in the root you specify.
190
191    To build for another Linux kernel version, determine the sysname for
192    the system type as defined in step A1 for the other kernel version and
193    then run:
194
195       % ./configure --with-afs-sysname=<sysname> \
196           --with-linux-kernel-headers=/usr/src/linux-3.19-i686
197       % make
198
199    Your build tree will now include an additional kernel module for your
200    additional kernel headers. Be aware that if the kernel version string
201    which UTS_RELEASE is defined to in include/linux/version.h matches the
202    last kernel you built for, the previous kernel module will be
203    overwritten.
204
205    The Linux 2.4 series (and older) are no longer supported. The OpenAFS 1.6
206    series of releases are the last ones supporting those old kernels and in
207    particular their LinuxThreads.
208
209 E  HP-UX 11.0 Notes
210
211    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on
212    their web site.  Go to http://www.hp.com/dspp, choose Software
213    downloads from the side menu, and select Software: HP operating systems
214    and then Operating systems: HP-UX from the select boxes.  The last
215    select box will have an option for downloading vfs_vm.h.
216
217 F  OpenBSD Notes
218
219    If you need to run regen.sh to make the configure script, you should
220    first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
221
222    You need kernel source installed to build OpenAFS.  Use the
223    --with-bsd-kernel-headers= configure option if your kernel source is
224    not in /usr/src/sys.
225
226    src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing
227    the client.  There is no server package, but I am told that "make
228    install" will put server binaries in /usr/afs.
229
230    Your kernel may panic when you try to shutdown after running the
231    OpenAFS client.  To prevent this, change the "dangling vnode" panic in
232    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
233
234    You can't run arla and OpenAFS at the same time.
235
236 G  FreeBSD Notes
237
238    The FreeBSD client supports FreeBSD 8.x and later, but does not receive
239    regular testing on versions older than FreeBSD 9.x at this time.  Only
240    the amd64 and i386 architectures are supported, but it should not be
241    hard to port to other processors if they are already supported under
242    another operating system.
243
244    You need kernel source installed to build OpenAFS.  Use the
245    --with-bsd-kernel-headers= configure option if your kernel source is
246    not in /usr/src/sys.
247
248    You also need access to your kernel build directory for the opt_global.h
249    include file.  Use the --with-bsd-kernel-build= configure option if your
250    kernel build is not GENERIC in the standard place. If
251    /usr/src/sys/${CPUARCH}/compile/GENERIC does not point to
252    /usr/obj/usr/src/sys/GENERIC you may need to resolve that and retry the
253    build.
254
255 H  AIX notes
256
257    Make sure that your default build environment is 32bit, ie.
258    the OBJECT_MODE environment variable is either unset or set to "32".
259
260    Verify this before doing configure and make. For example, assuming
261    ksh/bash:
262
263    % export OBJECT_MODE=32
264
265    To build aklog (in order to be able to get tokens from your Kerberos v5
266    ticket), you will need Kerberos libraries.  On AIX 6.1, the IBM
267    Kerberos v5 libraries are in the packages krb5.client.rte and
268    krb5.toolkit.adt on the Expansion Pack.
269
270 I  Other configure options
271
272    AFS has a ton of other optional features that must be enabled using
273    configure options.  Here is a summary:
274
275    --enable-bigendian
276    --enable-littleendian
277        These configure options are normally not required and should not be
278        given.  They're only needed if the OpenAFS build system cannot
279        determine the endianness of your system, in which case configure
280        will abort and say to use one of these options.
281
282    --enable-bitmap-later
283        Speeds the startup of the fileserver by deferring reading volume
284        bitmaps until necessary.  Demand attach is a better solution to the
285        same problem.
286
287    --enable-checking
288        Enable compiler warnings when building with GCC and turn compiler
289        warnings into errors so that new warnings will cause compilation
290        failures.  If you are developing patches to contribute to OpenAFS,
291        please build OpenAFS with this flag enabled.  Warning-free code is
292        a requirement for all new submissions to OpenAFS.
293
294    --enable-debug
295    --enable-debug-kernel
296    --enable-debug-lwp
297    --enable-debug-pam
298        Compile the userspace code (for --enable-debug) or the code named
299        by the option with debugging information.  If --enable-debug is
300        given, also do not strip binaries when installing them.
301
302    --enable-linux-d_splice_alias-extra-iput
303        Work around a kernel memory leak present in a few Linux kernels.
304        The only affected mainline kernels are 3.17 to 3.17.2, but this
305        switch will also be required should a distribution backport commit
306        908790fa3b779d37365e6b28e3aa0f6e833020c3 or commit
307        95ad5c291313b66a98a44dc92b57e0b37c1dd589 but not the fix in commit
308        51486b900ee92856b977eacfc5bfbe6565028070 from the linux-stable repo
309        (git.kernel.org/cgit/linux/kernel/git/stable/linux-stable.git) or
310        the corresponding changes on other branches. This is impossible to
311        detect automatically. Without this switch, the openafs module will
312        build and work even with affected kernels. But it will leak kernel
313        memory, leading to performance degradation and eventually system
314        failure due to memory exhaustion.
315
316    --enable-linux-syscall-probing
317        OpenAFS now uses keyrings to manage PAGs by default on Linux, which
318        does not require hooking into the system call table.  On older
319        versions of Linux without keyring support, OpenAFS uses groups to
320        manage PAGs and probes for the system call table to hook into it to
321        preserve that group information.  Normally, which method to use is
322        detected automatically, and if keyring support is present, support
323        for system call table probing is not compiled in.  Use this
324        configure option to force inclusion of the system call table
325        probing code even if the kernel appears to support keyrings.
326
327    --enable-namei-fileserver
328        Forces the namei fileserver on platforms (like Solaris 8 and 9)
329        where the inode fileserver is the default.
330
331    --enable-redhat-buildsys
332        Enable compilation of the kernel module for the Red Hat build
333        system kernel.  Use this configure flag when building kernel
334        modules for Red Hat Linux systems.
335
336    --enable-reduced-depends
337        Try to minimize the shared library dependencies encoded in the
338        binaries.  This omits from the link line all the libraries included
339        solely because the Kerberos libraries depend on them and instead
340        links the programs only against libraries whose APIs are called
341        directly.  This will only work with shared Kerberos libraries and
342        will only work on platforms where shared libraries properly encode
343        their own dependencies (such as Linux).  It is intended primarily
344        for building packages for Linux distributions to avoid encoding
345        unnecessary shared library dependencies that make shared library
346        migrations more difficult.  If none of the above made any sense to
347        you, don't bother with this flag.
348
349    --enable-supergroups
350        Enables support of nested groups in the ptserver.  WARNING: Once
351        you make use of this option by nesting one group inside another,
352        the resulting PTS database cannot be correctly and safely used by a
353        ptserver built without this option.  If some of your ptservers were
354        built with this option and some without this option, you will
355        probably corrupt your PTS database.
356
357    --enable-tivoli-tsm
358        Build with the Tivoli TSM API libraries for butc support of the
359        Tivoli backup system.
360
361    --enable-transarc-paths
362        As discussed in A2 above, build for the traditional paths used by
363        the Transarc and IBM AFS distributions instead of the more typical
364        open source /usr/local paths.  Passing this option to configure and
365        then running make dest will generate, in the dest directory, the
366        set of files and directory layout matching a Transarc or IBM AFS
367        tape distribution.
368
369    --enable-warnings
370        Enable compilation warnings when built with GCC.  This is similar
371        to --enable-checking, but new warnings will only be displayed, not
372        cause a build failure.
373
374    It's also possible to disable some standard features.  None of these
375    options are normally needed, but they may be useful in unusual
376    circumstances:
377
378    --disable-kernel-module
379        Even if kernel headers are found, do not attempt to build the
380        kernel module.  On Linux, if you provide this flag, you'll also
381        need to provide --with-afs-sysname, since OpenAFS cannot determine
382        the correct sysname automatically without the kernel headers.
383
384    --disable-optimize
385    --disable-optimize-kernel
386    --disable-optimize-lwp
387    --disable-optimize-pam
388        Disable optimization for the given portion of the OpenAFS code.
389        Usually used either for debugging to avoid code optimization making
390        it harder to use a debugger, or to work around bugs in the compiler
391        optimizers or in the OpenAFS code.
392
393    --disable-pam
394        Do not build the AFS PAM modules.  Normally building them is
395        harmless, but the PAM modules that come with OpenAFS are deprecated
396        and should not be used unless you're still using the OpenAFS
397        kaserver (which is itself deprecated and should not be used).
398
399    --disable-pthreaded-ubik
400        Disable the threaded version of Ubik and install the LWP
401        versions of Ubik servers.
402
403    --disable-strip-binaries
404        Disable stripping of binaries on installation.  You probably want
405        to use --enable-debug instead of this flag to also inclusion of
406        debugging information.
407
408    --disable-unix-sockets
409        Disable use of UNIX domain sockets for fssync.  A TCP connection to
410        localhost will be used instead.
411
412    You may need to pass one or more of the following options to specify
413    paths and locations of files needed by the OpenAFS build process or
414    additional information required by the build process:
415
416    --with-afs-sysname=SYSNAME
417        Specifies the AFS sysname of the target system is SYSNAME.
418        Normally this is determined automatically from the build
419        architecture plus additional information (such as, on Linux, from
420        the kernel headers).  The SYSNAME should be one of the options
421        listed in A2.
422
423    --with-gssapi=DIR
424    --with-gssapi-include=DIR
425    --with-gssapi-lib=DIR
426    --with-krb5[=DIR]
427    --with-krb5-include=DIR
428    --with-krb5-lib=DIR
429        Normally, OpenAFS will automatically build with Kerberos support if
430        Kerberos is found during the build.  If your Kerberos libraries are
431        in an unusual location, however, you may need to pass one or more
432        of these flags.  --with-krb5 forces building with Kerberos support
433        if given and will cause configure to fail if Kerberos is not found.
434        You may optionally specify the root path to your Kerberos
435        installation as an argument to --with-krb5.
436
437        If you have a krb5-config script, it's used to find the flags to
438        build with Kerberos.  If you have no krb5-config script, you can
439        specify the location to the include files with --with-krb5-include
440        and the libraries with --with-krb5-lib.  You may need to do this if
441        Autoconf can't figure out whether to use lib, lib32, or lib64 on
442        your platform.
443
444        --with-gssapi is similar, except for the GSS-API libraries instead
445        of the Kerberos libraries.  If you have to manually set the
446        location of the Kerberos libraries, you may need to do the same
447        thing for the GSS-API libraries.
448
449    --with-libintl=DIR
450    --with-libintl-include=DIR
451    --with-libintl-lib=DIR
452        Specifies the install location of the libintl library, used for
453        internationalization, or separately specifies the location of the
454        header files and libraries.  By default, the default system library
455        paths will be searched.  This library is not required on many
456        platforms.
457
458    --with-roken=PATH
459    --with-roken=internal
460        Specifies the install location of the libroken library.  Specify
461        "internal" to use the embedded libroken library that comes with
462        OpenAFS (the default).  This option is primarily useful for
463        building against a system libroken library if you have one.
464
465    --with-linux-kernel-build=PATH
466    --with-linux-kernel-headers=PATH
467    --with-bsd-kernel-build=PATH
468    --with-bsd-kernel-headers=PATH
469        Specifies the path to the kernel headers and build system.  See the
470        information above for Linux and *BSD systems.
471
472    --with-linux-kernel-packaging
473        Tells the OpenAFS kernel module build system to use conventions
474        appropriate for building modules to include in Linux kernel module
475        packages.  Primarily, this renames the kernel module to openafs.ko
476        rather than libafs-<VERSION>.ko, which is easier to handle in Linux
477        distribution init scripts.
478
479    --with-docbook2pdf=PROGRAM
480        Specifies the program used to convert the DocBook manuals to PDF.
481        Supported choices are fop, dblatex, and docbook2pdf.  By default,
482        the user's path is searched for those programs in that order, and
483        the first one found is used.
484
485    --with-docbook-stylesheets=PATH
486        The location of the DocBook style sheets, used to convert the
487        DocBook manuals to other formats.  By default, a set of likely
488        paths are searched.
489
490    --with-html-xsl=PATH
491        Specifies the XSLT style sheet to convert DocBook manuals into
492        HTML.  The default is html/chunk.xsl.  You may wish to use
493        html/docbook.xsml instead.
494
495    --with-xslt-processor=PROGRAM
496        Specifies the XSLT processor to use to convert the DocBook manuals
497        into HTML.  Supported choices are libxslt, saxon, xalan-j, and
498        xsltproc.  By default, the user's path is searched for those
499        programs in that order, and the first one found is used.
500
501    --with-ctf-tools[=DIR]
502        Location of ctfconvert and ctfmerge. Defaults to detect. These
503        tools create a reduced form of debug information that describes
504        types and function prototypes. This option is only relevant to
505        platforms that provide CTF tools and, at the moment, it is only
506        functional on Solaris (onbld package must be installed).
507
508    There are also some environment variables that you can set to control
509    aspects of the build.  They can be set either on the configure command
510    line (preferred) or in the environment.
511
512    CC
513        The C compiler to use.  Be aware that this is overridden on some
514        architectures that require a specific compiler be used to build the
515        kernel module.  If gcc is used, version 3 or later is required.
516        If clang is used, version 3 or later is required.  (Additional
517        restrictions apply when --enable-checking is used.)
518
519    CFLAGS
520        Additional flags to pass to the C compiler.
521
522    CPP
523        The C preprocessor to use.  Defaults to cpp if found, otherwise
524        $CC -E.
525
526    CPPFLAGS
527        Additional flags to pass to the C preprocessor or compiler.  This
528        is where to put -I options to add paths to the include file search.
529
530    FUSE_CFLAGS
531        Compiler flags required for building applications that use FUSE.
532
533    FUSE_LIBS
534        Libraries required for linking applications that use FUSE.
535
536    KRB5_CONFIG
537        To specify a particular krb5-config script to use, either set the
538        KRB5_CONFIG environment variable or pass it to configure like:
539
540            ./configure KRB5_CONFIG=/path/to/krb5-config
541
542        To not use krb5-config and force library probing even if there is a
543        krb5-config script on your path, set KRB5_CONFIG to a nonexistent
544        path:
545
546            ./configure KRB5_CONFIG=/nonexistent
547
548    LDFLAGS
549        Additional flags to pass to the linker.  This is where to put -L
550        options to add paths to the library search.
551
552    LIBS
553        Additional libraries to link all userspace programs with.
554
555    PKG_CONFIG
556        The path to the pkg-config utility.  Currently, this is only used
557        to locate the flags for building the FUSE version of afsd.
558
559    YACC
560        The yacc implementation to use.  Defaults to bison, byacc, or yacc,
561        whichever is found first.
562
563    YFLAGS
564        Additional flags to pass to yacc.