linux/drivers/staging/batman-adv
Tejun Heo 5a0e3ad6af include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h
percpu.h is included by sched.h and module.h and thus ends up being
included when building most .c files.  percpu.h includes slab.h which
in turn includes gfp.h making everything defined by the two files
universally available and complicating inclusion dependencies.

percpu.h -> slab.h dependency is about to be removed.  Prepare for
this change by updating users of gfp and slab facilities include those
headers directly instead of assuming availability.  As this conversion
needs to touch large number of source files, the following script is
used as the basis of conversion.

  http://userweb.kernel.org/~tj/misc/slabh-sweep.py

The script does the followings.

* Scan files for gfp and slab usages and update includes such that
  only the necessary includes are there.  ie. if only gfp is used,
  gfp.h, if slab is used, slab.h.

* When the script inserts a new include, it looks at the include
  blocks and try to put the new include such that its order conforms
  to its surrounding.  It's put in the include block which contains
  core kernel includes, in the same order that the rest are ordered -
  alphabetical, Christmas tree, rev-Xmas-tree or at the end if there
  doesn't seem to be any matching order.

* If the script can't find a place to put a new include (mostly
  because the file doesn't have fitting include block), it prints out
  an error message indicating which .h file needs to be added to the
  file.

The conversion was done in the following steps.

1. The initial automatic conversion of all .c files updated slightly
   over 4000 files, deleting around 700 includes and adding ~480 gfp.h
   and ~3000 slab.h inclusions.  The script emitted errors for ~400
   files.

2. Each error was manually checked.  Some didn't need the inclusion,
   some needed manual addition while adding it to implementation .h or
   embedding .c file was more appropriate for others.  This step added
   inclusions to around 150 files.

3. The script was run again and the output was compared to the edits
   from #2 to make sure no file was left behind.

4. Several build tests were done and a couple of problems were fixed.
   e.g. lib/decompress_*.c used malloc/free() wrappers around slab
   APIs requiring slab.h to be added manually.

5. The script was run on all .h files but without automatically
   editing them as sprinkling gfp.h and slab.h inclusions around .h
   files could easily lead to inclusion dependency hell.  Most gfp.h
   inclusion directives were ignored as stuff from gfp.h was usually
   wildly available and often used in preprocessor macros.  Each
   slab.h inclusion directive was examined and added manually as
   necessary.

6. percpu.h was updated not to include slab.h.

7. Build test were done on the following configurations and failures
   were fixed.  CONFIG_GCOV_KERNEL was turned off for all tests (as my
   distributed build env didn't work with gcov compiles) and a few
   more options had to be turned off depending on archs to make things
   build (like ipr on powerpc/64 which failed due to missing writeq).

   * x86 and x86_64 UP and SMP allmodconfig and a custom test config.
   * powerpc and powerpc64 SMP allmodconfig
   * sparc and sparc64 SMP allmodconfig
   * ia64 SMP allmodconfig
   * s390 SMP allmodconfig
   * alpha SMP allmodconfig
   * um on x86_64 SMP allmodconfig

8. percpu.h modifications were reverted so that it could be applied as
   a separate patch and serve as bisection point.

Given the fact that I had only a couple of failures from tests on step
6, I'm fairly confident about the coverage of this conversion patch.
If there is a breakage, it's likely to be something in one of the arch
headers which should be easily discoverable easily on most builds of
the specific arch.

Signed-off-by: Tejun Heo <tj@kernel.org>
Guess-its-ok-by: Christoph Lameter <cl@linux-foundation.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Lee Schermerhorn <Lee.Schermerhorn@hp.com>
2010-03-30 22:02:32 +09:00
..
CHANGELOG
Kconfig Staging: batman-adv: depend on NET instead of PACKET in Kconfig 2010-03-03 16:43:02 -08:00
Makefile Staging: batman-adv: Split originator handling parts out of routing.c 2010-03-03 16:42:30 -08:00
README Staging: batman-adv: Update the README for mainline usage. 2010-03-03 16:42:40 -08:00
TODO Staging: batman-adv: Remove compat.h 2010-03-03 16:42:36 -08:00
aggregation.c Staging: batman-adv: receive packets directly using skbs 2010-03-03 16:42:36 -08:00
aggregation.h
bitarray.c Staging: batman-adv: replace internal logging mechanism. 2010-03-03 16:42:29 -08:00
bitarray.h
device.c include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h 2010-03-30 22:02:32 +09:00
device.h
hard-interface.c Staging: batman-adv: fix module initialization 2010-03-03 16:43:03 -08:00
hard-interface.h Staging: batman-adv: receive packets directly using skbs 2010-03-03 16:42:36 -08:00
hash.c Staging: batman-adv: initialize static hash iterators 2010-03-03 16:42:35 -08:00
hash.h Staging: batman-adv: initialize static hash iterators 2010-03-03 16:42:35 -08:00
main.c Staging: batman-adv: atomic variable for vis-srv activation 2010-03-03 16:43:02 -08:00
main.h include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h 2010-03-30 22:02:32 +09:00
originator.c Staging: batman-adv: Remove compat.h 2010-03-03 16:42:36 -08:00
originator.h Staging: batman-adv: Split originator handling parts out of routing.c 2010-03-03 16:42:30 -08:00
packet.h Staging: batman-adv: consistent spelling of "neighbors" 2010-03-03 16:42:35 -08:00
proc.c Staging: batman-adv: fix module initialization 2010-03-03 16:43:03 -08:00
proc.h Staging: batman-adv: splitting /proc vis file into vis_server and vis_data 2010-03-03 16:42:35 -08:00
ring_buffer.c
ring_buffer.h
routing.c Staging: batman-adv: Fix skbuff leak in VIS code. 2010-03-03 16:43:03 -08:00
routing.h Staging: batman-adv: remove obsolete variables 2010-03-03 16:43:02 -08:00
send.c Staging: batman-adv: atomic variable for vis-srv activation 2010-03-03 16:43:02 -08:00
send.h Staging: batman-adv: receive packets directly using skbs 2010-03-03 16:42:36 -08:00
soft-interface.c include cleanup: Update gfp.h and slab.h includes to prepare for breaking implicit slab.h inclusion from percpu.h 2010-03-30 22:02:32 +09:00
soft-interface.h Staging: batman-adv: receive packets directly using skbs 2010-03-03 16:42:36 -08:00
translation-table.c Staging: batman-adv: Remove compat.h 2010-03-03 16:42:36 -08:00
translation-table.h Staging: batman-adv: Allow the MAC address to be set 2010-03-03 16:42:36 -08:00
types.h Staging: batman-adv: receive packets directly using skbs 2010-03-03 16:42:36 -08:00
vis.c Staging: batman-adv: atomic variable for vis-srv activation 2010-03-03 16:43:02 -08:00
vis.h Staging: batman-adv: atomic variable for vis-srv activation 2010-03-03 16:43:02 -08:00

README

[state: 06-01-2010]

BATMAN-ADV
----------

Batman-advanced is a new approach to wireless networking which does no longer
operate on the IP basis. Unlike B.A.T.M.A.N, which exchanges information
using UDP packets and sets routing tables, batman-advanced operates on ISO/OSI
Layer 2 only and uses and routes (or better: bridges) Ethernet Frames. It
emulates a virtual network switch of all nodes participating. Therefore all
nodes appear to be link local, thus all higher operating protocols won't be
affected by any changes within the network. You can run almost any protocol
above B.A.T.M.A.N. Advanced, prominent examples are: IPv4, IPv6, DHCP, IPX.

This is batman-advanced implemented as Linux kernel driver. It does not depend
on any network (other) driver, and can be used on wifi as well as ethernet,
vpn, etc ... (anything with ethernet-style layer 2).

USAGE
-----

insmod the batman-adv.ko in your kernel:

# insmod batman-adv.ko

the module is now waiting for activation. You must add some interfaces
on which batman can operate. Each interface must be added separately:

# echo wlan0 > /proc/net/batman-adv/interfaces

( # echo wlan1 > /proc/net/batman-adv/interfaces )
( # echo eth0 > /proc/net/batman-adv/interfaces )
( ... )

Now batman starts broadcasting on this interface.
You can now view the table of originators (mesh participants) with:

# cat /proc/net/batman-adv/originators

The module will create a new interface "bat0", which can be used as a
regular interface:

# ifconfig bat0 inet 192.168.0.1 up
# ping 192.168.0.2
...

If you want topology visualization, your meshnode must be configured
as VIS-server:

# echo "server" > /proc/net/batman-adv/vis

Each node is either configured as "server" or as "client" (default:
"client"). Clients send their topology data to the server next to them,
and server synchronize with other servers. If there is no server
configured (default) within the mesh, no topology information will be
transmitted. With these "synchronizing servers", there can be 1 or
more vis servers sharing the same (or at least very similar) data.

When configured as server, you can get a topology snapshot of your mesh:

# cat /proc/net/batman-adv/vis

The output is in a generic raw format. Use the batctl tool (See below)
to convert this to other formats more suitable for graphing, eg
graphviz dot, or JSON data-interchange format.

In very mobile scenarios, you might want to adjust the originator
interval to a lower value. This will make the mesh more responsive to
topology changes, but will also increase the overhead. Please make sure
that all nodes in your mesh use the same interval. The default value
is 1000 ms (1 second).

# echo 1000 > /proc/net/batman-adv/orig_interval

To deactivate batman, do:

# echo "" > /proc/net/batman-adv/interfaces

LOGGING/DEBUGGING
-----------------

All error messages, warnings and information messages are sent to the
kernel log. Depending on your operating system distribution this can be
read in one of a number of ways. Try using the commands: dmesg,
logread, or looking in the files /var/log/kern.log or
/var/log/syslog. All batman-adv messages are prefixed with
"batman-adv:" So to see just these messages try

dmesg | grep batman-adv

When investigating problems with your mesh network it is sometimes
necessary to see more detail debug messages. This must be enabled when
compiling the batman-adv module. Use "make menuconfig" and enable the
option "B.A.T.M.A.N. debugging".

The additional debug output is by default disabled. It can be enabled
either at kernel module load time or during run time. To enable debug
output at module load time, add the module parameter debug=<value>.
<value> can take one of four values.

0 - All debug output disabled
1 - Enable messages related to routing / flooding / broadcasting
2 - Enable route or hna added / changed / deleted
3 - Enable all messages

e.g.

modprobe batman-adv debug=2

will load the module and enable debug messages for when routes or HNAs
change.

The debug output can also be changed at runtime using the file
/sys/module/batman-adv/parameters/debug. e.g.

echo 2 > /sys/module/batman-adv/parameters/debug

enables debug messages for when routes or HNAs

The debug output is sent to the kernel logs. So try dmesg, logread etc
to see the debug messages.

BATCTL
------

B.A.T.M.A.N.  advanced operates on layer 2 and thus all hosts
participating in the virtual switch are completely transparent for all
protocols above layer 2. Therefore the common diagnosis tools do not
work as expected. To overcome these problems batctl was created. At
the moment the batctl contains ping, traceroute, tcpdump and
interfaces to the kernel module settings.

For more information, please see the manpage (man batctl).

batctl is available on http://www.open-mesh.net/

CONTACT
-------

Please send us comments, experiences, questions, anything :)

IRC:             #batman on irc.freenode.org
Mailing-list:    b.a.t.m.a.n@open-mesh.net
(subscription at https://list.open-mesh.net/mm/listinfo/b.a.t.m.a.n )

You can also contact the Authors:

Marek Lindner <lindner_marek@yahoo.de>
Simon Wunderlich <siwu@hrz.tu-chemnitz.de>