INSTALL

   1
   2 Quick Installation Guide for musl libc
   3 ======================================
   4
   5 There are many different ways to install musl depending on your usage
   6 case. This document covers only the build and installation of musl by
   7 itself, which is useful for upgrading an existing musl-based system or
   8 compiler toolchain, or for using the provided musl-gcc wrapper with an
   9 existing non-musl-based compiler.
  10
  11 Building complete native or cross-compiler toolchains is outside the
  12 scope of this INSTALL file. More information can be found on the musl
  13 website and community wiki.
  14
  15
  16 Build Prerequisites
  17 -------------------
  18
  19 The only build-time prerequisites for musl are GNU Make and a
  20 freestanding C99 compiler toolchain targeting the desired instruction
  21 set architecture and ABI, with support for a minimal subset of "GNU C"
  22 extensions consisting mainly of gcc-style inline assembly, weak
  23 aliases, hidden visibility, and stand-alone assembly source files.
  24
  25 GCC, LLVM/clang, Firm/cparser, and PCC have all successfully built
  26 musl, but GCC is the most widely used/tested. Recent compiler (and
  27 binutils) versions should be used if possible since some older
  28 versions have bugs which affect musl.
  29
  30 The system used to build musl does not need to be Linux-based, nor do
  31 the Linux kernel headers need to be available.
  32
  33
  34
  35 Supported Targets
  36 -----------------
  37
  38 musl can be built for the following CPU instruction set architecture
  39 and ABI combinations:
  40
  41 * i386
  42     * Minimum CPU model is actually 80486 unless kernel emulation of
  43       the `cmpxchg` instruction is added
  44
  45 * x86_64
  46     * ILP32 ABI (x32) is available as a separate arch but is still
  47       experimental
  48
  49 * ARM
  50     * EABI, standard or hard-float VFP variant
  51     * Little-endian default; big-endian variants also supported
  52     * Compiler toolchains only support armv4t and later
  53
  54 * AArch64
  55     * Little-endian default; big-endian variants also supported
  56
  57 * MIPS
  58     * ABI is o32
  59     * Big-endian default; little-endian variants also supported
  60     * Default ABI variant uses FPU registers; alternate soft-float ABI
  61       that does not use FPU registers or instructions is available
  62     * MIPS2 or later, or kernel emulation of ll/sc (standard in Linux)
  63       is required
  64
  65 * MIPS64
  66     * ABI is n64 (LP64)
  67     * Big-endian default; little-endian variants also supported
  68     * Default ABI variant uses FPU registers; alternate soft-float ABI
  69       that does not use FPU registers or instructions is available
  70
  71 * PowerPC
  72     * Only 32-bit is supported
  73     * Compiler toolchain must provide 64-bit long double, not IBM
  74       double-double or IEEE quad
  75     * For dynamic linking, compiler toolchain must be configured for
  76       "secure PLT" variant
  77
  78 * SuperH (SH)
  79     * Standard ELF ABI or FDPIC ABI (shared-text without MMU)
  80     * Little-endian by default; big-engian variant also supported
  81     * Full FPU ABI or soft-float ABI is supported, but the
  82       single-precision-only FPU ABI is not
  83
  84 * Microblaze
  85     * Big-endian default; little-endian variants also supported
  86     * Soft-float
  87     * Requires support for lwx/swx instructions
  88
  89 * OpenRISC 1000 (or1k)
  90
  91
  92
  93 Build and Installation Procedure
  94 --------------------------------
  95
  96 To build and install musl:
  97
  98 1. Run the provided configure script from the top-level source
  99    directory, passing on its command line any desired options.
 100
 101 2. Run "make" to compile.
 102
 103 3. Run "make install" with appropriate privileges to write to the
 104    target locations.
 105
 106 The configure script attempts to determine automatically the correct
 107 target architecture based on the compiler being used. For some
 108 compilers, this may not be possible. If detection fails or selects the
 109 wrong architecture, you can provide an explicit selection on the
 110 configure command line.
 111
 112 By default, configure installs to a prefix of "/usr/local/musl". This
 113 differs from the behavior of most configure scripts, and is chosen
 114 specifically to avoid clashing with libraries already present on the
 115 system. DO NOT set the prefix to "/usr", "/usr/local", or "/" unless
 116 you're upgrading libc on an existing musl-based system. Doing so will
 117 break your existing system when you run "make install" and it may be
 118 difficult to recover.
 119
 120
 121
 122 Notes on Dynamic Linking
 123 ------------------------
 124
 125 If dynamic linking is enabled, one file needs to be installed outside
 126 of the installation prefix: /lib/ld-musl-$ARCH.so.1. This is the
 127 dynamic linker. Its pathname is hard-coded into all dynamic-linked
 128 programs, so for the sake of being able to share binaries between
 129 systems, a consistent location should be used everywhere. Note that
 130 the same applies to glibc and its dynamic linker, which is named
 131 /lib/ld-linux.so.2 on i386 systems.
 132
 133 If for some reason it is impossible to install the dynamic linker in
 134 its standard location (for example, if you are installing without root
 135 privileges), the --syslibdir option to configure can be used to
 136 provide a different location
 137
 138 At runtime, the dynamic linker needs to know the paths to search for
 139 shared libraries. You should create a text file named
 140 /etc/ld-musl-$ARCH.path (where $ARCH matches the architecture name
 141 used in the dynamic linker) containing a list of directories where you
 142 want the dynamic linker to search for shared libraries, separated by
 143 colons or newlines. If the dynamic linker has been installed in a
 144 non-default location, the path file also needs to reside at that
 145 location (../etc relative to the chosen syslibdir).
 146
 147 If you do not intend to use dynamic linking, you may disable it by
 148 passing --disable-shared to configure; this also cuts the build time
 149 in half.
 150
 151
 152
 153 Checking for Successful Installation
 154 ------------------------------------
 155
 156 After installing, you should be able to use musl via the musl-gcc
 157 wrapper. For example:
 158
 159 cat > hello.c <<EOF
 160 #include <stdio.h>
 161 int main()
 162 {
 163         printf("hello, world!\n");
 164         return 0;
 165 }
 166 EOF
 167 /usr/local/musl/bin/musl-gcc hello.c
 168 ./a.out
 169
 170 To configure autoconf-based program to compile and link against musl,
 171 set the CC variable to musl-gcc when running configure, as in:
 172
 173 CC=musl-gcc ./configure ...
 174
 175 You will probably also want to use --prefix when building libraries to
 176 ensure that they are installed under the musl prefix and not in the
 177 main host system library directories.