All new accounts created on Gitlab now require administrator approval. If you invite any collaborators, please let Flux staff know so they can approve the accounts.

Commit 7cac6387 authored by Charlie Jacobsen's avatar Charlie Jacobsen Committed by Vikram Narayanan

Patched modprobe (and rest of init tools suite) now in repo.

Found under tools/module-init-tools. These are not (for now)
automatically built and installed when the kernel is built.

To build and install, enter the module-init-tools directory,
and do the following:

   [ 1 ] aclocal -I m4 && automake --add-missing --copy && autoconf
   [ 2 ] ./configure --prefix=/ --program-prefx=lcd-
   [ 3 ] make
   [ 4 ] (sudo) make install

This will install the patched /sbin/lcd-modprobe and /sbin/lcd-insmod,
as well as the other init tools that were left untouched. The
user mode helper will use lcd-modprobe to load the module.

The man pages won't install on emulab (since /share is read only).
You can specify a different man dir via configure if you wish.

After installation, you should then be able to successfully run a
kernel module inside of an lcd, via lcd_create_as_module.

The only changes to init tools are in modprobe.c and insmod.c; only
the changes in modprobe.c are of interest (lcd-insmod is not currently
used/needed). Instead of doing the Linux init_module system call,
lcd-modprobe does an ioctl call to the LCD driver (hence, the LCD driver
must be loaded), with the bytes of the module, its size, and command
line options.
parent e0193fa4
*.swp
*~
# Generated by autotools
.deps
aclocal.m4
autom4te.cache
config.guess
config.log
config.status
config.sub
configure
depcomp
install-sh
Makefile.in
Makefile
!tests/data/Makefile
missing
# Compiled executables
*.o
*.a
depmod
insmod
insmod.static
lsmod
modinfo
modindex
modprobe
rmmod
# But don't ignore the symlinks with the same names in this directory
!tests/valgrind/*
# cscope/tags
tags
TAGS
cscope.*
ncscope.*
# Generated documentation
*.8
*.5
manpage.links
manpage.refs
# quilt's files
patches
series
# test output
tests/build
tests/tmp
tests/data/32
tests/data/64
Maintainer:
Jon Masters <jcm@jonmasters.org>
Many thanks to:
Adam J. Richter <adam@yggdrasil.com>
Alan Jenkins <alan-jenkins@tuffmail.co.uk>
Andreas Robinson <andr345@gmail.com>
Jon Masters <jcm@jonmasters.org>
Kay Sievers <kay.sievers@vrfy.org>
Keegan McAllister <keegan@ksplice.com>
Marco d'Itri <md@linux.it>
Michal Marek <mmarek@suse.cz>
Mike Frysinger <vapier@gentoo.org>
Robby Workman <rworkman@slackware.com>
Rusty Russell <rusty@rustcorp.com.au>
Tom Gundersen <teg@jklm.no>
Some BUGs, grouped by the individual utilty
-------------------------------------------
NOTE: There is an official Bugzilla on bugzilla.kernel.org. Please do not
add to this file - file a bug on that website instead (one line URL):
https://bugzilla.kernel.org/enter_bug.cgi?component=module-init-tools
&product=Other
(Or on buzilla.kernel.org click "New", "Other", "module-init-tools")
modprobe
--------
* BZ: https://bugzilla.kernel.org/show_bug.cgi?id=16044
* BUG: We don't output deps correctly when calling --show-depends (-D)
* REASON: show-depends sets a variety of individual flags but there's
no easy way for handle_module->insmod to know the difference between
these options or an actual "-D", so we skip out too early if we hit
command entries when processing a module. RHEL has a temp fix that
it will re-read the environment (which does have -D set) in insmod.
module-init-tools coding standards
----------------------------------
Patches to module-init-tools are welcome. Please note the following
design goals:
1) insmod and rmmod are designed to be as simple as possible.
2) modprobe is designed to be a swiss-army-knife, but the config file
format is designed to be as simple as possible: let the user create
complexity if they wish. Having said that, the "install" and "remove"
commands serve as examples of what we don't want to do in the future,
due to the problems they cause with identifying module dependencies.
3) module-init-tools contains a testsuite. Patches which do not pass
the testsuite get a frowny face. It's easy to run the testsuite,
as you can see below. Please do test patches before posting.
The testsuite
-------------
The testsuite is under tests/test-*: one directory for each tool. To
run the testsuite, type the following from the top level directory:
./tests/runtests
To start the tests at a particular test, use that test name on the
command line, eg. "./tests/runtests 26blacklist.sh". To see exactly
what the test is doing, use -vv, eg
./tests/runtests -vv 26blacklist.sh
To only test a given endianess or bitness, use
TEST_ENDIAN=32 TEST_BITS=le ./tests/runtests
Each test is a shell script run with "-e": ie. if any command fails,
the test will fail. The path is set up with special test versions of
the utilities (and possibly valgrind wrappers), so just invoke
"modprobe" etc. as normal. Environment variables can be used to
control normally hardwired behaviour:
1) $MODTEST_UNAME:
The result "uname" is to return. Set to 2.6.27 by default.
2) $MODTEST_OVERRIDE<n>, $MODTEST_OVERRIDE_WITH<n>
These cause file operations on $MODTEST_OVERRIDE1 to occur on
$MODTEST_OVERRIDE_WITH1, etc. The numbers must be consecutive:
the code stops searching for a replacement when a number is not
found. This is used to stop the utilities looking in
/lib/modules/2.6.27/ for example.
Other environment variables can be found in testing.h.
There are various pre-compiled test modules under tests/data/. Each
one has big and little endian and 32 and 64-bit variants: modprobe
must handle both 32 and 64 bit (for x86-64, PPC64, Sparc64, IA64), and
depmod and modinfo must handle any endianness as well. If you need to
add a new module to test something, put the source under tests/src,
make sure it passes for the cases you can test, and I'll compile and
test the others.
When writing tests, make sure your test aborts on any unexpected
behaviour: eg. compare the result is equal to what you expect, rather
than not equal to something.
Cheers!
Rusty and Jon.
This diff is collapsed.
This diff is collapsed.
Frequently Asked Module User Questions
--------------------------------------
Q) Where should I report bugs?
A) Please post to the linux-modules@vger.kernel.org mailing list, along with
a description of how to reproduce. Copy Jon Masters <jcm@jonmasters.org>.
Q) I get "/usr/bin/ld: cannot find -lc"
A) You need to install a development package which contains libc.a.
For example, on Fedora systems, you would type "yum install glibc-static".
Q) I'm having trouble inserting out-of-tree modules
A) See kernel source tree documentation: Documentation/kbuild/modules.txt
Notes for Hackers
-----------------
Here are some quick notes, that may or may not evolve into something more
substantial over time. Development is preferably done via git merges.
* git trees don't contain pre-built config/Makefiles/etc. You'll need to
run the following (in order):
aclocal -I m4
automake --add-missing --copy
autoconf
You can also run "autoreconf -i" to perform these three stages.
* Regression tests can be run as follows (try --help for more details):
tests/runtests
* Documentation is in SGML source in doc/ so don't edit *.8, *.5 directly.
Prior to a new release:
Update configure.ac with new version
commit git tree to appropriate branch (dev/master/topic)
perform a final tests/runtests on the tree
push tree up to git.kernel.org
prep tree for tarball (git archive)
sign tree with GPG and save signature
push archive up to kernel.org
Jon Masters <jcm@jonmasters.org>
Installation Instructions
*************************
Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005,
2006, 2007 Free Software Foundation, Inc.
This file is free documentation; the Free Software Foundation gives
unlimited permission to copy, distribute and modify it.
Basic Installation
==================
Briefly, the shell commands `./configure; make; make install' should
configure, build, and install this package. The following
more-detailed instructions are generic; see the `README' file for
instructions specific to this package.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, and a
file `config.log' containing compiler output (useful mainly for
debugging `configure').
It can also use an optional file (typically called `config.cache'
and enabled with `--cache-file=config.cache' or simply `-C') that saves
the results of its tests to speed up reconfiguring. Caching is
disabled by default to prevent problems with accidental use of stale
cache files.
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If you are using the cache, and at
some point `config.cache' contains results you don't want to keep, you
may remove or edit it.
The file `configure.ac' (or `configure.in') is used to create
`configure' by a program called `autoconf'. You need `configure.ac' if
you want to change it or regenerate `configure' using a newer version
of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system.
Running `configure' might take a while. While running, it prints
some messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
6. Often, you can also type `make uninstall' to remove the installed
files again.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that the
`configure' script does not know about. Run `./configure --help' for
details on some of the pertinent environment variables.
You can give `configure' initial values for configuration parameters
by setting variables in the command line or in the environment. Here
is an example:
./configure CC=c99 CFLAGS=-g LIBS=-lposix
*Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you can use GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
With a non-GNU `make', it is safer to compile the package for one
architecture at a time in the source code directory. After you have
installed the package for one architecture, use `make distclean' before
reconfiguring for another architecture.
Installation Names
==================
By default, `make install' installs the package's commands under
`/usr/local/bin', include files under `/usr/local/include', etc. You
can specify an installation prefix other than `/usr/local' by giving
`configure' the option `--prefix=PREFIX'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
pass the option `--exec-prefix=PREFIX' to `configure', the package uses
PREFIX as the prefix for installing programs and libraries.
Documentation and other data files still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=DIR' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' cannot figure out automatically,
but needs to determine by the type of machine the package will run on.
Usually, assuming the package is built to be run on the _same_
architectures, `configure' can figure that out, but if it prints a
message saying it cannot guess the machine type, give it the
`--build=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name which has the form:
CPU-COMPANY-SYSTEM
where SYSTEM can have one of these forms:
OS KERNEL-OS
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the machine type.
If you are _building_ compiler tools for cross-compiling, you should
use the option `--target=TYPE' to select the type of system they will
produce code for.
If you want to _use_ a cross compiler, that generates code for a
platform different from the build platform, you should specify the
"host" platform (i.e., that on which the generated programs will
eventually be run) with `--host=TYPE'.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share, you
can create a site shell script called `config.site' that gives default
values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Defining Variables
==================
Variables not defined in a site shell script can be set in the
environment passed to `configure'. However, some packages may run
configure again during the build, and the customized values of these
variables may be lost. In order to avoid this problem, you should set
them in the `configure' command line, using `VAR=value'. For example:
./configure CC=/usr/local2/bin/gcc
causes the specified `gcc' to be used as the C compiler (unless it is
overridden in the site shell script).
Unfortunately, this technique does not work for `CONFIG_SHELL' due to
an Autoconf bug. Until the bug is fixed you can use this workaround:
CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash
`configure' Invocation
======================
`configure' recognizes the following options to control how it operates.
`--help'
`-h'
Print a summary of the options to `configure', and exit.
`--version'
`-V'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`--cache-file=FILE'
Enable the cache: use and save the results of the tests in FILE,
traditionally `config.cache'. FILE defaults to `/dev/null' to
disable caching.
`--config-cache'
`-C'
Alias for `--cache-file=config.cache'.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`configure' also accepts some other, not widely useful, options. Run
`configure --help' for more details.
ACLOCAL_AMFLAGS = -I m4
insmod_SOURCES = insmod.c testing.h
lsmod_SOURCES = lsmod.c testing.h
modprobe_SOURCES = modprobe.c zlibsupport.c zlibsupport.h testing.h
rmmod_SOURCES = rmmod.c testing.h
depmod_SOURCES = depmod.c zlibsupport.c tables.c \
zlibsupport.h tables.h testing.h
modinfo_SOURCES = modinfo.c zlibsupport.c zlibsupport.h testing.h
modindex_SOURCES = modindex.c zlibsupport.c zlibsupport.h testing.h
insmod_static_SOURCES = insmod.c
insmod_static_LDFLAGS = -static
# We don't want the $(zlib_flags) here: that makes a dynamic executable
insmod_static_LDADD = libmodtools.a
EXTRA_insmod_SOURCES =
EXTRA_lsmod_SOURCES =
EXTRA_modprobe_SOURCES =
EXTRA_rmmod_SOURCES =
EXTRA_insmod_static_SOURCES =
EXTRA_depmod_SOURCES =
EXTRA_modinfo_SOURCES =
libmodtools_a_SOURCES = util.c logging.c index.c config_filter.c elfops.c \
util.h depmod.h logging.h index.h list.h config_filter.h elfops.h
libmodtools_a_CFLAGS = -ffunction-sections
EXTRA_libmodtools_a_SOURCES = elfops_core.c
insmod_LDADD = $(LDADD) libmodtools.a
lsmod_LDADD = $(LDADD) libmodtools.a
modprobe_LDADD = $(LDADD) libmodtools.a
rmmod_LDADD = $(LDADD) libmodtools.a
depmod_LDADD = $(LDADD) libmodtools.a
modinfo_LDADD = $(LDADD) libmodtools.a
modindex_LDADD = $(LDADD) libmodtools.a
MAN5 = depmod.conf.5 depmod.d.5 modprobe.conf.5 modprobe.d.5 \
modules.dep.5 modules.dep.bin.5
MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8
SGML = $(addprefix doc/, $(MAN5:%.5=%.sgml) $(MAN8:%.8=%.sgml))
dist_man_MANS = $(MAN5) $(MAN8)
# If they haven't overridden mandir, fix it (never /man!)
mandir =$(shell if [ @mandir@ = $(prefix)/man ]; then if [ $(prefix) = / ]; then echo /usr/share/man; else echo $(prefix)/share/man; fi; else echo @mandir@; fi)
TESTSUITE := $(shell test -e @srcdir@/tests && find @srcdir@/tests -type f ! -name '*~')
EXTRA_DIST = generate-modprobe.conf FAQ CODING stress_modules.sh install-with-care $(SGML) $(man_MANS) $(TESTSUITE)
sbin_PROGRAMS = insmod modprobe rmmod depmod modinfo
if BUILD_STATIC_UTILS
sbin_PROGRAMS += insmod.static
endif
bin_PROGRAMS = lsmod
noinst_PROGRAMS=modindex
noinst_LIBRARIES = libmodtools.a
INSTALL = $(SHELL) $(top_srcdir)/install-with-care
DIST_DIR := /data/work/releases/module-init-tools/
GIT_RELEASE_REMOTE := origin
GIT_RELEASE_BRANCH := master
SCP_RELEASE_URL := "jcm@master.kernel.org:/pub/linux/utils/kernel/module-init-tools/"
MAINTAINERCLEANFILES := $(man_MANS)
# docbook2man writes file itself, doesn't do stdout.
%.8: doc/%.sgml
if [ "$(DOCBOOKTOMAN)" = "docbook2man" ]; then \
$(DOCBOOKTOMAN) $< > /dev/null 2>&1; \
else \
$(DOCBOOKTOMAN) $< 2>&1 > $@ | sed 's/^[^:]*://'; \
fi
%.5: doc/%.sgml
if [ -h $< ]; then \
ln -s $$(basename $$(readlink $<) .sgml).5 $@; \
elif [ "$(DOCBOOKTOMAN)" = "docbook2man" ]; then \
$(DOCBOOKTOMAN) $< > /dev/null 2>&1; \
else \
$(DOCBOOKTOMAN) $< 2>&1 > $@ | sed 's/^[^:]*://'; \
fi
# docbook2man creates extra crap files which need cleaning.
distclean-local: killbuildmanpages
killbuildmanpages:
rm -f doc/*.tmp manpage.refs manpage.links
tarball: $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz
#$(DIST_DIR)/module-init-tools-$(VERSION).tar.gz: dist
# mv module-init-tools-$(VERSION).tar.gz $@
# git based version
$(DIST_DIR)/module-init-tools-$(VERSION).tar.gz:
cd $$(git rev-parse --show-toplevel) && git archive --format=tar --prefix=module-init-tools-$(VERSION)/ v$(VERSION) | (cd $(DIST_DIR) && tar xv)
cd $(DIST_DIR)/module-init-tools-$(VERSION) && aclocal -I m4 && automake --add-missing --copy && autoconf
cd $(DIST_DIR) && tar cvfz module-init-tools-$(VERSION).tar.gz module-init-tools-$(VERSION)
$(DIST_DIR)/.pushed/module-init-tools-$(VERSION).tar.gz:
mkdir -p $(DIST_DIR)/.pushed
ln -s $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz $(DIST_DIR)/.pushed/module-init-tools-$(VERSION).tar.gz
gpg-tarball: $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz.sign
$(DIST_DIR)/.pushed/module-init-tools-$(VERSION).tar.gz.sign:
mkdir -p $(DIST_DIR)/.pushed
ln -s $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz.sign $(DIST_DIR)/.pushed/module-init-tools-$(VERSION).tar.gz.sign
$(DIST_DIR)/module-init-tools-$(VERSION).tar.gz.sign: tarball
cd $(DIST_DIR) && gpg -a -b -s -o module-init-tools-$(VERSION).tar.gz.sign module-init-tools-$(VERSION).tar.gz
srpm: $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz
ln -sf $(DIST_DIR)/module-init-tools-$(VERSION).tar.gz /usr/src/rpm/SOURCES/
set -e; RELEASE=`grep '^Release:' /usr/src/rpm/SPECS/modutils.spec | awk '{ print $$2 }'`; \
if [ "`grep '%define mit_ver' /usr/src/rpm/SPECS/modutils.spec | awk '{print $$3}'`" != $(VERSION) ]; then \
sed -e "s/Release: $$RELEASE/Release: `expr $$RELEASE + 1`/" -e 's/%define mit_ver.*/%define mit_ver $(VERSION)/' < /usr/src/rpm/SPECS/modutils.spec > /tmp/modutils.spec; \
rpm -ba /tmp/modutils.spec; \
mv /usr/src/rpm/SRPMS/modutils-2.4.21-`expr $$RELEASE + 1`.src.rpm $(DIST_DIR); \
mv /tmp/modutils.spec /usr/src/rpm/SPECS/modutils.spec; \
else \
rpm -ba /usr/src/rpm/SPECS/modutils.spec; \
mv /usr/src/rpm/SRPMS/modutils-2.4.21-$$RELEASE.src.rpm $(DIST_DIR); \
fi