README.rst 17.8 KB
Newer Older
1 2
Linux kernel release 4.x <http://kernel.org/>
=============================================
L
Linus Torvalds 已提交
3

4
These are the release notes for Linux version 4.  Read them carefully,
L
Linus Torvalds 已提交
5
as they tell you what this is all about, explain how to install the
D
Diego Viola 已提交
6
kernel, and what to do if something goes wrong.
L
Linus Torvalds 已提交
7

8 9
What is Linux?
--------------
L
Linus Torvalds 已提交
10

X
Xose Vazquez Perez 已提交
11 12 13
  Linux is a clone of the operating system Unix, written from scratch by
  Linus Torvalds with assistance from a loosely-knit team of hackers across
  the Net. It aims towards POSIX and Single UNIX Specification compliance.
L
Linus Torvalds 已提交
14

X
Xose Vazquez Perez 已提交
15 16 17 18
  It has all the features you would expect in a modern fully-fledged Unix,
  including true multitasking, virtual memory, shared libraries, demand
  loading, shared copy-on-write executables, proper memory management,
  and multistack networking including IPv4 and IPv6.
L
Linus Torvalds 已提交
19

20
  It is distributed under the GNU General Public License v2 - see the
D
Diego Viola 已提交
21
  accompanying COPYING file for more details.
L
Linus Torvalds 已提交
22

23 24
On what hardware does it run?
-----------------------------
L
Linus Torvalds 已提交
25

X
Xose Vazquez Perez 已提交
26 27
  Although originally developed first for 32-bit x86-based PCs (386 or higher),
  today Linux also runs on (at least) the Compaq Alpha AXP, Sun SPARC and
28
  UltraSPARC, Motorola 68000, PowerPC, PowerPC64, ARM, Hitachi SuperH, Cell,
X
Xose Vazquez Perez 已提交
29
  IBM S/390, MIPS, HP PA-RISC, Intel IA-64, DEC VAX, AMD x86-64, AXIS CRIS,
30
  Xtensa, Tilera TILE, ARC and Renesas M32R architectures.
X
Xose Vazquez Perez 已提交
31 32 33 34 35 36

  Linux is easily portable to most general-purpose 32- or 64-bit architectures
  as long as they have a paged memory management unit (PMMU) and a port of the
  GNU C compiler (gcc) (part of The GNU Compiler Collection, GCC). Linux has
  also been ported to a number of architectures without a PMMU, although
  functionality is then obviously somewhat limited.
37 38
  Linux has also been ported to itself. You can now run the kernel as a
  userspace application - this is called UserMode Linux (UML).
L
Linus Torvalds 已提交
39

40 41
Documentation
-------------
L
Linus Torvalds 已提交
42 43 44 45 46 47 48 49 50

 - There is a lot of documentation available both in electronic form on
   the Internet and in books, both Linux-specific and pertaining to
   general UNIX questions.  I'd recommend looking into the documentation
   subdirectories on any Linux FTP site for the LDP (Linux Documentation
   Project) books.  This README is not meant to be documentation on the
   system: there are much better sources available.

 - There are various README files in the Documentation/ subdirectory:
D
Diego Viola 已提交
51
   these typically contain kernel-specific installation notes for some
L
Linus Torvalds 已提交
52
   drivers for example. See Documentation/00-INDEX for a list of what
53 54
   is contained in each file.  Please read the
   :ref:`Documentation/process/changes.rst <changes>` file, as it
L
Linus Torvalds 已提交
55 56 57
   contains information about the problems, which may result by upgrading
   your kernel.

58 59
Installing the kernel source
----------------------------
L
Linus Torvalds 已提交
60 61

 - If you install the full sources, put the kernel tarball in a
D
Diego Viola 已提交
62
   directory where you have permissions (e.g. your home directory) and
63
   unpack it::
L
Linus Torvalds 已提交
64

65
     xz -cd linux-4.X.tar.xz | tar xvf -
66

67
   Replace "X" with the version number of the latest kernel.
L
Linus Torvalds 已提交
68 69 70 71 72 73

   Do NOT use the /usr/src/linux area! This area has a (usually
   incomplete) set of kernel headers that are used by the library header
   files.  They should match the library, and not get messed up by
   whatever the kernel-du-jour happens to be.

74
 - You can also upgrade between 4.x releases by patching.  Patches are
75 76
   distributed in the xz format.  To install by patching, get all the
   newer patch files, enter the top level directory of the kernel source
77
   (linux-4.X) and execute::
78

79
     xz -cd ../patch-4.x.xz | patch -p1
L
Linus Torvalds 已提交
80

81
   Replace "x" for all versions bigger than the version "X" of your current
82
   source tree, **in_order**, and you should be ok.  You may want to remove
83 84
   the backup files (some-file-name~ or some-file-name.orig), and make sure
   that there are no failed patches (some-file-name# or some-file-name.rej).
85
   If there are, either you or I have made a mistake.
L
Linus Torvalds 已提交
86

87
   Unlike patches for the 4.x kernels, patches for the 4.x.y kernels
88
   (also known as the -stable kernels) are not incremental but instead apply
89 90 91 92
   directly to the base 4.x kernel.  For example, if your base kernel is 4.0
   and you want to apply the 4.0.3 patch, you must not first apply the 4.0.1
   and 4.0.2 patches. Similarly, if you are running kernel version 4.0.2 and
   want to jump to 4.0.3, you must first reverse the 4.0.2 patch (that is,
93
   patch -R) **before** applying the 4.0.3 patch. You can read more on this in
94
   :ref:`Documentation/process/applying-patches.rst <applying_patches>`.
95

L
Linus Torvalds 已提交
96 97
   Alternatively, the script patch-kernel can be used to automate this
   process.  It determines the current kernel version and applies any
98
   patches found::
L
Linus Torvalds 已提交
99

M
Michael Witten 已提交
100
     linux/scripts/patch-kernel linux
L
Linus Torvalds 已提交
101 102 103 104 105

   The first argument in the command above is the location of the
   kernel source.  Patches are applied from the current directory, but
   an alternative directory can be specified as the second argument.

106
 - Make sure you have no stale .o files and dependencies lying around::
L
Linus Torvalds 已提交
107

M
Michael Witten 已提交
108 109
     cd linux
     make mrproper
L
Linus Torvalds 已提交
110 111 112

   You should now have the sources correctly installed.

113 114
Software requirements
---------------------
L
Linus Torvalds 已提交
115

116
   Compiling and running the 4.x kernels requires up-to-date
L
Linus Torvalds 已提交
117
   versions of various software packages.  Consult
118
   :ref:`Documentation/process/changes.rst <changes>` for the minimum version numbers
119
   required and how to get updates for these packages.  Beware that using
L
Linus Torvalds 已提交
120 121 122 123 124
   excessively old versions of these packages can cause indirect
   errors that are very difficult to track down, so don't assume that
   you can just update packages when obvious problems arise during
   build or operation.

125 126
Build directory for the kernel
------------------------------
L
Linus Torvalds 已提交
127

M
Michael Witten 已提交
128
   When compiling the kernel, all output files will per default be
L
Linus Torvalds 已提交
129
   stored together with the kernel source code.
130
   Using the option ``make O=output/dir`` allows you to specify an alternate
L
Linus Torvalds 已提交
131
   place for the output files (including .config).
132
   Example::
133

134
     kernel source code: /usr/src/linux-4.X
M
Michael Witten 已提交
135
     build directory:    /home/name/build/kernel
L
Linus Torvalds 已提交
136

137
   To configure and build the kernel, use::
138

139
     cd /usr/src/linux-4.X
140 141 142
     make O=/home/name/build/kernel menuconfig
     make O=/home/name/build/kernel
     sudo make O=/home/name/build/kernel modules_install install
L
Linus Torvalds 已提交
143

144
   Please note: If the ``O=output/dir`` option is used, then it must be
L
Linus Torvalds 已提交
145 146
   used for all invocations of make.

147 148
Configuring the kernel
----------------------
L
Linus Torvalds 已提交
149 150 151 152 153

   Do not skip this step even if you are only upgrading one minor
   version.  New configuration options are added in each release, and
   odd problems will turn up if the configuration files are not set up
   as expected.  If you want to carry your existing configuration to a
154
   new version with minimal work, use ``make oldconfig``, which will
L
Linus Torvalds 已提交
155 156
   only ask you for the answers to new questions.

157
 - Alternative configuration commands are::
158

M
Michael Witten 已提交
159
     "make config"      Plain text interface.
160

M
Michael Witten 已提交
161
     "make menuconfig"  Text based color menus, radiolists & dialogs.
162

M
Michael Witten 已提交
163
     "make nconfig"     Enhanced text based color menus.
164

D
Diego Viola 已提交
165
     "make xconfig"     Qt based configuration tool.
166

D
Diego Viola 已提交
167
     "make gconfig"     GTK+ based configuration tool.
168

M
Michael Witten 已提交
169 170 171
     "make oldconfig"   Default all questions based on the contents of
                        your existing ./.config file and asking about
                        new config symbols.
172

K
Kees Cook 已提交
173 174 175 176
     "make olddefconfig"
                        Like above, but sets new symbols to their default
                        values without prompting.

M
Michael Witten 已提交
177 178 179 180
     "make defconfig"   Create a ./.config file by using the default
                        symbol values from either arch/$ARCH/defconfig
                        or arch/$ARCH/configs/${PLATFORM}_defconfig,
                        depending on the architecture.
181

M
Michael Witten 已提交
182 183 184 185 186 187
     "make ${PLATFORM}_defconfig"
                        Create a ./.config file by using the default
                        symbol values from
                        arch/$ARCH/configs/${PLATFORM}_defconfig.
                        Use "make help" to get a list of all available
                        platforms of your architecture.
188

M
Michael Witten 已提交
189 190 191
     "make allyesconfig"
                        Create a ./.config file by setting symbol
                        values to 'y' as much as possible.
192

M
Michael Witten 已提交
193 194 195
     "make allmodconfig"
                        Create a ./.config file by setting symbol
                        values to 'm' as much as possible.
196

M
Michael Witten 已提交
197 198
     "make allnoconfig" Create a ./.config file by setting symbol
                        values to 'n' as much as possible.
199

M
Michael Witten 已提交
200 201
     "make randconfig"  Create a ./.config file by setting symbol
                        values to random values.
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
     "make localmodconfig" Create a config based on current config and
                           loaded modules (lsmod). Disables any module
                           option that is not needed for the loaded modules.

                           To create a localmodconfig for another machine,
                           store the lsmod of that machine into a file
                           and pass it in as a LSMOD parameter.

                   target$ lsmod > /tmp/mylsmod
                   target$ scp /tmp/mylsmod host:/tmp

                   host$ make LSMOD=/tmp/mylsmod localmodconfig

                           The above also works when cross compiling.

     "make localyesconfig" Similar to localmodconfig, except it will convert
                           all module options to built in (=y) options.

R
Randy Dunlap 已提交
221
   You can find more information on using the Linux kernel config tools
L
Li Zefan 已提交
222
   in Documentation/kbuild/kconfig.txt.
R
Randy Dunlap 已提交
223

224
 - NOTES on ``make config``:
225

M
Michael Witten 已提交
226 227
    - Having unnecessary drivers will make the kernel bigger, and can
      under some circumstances lead to problems: probing for a
228
      nonexistent controller card may confuse your other controllers.
229

M
Michael Witten 已提交
230 231 232 233 234
    - A kernel with math-emulation compiled in will still use the
      coprocessor if one is present: the math emulation will just
      never get used in that case.  The kernel will be slightly larger,
      but will work on different machines regardless of whether they
      have a math coprocessor or not.
235

M
Michael Witten 已提交
236 237 238 239 240 241
    - The "kernel hacking" configuration details usually result in a
      bigger or slower kernel (or both), and can even make the kernel
      less stable by configuring some routines to actively try to
      break bad code to find kernel problems (kmalloc()).  Thus you
      should probably answer 'n' to the questions for "development",
      "experimental", or "debugging" features.
L
Linus Torvalds 已提交
242

243 244
Compiling the kernel
--------------------
L
Linus Torvalds 已提交
245

A
Andrew Morton 已提交
246
 - Make sure you have at least gcc 3.2 available.
247
   For more information, refer to :ref:`Documentation/process/changes.rst <changes>`.
L
Linus Torvalds 已提交
248 249 250

   Please note that you can still run a.out user programs with this kernel.

251 252
 - Do a ``make`` to create a compressed kernel image. It is also
   possible to do ``make install`` if you have lilo installed to suit the
L
Linus Torvalds 已提交
253 254
   kernel makefiles, but you may want to check your particular lilo setup first.

M
Michael Witten 已提交
255
   To do the actual install, you have to be root, but none of the normal
L
Linus Torvalds 已提交
256 257
   build should require that. Don't take the name of root in vain.

258 259
 - If you configured any of the parts of the kernel as ``modules``, you
   will also have to do ``make modules_install``.
L
Linus Torvalds 已提交
260

R
Randy Dunlap 已提交
261 262
 - Verbose kernel compile/build output:

M
Michael Witten 已提交
263
   Normally, the kernel build system runs in a fairly quiet mode (but not
R
Randy Dunlap 已提交
264 265
   totally silent).  However, sometimes you or other kernel developers need
   to see compile, link, or other commands exactly as they are executed.
D
Diego Viola 已提交
266
   For this, use "verbose" build mode.  This is done by passing
267
   ``V=1`` to the ``make`` command, e.g.::
R
Randy Dunlap 已提交
268

M
Michael Witten 已提交
269
     make V=1 all
R
Randy Dunlap 已提交
270 271

   To have the build system also tell the reason for the rebuild of each
272
   target, use ``V=2``.  The default is ``V=0``.
R
Randy Dunlap 已提交
273

D
Diego Viola 已提交
274
 - Keep a backup kernel handy in case something goes wrong.  This is
L
Linus Torvalds 已提交
275 276 277 278 279
   especially true for the development releases, since each new release
   contains new code which has not been debugged.  Make sure you keep a
   backup of the modules corresponding to that kernel, as well.  If you
   are installing a new kernel with the same version number as your
   working kernel, make a backup of your modules directory before you
280
   do a ``make modules_install``.
281

282 283 284
   Alternatively, before compiling, use the kernel config option
   "LOCALVERSION" to append a unique suffix to the regular kernel version.
   LOCALVERSION can be set in the "General Setup" menu.
L
Linus Torvalds 已提交
285 286

 - In order to boot your new kernel, you'll need to copy the kernel
287
   image (e.g. .../linux/arch/x86/boot/bzImage after compilation)
D
Diego Viola 已提交
288
   to the place where your regular bootable kernel is found.
L
Linus Torvalds 已提交
289 290 291 292

 - Booting a kernel directly from a floppy without the assistance of a
   bootloader such as LILO, is no longer supported.

M
Michael Witten 已提交
293
   If you boot Linux from the hard drive, chances are you use LILO, which
L
Linus Torvalds 已提交
294 295 296 297
   uses the kernel image as specified in the file /etc/lilo.conf.  The
   kernel image file is usually /vmlinuz, /boot/vmlinuz, /bzImage or
   /boot/bzImage.  To use the new kernel, save a copy of the old image
   and copy the new image over the old one.  Then, you MUST RERUN LILO
D
Diego Viola 已提交
298
   to update the loading map! If you don't, you won't be able to boot
L
Linus Torvalds 已提交
299 300
   the new kernel image.

D
Diego Viola 已提交
301
   Reinstalling LILO is usually a matter of running /sbin/lilo.
L
Linus Torvalds 已提交
302 303
   You may wish to edit /etc/lilo.conf to specify an entry for your
   old kernel image (say, /vmlinux.old) in case the new one does not
D
Diego Viola 已提交
304
   work.  See the LILO docs for more information.
L
Linus Torvalds 已提交
305 306 307 308 309

   After reinstalling LILO, you should be all set.  Shutdown the system,
   reboot, and enjoy!

   If you ever need to change the default root device, video mode,
310
   ramdisk size, etc.  in the kernel image, use the ``rdev`` program (or
L
Linus Torvalds 已提交
311
   alternatively the LILO boot options when appropriate).  No need to
D
Diego Viola 已提交
312
   recompile the kernel to change these parameters.
L
Linus Torvalds 已提交
313

D
Diego Viola 已提交
314
 - Reboot with the new kernel and enjoy.
L
Linus Torvalds 已提交
315

316 317
If something goes wrong
-----------------------
L
Linus Torvalds 已提交
318 319 320 321 322

 - If you have problems that seem to be due to kernel bugs, please check
   the file MAINTAINERS to see if there is a particular person associated
   with the part of the kernel that you are having trouble with. If there
   isn't anyone listed there, then the second best thing is to mail
L
Linus Torvalds 已提交
323 324
   them to me (torvalds@linux-foundation.org), and possibly to any other
   relevant mailing-list or to the newsgroup.
L
Linus Torvalds 已提交
325 326 327 328 329 330

 - In all bug-reports, *please* tell what kernel you are talking about,
   how to duplicate the problem, and what your setup is (use your common
   sense).  If the problem is new, tell me so, and if the problem is
   old, please try to tell me when you first noticed it.

331
 - If the bug results in a message like::
L
Linus Torvalds 已提交
332

M
Michael Witten 已提交
333 334 335 336 337 338 339 340
     unable to handle kernel paging request at address C0000010
     Oops: 0002
     EIP:   0010:XXXXXXXX
     eax: xxxxxxxx   ebx: xxxxxxxx   ecx: xxxxxxxx   edx: xxxxxxxx
     esi: xxxxxxxx   edi: xxxxxxxx   ebp: xxxxxxxx
     ds: xxxx  es: xxxx  fs: xxxx  gs: xxxx
     Pid: xx, process nr: xx
     xx xx xx xx xx xx xx xx xx xx
L
Linus Torvalds 已提交
341 342 343 344 345 346

   or similar kernel debugging information on your screen or in your
   system log, please duplicate it *exactly*.  The dump may look
   incomprehensible to you, but it does contain information that may
   help debugging the problem.  The text above the dump is also
   important: it tells something about why the kernel dumped code (in
M
Michael Witten 已提交
347
   the above example, it's due to a bad kernel pointer). More information
348
   on making sense of the dump is in Documentation/admin-guide/bug-hunting.rst
L
Linus Torvalds 已提交
349 350

 - If you compiled the kernel with CONFIG_KALLSYMS you can send the dump
351
   as is, otherwise you will have to use the ``ksymoops`` program to make
352 353
   sense of the dump (but compiling with CONFIG_KALLSYMS is usually preferred).
   This utility can be downloaded from
354
   https://www.kernel.org/pub/linux/utils/kernel/ksymoops/ .
355
   Alternatively, you can do the dump lookup by hand:
L
Linus Torvalds 已提交
356 357 358 359 360

 - In debugging dumps like the above, it helps enormously if you can
   look up what the EIP value means.  The hex value as such doesn't help
   me or anybody else very much: it will depend on your particular
   kernel setup.  What you should do is take the hex value from the EIP
361
   line (ignore the ``0010:``), and look it up in the kernel namelist to
L
Linus Torvalds 已提交
362 363 364 365 366
   see which kernel function contains the offending address.

   To find out the kernel function name, you'll need to find the system
   binary associated with the kernel that exhibited the symptom.  This is
   the file 'linux/vmlinux'.  To extract the namelist and match it against
367
   the EIP from the kernel crash, do::
L
Linus Torvalds 已提交
368

M
Michael Witten 已提交
369
     nm vmlinux | sort | less
L
Linus Torvalds 已提交
370 371 372 373 374 375 376 377 378 379 380 381

   This will give you a list of kernel addresses sorted in ascending
   order, from which it is simple to find the function that contains the
   offending address.  Note that the address given by the kernel
   debugging messages will not necessarily match exactly with the
   function addresses (in fact, that is very unlikely), so you can't
   just 'grep' the list: the list will, however, give you the starting
   point of each kernel function, so by looking for the function that
   has a starting address lower than the one you are searching for but
   is followed by a function with a higher address you will find the one
   you want.  In fact, it may be a good idea to include a bit of
   "context" in your problem report, giving a few lines around the
D
Diego Viola 已提交
382
   interesting one.
L
Linus Torvalds 已提交
383 384 385

   If you for some reason cannot do the above (you have a pre-compiled
   kernel image or similar), telling me as much about your setup as
386
   possible will help.  Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
387
   document for details.
L
Linus Torvalds 已提交
388

389
 - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
L
Linus Torvalds 已提交
390
   cannot change values or set break points.) To do this, first compile the
391 392
   kernel with -g; edit arch/x86/Makefile appropriately, then do a ``make
   clean``. You'll also need to enable CONFIG_PROC_FS (via ``make config``).
L
Linus Torvalds 已提交
393

394
   After you've rebooted with the new kernel, do ``gdb vmlinux /proc/kcore``.
L
Linus Torvalds 已提交
395
   You can now use all the usual gdb commands. The command to look up the
396
   point where your system crashed is ``l *0xXXXXXXXX``. (Replace the XXXes
L
Linus Torvalds 已提交
397 398
   with the EIP value.)

399
   gdb'ing a non-running kernel currently fails because ``gdb`` (wrongly)
L
Linus Torvalds 已提交
400
   disregards the starting offset for which the kernel is compiled.