{"id":7115,"date":"2022-02-02T08:22:07","date_gmt":"2022-02-02T08:22:07","guid":{"rendered":"http:\/\/fastbitlab.com\/?p=7115"},"modified":"2023-09-12T09:58:46","modified_gmt":"2023-09-12T04:28:46","slug":"lkm-writing-syntax","status":"publish","type":"post","link":"https:\/\/fastbitlab.com\/blog\/lkm-writing-syntax\/","title":{"rendered":"Linux Device Driver Programming Lecture 17- LKM writing syntax"},"content":{"rendered":"
\n
\n
\n
\n

 <\/p>\n<\/div>\n

\n

LKM writing syntax<\/b><\/strong><\/span><\/h1>\n
\n
\n
\n

 <\/p>\n

<\/div>\n

 <\/p>\n<\/div>\n<\/div>\n<\/div>\n

In this article, let’s write our very first kernel module, as shown in Figure 1. Here is an example of a  hello world kernel module.<\/span><\/p>\n

\"Figure
Figure 1. Example kernel module<\/span><\/figcaption><\/figure>\n

 <\/p>\n

It looks like a normal user-space C program. But, we have to understand a lot of things here because we write kernel modules according to some rules because the kernel module is going to run in the kernel space.<\/span><\/p>\n

 <\/p>\n

Understanding the Structure<\/strong><\/span><\/p>\n

A kernel module can be divided into distinct sections:<\/span><\/p>\n

\"Figure
Figure 2. Different sections in a program<\/span><\/figcaption><\/figure>\n

 <\/p>\n

There is a header section, there is your code section, and there is a registration section, and there is a module description section as shown in Figure 2. These sections are part of a kernel module. Let’s go through this section one by one.<\/span><\/p>\n

 <\/p>\n

Header Section:<\/strong><\/span><\/p>\n

\"LKM
Figure 3. Header section<\/span><\/figcaption><\/figure>\n

Here, you have to mention the appropriate kernel header for your kernel module. <\/span><\/span><\/p>\n

You can find all <\/span>the kernel headers in the kernel source tree in the path \/include\/linux. That’s a place where all the kernel headers are placed. In that location, you find a kernel header called module.h. <\/span><\/span><\/p>\n

Every kernel module should include this header file. Because it has got a definition of various macros, which we are going to use while writing a kernel module. <\/span><\/span><\/p>\n

 <\/p>\n

Kernel Headers vs. User-Space Headers<\/span><\/strong><\/span><\/span><\/span><\/p>\n

For example, what you just saw above is a kernel header. An example for a user-level header may be stdio.h. That’s a header file that you find in the standard C library. That’s a user level header. This is a kernel header.<\/span><\/p>\n

Since you write a kernel module that is going to be executed in kernel space, you should be using kernel headers, never include any user-space library headers like C standard library header files. No userspace library is linked to the kernel module during a kernel build procedure. For example, you don’t link your kernel module code with a C standard library.<\/span><\/p>\n

That’s why you should not use any user space headers while writing the kernel module. <\/span>Most of the relevant kernel headers are placed in the linux source tree at the path \/include\/linux.<\/span><\/span><\/p>\n

 <\/p>\n

Code Section:<\/strong><\/span><\/span><\/p>\n

\"LKM
Figure 4. Code section<\/span><\/figcaption><\/figure>\n

 <\/p>\n

The code section comprises a collection of functions. This is a normal C function. But it looks weird because it has some kernel-related syntaxes that are very easy to understand; it does look like a normal  C function.<\/span><\/p>\n

Basically, while writing a kernel module, we use 2 entry points.<\/span><\/p>\n

Module Initialization Function:<\/strong> This function initializes the module and is invoked during module insertion or system boot for statically linked modules. It returns an integer: 0 for success and non-zero for failure, preventing the module from loading.<\/span><\/p>\n

Module Cleanup Function:<\/strong> This function is responsible for module cleanup tasks. It is called during module removal.<\/span><\/p>\n

 <\/p>\n

Module Initialization Function<\/strong><\/span><\/p>\n

Let’s understand more about the module initialization function(as shown in Figure 5); why it is required?<\/span><\/p>\n

\"LKM
Figure 5. Module initialization function<\/span><\/figcaption><\/figure>\n

 <\/p>\n

int fun_name(void); <\/b>is the prototype of a module initialization function. It should return int and function name. You can give anything you want your custom name, and it will not be taking any parameters. Input parameters are void. The module initialization function must return a value; 0 for success, non zero means module initialization failed. So, the module will not get loaded into the kernel. <\/span>This is an entry point to your module (like main). We talk in terms of entry points. This function will get called during boot time in the case of static modules. <\/span><\/span><\/p>\n

In the case of dynamic modules, this function will get called during module insertion. There should be one module initialization entry point in the module. <\/span><\/p>\n

For example, if you compile this kernel module as a dynamic module, this function will get called when you insert the module into the kernel, using user-level programs such as insmod. <\/span><\/p>\n

 <\/p>\n

You do some initialization of devices, Initialization of device private data structures, you request some memory dynamically for various kernel data structures and services, you request for allocation of major and minor numbers, device file creation, various things you do in this function. <\/span><\/p>\n

All these things that we are going to understand when we write a character driver in the upcoming articles.<\/span><\/p>\n

Basically, you do initialization-related things in this function. Because, it’s an entry point. It’s like a main.<\/span><\/p>\n

 <\/p>\n

‘static’ Keyword and ‘_init’ Tag<\/strong><\/span><\/p>\n

You have got a static keyword there and you have got to __init tag there.<\/span><\/p>\n

In LKM development, you might notice the use of the static<\/code> keyword and the __init<\/code> tag. These serve the purpose of making the module initialization function module-specific and not callable from other parts of the kernel.<\/p>\n