usr.sbin/bsdconfig/share/media/ufs.subr

   1 if [ ! "$_MEDIA_UFS_SUBR" ]; then _MEDIA_UFS_SUBR=1
   2 #
   3 # Copyright (c) 2012-2013 Devin Teske
   4 # All rights reserved.
   5 #
   6 # Redistribution and use in source and binary forms, with or without
   7 # modification, are permitted provided that the following conditions
   8 # are met:
   9 # 1. Redistributions of source code must retain the above copyright
  10 #    notice, this list of conditions and the following disclaimer.
  11 # 2. Redistributions in binary form must reproduce the above copyright
  12 #    notice, this list of conditions and the following disclaimer in the
  13 #    documentation and/or other materials provided with the distribution.
  14 #
  15 # THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 # ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 # SUCH DAMAGE.
  26 #
  27 # $FreeBSD$
  28 #
  29 ############################################################ INCLUDES
  30
  31 BSDCFG_SHARE="/usr/share/bsdconfig"
  32 . $BSDCFG_SHARE/common.subr || exit 1
  33 f_dprintf "%s: loading includes..." media/ufs.subr
  34 f_include $BSDCFG_SHARE/device.subr
  35 f_include $BSDCFG_SHARE/dialog.subr
  36 f_include $BSDCFG_SHARE/media/common.subr
  37 f_include $BSDCFG_SHARE/struct.subr
  38 f_include $BSDCFG_SHARE/variable.subr
  39
  40 BSDCFG_LIBE="/usr/libexec/bsdconfig"
  41 f_include_lang $BSDCFG_LIBE/include/messages.subr
  42
  43 ############################################################ GLOBALS
  44
  45 UFS_MOUNTED=
  46
  47 ############################################################ FUNCTIONS
  48
  49 # f_media_set_ufs
  50 #
  51 # Return success if we both found and set the media type to be a UFS partition.
  52 # Variables from variable.subr that can be used to script user input:
  53 #
  54 #       VAR_UFS_PATH
  55 #               Path to a UFS character device node to be used with mount(8) in
  56 #               mounting a UFS formatted partition. Valid examples include:
  57 #                       /dev/da0s1a
  58 #                       /dev/ad4s1e
  59 #               However, other forms may be valid (see mount(8) for additional
  60 #               information).
  61 #
  62 f_media_set_ufs()
  63 {
  64         local ufs
  65
  66         f_media_close
  67
  68         local devs ndevs
  69         f_device_find "" $DEVICE_TYPE_UFS devs
  70         f_count ndevs $devs
  71
  72         if [ ${ndevs:=0} -eq 0 ]; then
  73                 f_variable_get_value $VAR_UFS_PATH \
  74                     "$msg_enter_the_device_name_of_a_ufs_formatted_partition"
  75                 f_getvar $VAR_UFS_PATH ufs
  76                 [ "$ufs" ] || return $FAILURE
  77
  78                 local fstype
  79                 fstype=$( df -nT $ufs 2> /dev/null |
  80                         awk '!/Type/{print $2;exit}' )
  81
  82                 f_struct_new DEVICE device_ufs
  83                 device_ufs set   name     ${fstype:-ufs}
  84                 device_ufs set   devname  "$ufs"
  85                 device_ufs set   get      f_media_get_ufs
  86                 device_ufs set   init     f_media_init_ufs
  87                 device_ufs set   shutdown f_media_shutdown_ufs
  88                 device_ufs unset private
  89
  90                 f_struct_copy device_ufs device_media
  91                 f_struct_free device_ufs
  92         elif [ $ndevs -eq 1 ]; then
  93                 f_struct_copy $devs device_media
  94         else
  95                 local dev
  96                 local title="$msg_choose_a_ufs_partition"
  97                 local prompt="$msg_please_select_ufs_partition"
  98                 local hline=""
  99
 100                 dev=$( f_device_menu \
 101                         "$title" "$prompt" "$hline" $DEVICE_TYPE_UFS \
 102                         2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD ) ||
 103                         return $FAILURE
 104
 105                 f_struct_copy "$dev" device_media
 106         fi
 107
 108         f_struct device_media || return $FAILURE
 109 }
 110
 111 # f_media_init_ufs $device
 112 #
 113 # Initializes the UFS media device. Returns success if able to mount the UFS
 114 # partition device using mount(1).
 115 #
 116 f_media_init_ufs()
 117 {
 118         local funcname=f_media_init_ufs
 119         local dev="$1" devname err
 120
 121         $dev get devname devname || return $FAILURE
 122         f_dprintf "Init routine called for UFS device. devname=[%s]" \
 123                   "$devname"
 124
 125         if [ "$UFS_MOUNTED" ]; then
 126                 f_dprintf "UFS device already mounted."
 127                 return $SUCCESS
 128         fi
 129
 130         if [ ! -e "$devname" ]; then
 131                 f_show_msg "$msg_no_such_file_or_directory" \
 132                            "f_media_init_ufs" "$devname"
 133                 return $FAILURE
 134         fi
 135
 136         if [ ! -e "$MOUNTPOINT" ]; then
 137                 f_eval_catch $funcname mkdir 'mkdir -p "%s"' "$MOUNTPOINT" ||
 138                         return $FAILURE
 139         fi
 140
 141         if ! f_eval_catch -dk err $funcname mount \
 142                 'mount "%s" "%s"' "$devname" "$MOUNTPOINT"
 143         then
 144                 err="${err#mount: }"; err="${err#$devname : }"
 145                 f_show_msg "$msg_error_mounting_device" \
 146                            "$devname" "$MOUNTPOINT" "$err"
 147                 return $FAILURE
 148         fi
 149         UFS_MOUNTED=1
 150         return $SUCCESS
 151 }
 152
 153 # f_media_get_ufs $device $file [$probe_type]
 154 #
 155 # Returns data from $file on a mounted UFS partition device. Similar to cat(1).
 156 # If $probe_type is present and non-NULL, returns success if $file exists. If
 157 # $probe_type is equal to $PROBE_SIZE, prints the size of $file in bytes to
 158 # standard-out.
 159 #
 160 f_media_get_ufs()
 161 {
 162         local dev="$1" file="$2" probe_type="$3"
 163         local name
 164
 165         $dev get name name
 166         f_dprintf "f_media_get_ufs: dev=[%s] file=[%s] probe_type=%s" \
 167                   "$name" "$file" "$probe_type"
 168
 169         f_media_generic_get "$MOUNTPOINT" "$file" "$probe_type"
 170 }
 171
 172 # f_media_shutdown_ufs $device
 173 #
 174 # Shuts down the UFS device using umount(8). Return status should be ignored.
 175 #
 176 f_media_shutdown_ufs()
 177 {
 178         local funcname=f_media_shutdown_ufs
 179         local dev="$1" err
 180
 181         [ "$UFS_MOUNTED" ] || return $FAILURE
 182
 183         if ! f_eval_catch -dk err $funcname umount \
 184                 'umount -f "%s"' "$MOUNTPOINT"
 185         then
 186                 err="${err#umount: }"; err="${err#*: }"
 187                 f_show_msg "$msg_could_not_unmount_the_ufs_partition" \
 188                            "$MOUNTPOINT" "$err"
 189         else
 190                 UFS_MOUNTED=
 191         fi
 192 }
 193
 194 ############################################################ MAIN
 195
 196 f_dprintf "%s: Successfully loaded." media/ufs.subr
 197
 198 fi # ! $_MEDIA_UFS_SUBR