Add ChangeLog to version control
[blkdevalias.git] / blkdevalias
1 #!/bin/bash
2 #
3 #  blkdevalias - manage aliases and permissions for block devices
4 #
5 #  Bryn M. Reeves <bmr@redhat.com>
6 #
7 #  Copyright (C) Red Hat, Inc. 2012
8 #
9 #  This program is free software; you can redistribute it and/or modify
10 #  it under the terms of the GNU General Public License as published by
11 #  the Free Software Foundation; either version 2 of the License, or
12 #  (at your option) any later version.
13 #
14 #  This program is distributed in the hope that it will be useful,
15 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 #  GNU General Public License for more details.
18 #
19 #  You should have received a copy of the GNU General Public License
20 #  along with this program; if not, write to the Free Software
21 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22 #
23 declare -A WWIDMAP
24 declare -A NAMEMAP
25 declare -A TYPEMAP
26
27 BA_DEBUG=yes
28 BA_DEFAULT_USER="oracle"
29 BA_DEFAULT_GROUP="oracle"
30 BA_CONF_PATH="/etc/blkdevalias"
31 BA_DEV_PATH="oracleasm/disks"
32 BA_MAP_PATH="${BA_CONF_PATH}/map"
33 BA_CONF="${BA_CONF_PATH}/conf"
34 BA_USER="$BA_DEFAULT_USER"
35 BA_GROUP="$BA_DEFAULT_GROUP"
36 BA_LOCK="/var/lock/blkdevalias"
37 BA_SCSI_ID="/sbin/scsi_id"
38 BA_SCSI_ID_FLAGS="-g -u"
39
40 # load config
41 . $BA_CONF
42
43 _error () {
44     echo "ERROR: $@" 1>&2
45 }
46
47 _warn () {
48     echo "WARNING: $@" 1>&2
49 }
50
51 _debug () {
52     [ "$BA_DEBUG" == "yes" ] && echo "$@" 1>&2
53 }
54
55 # debug print
56 print_wwid_mapping() {
57     local WWID=$1
58     if [ "$WWID" == "" ]; then
59         return
60     fi
61     _debug "ALIAS for WWID '$WWID' is: '${WWIDMAP[$WWID]}' (${TYPEMAP[$WWID]})"
62 }
63
64 # store the WWID map to disk
65 ba_store_wwid_map() {
66     TMP_MAP=$(mktemp --tmpdir=$BA_CONF_DIR)
67     if [ ! -f "$TMP_MAP" ]; then
68         _error "could not write temporary file"
69         exit 1
70     fi
71     for WWID in ${!WWIDMAP[@]}; do
72         echo "$WWID ${WWIDMAP[$WWID]} ${TYPEMAP[$WWID]}"
73     done  >> $TMP_MAP
74     mv $TMP_MAP $BA_MAP_PATH
75 }
76
77 # read the WWID map from disk
78 ba_load_wwid_map() {
79     if [ ! -f "$BA_MAP_PATH" ] || [ ! -r "$BA_MAP_PATH"  ]; then
80         _error "$BA_MAP_PATH does not exist or is not readable"
81         exit 1
82     fi
83     while read WWID ALIAS TYPE; do
84         if [[ $WWID == \#* ]] || [[ $WWID == "" ]]; then
85             continue
86         fi
87         WWIDMAP[$WWID]="$ALIAS"
88         NAMEMAP[$ALIAS]="$WWID"
89         TYPEMAP[$WWID]="$TYPE"
90     done < $BA_MAP_PATH
91 }
92
93 # ba_add_wwid_mapping <wwid> <alias> <sd|mpath>
94 ba_add_wwid_mapping() {
95     local WWID
96     WWID="$1"
97     ALIAS="$2"
98     TYPE="$3"
99     _debug "ba_add_wwid_mapping WWID=\"$WWID\" ALIAS=\"$ALIAS\""
100     if [ "$WWID" == "" ]; then
101         _warn "no wwid given"
102         return
103     fi
104     if [ "$ALIAS" == "" ]; then
105         _warn "no alias given"
106         return
107     fi
108     if [ "${NAMEMAP[$WWID]}" != "" ]; then
109         _warn "$WWID already mapped to alias ${NAMEMAP[$WWID]}; replacing it."
110     fi
111     WWIDMAP[$WWID]="$ALIAS"
112     NAMEMAP[$ALIAS]="$WWID"
113     TYPEMAP[$WWID]=${TYPE:-"sd"}
114 }
115
116 # ba_del_wwid_mapping <wwid>
117 ba_del_wwid_mapping() {
118     local WWID ALIAS
119     WWID="$1"
120     if [ "$WWID" == "" ]; then
121         return 1
122     fi
123     if [ "${WWIDMAP[$WWID]}" == "" ]; then
124         _warn "WARNING: $WWID does not exist; doing nothing."
125         return 1
126     fi
127     ALIAS=${WWIDMAP[$WWID]}
128     unset WWIDMAP[$WWID]
129     unset NAMEMAP[$ALIAS]
130     unset TYPEMAP[$WWID]
131 }
132
133 ba_scsi_id () {
134     $BA_SCSI_ID $BA_SCSI_ID_FLAGS $1
135 }
136
137 ba_configure () {
138     cat <<EOF
139 Configuring the blkdevalias map.
140
141 This will configure persistent aliases and permissions for storage
142 devices. The current values will be shown in brackets ('[]'). Hitting
143 <ENTER> without typing an answer will keep the current value.
144
145 Ctrl-C will abort.
146
147 EOF
148
149     echo -n "Default user to own device nodes [$BA_USER]: "
150     read _BA_USER
151     if [ "$_BA_USER" != "" ]; then
152         BA_USER=$_BA_USER;
153     fi
154     echo -n "Default group to own device nodes [$BA_GROUP]: "
155     read _BA_GROUP
156     if [ "$_BA_GROUP" != "" ]; then
157         BA_GROUP=$_BA_GROUP;
158     fi
159     echo -n "Default device directory [$BA_DEV_PATH]: "
160     read _BA_DEV_PATH
161     if [ "$_BA_DEV_PATH" != "" ]; then
162         BA_DEV_PATH=$_BA_DEV_PATH;
163     fi
164     _debug "BA_DEV_PATH=\"$BA_DEV_PATH\""
165     _debug "BA_USER=\"$BA_USER\""
166     _debug "BA_GROUP=\"$BA_GROUP\""
167     echo -n "Writing wwid map configuration: "
168     TMP_CONF=$(mktemp --tmpdir=$BA_CONF_PATH)
169     if [ ! -f "$TMP_CONF" ]; then
170         echo
171         _error "could not write temporary file"
172         exit 1
173     fi
174     echo "BA_DEV_PATH=\"$BA_DEV_PATH\"" >> $TMP_CONF
175     echo "BA_USER=\"$BA_USER\"" >> $TMP_CONF
176     echo "BA_GROUP=\"$BA_GROUP\"" >> $TMP_CONF
177     mv $TMP_CONF $BA_CONF
178     if [ "$?" != 0 ]; then
179         _error "could not create configuration file $BA_CONF"
180         exit
181     fi
182     echo -e "done\n"
183 }
184
185 # createdisk <alias> <device>
186 ba_createdisk () {
187     local WWID DEV ALIAS
188     ALIAS="$1"
189     DEV="$2"
190     if [ "$DEV" == "" ] || [ "$ALIAS" == "" ]; then
191         echo "Usage: $0 createdisk <alias> <device>"
192         exit 2
193     fi
194     _debug "ba_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
195
196     WWID=$(ba_scsi_id $DEV)
197     if [ "$WWID" == "" ]; then
198         _error "could not get SCSI ID for $DEV"
199         exit 1
200     fi
201     if [[ $DEV == *mpath* ]]; then
202         TYPE=mpath
203         _debug "wm_createdisk: WWID=\"$WWID\" DEV=\"$DEV\" ALIAS=\"$ALIAS\""
204     else
205         TYPE=sd
206     fi
207  
208     ba_add_wwid_mapping $WWID $ALIAS $TYPE
209     ba_store_wwid_map
210 }
211
212 ba_deletedisk () {
213     local WWID ALIAS
214     ALIAS=$1
215     if [ "$ALIAS" == "" ]; then
216         echo "Usage: $0 deletedisk <alias>"
217         exit 2
218     fi
219     WWID=${NAMEMAP[$ALIAS]}
220     if [ "$WWID" == "" ]; then
221         _error "\"$ALIAS\" does not exist"
222         echo "Usage: $0 deletedisk <alias>"
223         exit 2
224     fi
225     echo -n "Removing wwid map disk \"$ALIAS\":"
226     ba_del_wwid_mapping $WWID \
227     && echo "                                  [  OK  ]"
228     ba_store_wwid_map
229 }
230
231 ba_list_disks () {
232     for D in ${WWIDMAP[@]}; do
233         echo $D
234     done | sort -V
235 }
236
237 ba_querydisk () {
238     local LISTDEV ONDEV WWID ALIAS
239     if [ "$1" == "-d" ]; then
240         LISTDEV=1
241         shift
242     fi
243     ALIAS=$1
244     if [ "$ALIAS" == "" ]; then
245         echo "Usage: $0 querydisk <alias>"
246         exit 2
247     fi
248     WWID=${NAMEMAP[$ALIAS]}
249     _debug "ba_querydisk: ALIAS=\"$ALIAS\" WWID=\"$WWID\" LISTDEV=\"$LISTDEV\""
250     if [ "$LISTDEV" == "1" ]; then
251         DEV="/dev/$BA_DEV_PATH/$(readlink "/dev/$BA_DEV_PATH/$ALIAS")"
252         MAJ="$[0x$(stat --format "%t" $DEV)]"
253         MIN="$[0x$(stat --format "%T" $DEV)]"
254         ONDEV="on device [$MAJ,$MIN]"
255         _debug "ba_querydisk: DEV=\"$DEV\" MAJ=\"$MAJ\" MIN=\"$MIN\""
256     fi
257     if [ "$WWID" != "" ]; then
258         echo "$ALIAS is a valid blkdevalias disk $ONDEV"
259         return
260     fi
261     exit 1
262 }
263
264 ba_scandisks () {
265     _warn "(unimplemented)"
266 }
267
268 ba_map () {
269     local WWID
270     WWID="$1"
271     if [ "$WWID" == "" ] || [ "${WWIDMAP[$WWID]}" == "" ]; then
272         echo "Usage: $0 map <wwid>" 1>&2
273         exit 2
274     fi
275     echo "BA_WWID=$WWID"
276     echo "BA_NAME=$BA_DEV_PATH/${WWIDMAP[$WWID]}"
277     echo "BA_TYPE=${TYPEMAP[$WWID]}"
278     echo "BA_USER=$BA_USER"
279     echo "BA_GROUP=$BA_GROUP"
280 }
281
282 # no point optimizing this out for configure
283 ba_load_wwid_map
284 case "$1" in
285     configure)
286         ba_configure
287         ;;
288     create*)
289         ba_createdisk $2 $3
290         ;;
291     delete*)
292         ba_deletedisk $2
293         ;;
294     list*)
295         ba_list_disks
296         ;;
297     query*)
298         ba_querydisks $2 $3
299         ;;
300     scan*)
301         ba_scandisks
302         ;;
303     map)
304         ba_map $2
305         ;;
306     *)
307         echo -n "Usage: $0 "
308         echo "{configure|createdisk|deletedisk|scandisks|querydisk|map}"
309         exit 2
310 esac
311