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