aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/aoe
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/aoe')
-rw-r--r--Documentation/aoe/aoe.txt58
-rw-r--r--Documentation/aoe/mkdevs.sh41
-rw-r--r--Documentation/aoe/mkshelf.sh28
-rw-r--r--Documentation/aoe/status.sh3
4 files changed, 41 insertions, 89 deletions
diff --git a/Documentation/aoe/aoe.txt b/Documentation/aoe/aoe.txt
index 5f5aa16047ff..bfc9cb19abcd 100644
--- a/Documentation/aoe/aoe.txt
+++ b/Documentation/aoe/aoe.txt
@@ -1,8 +1,16 @@
1The EtherDrive (R) HOWTO for users of 2.6 kernels is found at ... 1ATA over Ethernet is a network protocol that provides simple access to
2block storage on the LAN.
2 3
3 http://www.coraid.com/SUPPORT/EtherDrive-HBA 4 http://support.coraid.com/documents/AoEr11.txt
4 5
5 It has many tips and hints! 6The EtherDrive (R) HOWTO for 2.6 and 3.x kernels is found at ...
7
8 http://support.coraid.com/support/linux/EtherDrive-2.6-HOWTO.html
9
10It has many tips and hints! Please see, especially, recommended
11tunings for virtual memory:
12
13 http://support.coraid.com/support/linux/EtherDrive-2.6-HOWTO-5.html#ss5.19
6 14
7The aoetools are userland programs that are designed to work with this 15The aoetools are userland programs that are designed to work with this
8driver. The aoetools are on sourceforge. 16driver. The aoetools are on sourceforge.
@@ -23,20 +31,12 @@ CREATING DEVICE NODES
23 There is a udev-install.sh script that shows how to install these 31 There is a udev-install.sh script that shows how to install these
24 rules on your system. 32 rules on your system.
25 33
26 If you are not using udev, two scripts are provided in
27 Documentation/aoe as examples of static device node creation for
28 using the aoe driver.
29
30 rm -rf /dev/etherd
31 sh Documentation/aoe/mkdevs.sh /dev/etherd
32
33 ... or to make just one shelf's worth of block device nodes ...
34
35 sh Documentation/aoe/mkshelf.sh /dev/etherd 0
36
37 There is also an autoload script that shows how to edit 34 There is also an autoload script that shows how to edit
38 /etc/modprobe.d/aoe.conf to ensure that the aoe module is loaded when 35 /etc/modprobe.d/aoe.conf to ensure that the aoe module is loaded when
39 necessary. 36 necessary. Preloading the aoe module is preferable to autoloading,
37 however, because AoE discovery takes a few seconds. It can be
38 confusing when an AoE device is not present the first time the a
39 command is run but appears a second later.
40 40
41USING DEVICE NODES 41USING DEVICE NODES
42 42
@@ -51,9 +51,9 @@ USING DEVICE NODES
51 "echo > /dev/etherd/discover" tells the driver to find out what AoE 51 "echo > /dev/etherd/discover" tells the driver to find out what AoE
52 devices are available. 52 devices are available.
53 53
54 These character devices may disappear and be replaced by sysfs 54 In the future these character devices may disappear and be replaced
55 counterparts. Using the commands in aoetools insulates users from 55 by sysfs counterparts. Using the commands in aoetools insulates
56 these implementation details. 56 users from these implementation details.
57 57
58 The block devices are named like this: 58 The block devices are named like this:
59 59
@@ -76,8 +76,8 @@ USING SYSFS
76 The netif attribute is the network interface on the localhost 76 The netif attribute is the network interface on the localhost
77 through which we are communicating with the remote AoE device. 77 through which we are communicating with the remote AoE device.
78 78
79 There is a script in this directory that formats this information 79 There is a script in this directory that formats this information in
80 in a convenient way. Users with aoetools can use the aoe-stat 80 a convenient way. Users with aoetools should use the aoe-stat
81 command. 81 command.
82 82
83 root@makki root# sh Documentation/aoe/status.sh 83 root@makki root# sh Documentation/aoe/status.sh
@@ -121,3 +121,21 @@ DRIVER OPTIONS
121 usage example for the module parameter. 121 usage example for the module parameter.
122 122
123 modprobe aoe_iflist="eth1 eth3" 123 modprobe aoe_iflist="eth1 eth3"
124
125 The aoe_deadsecs module parameter determines the maximum number of
126 seconds that the driver will wait for an AoE device to provide a
127 response to an AoE command. After aoe_deadsecs seconds have
128 elapsed, the AoE device will be marked as "down".
129
130 The aoe_maxout module parameter has a default of 128. This is the
131 maximum number of unresponded packets that will be sent to an AoE
132 target at one time.
133
134 The aoe_dyndevs module parameter defaults to 1, meaning that the
135 driver will assign a block device minor number to a discovered AoE
136 target based on the order of its discovery. With dynamic minor
137 device numbers in use, a greater range of AoE shelf and slot
138 addresses can be supported. Users with udev will never have to
139 think about minor numbers. Using aoe_dyndevs=0 allows device nodes
140 to be pre-created using a static minor-number scheme with the
141 aoe-mkshelf script in the aoetools.
diff --git a/Documentation/aoe/mkdevs.sh b/Documentation/aoe/mkdevs.sh
deleted file mode 100644
index 44c0ab702432..000000000000
--- a/Documentation/aoe/mkdevs.sh
+++ /dev/null
@@ -1,41 +0,0 @@
1#!/bin/sh
2
3n_shelves=${n_shelves:-10}
4n_partitions=${n_partitions:-16}
5
6if test "$#" != "1"; then
7 echo "Usage: sh `basename $0` {dir}" 1>&2
8 echo " n_partitions=16 sh `basename $0` {dir}" 1>&2
9 exit 1
10fi
11dir=$1
12
13MAJOR=152
14
15echo "Creating AoE devnode files in $dir ..."
16
17set -e
18
19mkdir -p $dir
20
21# (Status info is in sysfs. See status.sh.)
22# rm -f $dir/stat
23# mknod -m 0400 $dir/stat c $MAJOR 1
24rm -f $dir/err
25mknod -m 0400 $dir/err c $MAJOR 2
26rm -f $dir/discover
27mknod -m 0200 $dir/discover c $MAJOR 3
28rm -f $dir/interfaces
29mknod -m 0200 $dir/interfaces c $MAJOR 4
30rm -f $dir/revalidate
31mknod -m 0200 $dir/revalidate c $MAJOR 5
32rm -f $dir/flush
33mknod -m 0200 $dir/flush c $MAJOR 6
34
35export n_partitions
36mkshelf=`echo $0 | sed 's!mkdevs!mkshelf!'`
37i=0
38while test $i -lt $n_shelves; do
39 sh -xc "sh $mkshelf $dir $i"
40 i=`expr $i + 1`
41done
diff --git a/Documentation/aoe/mkshelf.sh b/Documentation/aoe/mkshelf.sh
deleted file mode 100644
index 32615814271c..000000000000
--- a/Documentation/aoe/mkshelf.sh
+++ /dev/null
@@ -1,28 +0,0 @@
1#! /bin/sh
2
3if test "$#" != "2"; then
4 echo "Usage: sh `basename $0` {dir} {shelfaddress}" 1>&2
5 echo " n_partitions=16 sh `basename $0` {dir} {shelfaddress}" 1>&2
6 exit 1
7fi
8n_partitions=${n_partitions:-16}
9dir=$1
10shelf=$2
11nslots=16
12maxslot=`echo $nslots 1 - p | dc`
13MAJOR=152
14
15set -e
16
17minor=`echo $nslots \* $shelf \* $n_partitions | bc`
18endp=`echo $n_partitions - 1 | bc`
19for slot in `seq 0 $maxslot`; do
20 for part in `seq 0 $endp`; do
21 name=e$shelf.$slot
22 test "$part" != "0" && name=${name}p$part
23 rm -f $dir/$name
24 mknod -m 0660 $dir/$name b $MAJOR $minor
25
26 minor=`expr $minor + 1`
27 done
28done
diff --git a/Documentation/aoe/status.sh b/Documentation/aoe/status.sh
index 751f3be514b8..eeec7baae57a 100644
--- a/Documentation/aoe/status.sh
+++ b/Documentation/aoe/status.sh
@@ -1,5 +1,8 @@
1#! /bin/sh 1#! /bin/sh
2# collate and present sysfs information about AoE storage 2# collate and present sysfs information about AoE storage
3#
4# A more complete version of this script is aoe-stat, in the
5# aoetools.
3 6
4set -e 7set -e
5format="%8s\t%8s\t%8s\n" 8format="%8s\t%8s\t%8s\n"