KK-KishoreKumar · August 27, 2024 16:16 · Aug 12, 2021 · Sep 9, 2020 · Sep 1, 2020 · Sep 1, 2020
diff --git a/kernel-dev.md b/kernel-dev.md
@@ -61,6 +61,11 @@ If you want more information about kernel internals (differences from userspace
  - <https://www.kernel.org/doc/html/latest/kernel-hacking/>
  - <https://github.com/0xAX/linux-insides>
 
+Some nice posts on getting a development environment set up:
+
+ - <https://medium.com/@daeseok.youn/prepare-the-environment-for-developing-linux-kernel-with-qemu-c55e37ba8ade>
+ - <https://www.nullbyte.cat/post/linux-kernel-exploit-development-environment/>
+
 ### Books
 
 I personally never used books much, but others have suggested these in the comments:

diff --git a/kernel-dev.md b/kernel-dev.md
@@ -96,7 +96,7 @@ One thing that could be relatively easy (and which could be seen as potentially
 
  - <https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html>
 
-Whatever you choose to work on, it could be a good idea to send the maintainer of the code a private email to hear what they think about your idea before you spend a lot of time on it. For example, there's probably not much point adding kernel-doc comments to some old derelict serial driver that hasn't been used in 15 years.
+Whatever you choose to work on, it could be a good idea to send an email to the mailing list for the subsystem/driver you are thinking of working on before you spend a lot of time on it. For example, there's probably not much point adding kernel-doc comments to some old derelict serial driver that hasn't been used in 15 years. Note that not all maintainers appreciate receiving private emails (see <https://people.kernel.org/tglx/notes-about-netiquette>), so don't do that unless they've explicitly said that they are fine receiving private/direct emails (for example, I am personally happy to receive private emails).
 
 ## Mailing lists
 

diff --git a/kernel-dev.md b/kernel-dev.md
@@ -61,6 +61,13 @@ If you want more information about kernel internals (differences from userspace
  - <https://www.kernel.org/doc/html/latest/kernel-hacking/>
  - <https://github.com/0xAX/linux-insides>
 
+### Books
+
+I personally never used books much, but others have suggested these in the comments:
+
+ - [The Linux Programming Interface](https://www.man7.org/tlpi/)
+ - [Linux Kernel Development by Robert Love](https://www.amazon.com/Linux-Kernel-Development-Robert-Love/dp/0672329468)
+
 ## Finding what to work on
 
 If you are unsure about what to work on, there are a few things you can look at. Personally I recommend playing around with the kernel before you go off trying to find your "big" project. By "playing around" I mean adding some printk()s here and there, maybe trying to trace the function calls that happen when you call a system call (e.g. start from [`fork()`](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/kernel/fork.c#n2484), follow it into `_do_fork()`, etc.). It can be fun to just understand how something works, you don't necessarily have to produce patches in your first few weeks/months of looking at the kernel (in fact, it would probably be a mistake to start producing patches right away).

diff --git a/kernel-dev.md b/kernel-dev.md
@@ -0,0 +1,117 @@
+# Getting started with Linux kernel development
+
+## Prerequisites
+
+The Linux kernel is written in C, so you should have at least a basic understanding of C before diving into kernel work. You don't need expert level C knowledge, since you can always pick some things up underway, but it certainly helps to know the language and to have written some userspace C programs already.
+
+It will also help to be a Linux _user_. If you have never used Linux before, it's probably a good idea to download a distro and get comfortable with it before you start doing kernel work.
+
+Lastly, knowing git is not actually required, but can really help you (since you can dig through changelogs and search for information you'll need). At a minimum you should probably be able to clone the git repository to a local directory.
+
+
+## First steps
+
+I always recommend getting comfortable with building and booting the kernel yourself, this is really the very first thing you should know as this will allow you to start experimenting with the code. Or put another way, you can't meaningfully do anything with the kernel code until you know how to build and run it. (Well, you can still _read_ the code, but by itself that doesn't buy you very much.)
+
+
+### Download
+
+Grab a copy of the mainline repository:
+
+    git clone http://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
+
+
+### Configure
+
+Make sure you have the `gcc` and `binutils` packages installed, as this is required to build the kernel.
+
+Run `make defconfig`, this will give you a basic config that should work on your current architecture/platform (which almost certainly is x86).
+
+Run `make menuconfig`, this will allow you to change the kernel configuration. The default configuration is mostly fine, the only thing I would recommend changing is to turn off `CONFIG_MODULES`, since this will make it easier to boot the kernel (no need to install the modules somewhere that the kernel can find them during boot). To do this, type `/MODULES` (and press enter) to search for the config option. Presssing `1` will take you to the first match. Then press `n` to disable this option. That's it! Save and exit.
+
+
+### Build
+
+Run `make -j8` (change 8 to whatever number of cores your computer has) to build the kernel, the important files at the end will be `arch/x86/boot/bzImage` and `vmlinux`. It can take anywhere from 5 to 15 minutes or more with the default config, depending also on your hardware of course.
+
+
+### Running in a VM
+
+Download a minimal disk image, for example:
+
+ - <https://people.debian.org/~aurel32/qemu/amd64/debian_wheezy_amd64_standard.qcow2>
+
+Boot the kernel in a VM:
+
+    kvm -cpu host -hda debian_wheezy_amd64_standard.qcow2 -kernel arch/x86/boot/bzImage -append "console=ttyS0 root=/dev/sda init=/bin/bash" -serial stdio -no-reboot -display none -m 1G
+
+(On some distros you have to use `qemu` or `qemu-system-x86_64` instead of `kvm`, but it's really the same program.)
+
+This should give you a root shell in the VM (type Ctrl-D/Ctrl-C to exit/kill the VM).
+
+
+## Resources
+
+Kernelnewbies has a lot of information that is useful for beginners:
+
+ - <https://kernelnewbies.org/>
+
+If you want more information about kernel internals (differences from userspace programming, more about internal APIs, etc.) you can try these links:
+
+ - <https://www.kernel.org/doc/html/latest/kernel-hacking/>
+ - <https://github.com/0xAX/linux-insides>
+
+## Finding what to work on
+
+If you are unsure about what to work on, there are a few things you can look at. Personally I recommend playing around with the kernel before you go off trying to find your "big" project. By "playing around" I mean adding some printk()s here and there, maybe trying to trace the function calls that happen when you call a system call (e.g. start from [`fork()`](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/kernel/fork.c#n2484), follow it into `_do_fork()`, etc.). It can be fun to just understand how something works, you don't necessarily have to produce patches in your first few weeks/months of looking at the kernel (in fact, it would probably be a mistake to start producing patches right away).
+
+When you are a bit more comfortable with the kernel sources and you want to try to take on a bigger project or just submit your first patches there is the kernelnewbies list of projects to look at:
+
+ - <https://kernelnewbies.org/KernelProjects>
+
+It looks a little bit outdated, but it could still be useful to have a look just to get some ideas.
+
+If you are interested in security, the Kernel Self-Protection Project also has a list of things that need to get done (although these projects may be a little bit more advanced):
+
+ - <https://kernsec.org/wiki/index.php/Kernel_Self_Protection_Project>
+
+Finally, if you just want to dive into some bugs (to try to understand or fix them), you can always have a look at the syzkaller list of open bugs:
+
+ - <https://syzkaller.appspot.com/>
+
+If you are just starting out, you shouldn't expect to be able to fix or even find the root cause of any of these bugs. But that doesn't mean you shouldn't try! You can learn a lot about the kernel from trying to understand how something works, even if it doesn't end up in a concrete patch or contribution. I wrote a blog post a few years ago about trying to fix a random syzkaller report that popped up, it could be a good read if you're into this sort of thing: <http://www.vegardno.net/2016/08/sync-debug.html>
+
+Joining mailing lists (see below) or reading [LWN](https://lwn.net/) can also be a good way to discover things that need to be done in the kernel.
+
+In general I would discourage sending a lot of small patches (e.g. typo fixes -- unless they're part of the `Documentation/` directory). Most maintainers are fine taking a few small patches like that (and it can be a good way to get used to the patch submission process), but if you keep sending only/mostly patches like that it will be more disruptive than helpful.
+
+One thing that could be relatively easy (and which could be seen as potentially very useful) would be to add more kernel-doc comments to code that is not documented. See more info about kernel-doc comments here:
+
+ - <https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html>
+
+Whatever you choose to work on, it could be a good idea to send the maintainer of the code a private email to hear what they think about your idea before you spend a lot of time on it. For example, there's probably not much point adding kernel-doc comments to some old derelict serial driver that hasn't been used in 15 years.
+
+## Mailing lists
+
+If you have specific areas of interest (e.g. BPF, filesystems, networking, etc.), I recommend subscribing to the mailing lists pertaining to that area. You can find a big list of many of the mailing lists (and how to subscribe to them) here:
+
+ - <http://vger.kernel.org/vger-lists.html>
+
+There is also a list of archives so you can go look at past discussions as well:
+
+ - <https://lore.kernel.org/lists.html>
+
+Subscribing to the mailing lists will give you a feel for the kinds of things people are working on in that subsystem, it will show you who the other people working on it are, what you can expect in terms of responses, etc.
+
+Maybe also check out the LKML FAQ:
+
+ - <http://vger.kernel.org/lkml/>
+
+## Submitting patches
+
+Some people have expressed fear around submitting patches or writing on mailing lists. In general I would say that you don't have that much to be scared of. Think twice before you hit "send" (i.e. don't send lots of little typo patches, don't send patches you haven't tested, etc.). You can use `git-send-email --dry-run` before you send off any patches to ensure that you're sending what you think you're sending. Also do a little bit of research around what is expected in terms of formatting and etiquette, there is some more info here:
+
+ - <https://www.kernel.org/doc/html/latest/process/submitting-patches.html>
+ - <https://www.kernel.org/doc/html/latest/process/email-clients.html>
+
+Everybody makes mistakes from time to time, so don't sweat it too much. If you are sending your first email to LKML, say that you are new and people will generally be understanding.
No results found