GNU Linux-libre 4.19.211-gnu1
[releases.git] / Documentation / admin-guide / README.rst
1 .. _readme:
2
3 GNU Linux-libre <http://linux-libre.fsfla.org>
4 ==============================================
5
6 These are the release notes for GNU Linux-libre.  Read them carefully,
7 as they tell you what this is all about, explain how to install the
8 kernel, and what to do if something goes wrong.
9
10 What is GNU Linux-libre?
11 ------------------------
12
13   GNU Linux-libre is a Free version of the kernel Linux (see below),
14   suitable for use with the GNU Operating System in 100% Free
15   GNU/Linux-libre System Distributions.
16   http://www.gnu.org/distros/
17
18   It removes non-Free components from Linux, that are disguised as
19   source code or distributed in separate files.  It also disables
20   run-time requests for non-Free components, shipped separately or as
21   part of Linux, and documentation pointing to them, so as to avoid
22   (Free-)baiting users into the trap of non-Free Software.
23   http://www.fsfla.org/anuncio/2010-11-Linux-2.6.36-libre-debait
24
25   Linux-libre started within the gNewSense GNU/Linux distribution.
26   It was later adopted by Jeff Moe, who coined its name, and in 2008
27   it became a project maintained by FSF Latin America.  In 2012, it
28   became part of the GNU Project.
29
30   The GNU Linux-libre project takes a minimal-changes approach to
31   cleaning up Linux, making no effort to substitute components that
32   need to be removed with functionally equivalent Free ones.
33   Nevertheless, we encourage and support efforts towards doing so.
34   http://libreplanet.org/wiki/LinuxLibre:Devices_that_require_non-free_firmware
35
36   Our mascot is Freedo, a light-blue penguin that has just come out
37   of the shower.  Although we like penguins, GNU is a much greater
38   contribution to the entire system, so its mascot deserves more
39   promotion.  See our web page for their images.
40   http://linux-libre.fsfla.org/
41
42   If you are the author of an awesome program and want to join us in
43   writing Free (libre) Software, please consider making it an official
44   GNU program and become a GNU Maintainer.  You can find instructions
45   on how to do so at https://www.gnu.org/help/evaluation.  We look
46   forward to hacking with you! :)
47
48 What is Linux?
49 --------------
50
51   Linux is a clone of the Unix kernel, written from scratch by
52   Linus Torvalds with assistance from a loosely-knit team of hackers across
53   the Net. It aims towards POSIX and Single UNIX Specification compliance.
54
55   It has all the features you would expect in a modern fully-fledged Unix kernel,
56   including true multitasking, virtual memory, shared libraries, demand
57   loading, shared copy-on-write executables, proper memory management,
58   and multistack networking including IPv4 and IPv6.
59
60   It is distributed under the GNU General Public License v2 - see the
61   accompanying COPYING file for more details.
62
63 On what hardware does it run?
64 -----------------------------
65
66   Although originally developed first for 32-bit x86-based PCs (386 or higher),
67   today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
68   UltraSPARC, Motorola 68000, PowerPC, PowerPC64, ARM, Hitachi SuperH, Cell,
69   IBM S/390, MIPS, HP PA-RISC, Intel IA-64, DEC VAX, AMD x86-64 Xtensa, and
70   ARC architectures.
71
72   Linux is easily portable to most general-purpose 32- or 64-bit architectures
73   as long as they have a paged memory management unit (PMMU) and a port of the
74   GNU C compiler (gcc) (part of The GNU Compiler Collection, GCC). Linux has
75   also been ported to a number of architectures without a PMMU, although
76   functionality is then obviously somewhat limited.
77   Linux has also been ported to itself. You can now run the kernel as a
78   userspace application - this is called UserMode Linux (UML).
79
80 Documentation
81 -------------
82
83  - There is a lot of documentation available both in electronic form on
84    the Internet and in books, both Linux-specific and pertaining to
85    general UNIX questions.  I'd recommend looking into the documentation
86    subdirectories on any Linux FTP site for the LDP (Linux Documentation
87    Project) books.  This README is not meant to be documentation on the
88    system: there are much better sources available.
89
90  - There are various README files in the Documentation/ subdirectory:
91    these typically contain kernel-specific installation notes for some
92    drivers for example. See Documentation/00-INDEX for a list of what
93    is contained in each file.  Please read the
94    :ref:`Documentation/process/changes.rst <changes>` file, as it
95    contains information about the problems, which may result by upgrading
96    your kernel.
97
98 Installing the kernel source
99 ----------------------------
100
101  - If you install the full sources, put the kernel tarball in a
102    directory where you have permissions (e.g. your home directory) and
103    unpack it::
104
105      xz -cd linux-4.X.tar.xz | tar xvf -
106
107    Replace "X" with the version number of the latest kernel.
108
109    Do NOT use the /usr/src/linux area! This area has a (usually
110    incomplete) set of kernel headers that are used by the library header
111    files.  They should match the library, and not get messed up by
112    whatever the kernel-du-jour happens to be.
113
114  - You can also upgrade between 4.x releases by patching.  Patches are
115    distributed in the xz format.  To install by patching, get all the
116    newer patch files, enter the top level directory of the kernel source
117    (linux-4.X) and execute::
118
119      xz -cd ../patch-4.x.xz | patch -p1
120
121    Replace "x" for all versions bigger than the version "X" of your current
122    source tree, **in_order**, and you should be ok.  You may want to remove
123    the backup files (some-file-name~ or some-file-name.orig), and make sure
124    that there are no failed patches (some-file-name# or some-file-name.rej).
125    If there are, either you or I have made a mistake.
126
127    Unlike patches for the 4.x kernels, patches for the 4.x.y kernels
128    (also known as the -stable kernels) are not incremental but instead apply
129    directly to the base 4.x kernel.  For example, if your base kernel is 4.0
130    and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
131    and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
132    want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
133    patch -R) **before** applying the 4.0.3 patch. You can read more on this in
134    :ref:`Documentation/process/applying-patches.rst <applying_patches>`.
135
136    Alternatively, the script patch-kernel can be used to automate this
137    process.  It determines the current kernel version and applies any
138    patches found::
139
140      linux/scripts/patch-kernel linux
141
142    The first argument in the command above is the location of the
143    kernel source.  Patches are applied from the current directory, but
144    an alternative directory can be specified as the second argument.
145
146  - Make sure you have no stale .o files and dependencies lying around::
147
148      cd linux
149      make mrproper
150
151    You should now have the sources correctly installed.
152
153 Software requirements
154 ---------------------
155
156    Compiling and running the 4.x kernels requires up-to-date
157    versions of various software packages.  Consult
158    :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
159    required and how to get updates for these packages.  Beware that using
160    excessively old versions of these packages can cause indirect
161    errors that are very difficult to track down, so don't assume that
162    you can just update packages when obvious problems arise during
163    build or operation.
164
165 Build directory for the kernel
166 ------------------------------
167
168    When compiling the kernel, all output files will per default be
169    stored together with the kernel source code.
170    Using the option ``make O=output/dir`` allows you to specify an alternate
171    place for the output files (including .config).
172    Example::
173
174      kernel source code: /usr/src/linux-4.X
175      build directory:    /home/name/build/kernel
176
177    To configure and build the kernel, use::
178
179      cd /usr/src/linux-4.X
180      make O=/home/name/build/kernel menuconfig
181      make O=/home/name/build/kernel
182      sudo make O=/home/name/build/kernel modules_install install
183
184    Please note: If the ``O=output/dir`` option is used, then it must be
185    used for all invocations of make.
186
187 Configuring the kernel
188 ----------------------
189
190    Do not skip this step even if you are only upgrading one minor
191    version.  New configuration options are added in each release, and
192    odd problems will turn up if the configuration files are not set up
193    as expected.  If you want to carry your existing configuration to a
194    new version with minimal work, use ``make oldconfig``, which will
195    only ask you for the answers to new questions.
196
197  - Alternative configuration commands are::
198
199      "make config"      Plain text interface.
200
201      "make menuconfig"  Text based color menus, radiolists & dialogs.
202
203      "make nconfig"     Enhanced text based color menus.
204
205      "make xconfig"     Qt based configuration tool.
206
207      "make gconfig"     GTK+ based configuration tool.
208
209      "make oldconfig"   Default all questions based on the contents of
210                         your existing ./.config file and asking about
211                         new config symbols.
212
213      "make olddefconfig"
214                         Like above, but sets new symbols to their default
215                         values without prompting.
216
217      "make defconfig"   Create a ./.config file by using the default
218                         symbol values from either arch/$ARCH/defconfig
219                         or arch/$ARCH/configs/${PLATFORM}_defconfig,
220                         depending on the architecture.
221
222      "make ${PLATFORM}_defconfig"
223                         Create a ./.config file by using the default
224                         symbol values from
225                         arch/$ARCH/configs/${PLATFORM}_defconfig.
226                         Use "make help" to get a list of all available
227                         platforms of your architecture.
228
229      "make allyesconfig"
230                         Create a ./.config file by setting symbol
231                         values to 'y' as much as possible.
232
233      "make allmodconfig"
234                         Create a ./.config file by setting symbol
235                         values to 'm' as much as possible.
236
237      "make allnoconfig" Create a ./.config file by setting symbol
238                         values to 'n' as much as possible.
239
240      "make randconfig"  Create a ./.config file by setting symbol
241                         values to random values.
242
243      "make localmodconfig" Create a config based on current config and
244                            loaded modules (lsmod). Disables any module
245                            option that is not needed for the loaded modules.
246
247                            To create a localmodconfig for another machine,
248                            store the lsmod of that machine into a file
249                            and pass it in as a LSMOD parameter.
250
251                    target$ lsmod > /tmp/mylsmod
252                    target$ scp /tmp/mylsmod host:/tmp
253
254                    host$ make LSMOD=/tmp/mylsmod localmodconfig
255
256                            The above also works when cross compiling.
257
258      "make localyesconfig" Similar to localmodconfig, except it will convert
259                            all module options to built in (=y) options.
260
261      "make kvmconfig"   Enable additional options for kvm guest kernel support.
262
263      "make xenconfig"   Enable additional options for xen dom0 guest kernel
264                         support.
265
266      "make tinyconfig"  Configure the tiniest possible kernel.
267
268    You can find more information on using the Linux kernel config tools
269    in Documentation/kbuild/kconfig.txt.
270
271  - NOTES on ``make config``:
272
273     - Having unnecessary drivers will make the kernel bigger, and can
274       under some circumstances lead to problems: probing for a
275       nonexistent controller card may confuse your other controllers.
276
277     - A kernel with math-emulation compiled in will still use the
278       coprocessor if one is present: the math emulation will just
279       never get used in that case.  The kernel will be slightly larger,
280       but will work on different machines regardless of whether they
281       have a math coprocessor or not.
282
283     - The "kernel hacking" configuration details usually result in a
284       bigger or slower kernel (or both), and can even make the kernel
285       less stable by configuring some routines to actively try to
286       break bad code to find kernel problems (kmalloc()).  Thus you
287       should probably answer 'n' to the questions for "development",
288       "experimental", or "debugging" features.
289
290 Compiling the kernel
291 --------------------
292
293  - Make sure you have at least gcc 3.2 available.
294    For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
295
296    Please note that you can still run a.out user programs with this kernel.
297
298  - Do a ``make`` to create a compressed kernel image. It is also
299    possible to do ``make install`` if you have lilo installed to suit the
300    kernel makefiles, but you may want to check your particular lilo setup first.
301
302    To do the actual install, you have to be root, but none of the normal
303    build should require that. Don't take the name of root in vain.
304
305  - If you configured any of the parts of the kernel as ``modules``, you
306    will also have to do ``make modules_install``.
307
308  - Verbose kernel compile/build output:
309
310    Normally, the kernel build system runs in a fairly quiet mode (but not
311    totally silent).  However, sometimes you or other kernel developers need
312    to see compile, link, or other commands exactly as they are executed.
313    For this, use "verbose" build mode.  This is done by passing
314    ``V=1`` to the ``make`` command, e.g.::
315
316      make V=1 all
317
318    To have the build system also tell the reason for the rebuild of each
319    target, use ``V=2``.  The default is ``V=0``.
320
321  - Keep a backup kernel handy in case something goes wrong.  This is
322    especially true for the development releases, since each new release
323    contains new code which has not been debugged.  Make sure you keep a
324    backup of the modules corresponding to that kernel, as well.  If you
325    are installing a new kernel with the same version number as your
326    working kernel, make a backup of your modules directory before you
327    do a ``make modules_install``.
328
329    Alternatively, before compiling, use the kernel config option
330    "LOCALVERSION" to append a unique suffix to the regular kernel version.
331    LOCALVERSION can be set in the "General Setup" menu.
332
333  - In order to boot your new kernel, you'll need to copy the kernel
334    image (e.g. .../linux/arch/x86/boot/bzImage after compilation)
335    to the place where your regular bootable kernel is found.
336
337  - Booting a kernel directly from a floppy without the assistance of a
338    bootloader such as LILO, is no longer supported.
339
340    If you boot Linux from the hard drive, chances are you use LILO, which
341    uses the kernel image as specified in the file /etc/lilo.conf.  The
342    kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
343    /boot/bzImage.  To use the new kernel, save a copy of the old image
344    and copy the new image over the old one.  Then, you MUST RERUN LILO
345    to update the loading map! If you don't, you won't be able to boot
346    the new kernel image.
347
348    Reinstalling LILO is usually a matter of running /sbin/lilo.
349    You may wish to edit /etc/lilo.conf to specify an entry for your
350    old kernel image (say, /vmlinux.old) in case the new one does not
351    work.  See the LILO docs for more information.
352
353    After reinstalling LILO, you should be all set.  Shutdown the system,
354    reboot, and enjoy!
355
356    If you ever need to change the default root device, video mode,
357    ramdisk size, etc.  in the kernel image, use the ``rdev`` program (or
358    alternatively the LILO boot options when appropriate).  No need to
359    recompile the kernel to change these parameters.
360
361  - Reboot with the new kernel and enjoy.
362
363 If something goes wrong
364 -----------------------
365
366  - If you have problems that seem to be due to kernel bugs, please check
367    the file MAINTAINERS to see if there is a particular person associated
368    with the part of the kernel that you are having trouble with. If there
369    isn't anyone listed there, then the second best thing is to mail
370    them to me (torvalds@linux-foundation.org), and possibly to any other
371    relevant mailing-list or to the newsgroup.
372
373  - In all bug-reports, *please* tell what kernel you are talking about,
374    how to duplicate the problem, and what your setup is (use your common
375    sense).  If the problem is new, tell me so, and if the problem is
376    old, please try to tell me when you first noticed it.
377
378  - If the bug results in a message like::
379
380      unable to handle kernel paging request at address C0000010
381      Oops: 0002
382      EIP:   0010:XXXXXXXX
383      eax: xxxxxxxx   ebx: xxxxxxxx   ecx: xxxxxxxx   edx: xxxxxxxx
384      esi: xxxxxxxx   edi: xxxxxxxx   ebp: xxxxxxxx
385      ds: xxxx  es: xxxx  fs: xxxx  gs: xxxx
386      Pid: xx, process nr: xx
387      xx xx xx xx xx xx xx xx xx xx
388
389    or similar kernel debugging information on your screen or in your
390    system log, please duplicate it *exactly*.  The dump may look
391    incomprehensible to you, but it does contain information that may
392    help debugging the problem.  The text above the dump is also
393    important: it tells something about why the kernel dumped code (in
394    the above example, it's due to a bad kernel pointer). More information
395    on making sense of the dump is in Documentation/admin-guide/bug-hunting.rst
396
397  - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
398    as is, otherwise you will have to use the ``ksymoops`` program to make
399    sense of the dump (but compiling with CONFIG_KALLSYMS is usually preferred).
400    This utility can be downloaded from
401    https://www.kernel.org/pub/linux/utils/kernel/ksymoops/ .
402    Alternatively, you can do the dump lookup by hand:
403
404  - In debugging dumps like the above, it helps enormously if you can
405    look up what the EIP value means.  The hex value as such doesn't help
406    me or anybody else very much: it will depend on your particular
407    kernel setup.  What you should do is take the hex value from the EIP
408    line (ignore the ``0010:``), and look it up in the kernel namelist to
409    see which kernel function contains the offending address.
410
411    To find out the kernel function name, you'll need to find the system
412    binary associated with the kernel that exhibited the symptom.  This is
413    the file 'linux/vmlinux'.  To extract the namelist and match it against
414    the EIP from the kernel crash, do::
415
416      nm vmlinux | sort | less
417
418    This will give you a list of kernel addresses sorted in ascending
419    order, from which it is simple to find the function that contains the
420    offending address.  Note that the address given by the kernel
421    debugging messages will not necessarily match exactly with the
422    function addresses (in fact, that is very unlikely), so you can't
423    just 'grep' the list: the list will, however, give you the starting
424    point of each kernel function, so by looking for the function that
425    has a starting address lower than the one you are searching for but
426    is followed by a function with a higher address you will find the one
427    you want.  In fact, it may be a good idea to include a bit of
428    "context" in your problem report, giving a few lines around the
429    interesting one.
430
431    If you for some reason cannot do the above (you have a pre-compiled
432    kernel image or similar), telling me as much about your setup as
433    possible will help.  Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
434    document for details.
435
436  - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
437    cannot change values or set break points.) To do this, first compile the
438    kernel with -g; edit arch/x86/Makefile appropriately, then do a ``make
439    clean``. You'll also need to enable CONFIG_PROC_FS (via ``make config``).
440
441    After you've rebooted with the new kernel, do ``gdb vmlinux /proc/kcore``.
442    You can now use all the usual gdb commands. The command to look up the
443    point where your system crashed is ``l *0xXXXXXXXX``. (Replace the XXXes
444    with the EIP value.)
445
446    gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
447    disregards the starting offset for which the kernel is compiled.