man2/get_kernel_syms.2

   1 .\" Copyright (C) 1996 Free Software Foundation, Inc.
   2 .\"
   3 .\" SPDX-License-Identifier: GPL-1.0-or-later
   4 .\"
   5 .\" 2006-02-09, some reformatting by Luc Van Oostenryck; some
   6 .\" reformatting and rewordings by mtk
   7 .\"
   8 .TH GET_KERNEL_SYMS 2 2021-03-22 "Linux" "Linux Programmer's Manual"
   9 .SH NAME
  10 get_kernel_syms \- retrieve exported kernel and module symbols
  11 .SH SYNOPSIS
  12 .nf
  13 .B #include <linux/module.h>
  14 .PP
  15 .BI "int get_kernel_syms(struct kernel_sym *" table );
  16 .fi
  17 .PP
  18 .IR Note :
  19 No declaration of this system call is provided in glibc headers; see NOTES.
  20 .SH DESCRIPTION
  21 .BR Note :
  22 This system call is present only in kernels before Linux 2.6.
  23 .PP
  24 If
  25 .I table
  26 is NULL,
  27 .BR get_kernel_syms ()
  28 returns the number of symbols available for query.
  29 Otherwise, it fills in a table of structures:
  30 .PP
  31 .in +4n
  32 .EX
  33 struct kernel_sym {
  34     unsigned long value;
  35     char          name[60];
  36 };
  37 .EE
  38 .in
  39 .PP
  40 The symbols are interspersed with magic symbols of the form
  41 .BI # module-name
  42 with the kernel having an empty name.
  43 The value associated with a symbol of this form is the address at
  44 which the module is loaded.
  45 .PP
  46 The symbols exported from each module follow their magic module tag
  47 and the modules are returned in the reverse of the
  48 order in which they were loaded.
  49 .SH RETURN VALUE
  50 On success, returns the number of symbols copied to
  51 .IR table .
  52 On error, \-1 is returned and
  53 .I errno
  54 is set to indicate the error.
  55 .SH ERRORS
  56 There is only one possible error return:
  57 .TP
  58 .B ENOSYS
  59 .BR get_kernel_syms ()
  60 is not supported in this version of the kernel.
  61 .SH VERSIONS
  62 This system call is present on Linux only up until kernel 2.4;
  63 it was removed in Linux 2.6.
  64 .\" Removed in Linux 2.5.48
  65 .SH STANDARDS
  66 .BR get_kernel_syms ()
  67 is Linux-specific.
  68 .SH NOTES
  69 This obsolete system call is not supported by glibc.
  70 No declaration is provided in glibc headers, but, through a quirk of history,
  71 glibc versions before 2.23 did export an ABI for this system call.
  72 Therefore, in order to employ this system call,
  73 it was sufficient to manually declare the interface in your code;
  74 alternatively, you could invoke the system call using
  75 .BR syscall (2).
  76 .SH BUGS
  77 There is no way to indicate the size of the buffer allocated for
  78 .IR table .
  79 If symbols have been added to the kernel since the
  80 program queried for the symbol table size, memory will be corrupted.
  81 .PP
  82 The length of exported symbol names is limited to 59 characters.
  83 .PP
  84 Because of these limitations, this system call is deprecated in
  85 favor of
  86 .BR query_module (2)
  87 (which is itself nowadays deprecated
  88 in favor of other interfaces described on its manual page).
  89 .SH SEE ALSO
  90 .BR create_module (2),
  91 .BR delete_module (2),
  92 .BR init_module (2),
  93 .BR query_module (2)