2 * libkmod - interface to kernel module operations
4 * Copyright (C) 2011-2012 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, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
34 #include <sys/types.h>
41 #include "libkmod-private.h"
44 * SECTION:libkmod-module
45 * @short_description: operate on kernel modules
51 * Opaque object representing a module.
58 struct kmod_list
*dep
;
60 const char *install_commands
; /* owned by kmod_config */
61 const char *remove_commands
; /* owned by kmod_config */
62 char *alias
; /* only set if this module was created from an alias */
68 bool install_commands
: 1;
69 bool remove_commands
: 1;
73 * private field used by kmod_module_get_probe_list() to detect
79 * set by kmod_module_get_probe_list: indicates for probe_insert()
80 * whether the module's command and softdep should be ignored
85 * if module was created by searching the modules.builtin file, this
86 * is set. There's nothing much useful one can do with such a
87 * "module", except knowing it's builtin.
92 static inline const char *path_join(const char *path
, size_t prefixlen
,
100 pathlen
= strlen(path
);
101 if (prefixlen
+ pathlen
+ 1 >= PATH_MAX
)
104 memcpy(buf
+ prefixlen
, path
, pathlen
+ 1);
108 static inline bool module_is_inkernel(struct kmod_module
*mod
)
110 int state
= kmod_module_get_initstate(mod
);
112 if (state
== KMOD_MODULE_LIVE
||
113 state
== KMOD_MODULE_BUILTIN
)
119 int kmod_module_parse_depline(struct kmod_module
*mod
, char *line
)
121 struct kmod_ctx
*ctx
= mod
->ctx
;
122 struct kmod_list
*list
= NULL
;
131 assert(mod
->dep
== NULL
);
132 mod
->init
.dep
= true;
134 p
= strchr(line
, ':');
139 dirname
= kmod_get_dirname(mod
->ctx
);
140 dirnamelen
= strlen(dirname
);
141 if (dirnamelen
+ 2 >= PATH_MAX
)
144 memcpy(buf
, dirname
, dirnamelen
);
145 buf
[dirnamelen
] = '/';
147 buf
[dirnamelen
] = '\0';
149 if (mod
->path
== NULL
) {
150 const char *str
= path_join(line
, dirnamelen
, buf
);
153 mod
->path
= strdup(str
);
154 if (mod
->path
== NULL
)
159 for (p
= strtok_r(p
, " \t", &saveptr
); p
!= NULL
;
160 p
= strtok_r(NULL
, " \t", &saveptr
)) {
161 struct kmod_module
*depmod
;
164 path
= path_join(p
, dirnamelen
, buf
);
166 ERR(ctx
, "could not join path '%s' and '%s'.\n",
171 err
= kmod_module_new_from_path(ctx
, path
, &depmod
);
173 ERR(ctx
, "ctx=%p path=%s error=%s\n",
174 ctx
, path
, strerror(-err
));
178 DBG(ctx
, "add dep: %s\n", path
);
180 list
= kmod_list_prepend(list
, depmod
);
184 DBG(ctx
, "%d dependencies for %s\n", n
, mod
->name
);
191 kmod_module_unref_list(list
);
192 mod
->init
.dep
= false;
196 void kmod_module_set_visited(struct kmod_module
*mod
, bool visited
)
198 mod
->visited
= visited
;
201 void kmod_module_set_builtin(struct kmod_module
*mod
, bool builtin
)
203 mod
->builtin
= builtin
;
207 * Memory layout with alias:
209 * struct kmod_module {
214 * name <----------' | |
215 * alias <-----------' |
216 * name\alias <--------'
218 * Memory layout without alias:
220 * struct kmod_module {
222 * alias -----|----> NULL
225 * name <----------'-'
227 * @key is "name\alias" or "name" (in which case alias == NULL)
229 static int kmod_module_new(struct kmod_ctx
*ctx
, const char *key
,
230 const char *name
, size_t namelen
,
231 const char *alias
, size_t aliaslen
,
232 struct kmod_module
**mod
)
234 struct kmod_module
*m
;
237 m
= kmod_pool_get_module(ctx
, key
);
239 *mod
= kmod_module_ref(m
);
246 keylen
= namelen
+ aliaslen
+ 1;
248 m
= malloc(sizeof(*m
) + (alias
== NULL
? 1 : 2) * (keylen
+ 1));
254 memset(m
, 0, sizeof(*m
));
256 m
->ctx
= kmod_ref(ctx
);
257 m
->name
= (char *)m
+ sizeof(*m
);
258 memcpy(m
->name
, key
, keylen
+ 1);
260 m
->hashkey
= m
->name
;
263 m
->name
[namelen
] = '\0';
264 m
->alias
= m
->name
+ namelen
+ 1;
265 m
->hashkey
= m
->name
+ keylen
+ 1;
266 memcpy(m
->hashkey
, key
, keylen
+ 1);
270 kmod_pool_add_module(ctx
, m
, m
->hashkey
);
277 * kmod_module_new_from_name:
278 * @ctx: kmod library context
279 * @name: name of the module
280 * @mod: where to save the created struct kmod_module
282 * Create a new struct kmod_module using the module name. @name can not be an
283 * alias, file name or anything else; it must be a module name. There's no
284 * check if the module exists in the system.
286 * This function is also used internally by many others that return a new
287 * struct kmod_module or a new list of modules.
289 * The initial refcount is 1, and needs to be decremented to release the
290 * resources of the kmod_module. Since libkmod keeps track of all
291 * kmod_modules created, they are all released upon @ctx destruction too. Do
292 * not unref @ctx before all the desired operations with the returned
293 * kmod_module are done.
295 * Returns: 0 on success or < 0 otherwise. It fails if name is not a valid
296 * module name or if memory allocation failed.
298 KMOD_EXPORT
int kmod_module_new_from_name(struct kmod_ctx
*ctx
,
300 struct kmod_module
**mod
)
303 char name_norm
[PATH_MAX
];
305 if (ctx
== NULL
|| name
== NULL
|| mod
== NULL
)
308 modname_normalize(name
, name_norm
, &namelen
);
310 return kmod_module_new(ctx
, name_norm
, name_norm
, namelen
, NULL
, 0, mod
);
313 int kmod_module_new_from_alias(struct kmod_ctx
*ctx
, const char *alias
,
314 const char *name
, struct kmod_module
**mod
)
318 size_t namelen
= strlen(name
);
319 size_t aliaslen
= strlen(alias
);
321 if (namelen
+ aliaslen
+ 2 > PATH_MAX
)
322 return -ENAMETOOLONG
;
324 memcpy(key
, name
, namelen
);
325 memcpy(key
+ namelen
+ 1, alias
, aliaslen
+ 1);
328 err
= kmod_module_new(ctx
, key
, name
, namelen
, alias
, aliaslen
, mod
);
336 * kmod_module_new_from_path:
337 * @ctx: kmod library context
338 * @path: path where to find the given module
339 * @mod: where to save the created struct kmod_module
341 * Create a new struct kmod_module using the module path. @path must be an
342 * existent file with in the filesystem and must be accessible to libkmod.
344 * The initial refcount is 1, and needs to be decremented to release the
345 * resources of the kmod_module. Since libkmod keeps track of all
346 * kmod_modules created, they are all released upon @ctx destruction too. Do
347 * not unref @ctx before all the desired operations with the returned
348 * kmod_module are done.
350 * If @path is relative, it's treated as relative to the current working
351 * directory. Otherwise, give an absolute path.
353 * Returns: 0 on success or < 0 otherwise. It fails if file does not exist, if
354 * it's not a valid file for a kmod_module or if memory allocation failed.
356 KMOD_EXPORT
int kmod_module_new_from_path(struct kmod_ctx
*ctx
,
358 struct kmod_module
**mod
)
360 struct kmod_module
*m
;
367 if (ctx
== NULL
|| path
== NULL
|| mod
== NULL
)
370 abspath
= path_make_absolute_cwd(path
);
371 if (abspath
== NULL
) {
372 DBG(ctx
, "no absolute path for %s\n", path
);
376 err
= stat(abspath
, &st
);
379 DBG(ctx
, "stat %s: %s\n", path
, strerror(errno
));
384 if (path_to_modname(path
, name
, &namelen
) == NULL
) {
385 DBG(ctx
, "could not get modname from path %s\n", path
);
390 m
= kmod_pool_get_module(ctx
, name
);
394 else if (streq(m
->path
, abspath
))
397 ERR(ctx
, "kmod_module '%s' already exists with different path: new-path='%s' old-path='%s'\n",
398 name
, abspath
, m
->path
);
403 *mod
= kmod_module_ref(m
);
407 err
= kmod_module_new(ctx
, name
, name
, namelen
, NULL
, 0, &m
);
421 * Drop a reference of the kmod module. If the refcount reaches zero, its
422 * resources are released.
424 * Returns: NULL if @mod is NULL or if the module was released. Otherwise it
425 * returns the passed @mod with its refcount decremented.
427 KMOD_EXPORT
struct kmod_module
*kmod_module_unref(struct kmod_module
*mod
)
432 if (--mod
->refcount
> 0)
435 DBG(mod
->ctx
, "kmod_module %p released\n", mod
);
437 kmod_pool_del_module(mod
->ctx
, mod
, mod
->hashkey
);
438 kmod_module_unref_list(mod
->dep
);
439 kmod_unref(mod
->ctx
);
450 * Take a reference of the kmod module, incrementing its refcount.
452 * Returns: the passed @module with its refcount incremented.
454 KMOD_EXPORT
struct kmod_module
*kmod_module_ref(struct kmod_module
*mod
)
464 #define CHECK_ERR_AND_FINISH(_err, _label_err, _list, label_finish) \
468 if (*(_list) != NULL) \
473 * kmod_module_new_from_lookup:
474 * @ctx: kmod library context
475 * @given_alias: alias to look for
476 * @list: an empty list where to save the list of modules matching
479 * Create a new list of kmod modules using an alias or module name and lookup
480 * libkmod's configuration files and indexes in order to find the module.
481 * Once it's found in one of the places, it stops searching and create the
482 * list of modules that is saved in @list.
484 * The search order is: 1. aliases in configuration file; 2. module names in
485 * modules.dep index; 3. symbol aliases in modules.symbols index; 4. aliases
486 * in modules.alias index.
488 * The initial refcount is 1, and needs to be decremented to release the
489 * resources of the kmod_module. The returned @list must be released by
490 * calling kmod_module_unref_list(). Since libkmod keeps track of all
491 * kmod_modules created, they are all released upon @ctx destruction too. Do
492 * not unref @ctx before all the desired operations with the returned list are
495 * Returns: 0 on success or < 0 otherwise. It fails if any of the lookup
496 * methods failed, which is basically due to memory allocation fail. If module
497 * is not found, it still returns 0, but @list is an empty list.
499 KMOD_EXPORT
int kmod_module_new_from_lookup(struct kmod_ctx
*ctx
,
500 const char *given_alias
,
501 struct kmod_list
**list
)
504 char alias
[PATH_MAX
];
506 if (ctx
== NULL
|| given_alias
== NULL
)
509 if (list
== NULL
|| *list
!= NULL
) {
510 ERR(ctx
, "An empty list is needed to create lookup\n");
514 if (alias_normalize(given_alias
, alias
, NULL
) < 0) {
515 DBG(ctx
, "invalid alias: %s\n", given_alias
);
519 DBG(ctx
, "input alias=%s, normalized=%s\n", given_alias
, alias
);
521 /* Aliases from config file override all the others */
522 err
= kmod_lookup_alias_from_config(ctx
, alias
, list
);
523 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
525 DBG(ctx
, "lookup modules.dep %s\n", alias
);
526 err
= kmod_lookup_alias_from_moddep_file(ctx
, alias
, list
);
527 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
529 DBG(ctx
, "lookup modules.symbols %s\n", alias
);
530 err
= kmod_lookup_alias_from_symbols_file(ctx
, alias
, list
);
531 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
533 DBG(ctx
, "lookup install and remove commands %s\n", alias
);
534 err
= kmod_lookup_alias_from_commands(ctx
, alias
, list
);
535 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
537 DBG(ctx
, "lookup modules.aliases %s\n", alias
);
538 err
= kmod_lookup_alias_from_aliases_file(ctx
, alias
, list
);
539 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
541 DBG(ctx
, "lookup modules.builtin %s\n", alias
);
542 err
= kmod_lookup_alias_from_builtin_file(ctx
, alias
, list
);
543 CHECK_ERR_AND_FINISH(err
, fail
, list
, finish
);
546 DBG(ctx
, "lookup %s=%d, list=%p\n", alias
, err
, *list
);
549 DBG(ctx
, "Failed to lookup %s\n", alias
);
550 kmod_module_unref_list(*list
);
554 #undef CHECK_ERR_AND_FINISH
557 * kmod_module_unref_list:
558 * @list: list of kmod modules
560 * Drop a reference of each kmod module in @list and releases the resources
561 * taken by the list itself.
563 * Returns: NULL if @mod is NULL or if the module was released. Otherwise it
564 * returns the passed @mod with its refcount decremented.
566 KMOD_EXPORT
int kmod_module_unref_list(struct kmod_list
*list
)
568 for (; list
!= NULL
; list
= kmod_list_remove(list
))
569 kmod_module_unref(list
->data
);
575 * kmod_module_get_filtered_blacklist:
576 * @ctx: kmod library context
577 * @input: list of kmod_module to be filtered with blacklist
578 * @output: where to save the new list
580 * Given a list @input, this function filter it out with config's blacklist
581 * ans save it in @output.
583 * Returns: 0 on success or < 0 otherwise. @output is saved with the updated
586 KMOD_EXPORT
int kmod_module_get_filtered_blacklist(const struct kmod_ctx
*ctx
,
587 const struct kmod_list
*input
,
588 struct kmod_list
**output
)
590 const struct kmod_list
*li
;
591 const struct kmod_list
*blacklist
;
593 if (ctx
== NULL
|| output
== NULL
)
600 blacklist
= kmod_get_blacklists(ctx
);
601 kmod_list_foreach(li
, input
) {
602 struct kmod_module
*mod
= li
->data
;
603 const struct kmod_list
*lb
;
604 struct kmod_list
*node
;
605 bool filtered
= false;
607 kmod_list_foreach(lb
, blacklist
) {
608 const char *name
= lb
->data
;
610 if (streq(name
, mod
->name
)) {
619 node
= kmod_list_append(*output
, mod
);
624 kmod_module_ref(mod
);
630 kmod_module_unref_list(*output
);
635 static const struct kmod_list
*module_get_dependencies_noref(const struct kmod_module
*mod
)
637 if (!mod
->init
.dep
) {
639 char *line
= kmod_search_moddep(mod
->ctx
, mod
->name
);
644 kmod_module_parse_depline((struct kmod_module
*)mod
, line
);
655 * kmod_module_get_dependencies:
658 * Search the modules.dep index to find the dependencies of the given @mod.
659 * The result is cached in @mod, so subsequent calls to this function will
660 * return the already searched list of modules.
662 * Returns: NULL on failure or if there are any dependencies. Otherwise it
663 * returns a list of kmod modules that can be released by calling
664 * kmod_module_unref_list().
666 KMOD_EXPORT
struct kmod_list
*kmod_module_get_dependencies(const struct kmod_module
*mod
)
668 struct kmod_list
*l
, *l_new
, *list_new
= NULL
;
673 module_get_dependencies_noref(mod
);
675 kmod_list_foreach(l
, mod
->dep
) {
676 l_new
= kmod_list_append(list_new
, kmod_module_ref(l
->data
));
678 kmod_module_unref(l
->data
);
688 ERR(mod
->ctx
, "out of memory\n");
689 kmod_module_unref_list(list_new
);
694 * kmod_module_get_module:
695 * @entry: an entry in a list of kmod modules.
697 * Get the kmod module of this @entry in the list, increasing its refcount.
698 * After it's used, unref it. Since the refcount is incremented upon return,
699 * you still have to call kmod_module_unref_list() to release the list of kmod
702 * Returns: NULL on failure or the kmod_module contained in this list entry
703 * with its refcount incremented.
705 KMOD_EXPORT
struct kmod_module
*kmod_module_get_module(const struct kmod_list
*entry
)
710 return kmod_module_ref(entry
->data
);
714 * kmod_module_get_name:
717 * Get the name of this kmod module. Name is always available, independently
718 * if it was created by kmod_module_new_from_name() or another function and
719 * it's always normalized (dashes are replaced with underscores).
721 * Returns: the name of this kmod module.
723 KMOD_EXPORT
const char *kmod_module_get_name(const struct kmod_module
*mod
)
732 * kmod_module_get_path:
735 * Get the path of this kmod module. If this kmod module was not created by
736 * path, it can search the modules.dep index in order to find out the module
737 * under context's dirname.
739 * Returns: the path of this kmod module or NULL if such information is not
742 KMOD_EXPORT
const char *kmod_module_get_path(const struct kmod_module
*mod
)
749 DBG(mod
->ctx
, "name='%s' path='%s'\n", mod
->name
, mod
->path
);
751 if (mod
->path
!= NULL
)
757 line
= kmod_search_moddep(mod
->ctx
, mod
->name
);
761 kmod_module_parse_depline((struct kmod_module
*) mod
, line
);
768 extern long delete_module(const char *name
, unsigned int flags
);
771 * kmod_module_remove_module:
773 * @flags: flags to pass to Linux kernel when removing the module
775 * Remove a module from Linux kernel.
777 * Returns: 0 on success or < 0 on failure.
779 KMOD_EXPORT
int kmod_module_remove_module(struct kmod_module
*mod
,
787 /* Filter out other flags */
788 flags
&= (KMOD_REMOVE_FORCE
| 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.
806 * @options: module's options to pass to Linux Kernel.
808 * Insert a module in Linux kernel. It opens the file pointed by @mod,
809 * mmap'ing it and passing to kernel.
811 * Returns: 0 on success or < 0 on failure. If module is already loaded it
814 KMOD_EXPORT
int kmod_module_insert_module(struct kmod_module
*mod
,
821 struct kmod_file
*file
;
822 struct kmod_elf
*elf
= NULL
;
824 const char *args
= options
? options
: "";
829 path
= kmod_module_get_path(mod
);
831 ERR(mod
->ctx
, "could not find module by name='%s'\n", mod
->name
);
835 file
= kmod_file_open(mod
->ctx
, path
);
841 size
= kmod_file_get_size(file
);
842 mem
= kmod_file_get_contents(file
);
844 if (flags
& (KMOD_INSERT_FORCE_VERMAGIC
| KMOD_INSERT_FORCE_MODVERSION
)) {
845 elf
= kmod_elf_new(mem
, size
);
851 if (flags
& KMOD_INSERT_FORCE_MODVERSION
) {
852 err
= kmod_elf_strip_section(elf
, "__versions");
854 INFO(mod
->ctx
, "Failed to strip modversion: %s\n", strerror(-err
));
857 if (flags
& KMOD_INSERT_FORCE_VERMAGIC
) {
858 err
= kmod_elf_strip_vermagic(elf
);
860 INFO(mod
->ctx
, "Failed to strip vermagic: %s\n", strerror(-err
));
863 mem
= kmod_elf_get_memory(elf
);
866 err
= init_module(mem
, size
, args
);
869 INFO(mod
->ctx
, "Failed to insert module '%s': %m\n", path
);
875 kmod_file_unref(file
);
880 static bool module_is_blacklisted(struct kmod_module
*mod
)
882 struct kmod_ctx
*ctx
= mod
->ctx
;
883 const struct kmod_list
*bl
= kmod_get_blacklists(ctx
);
884 const struct kmod_list
*l
;
886 kmod_list_foreach(l
, bl
) {
887 const char *modname
= kmod_blacklist_get_modname(l
);
889 if (streq(modname
, mod
->name
))
896 static int command_do(struct kmod_module
*mod
, const char *type
,
899 const char *modname
= kmod_module_get_name(mod
);
902 DBG(mod
->ctx
, "%s %s\n", type
, cmd
);
904 setenv("MODPROBE_MODULE", modname
, 1);
906 unsetenv("MODPROBE_MODULE");
908 if (err
== -1 || WEXITSTATUS(err
)) {
909 ERR(mod
->ctx
, "Error running %s command for %s\n",
912 err
= -WEXITSTATUS(err
);
918 struct probe_insert_cb
{
919 int (*run_install
)(struct kmod_module
*m
, const char *cmd
, void *data
);
923 static int module_do_install_commands(struct kmod_module
*mod
,
925 struct probe_insert_cb
*cb
)
927 const char *command
= kmod_module_get_install_commands(mod
);
930 size_t cmdlen
, options_len
, varlen
;
937 options_len
= strlen(options
);
938 cmdlen
= strlen(command
);
939 varlen
= sizeof("$CMDLINE_OPTS") - 1;
941 cmd
= memdup(command
, cmdlen
+ 1);
945 while ((p
= strstr(cmd
, "$CMDLINE_OPTS")) != NULL
) {
946 size_t prefixlen
= p
- cmd
;
947 size_t suffixlen
= cmdlen
- prefixlen
- varlen
;
948 size_t slen
= cmdlen
- varlen
+ options_len
;
949 char *suffix
= p
+ varlen
;
950 char *s
= malloc(slen
+ 1);
955 memcpy(s
, cmd
, p
- cmd
);
956 memcpy(s
+ prefixlen
, options
, options_len
);
957 memcpy(s
+ prefixlen
+ options_len
, suffix
, suffixlen
);
965 if (cb
->run_install
!= NULL
)
966 err
= cb
->run_install(mod
, cmd
, cb
->data
);
968 err
= command_do(mod
, "install", cmd
);
975 static char *module_options_concat(const char *opt
, const char *xopt
)
977 // TODO: we might need to check if xopt overrides options on opt
978 size_t optlen
= opt
== NULL
? 0 : strlen(opt
);
979 size_t xoptlen
= xopt
== NULL
? 0 : strlen(xopt
);
982 if (optlen
== 0 && xoptlen
== 0)
985 r
= malloc(optlen
+ xoptlen
+ 2);
988 memcpy(r
, opt
, optlen
);
994 memcpy(r
+ optlen
, xopt
, xoptlen
);
996 r
[optlen
+ xoptlen
] = '\0';
1001 static int __kmod_module_get_probe_list(struct kmod_module
*mod
,
1003 struct kmod_list
**list
);
1006 static int __kmod_module_fill_softdep(struct kmod_module
*mod
,
1007 struct kmod_list
**list
)
1009 struct kmod_list
*pre
= NULL
, *post
= NULL
, *l
;
1012 err
= kmod_module_get_softdeps(mod
, &pre
, &post
);
1014 ERR(mod
->ctx
, "could not get softdep: %s\n",
1019 kmod_list_foreach(l
, pre
) {
1020 struct kmod_module
*m
= l
->data
;
1021 err
= __kmod_module_get_probe_list(m
, false, list
);
1026 l
= kmod_list_append(*list
, kmod_module_ref(mod
));
1028 kmod_module_unref(mod
);
1033 mod
->ignorecmd
= (pre
!= NULL
|| post
!= NULL
);
1035 kmod_list_foreach(l
, post
) {
1036 struct kmod_module
*m
= l
->data
;
1037 err
= __kmod_module_get_probe_list(m
, false, list
);
1043 kmod_module_unref_list(pre
);
1044 kmod_module_unref_list(post
);
1050 static int __kmod_module_get_probe_list(struct kmod_module
*mod
,
1052 struct kmod_list
**list
)
1054 struct kmod_list
*dep
, *l
;
1058 DBG(mod
->ctx
, "Ignore module '%s': already visited\n",
1062 mod
->visited
= true;
1064 dep
= kmod_module_get_dependencies(mod
);
1065 kmod_list_foreach(l
, dep
) {
1066 struct kmod_module
*m
= l
->data
;
1067 err
= __kmod_module_fill_softdep(m
, list
);
1073 l
= kmod_list_append(*list
, kmod_module_ref(mod
));
1075 kmod_module_unref(mod
);
1080 mod
->ignorecmd
= true;
1082 err
= __kmod_module_fill_softdep(mod
, list
);
1085 kmod_module_unref_list(dep
);
1089 static int kmod_module_get_probe_list(struct kmod_module
*mod
,
1091 struct kmod_list
**list
)
1095 assert(mod
!= NULL
);
1096 assert(list
!= NULL
&& *list
== NULL
);
1099 * Make sure we don't get screwed by previous calls to this function
1101 kmod_set_modules_visited(mod
->ctx
, false);
1103 err
= __kmod_module_get_probe_list(mod
, ignorecmd
, list
);
1105 kmod_module_unref_list(*list
);
1113 * kmod_module_probe_insert_module:
1115 * @flags: flags are not passed to Linux Kernel, but instead they dictate the
1116 * behavior of this function.
1117 * @extra_options: module's options to pass to Linux Kernel. It applies only
1118 * to @mod, not to its dependencies.
1119 * @run_install: function to run when @mod is backed by an install command.
1120 * @data: data to give back to @run_install callback
1121 * @print_action: function to call with the action being taken (install or
1122 * insmod). It's useful for tools like modprobe when running with verbose
1123 * output or in dry-run mode.
1125 * Insert a module in Linux kernel resolving dependencies, soft dependencies,
1126 * install commands and applying blacklist.
1128 * If @run_install is NULL, this function will fork and exec by calling
1129 * system(3). Don't pass a NULL argument in @run_install if your binary is
1130 * setuid/setgid (see warning in system(3)). If you need control over the
1131 * execution of an install command, give a callback function instead.
1133 * Returns: 0 on success, > 0 if stopped by a reason given in @flags or < 0 on
1136 KMOD_EXPORT
int kmod_module_probe_insert_module(struct kmod_module
*mod
,
1137 unsigned int flags
, const char *extra_options
,
1138 int (*run_install
)(struct kmod_module
*m
,
1139 const char *cmd
, void *data
),
1141 void (*print_action
)(struct kmod_module
*m
,
1143 const char *options
))
1145 struct kmod_list
*list
= NULL
, *l
;
1146 struct probe_insert_cb cb
;
1152 if (!(flags
& KMOD_PROBE_IGNORE_LOADED
)
1153 && module_is_inkernel(mod
)) {
1154 if (flags
& KMOD_PROBE_FAIL_ON_LOADED
)
1160 err
= flags
& (KMOD_PROBE_APPLY_BLACKLIST
|
1161 KMOD_PROBE_APPLY_BLACKLIST_ALL
);
1163 if (module_is_blacklisted(mod
))
1167 err
= kmod_module_get_probe_list(mod
,
1168 !!(flags
& KMOD_PROBE_IGNORE_COMMAND
), &list
);
1172 if (flags
& KMOD_PROBE_APPLY_BLACKLIST_ALL
) {
1173 struct kmod_list
*filtered
= NULL
;
1175 err
= kmod_module_get_filtered_blacklist(mod
->ctx
,
1180 kmod_module_unref_list(list
);
1181 if (filtered
== NULL
)
1182 return KMOD_PROBE_APPLY_BLACKLIST_ALL
;
1187 cb
.run_install
= run_install
;
1188 cb
.data
= (void *) data
;
1190 kmod_list_foreach(l
, list
) {
1191 struct kmod_module
*m
= l
->data
;
1192 const char *moptions
= kmod_module_get_options(m
);
1193 const char *cmd
= kmod_module_get_install_commands(m
);
1196 if (!(flags
& KMOD_PROBE_IGNORE_LOADED
)
1197 && module_is_inkernel(m
)) {
1198 DBG(mod
->ctx
, "Ignoring module '%s': already loaded\n",
1204 options
= module_options_concat(moptions
,
1205 m
== mod
? extra_options
: NULL
);
1207 if (cmd
!= NULL
&& !m
->ignorecmd
) {
1208 if (print_action
!= NULL
)
1209 print_action(m
, true, options
?: "");
1211 if (!(flags
& KMOD_PROBE_DRY_RUN
))
1212 err
= module_do_install_commands(m
, options
,
1215 if (print_action
!= NULL
)
1216 print_action(m
, false, options
?: "");
1218 if (!(flags
& KMOD_PROBE_DRY_RUN
))
1219 err
= kmod_module_insert_module(m
, flags
,
1227 * Treat "already loaded" error. If we were told to stop on
1228 * already loaded and the module being loaded is not a softdep
1229 * or dep, bail out. Otherwise, just ignore and continue.
1231 * We need to check here because of race conditions. We
1232 * checked first if module was already loaded but it may have
1233 * been loaded between the check and the moment we try to
1236 if (err
== -EEXIST
&& m
== mod
&&
1237 (flags
& KMOD_PROBE_FAIL_ON_LOADED
))
1246 kmod_module_unref_list(list
);
1251 * kmod_module_get_options:
1254 * Get options of this kmod module. Options come from the configuration file
1255 * and are cached in @mod. The first call to this function will search for
1256 * this module in configuration and subsequent calls return the cached string.
1258 * Returns: a string with all the options separated by spaces. This string is
1259 * owned by @mod, do not free it.
1261 KMOD_EXPORT
const char *kmod_module_get_options(const struct kmod_module
*mod
)
1266 if (!mod
->init
.options
) {
1268 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1269 const struct kmod_list
*l
, *ctx_options
;
1273 ctx_options
= kmod_get_options(mod
->ctx
);
1275 kmod_list_foreach(l
, ctx_options
) {
1276 const char *modname
= kmod_option_get_modname(l
);
1281 DBG(mod
->ctx
, "modname=%s mod->name=%s mod->alias=%s\n", modname
, mod
->name
, mod
->alias
);
1282 if (!(streq(modname
, mod
->name
) || (mod
->alias
!= NULL
&&
1283 streq(modname
, mod
->alias
))))
1286 DBG(mod
->ctx
, "passed = modname=%s mod->name=%s mod->alias=%s\n", modname
, mod
->name
, mod
->alias
);
1287 str
= kmod_option_get_options(l
);
1292 tmp
= realloc(opts
, optslen
+ len
+ 2);
1301 opts
[optslen
] = ' ';
1305 memcpy(opts
+ optslen
, str
, len
);
1307 opts
[optslen
] = '\0';
1310 m
->init
.options
= true;
1314 return mod
->options
;
1317 ERR(mod
->ctx
, "out of memory\n");
1322 * kmod_module_get_install_commands:
1325 * Get install commands for this kmod module. Install commands come from the
1326 * configuration file and are cached in @mod. The first call to this function
1327 * will search for this module in configuration and subsequent calls return
1328 * the cached string. The install commands are returned as they were in the
1329 * configuration, concatenated by ';'. No other processing is made in this
1332 * Returns: a string with all install commands separated by semicolons. This
1333 * string is owned by @mod, do not free it.
1335 KMOD_EXPORT
const char *kmod_module_get_install_commands(const struct kmod_module
*mod
)
1340 if (!mod
->init
.install_commands
) {
1342 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1343 const struct kmod_list
*l
, *ctx_install_commands
;
1345 ctx_install_commands
= kmod_get_install_commands(mod
->ctx
);
1347 kmod_list_foreach(l
, ctx_install_commands
) {
1348 const char *modname
= kmod_command_get_modname(l
);
1350 if (fnmatch(modname
, mod
->name
, 0) != 0)
1353 m
->install_commands
= kmod_command_get_command(l
);
1356 * find only the first command, as modprobe from
1357 * module-init-tools does
1362 m
->init
.install_commands
= true;
1365 return mod
->install_commands
;
1368 void kmod_module_set_install_commands(struct kmod_module
*mod
, const char *cmd
)
1370 mod
->init
.install_commands
= true;
1371 mod
->install_commands
= cmd
;
1374 static struct kmod_list
*lookup_softdep(struct kmod_ctx
*ctx
, const char * const * array
, unsigned int count
)
1376 struct kmod_list
*ret
= NULL
;
1379 for (i
= 0; i
< count
; i
++) {
1380 const char *depname
= array
[i
];
1381 struct kmod_list
*lst
= NULL
;
1384 err
= kmod_module_new_from_lookup(ctx
, depname
, &lst
);
1386 ERR(ctx
, "failed to lookup soft dependency '%s', continuing anyway.\n", depname
);
1388 } else if (lst
!= NULL
)
1389 ret
= kmod_list_append_list(ret
, lst
);
1395 * kmod_module_get_softdeps:
1397 * @pre: where to save the list of preceding soft dependencies.
1398 * @post: where to save the list of post soft dependencies.
1400 * Get soft dependencies for this kmod module. Soft dependencies come
1401 * from configuration file and are not cached in @mod because it may include
1402 * dependency cycles that would make we leak kmod_module. Any call
1403 * to this function will search for this module in configuration, allocate a
1404 * list and return the result.
1406 * Both @pre and @post are newly created list of kmod_module and
1407 * should be unreferenced with kmod_module_unref_list().
1409 * Returns: 0 on success or < 0 otherwise.
1411 KMOD_EXPORT
int kmod_module_get_softdeps(const struct kmod_module
*mod
,
1412 struct kmod_list
**pre
,
1413 struct kmod_list
**post
)
1415 const struct kmod_list
*l
, *ctx_softdeps
;
1417 if (mod
== NULL
|| pre
== NULL
|| post
== NULL
)
1420 assert(*pre
== NULL
);
1421 assert(*post
== NULL
);
1423 ctx_softdeps
= kmod_get_softdeps(mod
->ctx
);
1425 kmod_list_foreach(l
, ctx_softdeps
) {
1426 const char *modname
= kmod_softdep_get_name(l
);
1427 const char * const *array
;
1430 if (fnmatch(modname
, mod
->name
, 0) != 0)
1433 array
= kmod_softdep_get_pre(l
, &count
);
1434 *pre
= lookup_softdep(mod
->ctx
, array
, count
);
1435 array
= kmod_softdep_get_post(l
, &count
);
1436 *post
= lookup_softdep(mod
->ctx
, array
, count
);
1439 * find only the first command, as modprobe from
1440 * module-init-tools does
1449 * kmod_module_get_remove_commands:
1452 * Get remove commands for this kmod module. Remove commands come from the
1453 * configuration file and are cached in @mod. The first call to this function
1454 * will search for this module in configuration and subsequent calls return
1455 * the cached string. The remove commands are returned as they were in the
1456 * configuration, concatenated by ';'. No other processing is made in this
1459 * Returns: a string with all remove commands separated by semicolons. This
1460 * string is owned by @mod, do not free it.
1462 KMOD_EXPORT
const char *kmod_module_get_remove_commands(const struct kmod_module
*mod
)
1467 if (!mod
->init
.remove_commands
) {
1469 struct kmod_module
*m
= (struct kmod_module
*)mod
;
1470 const struct kmod_list
*l
, *ctx_remove_commands
;
1472 ctx_remove_commands
= kmod_get_remove_commands(mod
->ctx
);
1474 kmod_list_foreach(l
, ctx_remove_commands
) {
1475 const char *modname
= kmod_command_get_modname(l
);
1477 if (fnmatch(modname
, mod
->name
, 0) != 0)
1480 m
->remove_commands
= kmod_command_get_command(l
);
1483 * find only the first command, as modprobe from
1484 * module-init-tools does
1489 m
->init
.remove_commands
= true;
1492 return mod
->remove_commands
;
1495 void kmod_module_set_remove_commands(struct kmod_module
*mod
, const char *cmd
)
1497 mod
->init
.remove_commands
= true;
1498 mod
->remove_commands
= cmd
;
1502 * SECTION:libkmod-loaded
1503 * @short_description: currently loaded modules
1505 * Information about currently loaded modules, as reported by Linux kernel.
1506 * These information are not cached by libkmod and are always read from /sys
1507 * and /proc/modules.
1511 * kmod_module_new_from_loaded:
1512 * @ctx: kmod library context
1513 * @list: where to save the list of loaded modules
1515 * Create a new list of kmod modules with all modules currently loaded in
1516 * kernel. It uses /proc/modules to get the names of loaded modules and to
1517 * create kmod modules by calling kmod_module_new_from_name() in each of them.
1518 * They are put are put in @list in no particular order.
1520 * The initial refcount is 1, and needs to be decremented to release the
1521 * resources of the kmod_module. The returned @list must be released by
1522 * calling kmod_module_unref_list(). Since libkmod keeps track of all
1523 * kmod_modules created, they are all released upon @ctx destruction too. Do
1524 * not unref @ctx before all the desired operations with the returned list are
1527 * Returns: 0 on success or < 0 on error.
1529 KMOD_EXPORT
int kmod_module_new_from_loaded(struct kmod_ctx
*ctx
,
1530 struct kmod_list
**list
)
1532 struct kmod_list
*l
= NULL
;
1536 if (ctx
== NULL
|| list
== NULL
)
1539 fp
= fopen("/proc/modules", "re");
1542 ERR(ctx
, "could not open /proc/modules: %s\n", strerror(errno
));
1546 while (fgets(line
, sizeof(line
), fp
)) {
1547 struct kmod_module
*m
;
1548 struct kmod_list
*node
;
1550 char *saveptr
, *name
= strtok_r(line
, " \t", &saveptr
);
1552 err
= kmod_module_new_from_name(ctx
, name
, &m
);
1554 ERR(ctx
, "could not get module from name '%s': %s\n",
1555 name
, strerror(-err
));
1559 node
= kmod_list_append(l
, m
);
1563 ERR(ctx
, "out of memory\n");
1564 kmod_module_unref(m
);
1575 * kmod_module_initstate_str:
1576 * @state: the state as returned by kmod_module_get_initstate()
1578 * Translate a initstate to a string.
1580 * Returns: the string associated to the @state. This string is statically
1581 * allocated, do not free it.
1583 KMOD_EXPORT
const char *kmod_module_initstate_str(enum kmod_module_initstate state
)
1586 case KMOD_MODULE_BUILTIN
:
1588 case KMOD_MODULE_LIVE
:
1590 case KMOD_MODULE_COMING
:
1592 case KMOD_MODULE_GOING
:
1600 * kmod_module_get_initstate:
1603 * Get the initstate of this @mod, as returned by Linux Kernel, by reading
1606 * Returns: < 0 on error or enum kmod_initstate if module is found in kernel.
1608 KMOD_EXPORT
int kmod_module_get_initstate(const struct kmod_module
*mod
)
1610 char path
[PATH_MAX
], buf
[32];
1611 int fd
, err
, pathlen
;
1617 return KMOD_MODULE_BUILTIN
;
1619 pathlen
= snprintf(path
, sizeof(path
),
1620 "/sys/module/%s/initstate", mod
->name
);
1621 fd
= open(path
, O_RDONLY
|O_CLOEXEC
);
1625 DBG(mod
->ctx
, "could not open '%s': %s\n",
1626 path
, strerror(-err
));
1628 if (pathlen
> (int)sizeof("/initstate") - 1) {
1630 path
[pathlen
- (sizeof("/initstate") - 1)] = '\0';
1631 if (stat(path
, &st
) == 0 && S_ISDIR(st
.st_mode
))
1632 return KMOD_MODULE_BUILTIN
;
1635 DBG(mod
->ctx
, "could not open '%s': %s\n",
1636 path
, strerror(-err
));
1640 err
= read_str_safe(fd
, buf
, sizeof(buf
));
1643 ERR(mod
->ctx
, "could not read from '%s': %s\n",
1644 path
, strerror(-err
));
1648 if (streq(buf
, "live\n"))
1649 return KMOD_MODULE_LIVE
;
1650 else if (streq(buf
, "coming\n"))
1651 return KMOD_MODULE_COMING
;
1652 else if (streq(buf
, "going\n"))
1653 return KMOD_MODULE_GOING
;
1655 ERR(mod
->ctx
, "unknown %s: '%s'\n", path
, buf
);
1660 * kmod_module_get_size:
1663 * Get the size of this kmod module as returned by Linux kernel. It reads the
1664 * file /proc/modules to search for this module and get its size.
1666 * Returns: the size of this kmod module.
1668 KMOD_EXPORT
long kmod_module_get_size(const struct kmod_module
*mod
)
1670 // FIXME TODO: this should be available from /sys/module/foo
1674 long size
= -ENOENT
;
1679 fp
= fopen("/proc/modules", "re");
1683 "could not open /proc/modules: %s\n", strerror(errno
));
1687 while (fgets(line
, sizeof(line
), fp
)) {
1688 char *saveptr
, *endptr
, *tok
= strtok_r(line
, " \t", &saveptr
);
1692 if (tok
== NULL
|| !streq(tok
, mod
->name
))
1695 tok
= strtok_r(NULL
, " \t", &saveptr
);
1698 "invalid line format at /proc/modules:%d\n", lineno
);
1702 value
= strtol(tok
, &endptr
, 10);
1703 if (endptr
== tok
|| *endptr
!= '\0') {
1705 "invalid line format at /proc/modules:%d\n", lineno
);
1717 * kmod_module_get_refcnt:
1720 * Get the ref count of this @mod, as returned by Linux Kernel, by reading
1723 * Returns: 0 on success or < 0 on failure.
1725 KMOD_EXPORT
int kmod_module_get_refcnt(const struct kmod_module
*mod
)
1727 char path
[PATH_MAX
];
1734 snprintf(path
, sizeof(path
), "/sys/module/%s/refcnt", mod
->name
);
1735 fd
= open(path
, O_RDONLY
|O_CLOEXEC
);
1738 ERR(mod
->ctx
, "could not open '%s': %s\n",
1739 path
, strerror(errno
));
1743 err
= read_str_long(fd
, &refcnt
, 10);
1746 ERR(mod
->ctx
, "could not read integer from '%s': '%s'\n",
1747 path
, strerror(-err
));
1755 * kmod_module_get_holders:
1758 * Get a list of kmod modules that are holding this @mod, as returned by Linux
1759 * Kernel. After use, free the @list by calling kmod_module_unref_list().
1761 * Returns: a new list of kmod modules on success or NULL on failure.
1763 KMOD_EXPORT
struct kmod_list
*kmod_module_get_holders(const struct kmod_module
*mod
)
1765 char dname
[PATH_MAX
];
1766 struct kmod_list
*list
= NULL
;
1772 snprintf(dname
, sizeof(dname
), "/sys/module/%s/holders", mod
->name
);
1776 ERR(mod
->ctx
, "could not open '%s': %s\n",
1777 dname
, strerror(errno
));
1782 struct dirent de
, *entp
;
1783 struct kmod_module
*holder
;
1784 struct kmod_list
*l
;
1787 err
= readdir_r(d
, &de
, &entp
);
1789 ERR(mod
->ctx
, "could not iterate for module '%s': %s\n",
1790 mod
->name
, strerror(-err
));
1797 if (de
.d_name
[0] == '.') {
1798 if (de
.d_name
[1] == '\0' ||
1799 (de
.d_name
[1] == '.' && de
.d_name
[2] == '\0'))
1803 err
= kmod_module_new_from_name(mod
->ctx
, de
.d_name
, &holder
);
1805 ERR(mod
->ctx
, "could not create module for '%s': %s\n",
1806 de
.d_name
, strerror(-err
));
1810 l
= kmod_list_append(list
, holder
);
1814 ERR(mod
->ctx
, "out of memory\n");
1815 kmod_module_unref(holder
);
1825 kmod_module_unref_list(list
);
1829 struct kmod_module_section
{
1830 unsigned long address
;
1834 static void kmod_module_section_free(struct kmod_module_section
*section
)
1840 * kmod_module_get_sections:
1843 * Get a list of kmod sections of this @mod, as returned by Linux Kernel. The
1844 * structure contained in this list is internal to libkmod and their fields
1845 * can be obtained by calling kmod_module_section_get_name() and
1846 * kmod_module_section_get_address().
1848 * After use, free the @list by calling kmod_module_section_free_list().
1850 * Returns: a new list of kmod module sections on success or NULL on failure.
1852 KMOD_EXPORT
struct kmod_list
*kmod_module_get_sections(const struct kmod_module
*mod
)
1854 char dname
[PATH_MAX
];
1855 struct kmod_list
*list
= NULL
;
1862 snprintf(dname
, sizeof(dname
), "/sys/module/%s/sections", mod
->name
);
1866 ERR(mod
->ctx
, "could not open '%s': %s\n",
1867 dname
, strerror(errno
));
1874 struct dirent de
, *entp
;
1875 struct kmod_module_section
*section
;
1876 struct kmod_list
*l
;
1877 unsigned long address
;
1881 err
= readdir_r(d
, &de
, &entp
);
1883 ERR(mod
->ctx
, "could not iterate for module '%s': %s\n",
1884 mod
->name
, strerror(-err
));
1888 if (de
.d_name
[0] == '.') {
1889 if (de
.d_name
[1] == '\0' ||
1890 (de
.d_name
[1] == '.' && de
.d_name
[2] == '\0'))
1894 fd
= openat(dfd
, de
.d_name
, O_RDONLY
|O_CLOEXEC
);
1896 ERR(mod
->ctx
, "could not open '%s/%s': %m\n",
1901 err
= read_str_ulong(fd
, &address
, 16);
1904 ERR(mod
->ctx
, "could not read long from '%s/%s': %m\n",
1909 namesz
= strlen(de
.d_name
) + 1;
1910 section
= malloc(sizeof(*section
) + namesz
);
1912 if (section
== NULL
) {
1913 ERR(mod
->ctx
, "out of memory\n");
1917 section
->address
= address
;
1918 memcpy(section
->name
, de
.d_name
, namesz
);
1920 l
= kmod_list_append(list
, section
);
1924 ERR(mod
->ctx
, "out of memory\n");
1935 kmod_module_unref_list(list
);
1940 * kmod_module_section_get_module_name:
1941 * @entry: a list entry representing a kmod module section
1943 * Get the name of a kmod module section.
1945 * After use, free the @list by calling kmod_module_section_free_list().
1947 * Returns: the name of this kmod module section on success or NULL on
1948 * failure. The string is owned by the section, do not free it.
1950 KMOD_EXPORT
const char *kmod_module_section_get_name(const struct kmod_list
*entry
)
1952 struct kmod_module_section
*section
;
1957 section
= entry
->data
;
1958 return section
->name
;
1962 * kmod_module_section_get_address:
1963 * @entry: a list entry representing a kmod module section
1965 * Get the address of a kmod module section.
1967 * After use, free the @list by calling kmod_module_section_free_list().
1969 * Returns: the address of this kmod module section on success or ULONG_MAX
1972 KMOD_EXPORT
unsigned long kmod_module_section_get_address(const struct kmod_list
*entry
)
1974 struct kmod_module_section
*section
;
1977 return (unsigned long)-1;
1979 section
= entry
->data
;
1980 return section
->address
;
1984 * kmod_module_section_free_list:
1985 * @list: kmod module section list
1987 * Release the resources taken by @list
1989 KMOD_EXPORT
void kmod_module_section_free_list(struct kmod_list
*list
)
1992 kmod_module_section_free(list
->data
);
1993 list
= kmod_list_remove(list
);
1997 struct kmod_module_info
{
2002 static struct kmod_module_info
*kmod_module_info_new(const char *key
, size_t keylen
, const char *value
, size_t valuelen
)
2004 struct kmod_module_info
*info
;
2006 info
= malloc(sizeof(struct kmod_module_info
) + keylen
+ valuelen
+ 2);
2010 info
->key
= (char *)info
+ sizeof(struct kmod_module_info
)
2012 memcpy(info
->key
, key
, keylen
);
2013 info
->key
[keylen
] = '\0';
2014 memcpy(info
->value
, value
, valuelen
);
2015 info
->value
[valuelen
] = '\0';
2019 static void kmod_module_info_free(struct kmod_module_info
*info
)
2025 * kmod_module_get_info:
2027 * @list: where to return list of module information. Use
2028 * kmod_module_info_get_key() and
2029 * kmod_module_info_get_value(). Release this list with
2030 * kmod_module_info_free_list()
2032 * Get a list of entries in ELF section ".modinfo", these contain
2033 * alias, license, depends, vermagic and other keys with respective
2036 * After use, free the @list by calling kmod_module_info_free_list().
2038 * Returns: 0 on success or < 0 otherwise.
2040 KMOD_EXPORT
int kmod_module_get_info(const struct kmod_module
*mod
, struct kmod_list
**list
)
2042 struct kmod_file
*file
;
2043 struct kmod_elf
*elf
;
2048 int i
, count
, ret
= 0;
2050 if (mod
== NULL
|| list
== NULL
)
2053 assert(*list
== NULL
);
2055 path
= kmod_module_get_path(mod
);
2059 file
= kmod_file_open(mod
->ctx
, path
);
2063 size
= kmod_file_get_size(file
);
2064 mem
= kmod_file_get_contents(file
);
2066 elf
= kmod_elf_new(mem
, size
);
2069 goto elf_open_error
;
2072 count
= kmod_elf_get_strings(elf
, ".modinfo", &strings
);
2075 goto get_strings_error
;
2078 for (i
= 0; i
< count
; i
++) {
2079 struct kmod_module_info
*info
;
2080 struct kmod_list
*n
;
2081 const char *key
, *value
;
2082 size_t keylen
, valuelen
;
2085 value
= strchr(key
, '=');
2086 if (value
== NULL
) {
2087 keylen
= strlen(key
);
2090 keylen
= value
- key
;
2092 valuelen
= strlen(value
);
2095 info
= kmod_module_info_new(key
, keylen
, value
, valuelen
);
2098 kmod_module_info_free_list(*list
);
2103 n
= kmod_list_append(*list
, info
);
2107 kmod_module_info_free(info
);
2108 kmod_module_info_free_list(*list
);
2119 kmod_elf_unref(elf
);
2121 kmod_file_unref(file
);
2127 * kmod_module_info_get_key:
2128 * @entry: a list entry representing a kmod module info
2130 * Get the key of a kmod module info.
2132 * Returns: the key of this kmod module info on success or NULL on
2133 * failure. The string is owned by the info, do not free it.
2135 KMOD_EXPORT
const char *kmod_module_info_get_key(const struct kmod_list
*entry
)
2137 struct kmod_module_info
*info
;
2147 * kmod_module_info_get_value:
2148 * @entry: a list entry representing a kmod module info
2150 * Get the value of a kmod module info.
2152 * Returns: the value of this kmod module info on success or NULL on
2153 * failure. The string is owned by the info, do not free it.
2155 KMOD_EXPORT
const char *kmod_module_info_get_value(const struct kmod_list
*entry
)
2157 struct kmod_module_info
*info
;
2167 * kmod_module_info_free_list:
2168 * @list: kmod module info list
2170 * Release the resources taken by @list
2172 KMOD_EXPORT
void kmod_module_info_free_list(struct kmod_list
*list
)
2175 kmod_module_info_free(list
->data
);
2176 list
= kmod_list_remove(list
);
2180 struct kmod_module_version
{
2185 static struct kmod_module_version
*kmod_module_versions_new(uint64_t crc
, const char *symbol
)
2187 struct kmod_module_version
*mv
;
2188 size_t symbollen
= strlen(symbol
) + 1;
2190 mv
= malloc(sizeof(struct kmod_module_version
) + symbollen
);
2195 memcpy(mv
->symbol
, symbol
, symbollen
);
2199 static void kmod_module_version_free(struct kmod_module_version
*version
)
2205 * kmod_module_get_versions:
2207 * @list: where to return list of module versions. Use
2208 * kmod_module_version_get_symbol() and
2209 * kmod_module_version_get_crc(). Release this list with
2210 * kmod_module_versions_free_list()
2212 * Get a list of entries in ELF section "__versions".
2214 * After use, free the @list by calling kmod_module_versions_free_list().
2216 * Returns: 0 on success or < 0 otherwise.
2218 KMOD_EXPORT
int kmod_module_get_versions(const struct kmod_module
*mod
, struct kmod_list
**list
)
2220 struct kmod_file
*file
;
2221 struct kmod_elf
*elf
;
2224 struct kmod_modversion
*versions
;
2226 int i
, count
, ret
= 0;
2228 if (mod
== NULL
|| list
== NULL
)
2231 assert(*list
== NULL
);
2233 path
= kmod_module_get_path(mod
);
2237 file
= kmod_file_open(mod
->ctx
, path
);
2241 size
= kmod_file_get_size(file
);
2242 mem
= kmod_file_get_contents(file
);
2244 elf
= kmod_elf_new(mem
, size
);
2247 goto elf_open_error
;
2250 count
= kmod_elf_get_modversions(elf
, &versions
);
2253 goto get_strings_error
;
2256 for (i
= 0; i
< count
; i
++) {
2257 struct kmod_module_version
*mv
;
2258 struct kmod_list
*n
;
2260 mv
= kmod_module_versions_new(versions
[i
].crc
, versions
[i
].symbol
);
2263 kmod_module_versions_free_list(*list
);
2268 n
= kmod_list_append(*list
, mv
);
2272 kmod_module_version_free(mv
);
2273 kmod_module_versions_free_list(*list
);
2284 kmod_elf_unref(elf
);
2286 kmod_file_unref(file
);
2292 * kmod_module_versions_get_symbol:
2293 * @entry: a list entry representing a kmod module versions
2295 * Get the symbol of a kmod module versions.
2297 * Returns: the symbol of this kmod module versions on success or NULL
2298 * on failure. The string is owned by the versions, do not free it.
2300 KMOD_EXPORT
const char *kmod_module_version_get_symbol(const struct kmod_list
*entry
)
2302 struct kmod_module_version
*version
;
2307 version
= entry
->data
;
2308 return version
->symbol
;
2312 * kmod_module_version_get_crc:
2313 * @entry: a list entry representing a kmod module version
2315 * Get the crc of a kmod module version.
2317 * Returns: the crc of this kmod module version on success or NULL on
2318 * failure. The string is owned by the version, do not free it.
2320 KMOD_EXPORT
uint64_t kmod_module_version_get_crc(const struct kmod_list
*entry
)
2322 struct kmod_module_version
*version
;
2327 version
= entry
->data
;
2328 return version
->crc
;
2332 * kmod_module_versions_free_list:
2333 * @list: kmod module versions list
2335 * Release the resources taken by @list
2337 KMOD_EXPORT
void kmod_module_versions_free_list(struct kmod_list
*list
)
2340 kmod_module_version_free(list
->data
);
2341 list
= kmod_list_remove(list
);
2345 struct kmod_module_symbol
{
2350 static struct kmod_module_symbol
*kmod_module_symbols_new(uint64_t crc
, const char *symbol
)
2352 struct kmod_module_symbol
*mv
;
2353 size_t symbollen
= strlen(symbol
) + 1;
2355 mv
= malloc(sizeof(struct kmod_module_symbol
) + symbollen
);
2360 memcpy(mv
->symbol
, symbol
, symbollen
);
2364 static void kmod_module_symbol_free(struct kmod_module_symbol
*symbol
)
2370 * kmod_module_get_symbols:
2372 * @list: where to return list of module symbols. Use
2373 * kmod_module_symbol_get_symbol() and
2374 * kmod_module_symbol_get_crc(). Release this list with
2375 * kmod_module_symbols_free_list()
2377 * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
2379 * After use, free the @list by calling kmod_module_symbols_free_list().
2381 * Returns: 0 on success or < 0 otherwise.
2383 KMOD_EXPORT
int kmod_module_get_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
)
2385 struct kmod_file
*file
;
2386 struct kmod_elf
*elf
;
2389 struct kmod_modversion
*symbols
;
2391 int i
, count
, ret
= 0;
2393 if (mod
== NULL
|| list
== NULL
)
2396 assert(*list
== NULL
);
2398 path
= kmod_module_get_path(mod
);
2402 file
= kmod_file_open(mod
->ctx
, path
);
2406 size
= kmod_file_get_size(file
);
2407 mem
= kmod_file_get_contents(file
);
2409 elf
= kmod_elf_new(mem
, size
);
2412 goto elf_open_error
;
2415 count
= kmod_elf_get_symbols(elf
, &symbols
);
2418 goto get_strings_error
;
2421 for (i
= 0; i
< count
; i
++) {
2422 struct kmod_module_symbol
*mv
;
2423 struct kmod_list
*n
;
2425 mv
= kmod_module_symbols_new(symbols
[i
].crc
, symbols
[i
].symbol
);
2428 kmod_module_symbols_free_list(*list
);
2433 n
= kmod_list_append(*list
, mv
);
2437 kmod_module_symbol_free(mv
);
2438 kmod_module_symbols_free_list(*list
);
2449 kmod_elf_unref(elf
);
2451 kmod_file_unref(file
);
2457 * kmod_module_symbol_get_symbol:
2458 * @entry: a list entry representing a kmod module symbols
2460 * Get the symbol of a kmod module symbols.
2462 * Returns: the symbol of this kmod module symbols on success or NULL
2463 * on failure. The string is owned by the symbols, do not free it.
2465 KMOD_EXPORT
const char *kmod_module_symbol_get_symbol(const struct kmod_list
*entry
)
2467 struct kmod_module_symbol
*symbol
;
2472 symbol
= entry
->data
;
2473 return symbol
->symbol
;
2477 * kmod_module_symbol_get_crc:
2478 * @entry: a list entry representing a kmod module symbol
2480 * Get the crc of a kmod module symbol.
2482 * Returns: the crc of this kmod module symbol on success or NULL on
2483 * failure. The string is owned by the symbol, do not free it.
2485 KMOD_EXPORT
uint64_t kmod_module_symbol_get_crc(const struct kmod_list
*entry
)
2487 struct kmod_module_symbol
*symbol
;
2492 symbol
= entry
->data
;
2497 * kmod_module_symbols_free_list:
2498 * @list: kmod module symbols list
2500 * Release the resources taken by @list
2502 KMOD_EXPORT
void kmod_module_symbols_free_list(struct kmod_list
*list
)
2505 kmod_module_symbol_free(list
->data
);
2506 list
= kmod_list_remove(list
);
2510 struct kmod_module_dependency_symbol
{
2516 static struct kmod_module_dependency_symbol
*kmod_module_dependency_symbols_new(uint64_t crc
, uint8_t bind
, const char *symbol
)
2518 struct kmod_module_dependency_symbol
*mv
;
2519 size_t symbollen
= strlen(symbol
) + 1;
2521 mv
= malloc(sizeof(struct kmod_module_dependency_symbol
) + symbollen
);
2527 memcpy(mv
->symbol
, symbol
, symbollen
);
2531 static void kmod_module_dependency_symbol_free(struct kmod_module_dependency_symbol
*dependency_symbol
)
2533 free(dependency_symbol
);
2537 * kmod_module_get_dependency_symbols:
2539 * @list: where to return list of module dependency_symbols. Use
2540 * kmod_module_dependency_symbol_get_symbol() and
2541 * kmod_module_dependency_symbol_get_crc(). Release this list with
2542 * kmod_module_dependency_symbols_free_list()
2544 * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
2546 * After use, free the @list by calling
2547 * kmod_module_dependency_symbols_free_list().
2549 * Returns: 0 on success or < 0 otherwise.
2551 KMOD_EXPORT
int kmod_module_get_dependency_symbols(const struct kmod_module
*mod
, struct kmod_list
**list
)
2553 struct kmod_file
*file
;
2554 struct kmod_elf
*elf
;
2557 struct kmod_modversion
*symbols
;
2559 int i
, count
, ret
= 0;
2561 if (mod
== NULL
|| list
== NULL
)
2564 assert(*list
== NULL
);
2566 path
= kmod_module_get_path(mod
);
2570 file
= kmod_file_open(mod
->ctx
, path
);
2574 size
= kmod_file_get_size(file
);
2575 mem
= kmod_file_get_contents(file
);
2577 elf
= kmod_elf_new(mem
, size
);
2580 goto elf_open_error
;
2583 count
= kmod_elf_get_dependency_symbols(elf
, &symbols
);
2586 goto get_strings_error
;
2589 for (i
= 0; i
< count
; i
++) {
2590 struct kmod_module_dependency_symbol
*mv
;
2591 struct kmod_list
*n
;
2593 mv
= kmod_module_dependency_symbols_new(symbols
[i
].crc
,
2598 kmod_module_dependency_symbols_free_list(*list
);
2603 n
= kmod_list_append(*list
, mv
);
2607 kmod_module_dependency_symbol_free(mv
);
2608 kmod_module_dependency_symbols_free_list(*list
);
2619 kmod_elf_unref(elf
);
2621 kmod_file_unref(file
);
2627 * kmod_module_dependency_symbol_get_symbol:
2628 * @entry: a list entry representing a kmod module dependency_symbols
2630 * Get the dependency symbol of a kmod module
2632 * Returns: the symbol of this kmod module dependency_symbols on success or NULL
2633 * on failure. The string is owned by the dependency_symbols, do not free it.
2635 KMOD_EXPORT
const char *kmod_module_dependency_symbol_get_symbol(const struct kmod_list
*entry
)
2637 struct kmod_module_dependency_symbol
*dependency_symbol
;
2642 dependency_symbol
= entry
->data
;
2643 return dependency_symbol
->symbol
;
2647 * kmod_module_dependency_symbol_get_crc:
2648 * @entry: a list entry representing a kmod module dependency_symbol
2650 * Get the crc of a kmod module dependency_symbol.
2652 * Returns: the crc of this kmod module dependency_symbol on success or NULL on
2653 * failure. The string is owned by the dependency_symbol, do not free it.
2655 KMOD_EXPORT
uint64_t kmod_module_dependency_symbol_get_crc(const struct kmod_list
*entry
)
2657 struct kmod_module_dependency_symbol
*dependency_symbol
;
2662 dependency_symbol
= entry
->data
;
2663 return dependency_symbol
->crc
;
2667 * kmod_module_dependency_symbol_get_bind:
2668 * @entry: a list entry representing a kmod module dependency_symbol
2670 * Get the bind type of a kmod module dependency_symbol.
2672 * Returns: the bind of this kmod module dependency_symbol on success
2673 * or < 0 on failure.
2675 KMOD_EXPORT
int kmod_module_dependency_symbol_get_bind(const struct kmod_list
*entry
)
2677 struct kmod_module_dependency_symbol
*dependency_symbol
;
2682 dependency_symbol
= entry
->data
;
2683 return dependency_symbol
->bind
;
2687 * kmod_module_dependency_symbols_free_list:
2688 * @list: kmod module dependency_symbols list
2690 * Release the resources taken by @list
2692 KMOD_EXPORT
void kmod_module_dependency_symbols_free_list(struct kmod_list
*list
)
2695 kmod_module_dependency_symbol_free(list
->data
);
2696 list
= kmod_list_remove(list
);