MAN page from Trustix modutils-2.4.3-2tr.i586.rpm

GENKSYMS

Section: Linux Module Support (8)
Updated: Sep 10, 1997
Index

NAME

genksyms - generate symbol version information

SYNOPSIS

genksyms[ -wq ] [ -dD ] [ -V ] -k version [ -p string ][ output directory ]

DESCRIPTION

Genksymsreads (on standard input) the output fromgcc -E source.cand generates a file containing version information.

Depending on the output format indicated by the-koption, the output will either be written to a .ver file in the namedoutput directory, or to the standard output.

Genksymsnormally looks for explicit symbol table definitions in the sourcefile. All definitions and declarations oftypedef, struct, unionandenumwill be saved for later expansion.Every global symbol will also be saved, together with pointersthat will enable a full expansion later on.

When a symbol table is found in the source, the symbol will beexpanded to its full definition, where all struct's, unions, enumsand typedefs will be expanded down to their basic part, recursively.This final string will then be used as input to a CRC algorithmthat will give an integer that will change as soon as any of theincluded definitions changes, for this symbol.

The version information in the kernel normally looks like:symbol_R12345678,where 12345678 is the hexadecimal representation of the CRC.

OPTIONS

-w: Enable warnings due to unrecognized syntax and declared but undefinedstructures. These warnings are normally suppressed.
-q: Quiet warnings, i.e. reverse the -w option.
-D: Dump expanded symbol definitions to stderr. For debugging use only.
-d: Output debugging information; repeating this option increases theverbosity. Debug level 1 generates moderate information about theactions being taken; debug level 2 enables parser recognitionoutput; debug level 3 enables lexical analysis output.
-k version: Select the version of the kernel for which to generate output. Omittingthis option assumes a version below 2.1.0. Versions below 2.1.18use checksum version 1, and produce their output in the directory givenon the command line. Versions 2.1.18 and above use checksum version 2and produce their output on stdout.
-p string: Prepend the given string to the CRCs generated for all symbols. This isintended for use with e.g. SMP kernels, wherein the modules are notcompatible at a level below that described by the data types. This isprimarily caused by inline function expansions in the module code itself.

HISTORY

This versioning concept is a result from discussions, not at leaston the KERNEL-channel, with a lot of people.

The genksyms utility was created in 1994 by Bjorn Ekwall <bj0rnAATTblox.se>being mostly inspired by Jacques Gelinas <jackAATTsolucorp.ca>and Jeremy Fitzhardinge <jeremyAATTsuite.sw.oz.au>

It was rewritten in 1996 by Richard Henderson to use a proper lexerand parser.

This document was created byman2html,using the manual pages.