8 # Contributed by Eric DOUTRELEAU <Eric.Doutreleau@int-evry.fr>
9 # This is supposed to work with Zubkoff/Dandelion version of mtx
11 # Modified by Joe Rhett <jrhett@isite.net>
12 # to work with MTX 1.2.9 by Eric Lee Green http://mtx.sourceforge.net
14 # Modified by Jason Hollinden <jhollind@sammg.com> on 13-Feb-2001
15 # to work with MTX 1.2.10, >9 slots, has barcode support, and works with
16 # multiple configs at once.
17 # NOTE: Only tested the 2 additions with an ADIC Scalar 100.
19 ################################################################################
20 # Here are the things you need to do and know to configure this script:
22 # * Figure out what the robot device name is and what the tape drive
23 # device name is. They will be different!
25 # You cannot send robot commands to a tape drive and vice versa.
26 # Both should respond to "mtx -f /dev/... inquiry". Hopefully,
27 # that output will make it obvious which is which.
29 # For instance, here is what mtx has to say about my current robot:
31 # Product Type: Medium Changer
33 # Product ID: 'ACL2640 206 '
35 # Attached Changer: No
37 # and here is what it says about a tape drive:
39 # Product Type: Tape Drive
40 # Vendor ID: 'Quantum '
41 # Product ID: 'DLT4000 '
43 # Attached Changer: No
45 # Note the "Product Type" value makes it clear which is which.
47 # If it is not obvious, "mf -f /dev/... rewind" should be happy when
48 # talking to a (loaded) tape drive but the changer should give some
49 # kind of error. Similarly, "mtx -f /dev/... status" should show good
50 # results with the changer but fail with a tape drive device name.
52 # Once you have this figured out, set "changerdev" in amanda.conf
53 # to the changer device and "tapedev" to the tape device.
55 # * Find out what the first and last storage slots are. Running
56 # "mtx -f /dev/... status" should give you something like this
57 # (although the output will vary widely based on the version of mtx
58 # and the specifics of your robot):
60 # Storage Changer /dev/changer:1 Drives, 9 Slots ( 0 Import/Export )
61 # Data Transfer Element 0:Empty
62 # Storage Element 1:Full :VolumeTag=SR0001
63 # Storage Element 2:Full :VolumeTag=SR0002
64 # Storage Element 3:Full :VolumeTag=SR0003
65 # Storage Element 4:Full :VolumeTag=SR0004
66 # Storage Element 5:Full :VolumeTag=SR0005
67 # Storage Element 6:Full :VolumeTag=SR0006
68 # Storage Element 7:Full :VolumeTag=SR0007
69 # Storage Element 8:Full :VolumeTag=SR0008
70 # Storage Element 9:Full :VolumeTag=SR0009
71 # Storage Element 10 IMPORT/EXPORT:Full :VolumeTag=SR0009
73 # This says the first storage slot (element) is "1" and the last
74 # is "9". If you allocate the entire robot to Amanda, you do not need
75 # to set the "firstslot" or "lastslot" configuration file variables --
76 # the script will compute these values for you.
78 # You do not have to allocate all of the slots for Amanda use,
79 # but whatever slots you use must be contiguous (i.e. 4 through 9
80 # in the above would be OK but 1, 2, 5, 6, 9 would not). The one
81 # exception to this is that if one of the slots contains a cleaning
82 # cartridge, it may be in any slot (Amanda will just skip over it if
83 # it is between firstslot and lastslot).
85 # * Speaking of cleaning cartridges, if you have a storage slot dedicated
86 # to one, figure out what slot it is in. That slot number will go in
87 # the "cleanslot" variable.
89 # Also, decide if you want the changer script to automatically run
90 # the cleaning tape through the drive after every so many mounts,
91 # and how many mounts you want to do between cleanings. If you
92 # want the script to do this, set the "autoclean" variable to 1 and
93 # the "autocleancount" to the number of mounts between cleanings.
94 # If you do not want to do automatic cleanings (including not having
95 # a cleaning cartridge in the robot), set "autoclean" to 0.
97 # Note that only a count of mounts is used to determine when it is
98 # time to clean. The script does not try to detect if the drive is
99 # requesting cleaning, or how much the drive was used on a given
102 # * If you tell Amanda about a cleaning cartridge, whether for automatic
103 # operation or manual (amtape <config> clean), you must also tell
104 # the script how long it takes to run the cleaning cycle. It is
105 # impossible for the script to determine when the cleaning operation
106 # is done, so the "cleancycle" variable is the number of seconds
107 # the longest cleaning operation takes (you'll just have to figure
108 # this out by watching it a few times, or maybe finding it in a tape
109 # drive hardware manual). The script will sleep for this length of
110 # time whenever the cleaning tape is referenced. The default is 120
111 # seconds (two minutes).
113 # * Figure out the drive slot number. By default, it is set to 0.
114 # In the example above, the tape drive ("Data Transfer Element")
115 # is in slot 0. If your drive slot is not 0, you
116 # need to set the drive slot number with the "driveslot" variable.
118 # * Figure out whether your robot has a barcode reader and whether
119 # your version of mtx supports it. If you see "VolumeTag" entries
120 # in the "mtx -f /dev/xxx status" output you did above, you have
121 # a reader and mtx can work with it, so you may set the "havereader"
122 # variable to 1. The default is 0 (do not use a reader).
124 # * Pick any tape to load and then determine if the robot can put it
125 # away directly or whether an "offline" must be done first.
127 # With the tape still mounted and ready, try to put the tape away
128 # with "mtx". If you get some kind of error, which is the most
129 # common response, try "mt -f /dev/... offline", wait for the drive
130 # to unload and make sure the robot takes no action on its own to
131 # store the tape. Assuming it does not, try the "mtx" command again
134 # If you had to issue the "mt -f /dev/... offline" before you could
135 # use "mtx" to store the tape, set the "offline_before_unload"
136 # variable to 1. If "mtx" unloaded the drive and put the tape away
137 # all by itself, set it to 0.
139 # * Some drives and robots require a small delay between unloading the
140 # tape and instructing the robot to move it back to storage.
141 # For instance, if you try to grab the tape too soon on an ATL robot
142 # with DLT tape drives, it will rip the leader out of the drive and
143 # require sincerely painful hardware maintenance.
145 # If you need a little delay, set the "unloadpause" variable to
146 # the number of seconds to wait before trying to take a tape from
147 # a drive back to storage. The default is 0.
149 # * Some drives also require a short pause after loading, or the drive
150 # will return an I/O error during a test to see if it's online (which
151 # this script uses "mt rewind" to test). My drives don't recover from
152 # this, and must be reloaded before they will come online after failing
153 # such a test. For this reason there is an "initial_poll_delay"
154 # variable which will pause for a certain number of seconds before
155 # looping through the online test for the first time. The default is 0.
159 # Now you are ready to set up the variables in the changer configuration
162 # All variables are in "changerfile".conf where "changerfile" is set
163 # in amanda.conf. For example, if amanda.conf has:
165 # changerfile="/etc/amanda/Dailyset1/CHANGER"
166 # or changerfile="/etc/amanda/Dailyset1/CHANGER.conf"
168 # the variables must be in "/etc/amanda/Dailyset1/CHANGER.conf".
169 # The ".conf" is appended only if it's not there".
171 # If "changerfile" is a relative path, it is relative to the directory
172 # that contains amanda.conf. That also happens to be the directory Amanda
173 # makes current before running this script.
175 # Here is a commented out example file with all the variables and showing
176 # their default value (if any):
178 # firstslot=? #### First storage slot (element) -- required
179 # lastslot=? #### Last storage slot (element) -- required
180 # cleanslot=-1 #### Slot with cleaner tape -- default is "-1"
181 # #### Set negative to indicate no cleaner available
182 # driveslot=0 #### Drive slot number. Defaults to 0
183 # #### Use the 'Data Transfer Element' you want
185 # # Do you want to clean the drive after a certain number of accesses?
186 # # NOTE - This is unreliable, since 'accesses' aren't 'uses', and we
187 # # have no reliable way to count this. A single amcheck could
188 # # generate as many accesses as slots you have, plus 1.
189 # # ALSO NOTE - many modern tape loaders handle this automatically.
191 # autoclean=0 #### Set to '1' or greater to enable
193 # autocleancount=99 #### Number of access before a clean.
195 # havereader=0 #### If you have a barcode reader, set to 1.
197 # offline_before_unload=0 #### Does your robot require an
198 # #### 'mt offline' before mtx unload?
200 # poll_drive_ready=NN #### Time (seconds) between tests to see if
201 # #### the tape drive has gone ready (default: 3).
203 # max_drive_wait=NN #### Maximum time (seconds) to wait for the
204 # #### tape drive to become ready (default: 120).
206 # initial_poll_delay=NN #### initial delay after load before polling for
211 # Now it is time to test the setup. Do all of the following in the
212 # directory that contains the amanda.conf file, and do all of it as
217 # .../chg-zd-mtx -info
218 # echo $? #### (or "echo $status" if you use csh/tcsh)
220 # You should get a single line from the script like this (the actual
221 # numbers will vary):
225 # The first number (5) is the "current" slot. This may or may not be
226 # the slot actually loaded at the moment (if any). It is the slot
227 # Amanda will try to use next.
229 # The second number (9) is the number of slots.
231 # The third number will always be "1" and indicates the changer is
232 # capable of going backward.
234 # The fourth number is optional. If you set $havereader to 1, it
235 # will be "1", otherwise it will not be present.
237 # The exit code ($? or $status) should be zero.
241 # .../chg-zd-mtx -reset
244 # The script should output a line like this:
248 # The number at the first should match $firstslot. The device name
249 # after that should be your tape device.
251 # The exit code ($? or $status) should be zero.
255 # .../chg-zd-mtx -slot next
258 # The script should output a line like this:
262 # The number at the first should be one higher than $firstslot.
263 # The device name after that should be your tape device.
265 # The exit code ($? or $status) should be zero.
269 # .../chg-zd-mtx -slot current
272 # Assuming the tape is still loaded from the previous test, the
273 # robot should not move and the script should report the same thing
274 # the previous command did.
276 # * If you continue to run "-slot next" commands, the robot should load
277 # each tape in turn then wrap back around to the first when it
278 # reaches $lasttape. If $cleanslot is within the $firstslot to
279 # $lastslot range, the script will skip over that entry.
281 # * Finally, try some of the amtape commands and make sure they work:
283 # amtape <config> reset
284 # amtape <config> slot next
285 # amtape <config> slot current
287 # * If you set $havereader non-zero, now would be a good time to create
288 # the initial barcode database:
290 # amtape <config> update
293 ################################################################################
294 # To debug this script, first look in @AMANDA_DBGDIR@. The script
295 # uses one of two log files there, depending on what version of Amanda
296 # is calling it. It may be chg-zd-mtx.YYYYMMDD*.debug, or it may be
297 # changer.debug.driveN where 'N' is the drive number.
299 # If the log file does not help, try running the script, **as the Amanda
300 # user**, in the amanda.conf directory with whatever set of args the log
301 # said were used when you had a problem. If nothing else useful shows up
302 # in the output, try running the script with the DEBUG environment variable
303 # set non-null, e.g.:
305 # env DEBUG=yes .../chg-zd-mtx ...
306 ################################################################################
308 ################################################################################
309 # You may need to customize these things
310 ################################################################################
316 ################################################################################
317 # No user-level customization should be required beyond this point.
318 ################################################################################
320 test -n "$DEBUG" && set -x
321 TMPDIR="@AMANDA_TMPDIR@"
322 DBGDIR="@AMANDA_DBGDIR@"
325 myname=`expr "$argv0" : '.*/\(.*\)'`
327 config=`pwd 2>/dev/null`
328 config=`expr "$config" : '.*/\(.*\)'`
331 # Functions to write a new log file entry and append more log information.
334 ds=`date '+%H:%M:%S' 2>/dev/null`
335 if [ $? -eq 0 -a -n "$ds" ]; then
336 logprefix=`echo "$ds" | sed 's/./ /g'`
342 if [ -z "$logprefix" ]; then
343 echo "$@" >> $DBGFILE
345 echo "$logprefix" "$@" >> $DBGFILE
350 if [ -z "$logprefix" ]; then
351 echo "===" "`date`" "===" >> $DBGFILE
352 echo "$@" >> $DBGFILE
354 ds=`date '+%H:%M:%S' 2>/dev/null`
355 echo "$ds" "$@" >> $DBGFILE
360 # Common exit function.
364 # $3 = additional information (error message, tape devive, etc)
369 if [ $internal_call -gt 0 ]; then
379 Log $call_type "($code)" "->" "$exit_slot" "$@"
380 echo "$exit_slot" "$@"
381 if [ $call_type = Return ]; then
384 amgetconf$SUF dbclose.$argv0:$DBGFILE > /dev/null 2>&1
389 # Function to run another command and log it.
394 rm -f $stdout $stderr
395 "$@" > $stdout 2> $stderr
397 Log Exit code: $exitcode
401 cat $stdout >> $DBGFILE
406 cat $stderr >> $DBGFILE
414 # Return success if the arg is numeric.
418 test -z "$1" && return 1
419 x="`expr "$1" : '\([-0-9][0-9]*\)' 2>/dev/null`"
420 return `expr X"$1" != X"$x"`
424 # Run $MTX status unless the previous output is still valid.
429 test -n "$DEBUG" && set -x
430 if [ $mtx_status_valid -ne 0 ]; then
434 Run $MTX status > $mtx_status 2>&1
436 if [ $status -eq 0 ]; then
443 # Determine the slot currently loaded. Set $loadedslot to the slot
444 # currently loaded, or "-1", and $loadedbarcode to the corresponding
445 # barcode (or nothing).
449 test -n "$DEBUG" && set -x
453 /^Data Transfer Element:Empty/ {
457 /^Data Transfer Element '$driveslot':Empty/ {
461 /^Data Transfer Element:Full (Storage Element \([0-9][0-9]*\) Loaded):VolumeTag *= *\([^ ]*\)/ {
462 s/.*(Storage Element \([0-9][0-9]*\) Loaded):VolumeTag *= *\([^ ]*\)/\1 \2/p
465 /^Data Transfer Element '$driveslot':Full (Storage Element \([0-9][0-9]*\) Loaded):VolumeTag *= *\([^ ]*\)/ {
466 s/.*(Storage Element \([0-9][0-9]*\) Loaded):VolumeTag *= *\([^ ]*\)/\1 \2/p
469 /^Data Transfer Element '$driveslot':Full (Unknown Storage Element Loaded):VolumeTag *= *\([^ ]*\)/ {
470 s/.*:VolumeTag *= *\([^ ]*\)/-2 \1/p
473 /^Data Transfer Element:Full (Storage Element \([0-9][0-9]*\) Loaded)/ {
474 s/.*(Storage Element \([0-9][0-9]*\) Loaded).*/\1/p
477 /^Data Transfer Element '$driveslot':Full (Storage Element \([0-9][0-9]*\) Loaded)/ {
478 s/.*Storage Element \([0-9][0-9]*\) Loaded.*/\1/p
481 /^Data Transfer Element '$driveslot':Full (Unknown Storage Element Loaded)/ {
485 ' < $mtx_status 2>&1`
486 shift # get rid of the "x"
489 if [ -z "$loadedslot" ]; then
490 Exit 2 "<none>" "could not determine current slot, are you sure your drive slot is $driveslot"
491 return $? # in case we are internal
494 #Use the current slot if it's empty and we don't know which slot is loaded'
495 if [ $loadedslot -eq -2 ]; then
498 /^.*Storage Element '$currentslot':Empty/ {
499 s/.*Storage Element \([0-9][0-9]*\):Empty/\1/p
502 /^.*Storage Element '$currentslot':Full/ {
503 s/.*Storage Element \([0-9][0-9]*\):Full/-2/p
506 /^.*Storage Element '$currentslot' IMPORT\/EXPORT:Empty/ {
507 s/.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Empty/\1/p
510 /^.*Storage Element '$currentslot' IMPORT\/EXPORT:Full/ {
511 s/.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Full/-2/p
515 ' < $mtx_status 2>& 1`
516 shift # get rid of the "x"
518 if [ ! -z $loadedslotx ]; then
519 loadedslot=$loadedslotx
523 #Use the first empty slot if we don't know which slot is loaded'
524 if [ $loadedslot -eq -2 ]; then
527 /^.*Storage Element \([0-9][0-9]*\):Empty/ {
528 s/.*Storage Element \([0-9][0-9]*\):Empty/\1/p
531 /^.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Empty/ {
532 s/.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Empty/\1/p
536 ' < $mtx_status 2>& 1`
537 shift # get rid of the "x"
541 if IsNumeric "$loadedslot" ; then
546 "currently loaded slot ($loadedslot) not numeric"
547 return $? # in case we are internal
549 Log "STATUS -> currently loaded slot = $loadedslot"
550 LogAppend " -> currently loaded barcode = \"$loadedbarcode\""
554 # Get a list of slots between $firstslot and $lastslot, if they are set.
555 # If they are not set, set them to the first and last slot seen on the
556 # assumption the entire robot is to be used (???).
561 test -n "$DEBUG" && set -x
562 if [ -n "$slot_list" ]; then
567 /^Data Transfer Element:Full (Storage Element \([0-9][0-9]*\) Loaded)/ {
568 s/.*(Storage Element \([0-9][0-9]*\) Loaded).*/\1/p
570 /^Data Transfer Element '$driveslot':Full (Storage Element \([0-9][0-9]*\) Loaded)/ {
571 s/.*Storage Element \([0-9][0-9]*\) Loaded.*/\1/p
573 /^Data Transfer Element '$driveslot':Full (Unknown Storage Element Loaded)/ {
576 /^.*Storage Element \([0-9][0-9]*\):Full/ {
577 s/.*Storage Element \([0-9][0-9]*\):Full.*/\1/p
580 /^.*Storage Element \([0-9][0-9]*\):Empty/ {
581 s/.*Storage Element \([0-9][0-9]*\):Empty/\1/p
584 /^.*Storage Element \([0-9][0-9]*\):Full/ {
585 s/.*Storage Element \([0-9][0-9]*\):Full.*/\1/p
587 /^.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Full/ {
588 s/.*Storage Element \([0-9][0-9]*\) IMPORT\/EXPORT:Full.*/\1/p
590 ' < $mtx_status 2>&1 | grep -v "^${cleanslot}\$" | sort -n`
591 slot_list=`echo $slot_list` # remove the newlines
592 if [ $firstslot -lt 0 -o $lastslot -lt 0 ]; then
594 for slot in $slot_list; do
595 if [ $firstslot -lt 0 ]; then
596 Log "SLOTLIST -> firstslot set to $slot"
599 if [ $lastslot -lt 0 ]; then
603 if [ $lastslot -lt 0 -a $last -ge 0 ]; then
604 Log "SLOTLIST -> lastslot set to $last"
607 if [ $firstslot -lt 0 ]; then
610 "cannot determine first slot"
611 return $? # in case we are internal
612 elif [ $lastslot -lt 0 ]; then
615 "cannot determine last slot"
616 return $? # in case we are internal
620 for slot in $slot_list; do
621 if [ $slot -ge $firstslot -a $slot -le $lastslot ]; then
622 amanda_slot_list="$amanda_slot_list $slot"
625 if [ -z "$amanda_slot_list" ]; then
629 return $? # in case we are internal
631 slot_list="$amanda_slot_list"
636 exec_prefix=@exec_prefix@
638 libexecdir=@libexecdir@
640 # try to hit all the possibilities here
641 PATH=$sbindir:$libexecdir:/usr/bin:/bin:/usr/sbin:/sbin:/usr/ucb:/usr/local/bin
644 USE_VERSION_SUFFIXES="@USE_VERSION_SUFFIXES@"
645 if test "$USE_VERSION_SUFFIXES" = "yes"; then
651 DBGFILE=`amgetconf$SUF dbopen.$argv0 2>/dev/null`
654 DBGFILE=/dev/null # will try this again below
657 changerfile=`amgetconf$SUF changerfile 2>/dev/null`
658 if [ -z "$changerfile" ]; then
661 "changerfile must be specified in amanda.conf"
664 tape=`amgetconf$SUF tapedev 2>/dev/null`
665 if [ -z "$tape" ]; then
668 "tapedev may not be empty"
669 elif [ $tape = "/dev/null" -o `expr "$tape" : 'null:'` -eq 5 ]; then
672 "tapedev ($tape) may not be the null device"
674 TAPE=`amgetconf$SUF changerdev 2>/dev/null`
675 if [ -z "$TAPE" ]; then
678 "changerdev may not be empty"
679 elif [ $TAPE = "/dev/null" ]; then
682 "changerdev ($TAPE) may not be the null device"
684 export TAPE # for mtx command
687 export CHANGER # for mtx command
689 #### Set up the various config files.
691 conf_match=`expr "$changerfile" : .\*\.conf\$`
692 if [ $conf_match -ge 6 ]; then
693 configfile=$changerfile
694 changerfile=`echo $changerfile | sed 's/.conf$//g'`
696 configfile=$changerfile.conf
699 cleanfile=$changerfile-clean
700 accessfile=$changerfile-access
701 slotfile=$changerfile-slot
702 labelfile=$changerfile-barcodes
703 [ ! -s $cleanfile ] && echo 0 > $cleanfile
704 [ ! -s $accessfile ] && echo 0 > $accessfile
705 [ ! -s $slotfile ] && echo -1 > $slotfile
706 [ ! -f $labelfile ] && > $labelfile
707 cleancount=`cat $cleanfile`
708 accesscount=`cat $accessfile`
710 test -z "$MT" && Exit 2 "<none>" "No mt command defined"
711 test ! -f "$MT" && Exit 2 "<none>" "mt command ($MT) doesn't exist"
712 test -z "$MTX" && Exit 2 "<none>" "No mtx command defined"
713 test ! -f "$MTX" && Exit 2 "<none>" "mtx command ($MTX) doesn't exist"
715 #### Dig out of the config file what is needed
718 varlist="$varlist firstslot"
719 varlist="$varlist lastslot"
720 varlist="$varlist cleanslot"
721 varlist="$varlist cleancycle"
722 varlist="$varlist OFFLINE_BEFORE_UNLOAD" # old name
723 varlist="$varlist offline_before_unload"
724 varlist="$varlist unloadpause"
725 varlist="$varlist AUTOCLEAN" # old name
726 varlist="$varlist autoclean"
727 varlist="$varlist autocleancount"
728 varlist="$varlist havereader"
729 varlist="$varlist driveslot"
730 varlist="$varlist poll_drive_ready"
731 varlist="$varlist initial_poll_delay"
732 varlist="$varlist max_drive_wait"
736 val="`cat $configfile 2>/dev/null | sed -n '
737 # Ignore comment lines (anything starting with a #).
739 # Find the first var=val line in the file, print the value and quit.
740 /^[ ]*'$var'[ ]*=[ ]*\([^ ][^ ]*\).*/ {
741 s/^[ ]*'$var'[ ]*=[ ]*\([^ ][^ ]*\).*/\1/p
748 # Deal with driveslot first so we can get DBGFILE set if we are still
749 # using the old amgetconf.
751 if [ -z "$driveslot" ]; then
755 # Get DBGFILE set if it is not already.
757 if [ $DBGFILE = /dev/null ]; then
758 if [ -d "$DBGDIR" ]; then
759 DBGFILE=$DBGDIR/changer.debug.drive$driveslot
763 Log === Start "`date`" ===
765 if [ -z "$driveslot" ]; then
768 "cannot determine drive slot from $tape"
771 stdout=$TMPDIR/$myname.1.$$
772 stderr=$TMPDIR/$myname.2.$$
773 mtx_status=$TMPDIR/$myname.status.$$
774 trap "rm -f $stdout $stderr $mtx_status" 0 # exit cleanup
776 Log "Using config file $configfile"
778 # Log the argument list.
783 LogAppend "\$$i = \"$argv0\""
786 LogAppend "\$$i = \"$arg\""
789 # Set the default config values for those not in the file. Log the
790 # results and make sure each is valid (numeric).
792 firstslot=${firstslot:-'-1'} # default: mtx status
793 lastslot=${lastslot:-'-1'} # default: mtx status
794 cleanslot=${cleanslot:-'-1'} # default: -1
795 cleancycle=${cleancycle:-'120'} # default: two minutes
796 if [ -z "$offline_before_unload" -a -n "$OFFLINE_BEFORE_UNLOAD" ]; then
797 offline_before_unload=$OFFLINE_BEFORE_UNLOAD # (old name)
799 offline_before_unload=${offline_before_unload:-'0'} # default: 0
800 unloadpause=${unloadpause:-'0'} # default: 0
801 if [ -z "$autoclean" -a -n "$AUTOCLEAN" ]; then
802 autoclean=$AUTOCLEAN # (old name)
804 autoclean=${autoclean:-'0'} # default: 0
805 autocleancount=${autocleancount:-'99'} # default: 99
806 havereader=${havereader:-'0'} # default: 0
807 poll_drive_ready=${poll_drive_ready:-'3'} # default: three seconds
808 initial_poll_delay=${initial_poll_delay:-'0'} # default: zero zeconds
809 max_drive_wait=${max_drive_wait:-'120'} # default: two minutes
814 for var in $varlist; do
815 if [ $var = "OFFLINE_BEFORE_UNLOAD" ]; then
817 elif [ $var = "AUTOCLEAN" ]; then
821 if [ -z "$val" ]; then
824 "$var missing in $configfile"
826 if IsNumeric "$val" ; then
831 "$var ($val) not numeric in $configfile"
833 LogAppend $var = \"$val\"
836 # Run the rest of the config file sanity checks.
838 if [ $firstslot -gt $lastslot ]; then
841 "firstslot ($firstslot) greater than" \
842 "lastslot ($lastslot) in $configfile"
844 if [ $autoclean -ne 0 -a $cleanslot -lt 0 ]; then
847 "autoclean set but cleanslot not valid ($cleanslot)"
850 # Set up the current slot
852 currentslot=`cat $slotfile`
853 if IsNumeric "$currentslot" ; then
854 if [ $currentslot -lt $firstslot ]; then
855 Log "SETUP -> current slot $currentslot" \
856 "less than $firstslot ..." \
857 "resetting to $firstslot"
858 currentslot=$firstslot
859 elif [ $currentslot -gt $lastslot ]; then
860 Log "SETUP -> current slot $currentslot" \
861 "greater than $lastslot ..." \
862 "resetting to $lastslot"
863 currentslot=$lastslot
866 Log "SETUP -> contents of $slotfile ($currentslot) invalid," \
867 "setting current slot to first slot ($firstslot)"
868 currentslot=$firstslot
872 first_slot_in_list=-1
873 next_slot_after_current=-1
874 for slot in $slot_list; do
875 if [ $first_slot_in_list -lt 0 ]; then
876 first_slot_in_list=$slot # in case $firstslot is missing
878 if [ $slot -eq $currentslot ]; then
881 elif [ $slot -gt $currentslot ]; then
882 next_slot_after_current=$slot # $currentslot is missing
886 if [ $found_current -eq 0 ]; then
887 if [ $next_slot_after_current -lt 0 ]; then
888 new_currentslot=$first_slot_in_list
890 new_currentslot=$next_slot_after_current
892 Log "WARNING -> current slot $currentslot not available," \
893 "setting current slot to next slot ($new_currentslot)"
894 currentslot=$new_currentslot
900 # Eject the current tape and put it away.
904 test -n "$DEBUG" && set -x
905 Log "EJECT -> ejecting tape from $tape"
907 if [ $loadedslot -gt 0 ]; then
908 Log "EJECT -> moving tape from drive $driveslot" \
909 "to storage slot $loadedslot"
910 if [ $offline_before_unload -ne 0 ]; then
911 Run $MT $MTF $tape offline > /dev/null 2>&1
914 result=`Run $MTX unload $loadedslot $driveslot 2>&1`
916 Log " -> status $status, result \"$result\""
918 if [ $status -ne 0 ]; then
926 answer="Drive was not loaded"
929 Exit $code "$loadedslot" "$answer"
930 return $? # in case we are internal
934 # Reset the robot back to the first slot.
938 test -n "$DEBUG" && set -x
939 Log "RESET -> loading tape from slot $firstslot" \
940 "to drive $driveslot ($tape)"
941 # Call loadslot without doing it as an internal and let it finish
945 Exit 2 "<none>" "reset: should not get here"
946 return $? # in case we are internal
950 # Unload the current tape (if necessary) and load a new one (unless
951 # "advance"). If no tape is loaded, get the value of "current" from
956 test -n "$DEBUG" && set -x
957 if [ $# -lt 1 ]; then
958 Exit 2 "<none>" "Missing -slot argument"
959 return $? # in case we are internal
962 Log "LOADSLOT -> load drive $driveslot ($tape) from slot $whichslot"
964 numeric=`echo $whichslot | sed 's/[^0-9]//g'`
966 current|prev|next|advance)
967 find_slot=$currentslot
982 Exit 2 "<none>" "Illegal slot: \"$whichslot\""
983 return $? # in case we are internal
987 # Find the requested slot in the slot list. By loading the "set"
988 # command with multiple copies, we guarantee that if the slot is
989 # found, we can look both forward and backward without running
990 # off the end. Putting $cleanslot at the end allows us to find
991 # that slot since it is not in $slot_list.
993 set x $slot_list $slot_list $slot_list $cleanslot
994 shift # get rid of the "x"
997 while [ $# -gt 0 ]; do
998 if [ $1 -eq $find_slot ]; then
1004 if [ $# -le 0 ]; then
1007 "Cannot find slot $find_slot" \
1008 "in slot list ($slot_list)"
1009 return $? # in case we are internal
1012 # Determine the slot to load.
1025 # If the desired slot is already loaded, we are done. Only update
1026 # current slot if this is not the cleaning slot.
1028 if [ $loadslot = $loadedslot ]; then
1029 if [ $loadslot -ne $cleanslot ]; then
1031 echo $loadslot > $slotfile
1033 Exit 0 "$loadedslot" "$tape"
1034 return $? # in case we are internal
1036 if [ $loadedslot -eq -2 ]; then
1037 Exit 0 "$loadedslot" "$tape"
1038 return $? # in case we are internal
1041 # If we are loading the cleaning tape, bump the cleaning count
1042 # and reset the access count. Otherwise, bump the access count
1043 # and see if it is time to do a cleaning.
1044 if [ $loadslot = $cleanslot ]; then
1045 rm -f $cleanfile $accessfile
1046 expr $cleancount + 1 > $cleanfile
1047 echo 0 > $accessfile
1050 expr $accesscount + 1 > $accessfile
1051 if [ $autoclean -ne 0 -a $accesscount -gt $autocleancount ]
1053 internal_call=`expr $internal_call + 1`
1054 loadslot clean > /dev/null 2>&1
1056 internal_call=`expr $internal_call - 1`
1057 if [ $status -ne 0 ]; then
1058 Exit $status "$loadslot" "$exit_answer"
1059 return $? # in case we are internal
1062 # Slot $cleanslot might contain an ordinary tape
1063 # rather than a cleaning tape. A cleaning tape
1064 # *MIGHT* auto-eject; an ordinary tape does not.
1065 # We therefore have to read the status again to
1066 # check what actually happened.
1072 # Unload whatever tape is in the drive.
1073 internal_call=`expr $internal_call + 1`
1074 eject > /dev/null 2>&1
1076 internal_call=`expr $internal_call - 1`
1077 if [ $status -gt 1 ]; then
1078 Exit $status "$exit_slot" "$exit_answer"
1079 return $? # in case we are internal
1082 # If we were doing an "advance", we are done.
1083 if [ $whichslot = advance ]; then
1084 if [ $loadslot -ne $cleanslot ]; then
1086 echo $loadslot > $slotfile
1088 Exit 0 "$loadslot" "/dev/null"
1089 return $? # in case we are internal
1092 # Load the tape, finally!
1093 Log "LOADSLOT -> loading tape from slot $loadslot" \
1094 "to drive $driveslot ($tape)"
1095 result=`Run $MTX load $loadslot $driveslot 2>&1`
1097 Log " -> status $status, result \"$result\""
1099 if [ $status -ne 0 ]; then
1100 Exit 2 "$loadslot" "$result"
1101 return $? # in case we are internal
1105 # Cleaning tapes never go "ready", so instead we just sit here
1106 # for "long enough" (as determined empirically by the user),
1107 # then return success.
1109 if [ $loadslot -eq $cleanslot ]; then
1110 Run sleep $cleancycle
1111 Exit 0 "$loadslot" "$tape"
1112 return $? # in case we are internal
1116 # Wait for the drive to go online.
1120 sleep $initial_poll_delay
1121 while [ $waittime -lt $max_drive_wait ]; do
1122 result=`Run $MT $MTF $tape rewind 2>&1`
1123 if [ $? -eq 0 ]; then
1127 sleep $poll_drive_ready
1128 waittime=`expr $waittime + $poll_drive_ready`
1130 if [ $ready -eq 0 ]; then
1131 Exit 2 "$loadslot" "Drive not ready after" \
1132 "$max_drive_wait seconds," \
1133 "rewind said \"$result\""
1134 return $? # in case we are internal
1137 if [ $loadslot -ne $cleanslot ]; then
1139 echo $loadslot > $slotfile
1141 Exit 0 "$loadslot" "$tape"
1142 return $? # in case we are internal
1146 # Return information about how the changer is configured and the current
1147 # state of the robot.
1151 test -n "$DEBUG" && set -x
1154 Log "INFO -> first slot: $firstslot"
1155 LogAppend " -> current slot: $currentslot"
1156 LogAppend " -> loaded slot: $loadedslot"
1157 LogAppend " -> last slot: $lastslot"
1158 LogAppend " -> slot list: $slot_list"
1159 LogAppend " -> can go backwards: 1"
1160 LogAppend " -> havereader: $havereader"
1163 # Check if a barcode reader is configured or not. If so, it
1164 # passes the 4th item in the echo back to amtape signifying it
1165 # can search based on barcodes.
1168 if [ $havereader -eq 1 ]; then
1172 if [ $currentslot -lt $firstslot -o $currentslot -gt $lastslot ]; then
1173 currentslot=$firstslot # what "current" will get
1175 numslots=`expr $lastslot - $firstslot + 1`
1176 Exit 0 "$currentslot" "$numslots 1 $reader"
1177 return $? # in case we are internal
1181 # Read the labelfile and scan for a particular entry.
1185 labelfile_entry_found=0
1193 while read lbl bc junk; do
1194 line=`expr $line + 1`
1195 if [ -z "$lbl" -o -z "$bc" -o -n "$junk" ]; then
1196 Log "ERROR -> Line $line malformed: $lbl $bc $junk"
1197 LogAppend " -> Remove $labelfile" \
1199 "\"$sbindir/amtape $config update\""
1202 "Line $line malformed in $labelfile: $lbl $bc $junk"
1203 return $? # in case we are internal
1205 if [ $lbl = "$lbl_search" -o $bc = "$bc_search" ]; then
1206 if [ $labelfile_entry_found -ne 0 ]; then
1207 Log "ERROR -> Duplicate entries: $labelfile line $line"
1208 LogAppend " -> Remove $labelfile" \
1210 "\"$sbindir/amtape $config update\""
1213 "Duplicate entries: $labelfile line $line"
1214 return $? # in case we are internal
1216 labelfile_entry_found=1
1217 labelfile_label=$lbl
1218 labelfile_barcode=$bc
1224 # Adds the label and barcode for the currently loaded tape to the
1225 # barcode file. Return an error if the database is messed up.
1229 test -n "$DEBUG" && set -x
1230 if [ $# -lt 1 ]; then
1231 Exit 2 "<none>" "Missing -label argument"
1232 return $? # in case we are internal
1235 if [ $havereader -eq 0 ]; then
1236 Exit 2 "<none>" "Not configured with barcode reader"
1237 return $? # in case we are internal
1240 if [ $loadedslot -lt 0 ]; then
1241 Exit 1 "<none>" "No tape currently loaded"
1242 return $? # in case we are internal
1244 Log "LABEL -> Adding label \"$tapelabel\"" \
1245 "with barcode \"$loadedbarcode\"" \
1246 "for slot $loadedslot" \
1248 read_labelfile "$tapelabel" "$loadedbarcode" < $labelfile
1249 if [ $labelfile_entry_found -ne 0 ]; then
1251 if [ "$labelfile_barcode" != "$loadedbarcode" ]; then
1255 old_val=$labelfile_barcode
1256 new_val=$loadedbarcode
1257 elif [ "$labelfile_label" != "$tapelabel" ]; then
1259 lf_val=$loadedbarcode
1261 old_val=$labelfile_label
1264 if [ -n "$lf_val" ]; then
1265 LogAppend "ERROR -> !!! Label database corrupted !!!"
1266 LogAppend " -> \"$old_val\" conflicts with" \
1267 "new $val_type \"$new_val\"" \
1268 "for $lf_type \"$lf_val\""
1269 LogAppend " -> Remove $labelfile" \
1271 "\"$sbindir/amtape $config update\""
1274 "$tapelabel: \"$old_val\" conflicts with" \
1275 "new $val_type \"$new_val\"" \
1276 "for $lf_type \"$lf_val\""
1277 return $? # in case we are internal
1279 LogAppend " -> already synced"
1281 echo "$tapelabel $loadedbarcode" >> $labelfile
1282 LogAppend " -> appended $labelfile entry:" \
1283 "$tapelabel $loadedbarcode"
1285 Exit 0 "$loadedslot" "$tape"
1286 return $? # in case we are internal
1290 # Look for a label in the barcode file. If found, locate the slot it's
1291 # in by looking for the barcode in the mtx output, then load that tape.
1295 test -n "$DEBUG" && set -x
1296 if [ $# -lt 1 ]; then
1297 Exit 2 "<none>" "Missing -search argument"
1298 return $? # in case we are internal
1301 if [ $havereader -eq 0 ]; then
1302 Exit 2 "<none>" "Not configured with barcode reader"
1303 return $? # in case we are internal
1305 Log "SEARCH -> Hunting for label \"$tapelabel\""
1306 read_labelfile "$tapelabel" "" < $labelfile
1307 if [ $labelfile_entry_found -eq 0 ]; then
1308 LogAppend " -> !!! label \"$tapelabel\" not found" \
1310 LogAppend " -> Remove $labelfile" \
1312 "\"$sbindir/amtape $config update\""
1315 "$tapelabel: label \"$tapelabel\" not found in $labelfile"
1316 return $? # in case we are internal
1318 LogAppend " -> barcode is \"$labelfile_barcode\""
1321 /VolumeTag *= *'$labelfile_barcode' *$/ {
1322 s/.*Storage Element \([0-9][0-9]*\).*/\1/p
1326 LogAppend " -> foundslot is $foundslot"
1327 if [ -z "$foundslot" ]; then
1328 LogAppend "ERROR -> !!! Could not find slot" \
1329 "for barcode \"$labelfile_barcode\"!!!"
1330 LogAppend " -> Remove $labelfile" \
1332 "\"$sbindir/amtape $config update\""
1335 "barcode \"$labelfile_barcode\"" \
1336 "not found in mtx status output"
1337 return $? # in case we are internal
1339 # Call loadslot without doing it as an internal and let it finish
1343 Exit 2 "<none>" "searchtape: should not get here"
1344 return $? # in case we are internal
1348 # Program invocation begins here
1351 if [ $# -lt 1 ]; then
1352 Exit 2 "<none>" "Usage: $myname -command args"
1379 Exit 2 "<none>" "unknown option: $cmd"
1383 Exit 2 "<none>" "$myname: should not get here"