2 * libkmod - interface to kernel module operations
4 * Copyright (C) 2011-2013 ProFUSION embedded systems
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
35 #include <sys/syscall.h>
36 #include <sys/types.h>
38 #ifdef HAVE_LINUX_MODULE_H
39 #include <linux/module.h>
42 #include <shared/util.h>
45 #include "libkmod-internal.h"
48 * SECTION:libkmod-module
49 * @short_description: operate on kernel modules
52 enum kmod_module_builtin
{
53 KMOD_MODULE_BUILTIN_UNKNOWN
,
54 KMOD_MODULE_BUILTIN_NO
,
55 KMOD_MODULE_BUILTIN_YES
,
61 * Opaque object representing a module.
68 struct kmod_list
*dep
;
70 const char *install_commands
; /* owned by kmod_config */
71 const char *remove_commands
; /* owned by kmod_config */
72 char *alias
; /* only set if this module was created from an alias */
73 struct kmod_file
*file
;
79 bool install_commands
: 1;
80 bool remove_commands
: 1;
84 * mark if module is builtin, i.e. it's present on modules.builtin
85 * file. This is set as soon as it is needed or as soon as we know
86 * about it, i.e. the module was created from builtin lookup.
88 enum kmod_module_builtin builtin
;
91 * private field used by kmod_module_get_probe_list() to detect
97 * set by kmod_module_get_probe_list: indicates for probe_insert()
98 * whether the module's command and softdep should be ignored
103 * set by kmod_module_get_probe_list: indicates whether this is the
104 * module the user asked for or its dependency, or whether this
110 static inline const char *path_join(const char *path
, size_t prefixlen
,
118 pathlen
= strlen(path
);
119 if (prefixlen
+ pathlen
+ 1 >= PATH_MAX
)
122 memcpy(buf
+ prefixlen
, path
, pathlen
+ 1);
126 static inline bool module_is_inkernel(struct kmod_module
*mod
)
128 int state
= kmod_module_get_initstate(mod
);
130 if (state
== KMOD_MODULE_LIVE
||
131 state
== KMOD_MODULE_BUILTIN
)
137 int kmod_module_parse_depline(struct kmod_module
*mod
, char *line
)
139 struct kmod_ctx
*ctx
= mod
->ctx
;
140 struct kmod_list
*list
= NULL
;
149 assert(mod
->dep
== NULL
);
150 mod
->init
.dep
= true;
152 p
= strchr(line
, ':');
157 dirname
= kmod_get_dirname(mod
->ctx
);
158 dirnamelen
= strlen(dirname
);
159 if (dirnamelen
+ 2 >= PATH_MAX
)
162 memcpy(buf
, dirname
, dirnamelen
);
163 buf
[dirnamelen
] = '/';
165 buf
[dirnamelen
] = '\0';
167 if (mod
->path
== NULL
) {
168 const char *str
= path_join(line
, dirnamelen
, buf
);
171 mod
->path
= strdup(str
);
172 if (mod
->path
== NULL
)
177 for (p
= strtok_r(p
, " \t", &saveptr
); p
!= NULL
;
178 p
= strtok_r(NULL
, " \t", &saveptr
)) {
179 struct kmod_module
*depmod
= NULL
;
182 path
= path_join(p
, dirnamelen
, buf
);
184 ERR(ctx
, "could not join path '%s' and '%s'.\n",
189 err
= kmod_module_new_from_path(ctx
, path
, &depmod
);
191 ERR(ctx
, "ctx=%p path=%s error=%s\n",
192 ctx
, path
, strerror(-err
));
196 DBG(ctx
, "add dep: %s\n", path
);
198 list
= kmod_list_prepend(list
, depmod
);
202 DBG(ctx
, "%d dependencies for %s\n", n
, mod
->name
);
209 kmod_module_unref_list(list
);
210 mod
->init
.dep
= false;
214 void kmod_module_set_visited(struct kmod_module
*mod
, bool visited
)
216 mod
->visited
= visited
;
219 void kmod_module_set_builtin(struct kmod_module
*mod
, bool builtin
)
222 builtin
? KMOD_MODULE_BUILTIN_YES
: KMOD_MODULE_BUILTIN_NO
;
225 void kmod_module_set_required(struct kmod_module
*mod
, bool required
)
227 mod
->required
= required
;
230 bool kmod_module_is_builtin(struct kmod_module
*mod
)
232 if (mod
->builtin
== KMOD_MODULE_BUILTIN_UNKNOWN
) {
233 kmod_module_set_builtin(mod
,
234 kmod_lookup_alias_is_builtin(mod
->ctx
, mod
->name
));
237 return mod
->builtin
== KMOD_MODULE_BUILTIN_YES
;
240 * Memory layout with alias:
242 * struct kmod_module {
247 * name <----------' | |
248 * alias <-----------' |
249 * name\alias <--------'
251 * Memory layout without alias:
253 * struct kmod_module {
255 * alias -----|----> NULL
258 * name <----------'-'
260 * @key is "name\alias" or "name" (in which case alias == NULL)
262 static int kmod_module_new(struct kmod_ctx
*ctx
, const char *key
,
263 const char *name
, size_t namelen
,
264 const char *alias
, size_t aliaslen
,
265 struct kmod_module
**mod
)
267 struct kmod_module
*m
;
270 m
= kmod_pool_get_module(ctx
, key
);
272 *mod
= kmod_module_ref(m
);
279 keylen
= namelen
+ aliaslen
+ 1;
281 m
= malloc(sizeof(*m
) + (alias
== NULL
? 1 : 2) * (keylen
+ 1));
285 memset(m
, 0, sizeof(*m
));
287 m
->ctx
= kmod_ref(ctx
);
288 m
->name
= (char *)m
+ sizeof(*m
);
289 memcpy(m
->name
, key
, keylen
+ 1);
291 m
->hashkey
= m
->name
;
294 m
->name
[namelen
] = '\0';
295 m
->alias
= m
->name
+ namelen
+ 1;
296 m
->hashkey
= m
->name
+ keylen
+ 1;
297 memcpy(m
->hashkey
, key
, keylen
+ 1);
301 kmod_pool_add_module(ctx
, m
, m
->hashkey
);
308 * kmod_module_new_from_name:
309 * @ctx: kmod library context
310 * @name: name of the module
311 * @mod: where to save the created struct kmod_module
313 * Create a new struct kmod_module using the module name. @name can not be an
314 * alias, file name or anything else; it must be a module name. There's no
315 * check if the module exists in the system.
317 * This function is also used internally by many others that return a new
318 * struct kmod_module or a new list of modules.
320 * The initial refcount is 1, and needs to be decremented to release the
321 * resources of the kmod_module. Since libkmod keeps track of all
322 * kmod_modules created, they are all released upon @ctx destruction too. Do
323 * not unref @ctx before all the desired operations with the returned
324 * kmod_module are done.
326 * Returns: 0 on success or < 0 otherwise. It fails if name is not a valid
327 * module name or if memory allocation failed.
329 KMOD_EXPORT
int kmod_module_new_from_name(struct kmod_ctx
*ctx
,
331 struct kmod_module
**mod
)
334 char name_norm
[PATH_MAX
];
336 if (ctx
== NULL
|| name
== NULL
|| mod
== NULL
)
339 modname_normalize(name
, name_norm
, &namelen
);
341 return kmod_module_new(ctx
, name_norm
, name_norm
, namelen
, NULL
, 0, mod
);
344 int kmod_module_new_from_alias(struct kmod_ctx
*ctx
, const char *alias
,
345 const char *name
, struct kmod_module
**mod
)
349 size_t namelen
= strlen(name
);
350 size_t aliaslen
= strlen(alias
);
352 if (namelen
+ aliaslen
+ 2 > PATH_MAX
)
353 return -ENAMETOOLONG
;
355 memcpy(key
, name
, namelen
);
356 memcpy(key
+ namelen
+ 1, alias
, aliaslen
+ 1);
359 err
= kmod_module_new(ctx
, key
, name
, namelen
, alias
, aliaslen
, mod
);
367 * kmod_module_new_from_path:
368 * @ctx: kmod library context
369 * @path: path where to find the given module
370 * @mod: where to save the created struct kmod_module
372 * Create a new struct kmod_module using the module path. @path must be an
373 * existent file with in the filesystem and must be accessible to libkmod.
375 * The initial refcount is 1, and needs to be decremented to release the
376 * resources of the kmod_module. Since libkmod keeps track of all
377 * kmod_modules created, they are all released upon @ctx destruction too. Do
378 * not unref @ctx before all the desired operations with the returned
379 * kmod_module are done.
381 * If @path is relative, it's treated as relative to the current working
382 * directory. Otherwise, give an absolute path.
384 * Returns: 0 on success or < 0 otherwise. It fails if file does not exist, if
385 * it's not a valid file for a kmod_module or if memory allocation failed.
387 KMOD_EXPORT
int kmod_module_new_from_path(struct kmod_ctx
*ctx
,
389 struct kmod_module
**mod
)
391 struct kmod_module
*m
;
398 if (ctx
== NULL
|| path
== NULL
|| mod
== NULL
)
401 abspath
= path_make_absolute_cwd(path
);
402 if (abspath
== NULL
) {
403 DBG(ctx
, "no absolute path for %s\n", path
);
407 err
= stat(abspath
, &st
);
410 DBG(ctx
, "stat %s: %s\n", path
, strerror(errno
));
415 if (path_to_modname(path
, name
, &namelen
) == NULL
) {
416 DBG(ctx
, "could not get modname from path %s\n", path
);
421 m
= kmod_pool_get_module(ctx
, name
);
425 else if (streq(m
->path
, abspath
))
428 ERR(ctx
, "kmod_module '%s' already exists with different path: new-path='%s' old-path='%s'\n",
429 name
, abspath
, m
->path
);
434 *mod
= kmod_module_ref(m
);
438 err
= kmod_module_new(ctx
, name
, name
, namelen
, NULL
, 0, &m
);
454 * Drop a reference of the kmod module. If the refcount reaches zero, its
455 * resources are released.
457 * Returns: NULL if @mod is NULL or if the module was released. Otherwise it
458 * returns the passed @mod with its refcount decremented.
460 KMOD_EXPORT
struct kmod_module
*kmod_module_unref(struct kmod_module
*mod
)
465 if (--mod
->refcount
> 0)
468 DBG(mod
->ctx
, "kmod_module %p released\n", mod
);
470 kmod_pool_del_module(mod
->ctx
, mod
, mod
->hashkey
);
471 kmod_module_unref_list(mod
->dep
);
474 kmod_file_unref(mod
->file
);
476 kmod_unref(mod
->ctx
);
487 * Take a reference of the kmod module, incrementing its refcount.
489 * Returns: the passed @module with its refcount incremented.
491 KMOD_EXPORT
struct kmod_module
*kmod_module_ref(struct kmod_module
*mod
)
501 #define CHECK_ERR_AND_FINISH(_err, _label_err, _list, label_finish) \
505 if (*(_list) != NULL) \
510 * kmod_module_new_from_lookup:
511 * @ctx: kmod library context
512 * @given_alias: alias to look for
513 * @list: an empty list where to save the list of modules matching
516 * Create a new list of kmod modules using an alias or module name and lookup
517 * libkmod's configuration files and indexes in order to find the module.
518 * Once it's found in one of the places, it stops searching and create the
519 * list of modules that is saved in @list.
521 * The search order is: 1. aliases in configuration file; 2. module names in
522 * modules.dep index; 3. symbol aliases in modules.symbols index; 4. aliases
523 * in modules.alias index.
525 * The initial refcount is 1, and needs to be decremented to release the
526 * resources of the kmod_module. The returned @list must be released by
527 * calling kmod_module_unref_list(). Since libkmod keeps track of all
528 * kmod_modules created, they are all released upon @ctx destruction too. Do
529 * not unref @ctx before all the desired operations with the returned list are
532 * Returns: 0 on success or < 0 otherwise. It fails if any of the lookup
533 * methods failed, which is basically due to memory allocation fail. If module
534 * is not found, it still returns 0, but @list is an empty list.
536 KMOD_EXPORT
int kmod_module_new_from_lookup(struct kmod_ctx
*ctx
,
537 const char *given_alias
,
538 struct kmod_list
**list
)
541 char alias
[PATH_MAX
];
543 if (ctx
== NULL
|| given_alias
== NULL
)
546 if (list
== NULL
|| *list
!= NULL
) {
547 ERR(ctx
, "An empty list is needed to create lookup\n");
551 if (alias_normalize(given_alias
, alias
, NULL
) < 0) {
552 DBG(ctx
, "invalid alias: %s\n", given_alias
);
556 DBG(ctx
, "input alias=%s, normalized=%s\n", given_alias
, alias
);
558 /* Aliases from config file override all the others */
559 err
= kmod_lookup_alias_from_config(ctx
, alias
, list
);
560 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
562 DBG(ctx
, "lookup modules.dep %s\n", alias
);
563 err
= kmod_lookup_alias_from_moddep_file(ctx
, alias
, list
);
564 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
566 DBG(ctx
, "lookup modules.symbols %s\n", alias
);
567 err
= kmod_lookup_alias_from_symbols_file(ctx
, alias
, list
);
568 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
570 DBG(ctx
, "lookup install and remove commands %s\n", alias
);
571 err
= kmod_lookup_alias_from_commands(ctx
, alias
, list
);
572 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
574 DBG(ctx
, "lookup modules.aliases %s\n", alias
);
575 err
= kmod_lookup_alias_from_aliases_file(ctx
, alias
, list
);
576 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
578 DBG(ctx
, "lookup modules.builtin %s\n", alias
);
579 err
= kmod_lookup_alias_from_builtin_file(ctx
, alias
, list
);
580 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
583 DBG(ctx
, "lookup %s=%d, list=%p\n", alias
, err
, *list
);
586 DBG(ctx
, "Failed to lookup %s\n", alias
);
587 kmod_module_unref_list(*list
);
591 #undef CHECK_ERR_AND_FINISH
594 * kmod_module_unref_list:
595 * @list: list of kmod modules
597 * Drop a reference of each kmod module in @list and releases the resources
598 * taken by the list itself.
602 KMOD_EXPORT
int kmod_module_unref_list(struct kmod_list
*list
)
604 for (; list
!= NULL
; list
= kmod_list_remove(list
))
605 kmod_module_unref(list
->data
);
611 * kmod_module_get_filtered_blacklist:
612 * @ctx: kmod library context
613 * @input: list of kmod_module to be filtered with blacklist
614 * @output: where to save the new list
616 * This function should not be used. Use kmod_module_apply_filter instead.
618 * Given a list @input, this function filter it out with config's blacklist
619 * and save it in @output.
621 * Returns: 0 on success or < 0 otherwise. @output is saved with the updated
624 KMOD_EXPORT
int kmod_module_get_filtered_blacklist(const struct kmod_ctx
*ctx
,
625 const struct kmod_list
*input
,
626 struct kmod_list
**output
)
628 return kmod_module_apply_filter(ctx
, KMOD_FILTER_BLACKLIST
, input
, output
);
631 static const struct kmod_list
*module_get_dependencies_noref(const struct kmod_module
*mod
)
633 if (!mod
->init
.dep
) {
635 char *line
= kmod_search_moddep(mod
->ctx
, mod
->name
);
640 kmod_module_parse_depline((struct kmod_module
*)mod
, line
);
651 * kmod_module_get_dependencies:
654 * Search the modules.dep index to find the dependencies of the given @mod.
655 * The result is cached in @mod, so subsequent calls to this function will
656 * return the already searched list of modules.
658 * Returns: NULL on failure. Otherwise it returns a list of kmod modules
659 * that can be released by calling kmod_module_unref_list().
661 KMOD_EXPORT
struct kmod_list
*kmod_module_get_dependencies(const struct kmod_module
*mod
)
663 struct kmod_list
*l
, *l_new
, *list_new
= NULL
;
668 module_get_dependencies_noref(mod
);
670 kmod_list_foreach(l
, mod
->dep
) {
671 l_new
= kmod_list_append(list_new
, kmod_module_ref(l
->data
));
673 kmod_module_unref(l
->data
);
683 ERR(mod
->ctx
, "out of memory\n");
684 kmod_module_unref_list(list_new
);
689 * kmod_module_get_module:
690 * @entry: an entry in a list of kmod modules.
692 * Get the kmod module of this @entry in the list, increasing its refcount.
693 * After it's used, unref it. Since the refcount is incremented upon return,
694 * you still have to call kmod_module_unref_list() to release the list of kmod
697 * Returns: NULL on failure or the kmod_module contained in this list entry
698 * with its refcount incremented.
700 KMOD_EXPORT
struct kmod_module
*kmod_module_get_module(const struct kmod_list
*entry
)
705 return kmod_module_ref(entry
->data
);
709 * kmod_module_get_name:
712 * Get the name of this kmod module. Name is always available, independently
713 * if it was created by kmod_module_new_from_name() or another function and
714 * it's always normalized (dashes are replaced with underscores).
716 * Returns: the name of this kmod module.
718 KMOD_EXPORT
const char *kmod_module_get_name(const struct kmod_module
*mod
)
727 * kmod_module_get_path:
730 * Get the path of this kmod module. If this kmod module was not created by
731 * path, it can search the modules.dep index in order to find out the module
732 * under context's dirname.
734 * Returns: the path of this kmod module or NULL if such information is not
737 KMOD_EXPORT
const char *kmod_module_get_path(const struct kmod_module
*mod
)
744 DBG(mod
->ctx
, "name='%s' path='%s'\n", mod
->name
, mod
->path
);
746 if (mod
->path
!= NULL
)
752 line
= kmod_search_moddep(mod
->ctx
, mod
->name
);
756 kmod_module_parse_depline((struct kmod_module
*) mod
, line
);
763 extern long delete_module(const char *name
, unsigned int flags
);
766 * kmod_module_remove_module:
768 * @flags: flags to pass to Linux kernel when removing the module. The only valid flag is
769 * KMOD_REMOVE_FORCE: force remove module regardless if it's still in
770 * use by a kernel subsystem or other process;
771 * KMOD_REMOVE_NOWAIT is always enforced, causing us to pass O_NONBLOCK to
774 * Remove a module from Linux kernel.
776 * Returns: 0 on success or < 0 on failure.
778 KMOD_EXPORT
int kmod_module_remove_module(struct kmod_module
*mod
,
786 /* Filter out other flags and force ONONBLOCK */
787 flags
&= KMOD_REMOVE_FORCE
;
788 flags
|= KMOD_REMOVE_NOWAIT
;
790 err
= delete_module(mod
->name
, flags
);
793 ERR(mod
->ctx
, "could not remove '%s': %m\n", mod
->name
);
799 extern long init_module(const void *mem
, unsigned long len
, const char *args
);
802 * kmod_module_insert_module:
804 * @flags: flags are not passed to Linux Kernel, but instead they dictate the
805 * behavior of this function, valid flags are
806 * KMOD_INSERT_FORCE_VERMAGIC: ignore kernel version magic;
807 * KMOD_INSERT_FORCE_MODVERSION: ignore symbol version hashes.
808 * @options: module's options to pass to Linux Kernel.
810 * Insert a module in Linux kernel. It opens the file pointed by @mod,
811 * mmap'ing it and passing to kernel.
813 * Returns: 0 on success or < 0 on failure. If module is already loaded it
816 KMOD_EXPORT
int kmod_module_insert_module(struct kmod_module
*mod
,
823 struct kmod_elf
*elf
;
825 const char *args
= options
? options
: "";
830 path
= kmod_module_get_path(mod
);
832 ERR(mod
->ctx
, "could not find module by name='%s'\n", mod
->name
);
836 mod
->file
= kmod_file_open(mod
->ctx
, path
);
837 if (mod
->file
== NULL
) {
842 if (kmod_file_get_direct(mod
->file
)) {
843 unsigned int kernel_flags
= 0;
845 if (flags
& KMOD_INSERT_FORCE_VERMAGIC
)
846 kernel_flags
|= MODULE_INIT_IGNORE_VERMAGIC
;
847 if (flags
& KMOD_INSERT_FORCE_MODVERSION
)
848 kernel_flags
|= MODULE_INIT_IGNORE_MODVERSIONS
;
850 err
= finit_module(kmod_file_get_fd(mod
->file
), args
, kernel_flags
);
851 if (err
== 0 || errno
!= ENOSYS
)
855 if (flags
& (KMOD_INSERT_FORCE_VERMAGIC
| KMOD_INSERT_FORCE_MODVERSION
)) {
856 elf
= kmod_file_get_elf(mod
->file
);
862 if (flags
& KMOD_INSERT_FORCE_MODVERSION
) {
863 err
= kmod_elf_strip_section(elf
, "__versions");
865 INFO(mod
->ctx
, "Failed to strip modversion: %s\n", strerror(-err
));
868 if (flags
& KMOD_INSERT_FORCE_VERMAGIC
) {
869 err
= kmod_elf_strip_vermagic(elf
);
871 INFO(mod
->ctx
, "Failed to strip vermagic: %s\n", strerror(-err
));
874 mem
= kmod_elf_get_memory(elf
);
876 mem
= kmod_file_get_contents(mod
->file
);
878 size
= kmod_file_get_size(mod
->file
);
880 err
= init_module(mem
, size
, args
);
884 INFO(mod
->ctx
, "Failed to insert module '%s': %m\n", path
);
889 static bool module_is_blacklisted(struct kmod_module
*mod
)
891 struct kmod_ctx
*ctx
= mod
->ctx
;
892 const struct kmod_config
*config
= kmod_get_config(ctx
);
893 const struct kmod_list
*bl
= config
->blacklists
;
894 const struct kmod_list
*l
;
896 kmod_list_foreach(l
, bl
) {
897 const char *modname
= kmod_blacklist_get_modname(l
);
899 if (streq(modname
, mod
->name
))
907 * kmod_module_apply_filter
908 * @ctx: kmod library context
909 * @filter_type: bitmask to filter modules out, valid types are
910 * KMOD_FILTER_BLACKLIST: filter modules in blacklist out;
911 * KMOD_FILTER_BUILTIN: filter builtin modules out.
912 * @input: list of kmod_module to be filtered
913 * @output: where to save the new list
915 * Given a list @input, this function filter it out by the filter mask
916 * and save it in @output.
918 * Returns: 0 on success or < 0 otherwise. @output is saved with the updated
921 KMOD_EXPORT
int kmod_module_apply_filter(const struct kmod_ctx
*ctx
,
922 enum kmod_filter filter_type
,
923 const struct kmod_list
*input
,
924 struct kmod_list
**output
)
926 const struct kmod_list
*li
;
928 if (ctx
== NULL
|| output
== NULL
)
935 kmod_list_foreach(li
, input
) {
936 struct kmod_module
*mod
= li
->data
;
937 struct kmod_list
*node
;
939 if ((filter_type
& KMOD_FILTER_BLACKLIST
) &&
940 module_is_blacklisted(mod
))
943 if ((filter_type
& KMOD_FILTER_BUILTIN
)
944 && kmod_module_is_builtin(mod
))
947 node
= kmod_list_append(*output
, mod
);
952 kmod_module_ref(mod
);
958 kmod_module_unref_list(*output
);
963 static int command_do(struct kmod_module
*mod
, const char *type
,
966 const char *modname
= kmod_module_get_name(mod
);
969 DBG(mod
->ctx
, "%s %s\n", type
, cmd
);
971 setenv("MODPROBE_MODULE", modname
, 1);
973 unsetenv("MODPROBE_MODULE");
975 if (err
== -1 || WEXITSTATUS(err
)) {
976 ERR(mod
->ctx
, "Error running %s command for %s\n",
979 err
= -WEXITSTATUS(err
);
985 struct probe_insert_cb
{
986 int (*run_install
)(struct kmod_module
*m
, const char *cmd
, void *data
);
990 static int module_do_install_commands(struct kmod_module
*mod
,
992 struct probe_insert_cb
*cb
)
994 const char *command
= kmod_module_get_install_commands(mod
);
996 _cleanup_free_
char *cmd
;
998 size_t cmdlen
, options_len
, varlen
;
1002 if (options
== NULL
)
1005 options_len
= strlen(options
);
1006 cmdlen
= strlen(command
);
1007 varlen
= sizeof("$CMDLINE_OPTS") - 1;
1009 cmd
= memdup(command
, cmdlen
+ 1);
1013 while ((p
= strstr(cmd
, "$CMDLINE_OPTS")) != NULL
) {
1014 size_t prefixlen
= p
- cmd
;
1015 size_t suffixlen
= cmdlen
- prefixlen
- varlen
;
1016 size_t slen
= cmdlen
- varlen
+ options_len
;
1017 char *suffix
= p
+ varlen
;
1018 char *s
= malloc(slen
+ 1);
1022 memcpy(s
, cmd
, p
- cmd
);
1023 memcpy(s
+ prefixlen
, options
, options_len
);
1024 memcpy(s
+ prefixlen
+ options_len
, suffix
, suffixlen
);
1032 if (cb
->run_install
!= NULL
)
1033 err
= cb
->run_install(mod
, cmd
, cb
->data
);
1035 err
= command_do(mod
, "install", cmd
);
1040 static char *module_options_concat(const char *opt
, const char *xopt
)
1042 // TODO: we might need to check if xopt overrides options on opt
1043 size_t optlen
= opt
== NULL
? 0 : strlen(opt
);
1044 size_t xoptlen
= xopt
== NULL
? 0 : strlen(xopt
);
1047 if (optlen
== 0 && xoptlen
== 0)
1050 r
= malloc(optlen
+ xoptlen
+ 2);
1053 memcpy(r
, opt
, optlen
);
1059 memcpy(r
+ optlen
, xopt
, xoptlen
);
1061 r
[optlen
+ xoptlen
] = '\0';
1066 static int __kmod_module_get_probe_list(struct kmod_module
*mod
,
1069 struct kmod_list
**list
);
1072 static int __kmod_module_fill_softdep(struct kmod_module
*mod
,
1073 struct kmod_list
**list
)
1075 struct kmod_list
*pre
= NULL
, *post
= NULL
, *l
;
1078 err
= kmod_module_get_softdeps(mod
, &pre
, &post
);
1080 ERR(mod
->ctx
, "could not get softdep: %s\n",
1085 kmod_list_foreach(l
, pre
) {
1086 struct kmod_module
*m
= l
->data
;
1087 err
= __kmod_module_get_probe_list(m
, false, false, list
);
1092 l
= kmod_list_append(*list
, kmod_module_ref(mod
));
1094 kmod_module_unref(mod
);
1099 mod
->ignorecmd
= (pre
!= NULL
|| post
!= NULL
);
1101 kmod_list_foreach(l
, post
) {
1102 struct kmod_module
*m
= l
->data
;
1103 err
= __kmod_module_get_probe_list(m
, false, false, list
);
1109 kmod_module_unref_list(pre
);
1110 kmod_module_unref_list(post
);
1116 static int __kmod_module_get_probe_list(struct kmod_module
*mod
,
1119 struct kmod_list
**list
)
1121 struct kmod_list
*dep
, *l
;
1125 DBG(mod
->ctx
, "Ignore module '%s': already visited\n",
1129 mod
->visited
= true;
1131 dep
= kmod_module_get_dependencies(mod
);
1134 * Called from kmod_module_probe_insert_module(); set the
1135 * ->required flag on mod and all its dependencies before
1136 * they are possibly visited through some softdeps.
1138 mod
->required
= true;
1139 kmod_list_foreach(l
, dep
) {
1140 struct kmod_module
*m
= l
->data
;
1145 kmod_list_foreach(l
, dep
) {
1146 struct kmod_module
*m
= l
->data
;
1147 err
= __kmod_module_fill_softdep(m
, list
);
1153 l
= kmod_list_append(*list
, kmod_module_ref(mod
));
1155 kmod_module_unref(mod
);
1160 mod
->ignorecmd
= true;
1162 err
= __kmod_module_fill_softdep(mod
, list
);
1165 kmod_module_unref_list(dep
);
1169 static int kmod_module_get_probe_list(struct kmod_module
*mod
,
1171 struct kmod_list
**list
)
1175 assert(mod
!= NULL
);
1176 assert(list
!= NULL
&& *list
== NULL
);
1179 * Make sure we don't get screwed by previous calls to this function
1181 kmod_set_modules_visited(mod
->ctx
, false);
1182 kmod_set_modules_required(mod
->ctx
, false);
1184 err
= __kmod_module_get_probe_list(mod
, true, ignorecmd
, list
);
1186 kmod_module_unref_list(*list
);
1194 * kmod_module_probe_insert_module:
1196 * @flags: flags are not passed to Linux Kernel, but instead they dictate the
1197 * behavior of this function, valid flags are
1198 * KMOD_PROBE_FORCE_VERMAGIC: ignore kernel version magic;
1199 * KMOD_PROBE_FORCE_MODVERSION: ignore symbol version hashes;
1200 * KMOD_PROBE_IGNORE_COMMAND: whether the probe should ignore install
1201 * commands and softdeps configured in the system;
1202 * KMOD_PROBE_IGNORE_LOADED: do not check whether the module is already
1203 * live in kernel or not;
1204 * KMOD_PROBE_DRY_RUN: dry run, do not insert module, just call the
1205 * associated callback function;
1206 * KMOD_PROBE_FAIL_ON_LOADED: if KMOD_PROBE_IGNORE_LOADED is not specified
1207 * and the module is already live in kernel, the function will fail if this
1208 * flag is specified;
1209 * KMOD_PROBE_APPLY_BLACKLIST_ALL: probe will apply KMOD_FILTER_BLACKLIST
1210 * filter to this module and its dependencies. If any of the dependencies (or
1211 * the module) is blacklisted, the probe will fail, unless the blacklisted
1212 * module is already live in kernel;
1213 * KMOD_PROBE_APPLY_BLACKLIST: probe will fail if the module is blacklisted;
1214 * KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY: probe will fail if the module is an
1215 * alias and is blacklisted.
1216 * @extra_options: module's options to pass to Linux Kernel. It applies only
1217 * to @mod, not to its dependencies.
1218 * @run_install: function to run when @mod is backed by an install command.
1219 * @data: data to give back to @run_install callback
1220 * @print_action: function to call with the action being taken (install or
1221 * insmod). It's useful for tools like modprobe when running with verbose
1222 * output or in dry-run mode.
1224 * Insert a module in Linux kernel resolving dependencies, soft dependencies,
1225 * install commands and applying blacklist.
1227 * If @run_install is NULL, this function will fork and exec by calling
1228 * system(3). Don't pass a NULL argument in @run_install if your binary is
1229 * setuid/setgid (see warning in system(3)). If you need control over the
1230 * execution of an install command, give a callback function instead.
1232 * Returns: 0 on success, > 0 if stopped by a reason given in @flags or < 0 on
1235 KMOD_EXPORT
int kmod_module_probe_insert_module(struct kmod_module
*mod
,
1236 unsigned int flags
, const char *extra_options
,
1237 int (*run_install
)(struct kmod_module
*m
,
1238 const char *cmd
, void *data
),
1240 void (*print_action
)(struct kmod_module
*m
,
1242 const char *options
))
1244 struct kmod_list
*list
= NULL
, *l
;
1245 struct probe_insert_cb cb
;
1251 if (!(flags
& KMOD_PROBE_IGNORE_LOADED
)
1252 && module_is_inkernel(mod
)) {
1253 if (flags
& KMOD_PROBE_FAIL_ON_LOADED
)
1260 * Ugly assignement + check. We need to check if we were told to check
1261 * blacklist and also return the reason why we failed.
1262 * KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY will take effect only if the
1263 * module is an alias, so we also need to check it
1265 if ((mod
->alias
!= NULL
&& ((err
= flags
& KMOD_PROBE_APPLY_BLACKLIST_ALIAS_ONLY
)))
1266 || (err
= flags
& KMOD_PROBE_APPLY_BLACKLIST_ALL
)
1267 || (err
= flags
& KMOD_PROBE_APPLY_BLACKLIST
)) {
1268 if (module_is_blacklisted(mod
))
1272 err
= kmod_module_get_probe_list(mod
,
1273 !!(flags
& KMOD_PROBE_IGNORE_COMMAND
), &list
);
1277 if (flags
& KMOD_PROBE_APPLY_BLACKLIST_ALL
) {
1278 struct kmod_list
*filtered
= NULL
;
1280 err
= kmod_module_apply_filter(mod
->ctx
,
1281 KMOD_FILTER_BLACKLIST
, list
, &filtered
);
1285 kmod_module_unref_list(list
);
1286 if (filtered
== NULL
)
1287 return KMOD_PROBE_APPLY_BLACKLIST_ALL
;
1292 cb
.run_install
= run_install
;
1293 cb
.data
= (void *) data
;
1295 kmod_list_foreach(l
, list
) {
1296 struct kmod_module
*m
= l
->data
;
1297 const char *moptions
= kmod_module_get_options(m
);
1298 const char *cmd
= kmod_module_get_install_commands(m
);
1301 if (!(flags
& KMOD_PROBE_IGNORE_LOADED
)
1302 && module_is_inkernel(m
)) {
1303 DBG(mod
->ctx
, "Ignoring module '%s': already loaded\n",
1309 options
= module_options_concat(moptions
,
1310 m
== mod
? extra_options
: NULL
);
1312 if (cmd
!= NULL
&& !m
->ignorecmd
) {
1313 if (print_action
!= NULL
)
1314 print_action(m
, true, options
?: "");
1316 if (!(flags
& KMOD_PROBE_DRY_RUN
))
1317 err
= module_do_install_commands(m
, options
,
1320 if (print_action
!= NULL
)
1321 print_action(m
, false, options
?: "");
1323 if (!(flags
& KMOD_PROBE_DRY_RUN
))
1324 err
= kmod_module_insert_module(m
, flags
,
1332 * Treat "already loaded" error. If we were told to stop on
1333 * already loaded and the module being loaded is not a softdep
1334 * or dep, bail out. Otherwise, just ignore and continue.
1336 * We need to check here because of race conditions. We
1337 * checked first if module was already loaded but it may have
1338 * been loaded between the check and the moment we try to
1341 if (err
== -EEXIST
&& m
== mod
&&
1342 (flags
& KMOD_PROBE_FAIL_ON_LOADED
))
1346 * Ignore errors from softdeps
1348 if (err
== -EEXIST
|| !m
->required
)
1355 kmod_module_unref_list(list
);
1360 * kmod_module_get_options:
1363 * Get options of this kmod module. Options come from the configuration file
1364 * and are cached in @mod. The first call to this function will search for
1365 * this module in configuration and subsequent calls return the cached string.
1367 * Returns: a string with all the options separated by spaces. This string is
1368 * owned by @mod, do not free it.
1370 KMOD_EXPORT
const char *kmod_module_get_options(const struct kmod_module
*mod
)
1375 if (!mod
->init
.options
) {
1377 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1378 const struct kmod_list
*l
;
1379 const struct kmod_config
*config
;
1383 config
= kmod_get_config(mod
->ctx
);
1385 kmod_list_foreach(l
, config
->options
) {
1386 const char *modname
= kmod_option_get_modname(l
);
1391 DBG(mod
->ctx
, "modname=%s mod->name=%s mod->alias=%s\n", modname
, mod
->name
, mod
->alias
);
1392 if (!(streq(modname
, mod
->name
) || (mod
->alias
!= NULL
&&
1393 streq(modname
, mod
->alias
))))
1396 DBG(mod
->ctx
, "passed = modname=%s mod->name=%s mod->alias=%s\n", modname
, mod
->name
, mod
->alias
);
1397 str
= kmod_option_get_options(l
);
1402 tmp
= realloc(opts
, optslen
+ len
+ 2);
1411 opts
[optslen
] = ' ';
1415 memcpy(opts
+ optslen
, str
, len
);
1417 opts
[optslen
] = '\0';
1420 m
->init
.options
= true;
1424 return mod
->options
;
1427 ERR(mod
->ctx
, "out of memory\n");
1432 * kmod_module_get_install_commands:
1435 * Get install commands for this kmod module. Install commands come from the
1436 * configuration file and are cached in @mod. The first call to this function
1437 * will search for this module in configuration and subsequent calls return
1438 * the cached string. The install commands are returned as they were in the
1439 * configuration, concatenated by ';'. No other processing is made in this
1442 * Returns: a string with all install commands separated by semicolons. This
1443 * string is owned by @mod, do not free it.
1445 KMOD_EXPORT
const char *kmod_module_get_install_commands(const struct kmod_module
*mod
)
1450 if (!mod
->init
.install_commands
) {
1452 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1453 const struct kmod_list
*l
;
1454 const struct kmod_config
*config
;
1456 config
= kmod_get_config(mod
->ctx
);
1458 kmod_list_foreach(l
, config
->install_commands
) {
1459 const char *modname
= kmod_command_get_modname(l
);
1461 if (fnmatch(modname
, mod
->name
, 0) != 0)
1464 m
->install_commands
= kmod_command_get_command(l
);
1467 * find only the first command, as modprobe from
1468 * module-init-tools does
1473 m
->init
.install_commands
= true;
1476 return mod
->install_commands
;
1479 void kmod_module_set_install_commands(struct kmod_module
*mod
, const char *cmd
)
1481 mod
->init
.install_commands
= true;
1482 mod
->install_commands
= cmd
;
1485 static struct kmod_list
*lookup_softdep(struct kmod_ctx
*ctx
, const char * const * array
, unsigned int count
)
1487 struct kmod_list
*ret
= NULL
;
1490 for (i
= 0; i
< count
; i
++) {
1491 const char *depname
= array
[i
];
1492 struct kmod_list
*lst
= NULL
;
1495 err
= kmod_module_new_from_lookup(ctx
, depname
, &lst
);
1497 ERR(ctx
, "failed to lookup soft dependency '%s', continuing anyway.\n", depname
);
1499 } else if (lst
!= NULL
)
1500 ret
= kmod_list_append_list(ret
, lst
);
1506 * kmod_module_get_softdeps:
1508 * @pre: where to save the list of preceding soft dependencies.
1509 * @post: where to save the list of post soft dependencies.
1511 * Get soft dependencies for this kmod module. Soft dependencies come
1512 * from configuration file and are not cached in @mod because it may include
1513 * dependency cycles that would make we leak kmod_module. Any call
1514 * to this function will search for this module in configuration, allocate a
1515 * list and return the result.
1517 * Both @pre and @post are newly created list of kmod_module and
1518 * should be unreferenced with kmod_module_unref_list().
1520 * Returns: 0 on success or < 0 otherwise.
1522 KMOD_EXPORT
int kmod_module_get_softdeps(const struct kmod_module
*mod
,
1523 struct kmod_list
**pre
,
1524 struct kmod_list
**post
)
1526 const struct kmod_list
*l
;
1527 const struct kmod_config
*config
;
1529 if (mod
== NULL
|| pre
== NULL
|| post
== NULL
)
1532 assert(*pre
== NULL
);
1533 assert(*post
== NULL
);
1535 config
= kmod_get_config(mod
->ctx
);
1537 kmod_list_foreach(l
, config
->softdeps
) {
1538 const char *modname
= kmod_softdep_get_name(l
);
1539 const char * const *array
;
1542 if (fnmatch(modname
, mod
->name
, 0) != 0)
1545 array
= kmod_softdep_get_pre(l
, &count
);
1546 *pre
= lookup_softdep(mod
->ctx
, array
, count
);
1547 array
= kmod_softdep_get_post(l
, &count
);
1548 *post
= lookup_softdep(mod
->ctx
, array
, count
);
1551 * find only the first command, as modprobe from
1552 * module-init-tools does
1561 * kmod_module_get_remove_commands:
1564 * Get remove commands for this kmod module. Remove commands come from the
1565 * configuration file and are cached in @mod. The first call to this function
1566 * will search for this module in configuration and subsequent calls return
1567 * the cached string. The remove commands are returned as they were in the
1568 * configuration, concatenated by ';'. No other processing is made in this
1571 * Returns: a string with all remove commands separated by semicolons. This
1572 * string is owned by @mod, do not free it.
1574 KMOD_EXPORT
const char *kmod_module_get_remove_commands(const struct kmod_module
*mod
)
1579 if (!mod
->init
.remove_commands
) {
1581 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1582 const struct kmod_list
*l
;
1583 const struct kmod_config
*config
;
1585 config
= kmod_get_config(mod
->ctx
);
1587 kmod_list_foreach(l
, config
->remove_commands
) {
1588 const char *modname
= kmod_command_get_modname(l
);
1590 if (fnmatch(modname
, mod
->name
, 0) != 0)
1593 m
->remove_commands
= kmod_command_get_command(l
);
1596 * find only the first command, as modprobe from
1597 * module-init-tools does
1602 m
->init
.remove_commands
= true;
1605 return mod
->remove_commands
;
1608 void kmod_module_set_remove_commands(struct kmod_module
*mod
, const char *cmd
)
1610 mod
->init
.remove_commands
= true;
1611 mod
->remove_commands
= cmd
;
1615 * SECTION:libkmod-loaded
1616 * @short_description: currently loaded modules
1618 * Information about currently loaded modules, as reported by Linux kernel.
1619 * These information are not cached by libkmod and are always read from /sys
1620 * and /proc/modules.
1624 * kmod_module_new_from_loaded:
1625 * @ctx: kmod library context
1626 * @list: where to save the list of loaded modules
1628 * Create a new list of kmod modules with all modules currently loaded in
1629 * kernel. It uses /proc/modules to get the names of loaded modules and to
1630 * create kmod modules by calling kmod_module_new_from_name() in each of them.
1631 * They are put in @list in no particular order.
1633 * The initial refcount is 1, and needs to be decremented to release the
1634 * resources of the kmod_module. The returned @list must be released by
1635 * calling kmod_module_unref_list(). Since libkmod keeps track of all
1636 * kmod_modules created, they are all released upon @ctx destruction too. Do
1637 * not unref @ctx before all the desired operations with the returned list are
1640 * Returns: 0 on success or < 0 on error.
1642 KMOD_EXPORT
int kmod_module_new_from_loaded(struct kmod_ctx
*ctx
,
1643 struct kmod_list
**list
)
1645 struct kmod_list
*l
= NULL
;
1649 if (ctx
== NULL
|| list
== NULL
)
1652 fp
= fopen("/proc/modules", "re");
1655 ERR(ctx
, "could not open /proc/modules: %s\n", strerror(errno
));
1659 while (fgets(line
, sizeof(line
), fp
)) {
1660 struct kmod_module
*m
;
1661 struct kmod_list
*node
;
1663 size_t len
= strlen(line
);
1664 char *saveptr
, *name
= strtok_r(line
, " \t", &saveptr
);
1666 err
= kmod_module_new_from_name(ctx
, name
, &m
);
1668 ERR(ctx
, "could not get module from name '%s': %s\n",
1669 name
, strerror(-err
));
1673 node
= kmod_list_append(l
, m
);
1677 ERR(ctx
, "out of memory\n");
1678 kmod_module_unref(m
);
1681 while (line
[len
- 1] != '\n' && fgets(line
, sizeof(line
), fp
))
1692 * kmod_module_initstate_str:
1693 * @state: the state as returned by kmod_module_get_initstate()
1695 * Translate a initstate to a string.
1697 * Returns: the string associated to the @state. This string is statically
1698 * allocated, do not free it.
1700 KMOD_EXPORT
const char *kmod_module_initstate_str(enum kmod_module_initstate state
)
1703 case KMOD_MODULE_BUILTIN
:
1705 case KMOD_MODULE_LIVE
:
1707 case KMOD_MODULE_COMING
:
1709 case KMOD_MODULE_GOING
:
1717 * kmod_module_get_initstate:
1720 * Get the initstate of this @mod, as returned by Linux Kernel, by reading
1723 * Returns: < 0 on error or module state if module is found in kernel, valid states are
1724 * KMOD_MODULE_BUILTIN: module is builtin;
1725 * KMOD_MODULE_LIVE: module is live in kernel;
1726 * KMOD_MODULE_COMING: module is being loaded;
1727 * KMOD_MODULE_GOING: module is being unloaded.
1729 KMOD_EXPORT
int kmod_module_get_initstate(const struct kmod_module
*mod
)
1731 char path
[PATH_MAX
], buf
[32];
1732 int fd
, err
, pathlen
;
1737 /* remove const: this can only change internal state */
1738 if (kmod_module_is_builtin((struct kmod_module
*)mod
))
1739 return KMOD_MODULE_BUILTIN
;
1741 pathlen
= snprintf(path
, sizeof(path
),
1742 "/sys/module/%s/initstate", mod
->name
);
1743 fd
= open(path
, O_RDONLY
|O_CLOEXEC
);
1747 DBG(mod
->ctx
, "could not open '%s': %s\n",
1748 path
, strerror(-err
));
1750 if (pathlen
> (int)sizeof("/initstate") - 1) {
1752 path
[pathlen
- (sizeof("/initstate") - 1)] = '\0';
1753 if (stat(path
, &st
) == 0 && S_ISDIR(st
.st_mode
))
1754 return KMOD_MODULE_COMING
;
1757 DBG(mod
->ctx
, "could not open '%s': %s\n",
1758 path
, strerror(-err
));
1762 err
= read_str_safe(fd
, buf
, sizeof(buf
));
1765 ERR(mod
->ctx
, "could not read from '%s': %s\n",
1766 path
, strerror(-err
));
1770 if (streq(buf
, "live\n"))
1771 return KMOD_MODULE_LIVE
;
1772 else if (streq(buf
, "coming\n"))
1773 return KMOD_MODULE_COMING
;
1774 else if (streq(buf
, "going\n"))
1775 return KMOD_MODULE_GOING
;
1777 ERR(mod
->ctx
, "unknown %s: '%s'\n", path
, buf
);
1782 * kmod_module_get_size:
1785 * Get the size of this kmod module as returned by Linux kernel. If supported,
1786 * the size is read from the coresize attribute in /sys/module. For older
1787 * kernels, this falls back on /proc/modules and searches for the specified
1788 * module to get its size.
1790 * Returns: the size of this kmod module.
1792 KMOD_EXPORT
long kmod_module_get_size(const struct kmod_module
*mod
)
1797 long size
= -ENOENT
;
1803 /* try to open the module dir in /sys. If this fails, don't
1804 * bother trying to find the size as we know the module isn't
1807 snprintf(line
, sizeof(line
), "/sys/module/%s", mod
->name
);
1808 dfd
= open(line
, O_RDONLY
|O_CLOEXEC
);
1812 /* available as of linux 3.3.x */
1813 cfd
= openat(dfd
, "coresize", O_RDONLY
|O_CLOEXEC
);
1815 if (read_str_long(cfd
, &size
, 10) < 0)
1816 ERR(mod
->ctx
, "failed to read coresize from %s\n", line
);
1821 /* fall back on parsing /proc/modules */
1822 fp
= fopen("/proc/modules", "re");
1826 "could not open /proc/modules: %s\n", strerror(errno
));
1831 while (fgets(line
, sizeof(line
), fp
)) {
1832 size_t len
= strlen(line
);
1833 char *saveptr
, *endptr
, *tok
= strtok_r(line
, " \t", &saveptr
);
1837 if (tok
== NULL
|| !streq(tok
, mod
->name
))
1840 tok
= strtok_r(NULL
, " \t", &saveptr
);
1843 "invalid line format at /proc/modules:%d\n", lineno
);
1847 value
= strtol(tok
, &endptr
, 10);
1848 if (endptr
== tok
|| *endptr
!= '\0') {
1850 "invalid line format at /proc/modules:%d\n", lineno
);
1857 while (line
[len
- 1] != '\n' && fgets(line
, sizeof(line
), fp
))
1868 * kmod_module_get_refcnt:
1871 * Get the ref count of this @mod, as returned by Linux Kernel, by reading
1874 * Returns: the reference count on success or < 0 on failure.
1876 KMOD_EXPORT
int kmod_module_get_refcnt(const struct kmod_module
*mod
)
1878 char path
[PATH_MAX
];
1885 snprintf(path
, sizeof(path
), "/sys/module/%s/refcnt", mod
->name
);
1886 fd
= open(path
, O_RDONLY
|O_CLOEXEC
);
1889 DBG(mod
->ctx
, "could not open '%s': %s\n",
1890 path
, strerror(errno
));
1894 err
= read_str_long(fd
, &refcnt
, 10);
1897 ERR(mod
->ctx
, "could not read integer from '%s': '%s'\n",
1898 path
, strerror(-err
));
1906 * kmod_module_get_holders:
1909 * Get a list of kmod modules that are holding this @mod, as returned by Linux
1910 * Kernel. After use, free the @list by calling kmod_module_unref_list().
1912 * Returns: a new list of kmod modules on success or NULL on failure.
1914 KMOD_EXPORT
struct kmod_list
*kmod_module_get_holders(const struct kmod_module
*mod
)
1916 char dname
[PATH_MAX
];
1917 struct kmod_list
*list
= NULL
;
1918 struct dirent
*dent
;
1921 if (mod
== NULL
|| mod
->ctx
== NULL
)
1924 snprintf(dname
, sizeof(dname
), "/sys/module/%s/holders", mod
->name
);
1928 ERR(mod
->ctx
, "could not open '%s': %s\n",
1929 dname
, strerror(errno
));
1933 for (dent
= readdir(d
); dent
!= NULL
; dent
= readdir(d
)) {
1934 struct kmod_module
*holder
;
1935 struct kmod_list
*l
;
1938 if (dent
->d_name
[0] == '.') {
1939 if (dent
->d_name
[1] == '\0' ||
1940 (dent
->d_name
[1] == '.' && dent
->d_name
[2] == '\0'))
1944 err
= kmod_module_new_from_name(mod
->ctx
, dent
->d_name
,
1947 ERR(mod
->ctx
, "could not create module for '%s': %s\n",
1948 dent
->d_name
, strerror(-err
));
1952 l
= kmod_list_append(list
, holder
);
1956 ERR(mod
->ctx
, "out of memory\n");
1957 kmod_module_unref(holder
);
1967 kmod_module_unref_list(list
);
1971 struct kmod_module_section
{
1972 unsigned long address
;
1976 static void kmod_module_section_free(struct kmod_module_section
*section
)
1982 * kmod_module_get_sections:
1985 * Get a list of kmod sections of this @mod, as returned by Linux Kernel. The
1986 * structure contained in this list is internal to libkmod and their fields
1987 * can be obtained by calling kmod_module_section_get_name() and
1988 * kmod_module_section_get_address().
1990 * After use, free the @list by calling kmod_module_section_free_list().
1992 * Returns: a new list of kmod module sections on success or NULL on failure.
1994 KMOD_EXPORT
struct kmod_list
*kmod_module_get_sections(const struct kmod_module
*mod
)
1996 char dname
[PATH_MAX
];
1997 struct kmod_list
*list
= NULL
;
1998 struct dirent
*dent
;
2005 snprintf(dname
, sizeof(dname
), "/sys/module/%s/sections", mod
->name
);
2009 ERR(mod
->ctx
, "could not open '%s': %s\n",
2010 dname
, strerror(errno
));
2016 for (dent
= readdir(d
); dent
; dent
= readdir(d
)) {
2017 struct kmod_module_section
*section
;
2018 struct kmod_list
*l
;
2019 unsigned long address
;
2023 if (dent
->d_name
[0] == '.') {
2024 if (dent
->d_name
[1] == '\0' ||
2025 (dent
->d_name
[1] == '.' && dent
->d_name
[2] == '\0'))
2029 fd
= openat(dfd
, dent
->d_name
, O_RDONLY
|O_CLOEXEC
);
2031 ERR(mod
->ctx
, "could not open '%s/%s': %m\n",
2032 dname
, dent
->d_name
);
2036 err
= read_str_ulong(fd
, &address
, 16);
2039 ERR(mod
->ctx
, "could not read long from '%s/%s': %m\n",
2040 dname
, dent
->d_name
);
2044 namesz
= strlen(dent
->d_name
) + 1;
2045 section
= malloc(sizeof(*section
) + namesz
);
2047 if (section
== NULL
) {
2048 ERR(mod
->ctx
, "out of memory\n");
2052 section
->address
= address
;
2053 memcpy(section
->name
, dent
->d_name
, namesz
);
2055 l
= kmod_list_append(list
, section
);
2059 ERR(mod
->ctx
, "out of memory\n");
2070 kmod_module_unref_list(list
);
2075 * kmod_module_section_get_module_name:
2076 * @entry: a list entry representing a kmod module section
2078 * Get the name of a kmod module section.
2080 * After use, free the @list by calling kmod_module_section_free_list().
2082 * Returns: the name of this kmod module section on success or NULL on
2083 * failure. The string is owned by the section, do not free it.
2085 KMOD_EXPORT
const char *kmod_module_section_get_name(const struct kmod_list
*entry
)
2087 struct kmod_module_section
*section
;
2092 section
= entry
->data
;
2093 return section
->name
;
2097 * kmod_module_section_get_address:
2098 * @entry: a list entry representing a kmod module section
2100 * Get the address of a kmod module section.
2102 * After use, free the @list by calling kmod_module_section_free_list().
2104 * Returns: the address of this kmod module section on success or ULONG_MAX
2107 KMOD_EXPORT
unsigned long kmod_module_section_get_address(const struct kmod_list
*entry
)
2109 struct kmod_module_section
*section
;
2112 return (unsigned long)-1;
2114 section
= entry
->data
;
2115 return section
->address
;
2119 * kmod_module_section_free_list:
2120 * @list: kmod module section list
2122 * Release the resources taken by @list
2124 KMOD_EXPORT
void kmod_module_section_free_list(struct kmod_list
*list
)
2127 kmod_module_section_free(list
->data
);
2128 list
= kmod_list_remove(list
);
2132 static struct kmod_elf
*kmod_module_get_elf(const struct kmod_module
*mod
)
2134 if (mod
->file
== NULL
) {
2135 const char *path
= kmod_module_get_path(mod
);
2142 ((struct kmod_module
*)mod
)->file
= kmod_file_open(mod
->ctx
,
2144 if (mod
->file
== NULL
)
2148 return kmod_file_get_elf(mod
->file
);
2151 struct kmod_module_info
{
2156 static struct kmod_module_info
*kmod_module_info_new(const char *key
, size_t keylen
, const char *value
, size_t valuelen
)
2158 struct kmod_module_info
*info
;
2160 info
= malloc(sizeof(struct kmod_module_info
) + keylen
+ valuelen
+ 2);
2164 info
->key
= (char *)info
+ sizeof(struct kmod_module_info
)
2166 memcpy(info
->key
, key
, keylen
);
2167 info
->key
[keylen
] = '\0';
2168 memcpy(info
->value
, value
, valuelen
);
2169 info
->value
[valuelen
] = '\0';
2173 static void kmod_module_info_free(struct kmod_module_info
*info
)
2178 static struct kmod_list
*kmod_module_info_append(struct kmod_list
**list
, const char *key
, size_t keylen
, const char *value
, size_t valuelen
)
2180 struct kmod_module_info
*info
;
2181 struct kmod_list
*n
;
2183 info
= kmod_module_info_new(key
, keylen
, value
, valuelen
);
2186 n
= kmod_list_append(*list
, info
);
2190 kmod_module_info_free(info
);
2195 * kmod_module_get_info:
2197 * @list: where to return list of module information. Use
2198 * kmod_module_info_get_key() and
2199 * kmod_module_info_get_value(). Release this list with
2200 * kmod_module_info_free_list()
2202 * Get a list of entries in ELF section ".modinfo", these contain
2203 * alias, license, depends, vermagic and other keys with respective
2204 * values. If the module is signed (CONFIG_MODULE_SIG), information
2205 * about the module signature is included as well: signer,
2206 * sig_key and sig_hashalgo.
2208 * After use, free the @list by calling kmod_module_info_free_list().
2210 * Returns: 0 on success or < 0 otherwise.
2212 KMOD_EXPORT
int kmod_module_get_info(const struct kmod_module
*mod
, struct kmod_list
**list
)
2214 struct kmod_elf
*elf
;
2216 int i
, count
, ret
= -ENOMEM
;
2217 struct kmod_signature_info sig_info
;
2219 if (mod
== NULL
|| list
== NULL
)
2222 assert(*list
== NULL
);
2224 elf
= kmod_module_get_elf(mod
);
2228 count
= kmod_elf_get_strings(elf
, ".modinfo", &strings
);
2232 for (i
= 0; i
< count
; i
++) {
2233 struct kmod_list
*n
;
2234 const char *key
, *value
;
2235 size_t keylen
, valuelen
;
2238 value
= strchr(key
, '=');
2239 if (value
== NULL
) {
2240 keylen
= strlen(key
);
2244 keylen
= value
- key
;
2246 valuelen
= strlen(value
);
2249 n
= kmod_module_info_append(list
, key
, keylen
, value
, valuelen
);
2254 if (kmod_module_signature_info(mod
->file
, &sig_info
)) {
2255 struct kmod_list
*n
;
2258 n
= kmod_module_info_append(list
, "signer", strlen("signer"),
2259 sig_info
.signer
, sig_info
.signer_len
);
2264 /* Display the key id as 01:12:DE:AD:BE:EF:... */
2265 key_hex
= malloc(sig_info
.key_id_len
* 3);
2266 if (key_hex
== NULL
)
2268 for (i
= 0; i
< (int)sig_info
.key_id_len
; i
++) {
2269 sprintf(key_hex
+ i
* 3, "%02X",
2270 (unsigned char)sig_info
.key_id
[i
]);
2271 if (i
< (int)sig_info
.key_id_len
- 1)
2272 key_hex
[i
* 3 + 2] = ':';
2274 n
= kmod_module_info_append(list
, "sig_key", strlen("sig_key"),
2275 key_hex
, sig_info
.key_id_len
* 3 - 1);
2281 n
= kmod_module_info_append(list
,
2282 "sig_hashalgo", strlen("sig_hashalgo"),
2283 sig_info
.hash_algo
, strlen(sig_info
.hash_algo
));
2289 * Omit sig_info.id_type and sig_info.algo for now, as these
2290 * are currently constant.
2297 kmod_module_info_free_list(*list
);
2305 * kmod_module_info_get_key:
2306 * @entry: a list entry representing a kmod module info
2308 * Get the key of a kmod module info.
2310 * Returns: the key of this kmod module info on success or NULL on
2311 * failure. The string is owned by the info, do not free it.
2313 KMOD_EXPORT
const char *kmod_module_info_get_key(const struct kmod_list
*entry
)
2315 struct kmod_module_info
*info
;
2325 * kmod_module_info_get_value:
2326 * @entry: a list entry representing a kmod module info
2328 * Get the value of a kmod module info.
2330 * Returns: the value of this kmod module info on success or NULL on
2331 * failure. The string is owned by the info, do not free it.
2333 KMOD_EXPORT
const char *kmod_module_info_get_value(const struct kmod_list
*entry
)
2335 struct kmod_module_info
*info
;
2345 * kmod_module_info_free_list:
2346 * @list: kmod module info list
2348 * Release the resources taken by @list
2350 KMOD_EXPORT
void kmod_module_info_free_list(struct kmod_list
*list
)
2353 kmod_module_info_free(list
->data
);
2354 list
= kmod_list_remove(list
);
2358 struct kmod_module_version
{
2363 static struct kmod_module_version
*kmod_module_versions_new(uint64_t crc
, const char *symbol
)
2365 struct kmod_module_version
*mv
;
2366 size_t symbollen
= strlen(symbol
) + 1;
2368 mv
= malloc(sizeof(struct kmod_module_version
) + symbollen
);
2373 memcpy(mv
->symbol
, symbol
, symbollen
);
2377 static void kmod_module_version_free(struct kmod_module_version
*version
)
2383 * kmod_module_get_versions:
2385 * @list: where to return list of module versions. Use
2386 * kmod_module_version_get_symbol() and
2387 * kmod_module_version_get_crc(). Release this list with
2388 * kmod_module_versions_free_list()
2390 * Get a list of entries in ELF section "__versions".
2392 * After use, free the @list by calling kmod_module_versions_free_list().
2394 * Returns: 0 on success or < 0 otherwise.
2396 KMOD_EXPORT
int kmod_module_get_versions(const struct kmod_module
*mod
, struct kmod_list
**list
)
2398 struct kmod_elf
*elf
;
2399 struct kmod_modversion
*versions
;
2400 int i
, count
, ret
= 0;
2402 if (mod
== NULL
|| list
== NULL
)
2405 assert(*list
== NULL
);
2407 elf
= kmod_module_get_elf(mod
);
2411 count
= kmod_elf_get_modversions(elf
, &versions
);
2415 for (i
= 0; i
< count
; i
++) {
2416 struct kmod_module_version
*mv
;
2417 struct kmod_list
*n
;
2419 mv
= kmod_module_versions_new(versions
[i
].crc
, versions
[i
].symbol
);
2422 kmod_module_versions_free_list(*list
);
2427 n
= kmod_list_append(*list
, mv
);
2431 kmod_module_version_free(mv
);
2432 kmod_module_versions_free_list(*list
);
2446 * kmod_module_version_get_symbol:
2447 * @entry: a list entry representing a kmod module versions
2449 * Get the symbol of a kmod module versions.
2451 * Returns: the symbol of this kmod module versions on success or NULL
2452 * on failure. The string is owned by the versions, do not free it.
2454 KMOD_EXPORT
const char *kmod_module_version_get_symbol(const struct kmod_list
*entry
)
2456 struct kmod_module_version
*version
;
2461 version
= entry
->data
;
2462 return version
->symbol
;
2466 * kmod_module_version_get_crc:
2467 * @entry: a list entry representing a kmod module version
2469 * Get the crc of a kmod module version.
2471 * Returns: the crc of this kmod module version on success or NULL on
2472 * failure. The string is owned by the version, do not free it.
2474 KMOD_EXPORT
uint64_t kmod_module_version_get_crc(const struct kmod_list
*entry
)
2476 struct kmod_module_version
*version
;
2481 version
= entry
->data
;
2482 return version
->crc
;
2486 * kmod_module_versions_free_list:
2487 * @list: kmod module versions list
2489 * Release the resources taken by @list
2491 KMOD_EXPORT
void kmod_module_versions_free_list(struct kmod_list
*list
)
2494 kmod_module_version_free(list
->data
);
2495 list
= kmod_list_remove(list
);
2499 struct kmod_module_symbol
{
2504 static struct kmod_module_symbol
*kmod_module_symbols_new(uint64_t crc
, const char *symbol
)
2506 struct kmod_module_symbol
*mv
;
2507 size_t symbollen
= strlen(symbol
) + 1;
2509 mv
= malloc(sizeof(struct kmod_module_symbol
) + symbollen
);
2514 memcpy(mv
->symbol
, symbol
, symbollen
);
2518 static void kmod_module_symbol_free(struct kmod_module_symbol
*symbol
)
2524 * kmod_module_get_symbols:
2526 * @list: where to return list of module symbols. Use
2527 * kmod_module_symbol_get_symbol() and
2528 * kmod_module_symbol_get_crc(). Release this list with
2529 * kmod_module_symbols_free_list()
2531 * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
2533 * After use, free the @list by calling kmod_module_symbols_free_list().
2535 * Returns: 0 on success or < 0 otherwise.
2537 KMOD_EXPORT
int kmod_module_get_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
)
2539 struct kmod_elf
*elf
;
2540 struct kmod_modversion
*symbols
;
2541 int i
, count
, ret
= 0;
2543 if (mod
== NULL
|| list
== NULL
)
2546 assert(*list
== NULL
);
2548 elf
= kmod_module_get_elf(mod
);
2552 count
= kmod_elf_get_symbols(elf
, &symbols
);
2556 for (i
= 0; i
< count
; i
++) {
2557 struct kmod_module_symbol
*mv
;
2558 struct kmod_list
*n
;
2560 mv
= kmod_module_symbols_new(symbols
[i
].crc
, symbols
[i
].symbol
);
2563 kmod_module_symbols_free_list(*list
);
2568 n
= kmod_list_append(*list
, mv
);
2572 kmod_module_symbol_free(mv
);
2573 kmod_module_symbols_free_list(*list
);
2587 * kmod_module_symbol_get_symbol:
2588 * @entry: a list entry representing a kmod module symbols
2590 * Get the symbol of a kmod module symbols.
2592 * Returns: the symbol of this kmod module symbols on success or NULL
2593 * on failure. The string is owned by the symbols, do not free it.
2595 KMOD_EXPORT
const char *kmod_module_symbol_get_symbol(const struct kmod_list
*entry
)
2597 struct kmod_module_symbol
*symbol
;
2602 symbol
= entry
->data
;
2603 return symbol
->symbol
;
2607 * kmod_module_symbol_get_crc:
2608 * @entry: a list entry representing a kmod module symbol
2610 * Get the crc of a kmod module symbol.
2612 * Returns: the crc of this kmod module symbol on success or NULL on
2613 * failure. The string is owned by the symbol, do not free it.
2615 KMOD_EXPORT
uint64_t kmod_module_symbol_get_crc(const struct kmod_list
*entry
)
2617 struct kmod_module_symbol
*symbol
;
2622 symbol
= entry
->data
;
2627 * kmod_module_symbols_free_list:
2628 * @list: kmod module symbols list
2630 * Release the resources taken by @list
2632 KMOD_EXPORT
void kmod_module_symbols_free_list(struct kmod_list
*list
)
2635 kmod_module_symbol_free(list
->data
);
2636 list
= kmod_list_remove(list
);
2640 struct kmod_module_dependency_symbol
{
2646 static struct kmod_module_dependency_symbol
*kmod_module_dependency_symbols_new(uint64_t crc
, uint8_t bind
, const char *symbol
)
2648 struct kmod_module_dependency_symbol
*mv
;
2649 size_t symbollen
= strlen(symbol
) + 1;
2651 mv
= malloc(sizeof(struct kmod_module_dependency_symbol
) + symbollen
);
2657 memcpy(mv
->symbol
, symbol
, symbollen
);
2661 static void kmod_module_dependency_symbol_free(struct kmod_module_dependency_symbol
*dependency_symbol
)
2663 free(dependency_symbol
);
2667 * kmod_module_get_dependency_symbols:
2669 * @list: where to return list of module dependency_symbols. Use
2670 * kmod_module_dependency_symbol_get_symbol() and
2671 * kmod_module_dependency_symbol_get_crc(). Release this list with
2672 * kmod_module_dependency_symbols_free_list()
2674 * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
2676 * After use, free the @list by calling
2677 * kmod_module_dependency_symbols_free_list().
2679 * Returns: 0 on success or < 0 otherwise.
2681 KMOD_EXPORT
int kmod_module_get_dependency_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
)
2683 struct kmod_elf
*elf
;
2684 struct kmod_modversion
*symbols
;
2685 int i
, count
, ret
= 0;
2687 if (mod
== NULL
|| list
== NULL
)
2690 assert(*list
== NULL
);
2692 elf
= kmod_module_get_elf(mod
);
2696 count
= kmod_elf_get_dependency_symbols(elf
, &symbols
);
2700 for (i
= 0; i
< count
; i
++) {
2701 struct kmod_module_dependency_symbol
*mv
;
2702 struct kmod_list
*n
;
2704 mv
= kmod_module_dependency_symbols_new(symbols
[i
].crc
,
2709 kmod_module_dependency_symbols_free_list(*list
);
2714 n
= kmod_list_append(*list
, mv
);
2718 kmod_module_dependency_symbol_free(mv
);
2719 kmod_module_dependency_symbols_free_list(*list
);
2733 * kmod_module_dependency_symbol_get_symbol:
2734 * @entry: a list entry representing a kmod module dependency_symbols
2736 * Get the dependency symbol of a kmod module
2738 * Returns: the symbol of this kmod module dependency_symbols on success or NULL
2739 * on failure. The string is owned by the dependency_symbols, do not free it.
2741 KMOD_EXPORT
const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list
*entry
)
2743 struct kmod_module_dependency_symbol
*dependency_symbol
;
2748 dependency_symbol
= entry
->data
;
2749 return dependency_symbol
->symbol
;
2753 * kmod_module_dependency_symbol_get_crc:
2754 * @entry: a list entry representing a kmod module dependency_symbol
2756 * Get the crc of a kmod module dependency_symbol.
2758 * Returns: the crc of this kmod module dependency_symbol on success or NULL on
2759 * failure. The string is owned by the dependency_symbol, do not free it.
2761 KMOD_EXPORT
uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list
*entry
)
2763 struct kmod_module_dependency_symbol
*dependency_symbol
;
2768 dependency_symbol
= entry
->data
;
2769 return dependency_symbol
->crc
;
2773 * kmod_module_dependency_symbol_get_bind:
2774 * @entry: a list entry representing a kmod module dependency_symbol
2776 * Get the bind type of a kmod module dependency_symbol.
2778 * Returns: the bind of this kmod module dependency_symbol on success
2779 * or < 0 on failure.
2781 KMOD_EXPORT
int kmod_module_dependency_symbol_get_bind(const struct kmod_list
*entry
)
2783 struct kmod_module_dependency_symbol
*dependency_symbol
;
2788 dependency_symbol
= entry
->data
;
2789 return dependency_symbol
->bind
;
2793 * kmod_module_dependency_symbols_free_list:
2794 * @list: kmod module dependency_symbols list
2796 * Release the resources taken by @list
2798 KMOD_EXPORT
void kmod_module_dependency_symbols_free_list(struct kmod_list
*list
)
2801 kmod_module_dependency_symbol_free(list
->data
);
2802 list
= kmod_list_remove(list
);