Creating Tasklet : Dynamic Method ================================= .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow Topics in this section, * :ref:`Version Info ` * :ref:`Learnings in this section ` * :ref:`Explanation of tasklet APIs ` * :ref:`tasklet_init ` * :ref:`tasklet_schedule ` * :ref:`tasklet_kill ` * :ref:`tasklet_setup ` * :ref:`Explanation of miscellaneous APIs ` * :ref:`Module parameter APIs ` * :ref:`Driver entry point APIs ` * :ref:`Example 1: Creating tasklet dynamically using tasklet_init ` * :ref:`List of headers ` * :ref:`Module Macros ` * :ref:`Initialize the tasklet dynamically ` * :ref:`Tasklet Handler Function ` * :ref:`Tasklet Start Function ` * :ref:`Task Init Function ` * :ref:`Tasklet Stop Function ` * :ref:`Task Exit Function ` * :ref:`Driver entry points ` * :ref:`See the full program below ` * :ref:`Makefile ` * :ref:`Compile and load the module ` * :ref:`Example 2: Creating tasklet dynamically using tasklet_setup ` * :ref:`List of headers ` * :ref:`Module Macros ` * :ref:`Initialize the tasklet dynamically ` * :ref:`Tasklet Handler Function ` * :ref:`Tasklet Start Function ` * :ref:`Task Init Function ` * :ref:`Tasklet Stop Function ` * :ref:`Task Exit Function ` * :ref:`Driver entry points ` * :ref:`See the full program below ` * :ref:`Makefile ` * :ref:`Compile and load the module ` .. _p2_taskletdynamic_0: .. tab-set:: .. tab-item:: Version Info =============================== ======================================= # Version =============================== ======================================= Ubuntu Ubuntu 22.10 Kernel 6.8.0 =============================== ======================================= .. _p2_taskletdynamic_1: .. tab-set:: .. tab-item:: Learnings in this section * In this program, you are going to learn .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow * How to create tasklet in dynamic method ? .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow * What are the different ways to create tasklet ? .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow * How to kill the tasklet ? .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow * How to use tasklet APIs ? * `tasklet_init `_ * `tasklet_schedule `_ * `tasklet_kill `_ * `from_tasklet `_ * `tasklet_setup `_ .. panels:: :container: container pb-4 :column: col-lg-12 p-2 :card: shadow * How to use below APIs ? * `MODULE_LICENSE `_ * `MODULE_DESCRIPTION `_ * `MODULE_AUTHOR `_ * `module_init `_ * `module_exit `_ .. _p2_taskletdynamic_2: .. tab-set:: .. tab-item:: Explanation of tasklet APIs .. _p2_taskletdynamic_3: .. tab-set:: .. tab-item:: tasklet_init * Here is the function prototype of the API: `tasklet_init `_ .. code-block:: c #include extern void tasklet_init(struct tasklet_struct *t, void (*func)(unsigned long), unsigned long data); * Here is an example of how to use the API, .. code-block:: c tasklet_init(my_tasklet, tasklet_handler, 10); .. _p2_taskletdynamic_4: .. tab-set:: .. tab-item:: tasklet_schedule * Here is the function prototype of the API: `tasklet_schedule `_ .. code-block:: c #include static inline void tasklet_schedule(struct tasklet_struct *t); * Here is an example of how to use the API, .. code-block:: c tasklet_schedule(my_tasklet); .. _p2_taskletdynamic_5: .. tab-set:: .. tab-item:: tasklet_kill * Here is the function prototype of the API: `tasklet_kill `_ .. code-block:: c #include extern void tasklet_kill(struct tasklet_struct *t); * Here is an example of how to use the API, .. code-block:: c tasklet_kill(my_tasklet); .. _p2_taskletdynamic_35: .. tab-set:: .. tab-item:: tasklet_setup * Here is the function prototype of the API: `tasklet_setup `_ .. code-block:: c #include extern void tasklet_setup(struct tasklet_struct *t, void (*callback)(struct tasklet_struct *)); * Here is an example of how to use the API, .. code-block:: c tasklet_setup(&task_t->tasklet, tasklet_handler); .. _p2_taskletdynamic_6: .. tab-set:: .. tab-item:: Explanation of miscellaneous APIs .. _p2_taskletdynamic_7: .. tab-set:: .. tab-item:: Module parameter APIs * Here is the prototype of module paramter APIs .. code-block:: c #include #define MODULE_LICENSE(_license) MODULE_FILE MODULE_INFO(license, _license) #define MODULE_AUTHOR(_author) MODULE_INFO(author, _author) #define MODULE_DESCRIPTION(_description) MODULE_INFO(description, _description) * where * `MODULE_LICENSE `_: tells the kernel what license is used by our module. * `MODULE_AUTHOR `_: denotes the author of this kernel module. * `MODULE_DESCRIPTION `_: gives a basic idea about what the kernel module does. * These information can be found when modinfo command is used which lists out all these above mentioned information. * Here is the example of how to use the Module parameter APIs, .. code-block:: c MODULE_LICENSE("GPL"); MODULE_AUTHOR("usr"); MODULE_DESCRIPTION("Tasklet"); .. _p2_taskletdynamic_8: .. tab-set:: .. tab-item:: Driver entry point API's * Here is the prototype of the Driver entry point API's .. code-block:: c #include #define module_init(x) __initcall(x); #define module_exit(x) __exitcall(x); * where * `module_init `_: driver initialization entry point which will be called at module insertion time. * `module_exit `_: driver exit entry point which will be called during the removal of module. * x: * function to be run at module insertion for `module_init `_ function. * function to be run when driver is removed for `module_exit `_ function. * Here is an example of how to use the driver entry point API's .. code-block:: c module_init(task_init); module_exit(task_exit); .. _p2_taskletdynamic_9: .. tab-set:: .. tab-item:: Example 1: Creating tasklet dynamically using tasklet_init * In this example let's see how to create tasklet dynamically using tasklet_init and execute it. .. _p2_taskletdynamic_10: .. tab-set:: .. tab-item:: List of headers * Include the follow header files(.h) to refer the API being used for the execution. .. code-block:: c #include #include #include #include #include .. _p2_taskletdynamic_11: .. tab-set:: .. tab-item:: Module macros * Add the following module macros to display information about the license, author and description about the module. .. code-block:: c MODULE_LICENSE("GPL"); MODULE_AUTHOR("usr"); MODULE_DESCRIPTION("Tasklet"); .. _p2_taskletdynamic_12: .. tab-set:: .. tab-item:: Initialize the tasklet dynamically. * Initialize the tasklet which we are going to create and use in this example .. code-block:: c tasklet_init(my_tasklet, tasklet_handler, 10); .. _p2_taskletdynamic_13: .. tab-set:: .. tab-item:: Tasklet Handler Function * This function executes once the tasklet is scheduled using tasklet_schedule. .. code-block:: c void tasklet_handler(unsigned long data) { pr_info("Executing tasklet handler function\n"); pr_info("data : %ld\n", data); } .. _p2_taskletdynamic_14: .. tab-set:: .. tab-item:: Tasklet Start Function * This function schedules a tasklet. .. code-block:: c void tasklet_start(void) { my_tasklet = kmalloc(sizeof(struct tasklet_struct), GFP_KERNEL); if (my_tasklet == NULL) pr_info("Cannot allocate memory\n"); tasklet_init(my_tasklet, tasklet_handler, 10); pr_info("Scheduling the tasklet\n"); tasklet_schedule(my_tasklet); } .. _p2_taskletdynamic_15: .. tab-set:: .. tab-item:: Task Init Function * This function calls tasklet_start function, will be executed once the module is loaded into the linux kernel. .. code-block:: c static int __init task_init(void) { pr_info("driver loaded\n"); tasklet_start(); return 0; } .. _p2_taskletdynamic_16: .. tab-set:: .. tab-item:: Tasklet Stop Function * This function kills tasklet and stops it's execution. .. code-block:: c void tasklet_stop(void) { tasklet_kill(my_tasklet); if (my_tasklet != NULL) kfree(my_tasklet); } .. _p2_taskletdynamic_17: .. tab-set:: .. tab-item:: Task Exit Function * This function calls tasklet_stop function, will be executed once the module is removed from the linux kernel .. code-block:: c static void __exit task_exit(void) { pr_info("driver unloaded!\n"); tasklet_stop(); } .. _p2_taskletdynamic_18: .. tab-set:: .. tab-item:: Driver entry points * Add the driver entry points which will be executed once the module is inserted or removed from the kernel. .. code-block:: c module_init(task_init); module_exit(task_exit); .. _p2_taskletdynamic_19: .. tab-set:: .. tab-item:: See the full program below .. tab-set:: .. tab-item:: tasklet.c .. literalinclude:: create_dynamic/tc1/tasklet.c :language: c :linenos: .. _p2_taskletdynamic_20: .. tab-set:: .. tab-item:: Makefile .. literalinclude:: create_dynamic/tc1/Makefile :language: c :linenos: .. _p2_taskletdynamic_21: .. tab-set:: .. tab-item:: Compile and load the module * Run make to compile the kernel source and generate the .ko image. .. code-block:: shell $ make make -C /lib/modules/6.8.0/build M=/home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1 modules make[1]: Entering directory '/home/arun/Desktop/kernel_api/linux-6.8' CC [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1/tasklet.o MODPOST /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1/Module.symvers CC [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1/tasklet.mod.o LD [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1/tasklet.ko make[1]: Leaving directory '/home/arun/Desktop/kernel_api/linux-6.8' * Check if the .ko is generated or not using ls command. .. code-block:: shell $ ls -l total 380 -rw-rw-r-- 1 arun arun 206 Jun 21 14:46 Makefile -rw-rw-r-- 1 arun arun 67 Jul 11 16:37 modules.order -rw-rw-r-- 1 arun arun 0 Jul 11 16:37 Module.symvers -rw-rw-r-- 1 arun arun 1586 Jun 24 18:37 tasklet.c -rw-rw-r-- 1 arun arun 180456 Jul 11 16:37 tasklet.ko -rw-rw-r-- 1 arun arun 67 Jul 11 16:37 tasklet.mod -rw-rw-r-- 1 arun arun 1166 Jul 11 16:37 tasklet.mod.c -rw-rw-r-- 1 arun arun 149416 Jul 11 16:37 tasklet.mod.o -rw-rw-r-- 1 arun arun 32432 Jul 11 16:37 tasklet.o * Run modinfo command to get the information about the kernel module. .. code-block:: shell $ modinfo tasklet.ko filename: /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc1/tasklet.ko description: Tasklet author: usr license: GPL srcversion: 6FA47F552DD69ABBBA7E0D3 depends: retpoline: Y name: tasklet vermagic: 6.8.0 SMP preempt mod_unload modversions * insert the module using insmod command. .. code-block:: shell $ sudo insmod ./tasklet.ko * check if the module is loaded or not using lsmod command. .. code-block:: shell $ lsmod | grep tasklet tasklet 12288 0 * check for the kernel messages from init function and thread function once the module is loaded and thread is created. .. code-block:: shell $ sudo dmesg [534946.455200] driver unloaded [536173.924724] driver loaded [536173.924728] Scheduling the tasklet [536173.924888] Executing tasklet handler function [536173.924891] data : 10 * remove the module from kernel using rmmod command. .. code-block:: shell $ sudo rmmod tasklet * check if the module is still loaded after removing the kernel module using lsmod if it is not displayed in lsmod output it is verified that the module is removed successfully. .. code-block:: shell $ lsmod | grep tasklet * Check for kernel messages from exit function using dmesg command. .. code-block:: shell $ sudo dmesg [534946.455200] driver unloaded .. _p2_taskletdynamic_22: .. tab-set:: .. tab-item:: Example 2: Creating tasklet dynamically using tasklet_setup * In this example let's see how to create tasklet dynamically using tasklet_setup and execute it. .. _p2_taskletdynamic_23: .. tab-set:: .. tab-item:: List of headers * Include the follow header files(.h) to refer the API being used for the execution. .. code-block:: c #include #include #include #include #include .. _p2_taskletdynamic_24: .. tab-set:: .. tab-item:: Module macros * Add the following module macros to display information about the license, author and description about the module. .. code-block:: c MODULE_LICENSE("GPL"); MODULE_AUTHOR("usr"); MODULE_DESCRIPTION("Tasklet"); .. _p2_taskletdynamic_25: .. tab-set:: .. tab-item:: Initialize the tasklet dynamically. * Initialize the tasklet which we are going to create and use in this example .. code-block:: c tasklet_setup(&task_t->tasklet, tasklet_handler); .. _p2_taskletdynamic_26: .. tab-set:: .. tab-item:: Tasklet Handler Function * This function executes once the tasklet is scheduled using tasklet_schedule. .. code-block:: c void tasklet_handler(struct tasklet_struct *t) { struct task *task_1 = from_tasklet(task_1, t, tasklet); pr_info("Inside tasklet handler function\n"); pr_info("task_a : %d\n", task_1->task_a); pr_info("task_b : %d\n", task_1->task_b); pr_info("task_c : %c\n", task_1->task_c); pr_info("task_d : %s\n", task_1->task_d); } .. _p2_taskletdynamic_27: .. tab-set:: .. tab-item:: Tasklet Start Function * This function schedules a tasklet. .. code-block:: c void tasklet_start(void) { task_t = kmalloc(sizeof(struct tasklet_struct *), GFP_KERNEL); if (task_t == NULL) pr_info("Cannot allocate memory\n"); task_t->task_a = 10; task_t->task_b = 20; task_t->task_c = 'a'; strncpy(task_t->task_d, "hello", sizeof(task_t->task_d)); tasklet_setup(&task_t->tasklet, tasklet_handler); pr_info("Scheduling the tasklet\n"); tasklet_schedule(&task_t->tasklet); } .. _p2_taskletdynamic_28: .. tab-set:: .. tab-item:: Task Init Function * This function calls tasklet_start function, will be executed once the module is loaded into the linux kernel. .. code-block:: c static int __init task_init(void) { pr_info("driver loaded\n"); tasklet_start(); return 0; } .. _p2_taskletdynamic_29: .. tab-set:: .. tab-item:: Tasklet Stop Function * This function kills tasklet and stops it's execution. .. code-block:: c void tasklet_stop(void) { tasklet_kill(&task_t->tasklet); if (task_t != NULL) kfree(task_t); } .. _p2_taskletdynamic_30: .. tab-set:: .. tab-item:: Task Exit Function * This function calls tasklet_stop function, will be executed once the module is removed from the linux kernel .. code-block:: c static void __exit task_exit(void) { pr_info("driver unloaded!\n"); tasklet_stop(); } .. _p2_taskletdynamic_31: .. tab-set:: .. tab-item:: Driver entry points * Add the driver entry points which will be executed once the module is inserted or removed from the kernel. .. code-block:: c module_init(task_init); module_exit(task_exit); .. _p2_taskletdynamic_32: .. tab-set:: .. tab-item:: See the full program below .. tab-set:: .. tab-item:: tasklet.c .. literalinclude:: create_dynamic/tc2/tasklet.c :language: c :linenos: .. _p2_taskletdynamic_33: .. tab-set:: .. tab-item:: Makefile .. literalinclude:: create_dynamic/tc2/Makefile :language: c :linenos: .. _p2_taskletdynamic_34: .. tab-set:: .. tab-item:: Compile and load the module * Run make to compile the kernel source and generate the .ko image. .. code-block:: shell $ make make -C /lib/modules/6.8.0/build M=/home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2 modules make[1]: Entering directory '/home/arun/Desktop/kernel_api/linux-6.8' CC [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2/tasklet.o MODPOST /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2/Module.symvers CC [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2/tasklet.mod.o LD [M] /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2/tasklet.ko make[1]: Leaving directory '/home/arun/Desktop/kernel_api/linux-6.8' * Check if the .ko is generated or not using ls command. .. code-block:: shell $ ls -l total 384 -rw-rw-r-- 1 arun arun 206 Jun 21 15:08 Makefile -rw-rw-r-- 1 arun arun 67 Jul 11 16:47 modules.order -rw-rw-r-- 1 arun arun 0 Jul 11 16:47 Module.symvers -rw-rw-r-- 1 arun arun 2026 Jun 24 15:24 tasklet.c -rw-rw-r-- 1 arun arun 182688 Jul 11 16:47 tasklet.ko -rw-rw-r-- 1 arun arun 67 Jul 11 16:47 tasklet.mod -rw-rw-r-- 1 arun arun 1167 Jul 11 16:47 tasklet.mod.c -rw-rw-r-- 1 arun arun 149416 Jul 11 16:47 tasklet.mod.o -rw-rw-r-- 1 arun arun 34664 Jul 11 16:47 tasklet.o * Run modinfo command to get the information about the kernel module. .. code-block:: shell $ modinfo tasklet.ko filename: /home/arun/Desktop/kernel_api/tasklet/create_dynamic/tc2/tasklet.ko description: Tasklet author: usr license: GPL srcversion: 3D90BF7ADED729B5A2D4BF7 depends: retpoline: Y name: tasklet vermagic: 6.8.0 SMP preempt mod_unload modversions * insert the module using insmod command. .. code-block:: shell $ sudo insmod ./tasklet.ko * check if the module is loaded or not using lsmod command. .. code-block:: shell $ lsmod | grep tasklet tasklet 12288 0 * check for the kernel messages from init function and thread function once the module is loaded and thread is created. .. code-block:: shell $ sudo dmesg [536418.420974] driver loaded [536418.420979] Scheduling the tasklet [536418.421469] Inside tasklet handler function [536418.421471] task_a : 10 [536418.421474] task_b : 20 [536418.421476] task_c : a [536418.421477] task_d : hello * remove the module from kernel using rmmod command. .. code-block:: shell $ sudo rmmod tasklet * check if the module is still loaded after removing the kernel module using lsmod if it is not displayed in lsmod output it is verified that the module is removed successfully. .. code-block:: shell $ lsmod | grep tasklet * Check for kernel messages from exit function using dmesg command. .. code-block:: shell $ sudo dmesg [534946.455200] driver unloaded