Documentation/networking/decnet.txt

   1                     Linux DECnet Networking Layer Information
   2                    ===========================================
   3
   4 1) Other documentation....
   5
   6    o Project Home Pages
   7        http://www.chygwyn.com/DECnet/                      - Kernel info
   8        http://linux-decnet.sourceforge.net/                - Userland tools
   9        http://www.sourceforge.net/projects/linux-decnet/   - Status page
  10
  11 2) Configuring the kernel
  12
  13 Be sure to turn on the following options:
  14
  15     CONFIG_DECNET (obviously)
  16     CONFIG_PROC_FS (to see what's going on)
  17     CONFIG_SYSCTL (for easy configuration)
  18
  19 if you want to try out router support (not properly debugged yet)
  20 you'll need the following options as well...
  21
  22     CONFIG_DECNET_ROUTER (to be able to add/delete routes)
  23     CONFIG_NETFILTER (will be required for the DECnet routing daemon)
  24
  25     CONFIG_DECNET_ROUTE_FWMARK is optional
  26
  27 Don't turn on SIOCGIFCONF support for DECnet unless you are really sure
  28 that you need it, in general you won't and it can cause ifconfig to
  29 malfunction.
  30
  31 3) Command line options
  32
  33 The kernel command line takes options looking like the following:
  34
  35     decnet=1,2
  36
  37 the two numbers are the node address 1,2 = 1.2 For 2.2.xx kernels
  38 and early 2.3.xx kernels, you must use a comma when specifying the
  39 DECnet address like this. For more recent 2.3.xx kernels, you may
  40 use almost any character except space, although a `.` would be the most
  41 obvious choice :-)
  42
  43 There used to be a third number specifying the node type. This option
  44 has gone away in favour of a per interface node type. This is now set
  45 using /proc/sys/net/decnet/conf/<dev>/forwarding. This file can be
  46 set with a single digit, 0=EndNode, 1=L1 Router and  2=L2 Router.
  47
  48 There are also equivalent options for modules. The node address can
  49 also be set through the /proc/sys/net/decnet/ files, as can other system
  50 parameters.
  51
  52 Currently the only supported devices are ethernet and ip_gre. The
  53 ethernet address of your ethernet card has to be set according to the DECnet
  54 address of the node in order for it to be recognised (and thus appear in
  55 /proc/net/decnet_dev). There is a utility available at the above
  56 FTP sites called dn2ethaddr which can compute the correct ethernet
  57 address to use. The address can be set by ifconfig either before at
  58 at the time the device is brought up. If you are using RedHat you can
  59 add the line:
  60
  61     MACADDR=AA:00:04:00:03:04
  62
  63 or something similar, to /etc/sysconfig/network-scripts/ifcfg-eth0 or
  64 wherever your network card's configuration lives.
  65
  66 You will also need to set /proc/sys/net/decnet/default_device to the
  67 device you want DECnet to route packets out of when no specific route
  68 is available. Usually this will be eth0, for example:
  69
  70     echo -n "eth0" >/proc/sys/net/decnet/default_device
  71
  72 There is a list of what the other files under /proc/sys/net/decnet/ do
  73 on the kernel patch web site (shown above).
  74
  75 4) Run time kernel configuration
  76
  77 This is either done through the sysctl/proc interface (see the kernel web
  78 pages for details on what the various options do) or through the iproute2
  79 package in the same way as IPv4/6 configuration is performed.
  80
  81 Documentation for iproute2 is included with the package, although there is
  82 as yet no specific section on DECnet, most of the features apply to both
  83 IP and DECnet, albeit with DECnet addresses instead of IP addresses and
  84 a reduced functionality.
  85
  86 If you want to configure a DECnet router you'll need the iproute2 package
  87 since its the _only_ way to add and delete routes currently. Eventually
  88 there will be a routing daemon to send and receive routing messages for
  89 each interface and update the kernel routing tables accordingly. The
  90 routing daemon will use netfilter to listen to routing packets, and
  91 rtnetlink to update the kernels routing tables.
  92
  93 The DECnet raw socket layer has been removed since it was there purely
  94 for use by the routing daemon which will now use netfilter (a much cleaner
  95 and more generic solution) instead.
  96
  97 5) How can I tell if its working ?
  98
  99 Here is a quick guide of what to look for in order to know if your DECnet
 100 kernel subsystem is working.
 101
 102    - Is the node address set (see /proc/sys/net/decnet/node_address)
 103    - Is the node of the correct type
 104                              (see /proc/sys/net/decnet/conf/<dev>/forwarding)
 105    - Is the Ethernet MAC address of each Ethernet card set to match
 106      the DECnet address. If in doubt use the dn2ethaddr utility available
 107      at the ftp archive.
 108    - If the previous two steps are satisfied, and the Ethernet card is up,
 109      you should find that it is listed in /proc/net/decnet_dev and also
 110      that it appears as a directory in /proc/sys/net/decnet/conf/. The
 111      loopback device (lo) should also appear and is required to communicate
 112      within a node.
 113    - If you have any DECnet routers on your network, they should appear
 114      in /proc/net/decnet_neigh, otherwise this file will only contain the
 115      entry for the node itself (if it doesn't check to see if lo is up).
 116    - If you want to send to any node which is not listed in the
 117      /proc/net/decnet_neigh file, you'll need to set the default device
 118      to point to an Ethernet card with connection to a router. This is
 119      again done with the /proc/sys/net/decnet/default_device file.
 120    - Try starting a simple server and client, like the dnping/dnmirror
 121      over the loopback interface. With luck they should communicate.
 122      For this step and those after, you'll need the DECnet library
 123      which can be obtained from the above ftp sites as well as the
 124      actual utilities themselves.
 125    - If this seems to work, then try talking to a node on your local
 126      network, and see if you can obtain the same results.
 127    - At this point you are on your own... :-)
 128
 129 6) How to send a bug report
 130
 131 If you've found a bug and want to report it, then there are several things
 132 you can do to help me work out exactly what it is that is wrong. Useful
 133 information (_most_ of which _is_ _essential_) includes:
 134
 135  - What kernel version are you running ?
 136  - What version of the patch are you running ?
 137  - How far though the above set of tests can you get ?
 138  - What is in the /proc/decnet* files and /proc/sys/net/decnet/* files ?
 139  - Which services are you running ?
 140  - Which client caused the problem ?
 141  - How much data was being transferred ?
 142  - Was the network congested ?
 143  - If there was a kernel panic, please run the output through ksymoops
 144    before sending it to me, otherwise its _useless_.
 145  - How can the problem be reproduced ?
 146  - Can you use tcpdump to get a trace ? (N.B. Most (all?) versions of
 147    tcpdump don't understand how to dump DECnet properly, so including
 148    the hex listing of the packet contents is _essential_, usually the -x flag.
 149    You may also need to increase the length grabbed with the -s flag. The
 150    -e flag also provides very useful information (ethernet MAC addresses))
 151
 152 7) Mailing list
 153
 154 If you are keen to get involved in development, or want to ask questions
 155 about configuration, or even just report bugs, then there is a mailing
 156 list that you can join, details are at:
 157
 158 http://sourceforge.net/mail/?group_id=4993
 159
 160 8) Legal Info
 161
 162 The Linux DECnet project team have placed their code under the GPL. The
 163 software is provided "as is" and without warranty express or implied.
 164 DECnet is a trademark of Compaq. This software is not a product of
 165 Compaq. We acknowledge the help of people at Compaq in providing extra
 166 documentation above and beyond what was previously publicly available.
 167
 168 Steve Whitehouse <SteveW@ACM.org>
 169