ufs.subr revision 260678
1232809Sjmallettif [ ! "$_MEDIA_UFS_SUBR" ]; then _MEDIA_UFS_SUBR=1 2232809Sjmallett# 3232809Sjmallett# Copyright (c) 2012-2013 Devin Teske 4232809Sjmallett# All rights reserved. 5232809Sjmallett# 6232809Sjmallett# Redistribution and use in source and binary forms, with or without 7232809Sjmallett# modification, are permitted provided that the following conditions 8232809Sjmallett# are met: 9232809Sjmallett# 1. Redistributions of source code must retain the above copyright 10232809Sjmallett# notice, this list of conditions and the following disclaimer. 11232809Sjmallett# 2. Redistributions in binary form must reproduce the above copyright 12232809Sjmallett# notice, this list of conditions and the following disclaimer in the 13232809Sjmallett# documentation and/or other materials provided with the distribution. 14232809Sjmallett# 15232809Sjmallett# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16232809Sjmallett# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17232809Sjmallett# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18232809Sjmallett# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19232809Sjmallett# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20232809Sjmallett# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21232809Sjmallett# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22232809Sjmallett# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23232809Sjmallett# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24232809Sjmallett# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25232809Sjmallett# SUCH DAMAGE. 26232809Sjmallett# 27232809Sjmallett# $FreeBSD: stable/10/usr.sbin/bsdconfig/share/media/ufs.subr 260678 2014-01-15 07:49:17Z dteske $ 28232809Sjmallett# 29232809Sjmallett############################################################ INCLUDES 30232809Sjmallett 31232809SjmallettBSDCFG_SHARE="/usr/share/bsdconfig" 32232809Sjmallett. $BSDCFG_SHARE/common.subr || exit 1 33232809Sjmallettf_dprintf "%s: loading includes..." media/ufs.subr 34232809Sjmallettf_include $BSDCFG_SHARE/device.subr 35232809Sjmallettf_include $BSDCFG_SHARE/dialog.subr 36232809Sjmallettf_include $BSDCFG_SHARE/media/common.subr 37232809Sjmallettf_include $BSDCFG_SHARE/struct.subr 38232809Sjmallettf_include $BSDCFG_SHARE/variable.subr 39232809Sjmallett 40232809SjmallettBSDCFG_LIBE="/usr/libexec/bsdconfig" 41232809Sjmallettf_include_lang $BSDCFG_LIBE/include/messages.subr 42232809Sjmallett 43232809Sjmallett############################################################ GLOBALS 44232809Sjmallett 45232809SjmallettUFS_MOUNTED= 46232809Sjmallett 47232809Sjmallett############################################################ FUNCTIONS 48232809Sjmallett 49232809Sjmallett# f_media_set_ufs 50232809Sjmallett# 51232809Sjmallett# Return success if we both found and set the media type to be a UFS partition. 52232809Sjmallett# Variables from variable.subr that can be used to script user input: 53232809Sjmallett# 54232809Sjmallett# VAR_UFS_PATH 55232809Sjmallett# Path to a UFS character device node to be used with mount(8) in 56232809Sjmallett# mounting a UFS formatted partition. Valid examples include: 57232809Sjmallett# /dev/da0s1a 58232809Sjmallett# /dev/ad4s1e 59232809Sjmallett# However, other forms may be valid (see mount(8) for additional 60232809Sjmallett# information). 61232809Sjmallett# 62232809Sjmallettf_media_set_ufs() 63232809Sjmallett{ 64232809Sjmallett local ufs 65232809Sjmallett 66232809Sjmallett f_media_close 67232809Sjmallett 68232809Sjmallett local devs ndevs 69232809Sjmallett f_device_find "" $DEVICE_TYPE_UFS devs 70232809Sjmallett f_count ndevs $devs 71232809Sjmallett 72232809Sjmallett if [ ${ndevs:=0} -eq 0 ]; then 73232809Sjmallett f_variable_get_value $VAR_UFS_PATH \ 74232809Sjmallett "$msg_enter_the_device_name_of_a_ufs_formatted_partition" 75232809Sjmallett f_getvar $VAR_UFS_PATH ufs 76232809Sjmallett [ "$ufs" ] || return $FAILURE 77232809Sjmallett 78232809Sjmallett local fstype 79232809Sjmallett fstype=$( df -nT $ufs 2> /dev/null | 80232809Sjmallett awk '!/Type/{print $2;exit}' ) 81232809Sjmallett 82232809Sjmallett f_struct_new DEVICE device_ufs 83232809Sjmallett device_ufs set name ${fstype:-ufs} 84232809Sjmallett device_ufs set devname "$ufs" 85232809Sjmallett device_ufs set get f_media_get_ufs 86232809Sjmallett device_ufs set init f_media_init_ufs 87232809Sjmallett device_ufs set shutdown f_media_shutdown_ufs 88232809Sjmallett device_ufs unset private 89232809Sjmallett 90232809Sjmallett f_struct_copy device_ufs device_media 91232809Sjmallett f_struct_free device_ufs 92232809Sjmallett elif [ $ndevs -gt 1 ]; then 93232809Sjmallett local title="$msg_choose_a_ufs_partition" 94232809Sjmallett local prompt="$msg_please_select_ufs_partition" 95232809Sjmallett local hline="" 96232809Sjmallett 97232809Sjmallett local dev retval 98232809Sjmallett dev=$( f_device_menu \ 99232809Sjmallett "$title" "$prompt" "$hline" $DEVICE_TYPE_UFS \ 100232809Sjmallett 2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD ) 101232809Sjmallett retval=$? 102232809Sjmallett [ "$dev" ] || return $FAILURE 103232809Sjmallett 104 f_struct_copy device_$dev device_media 105 [ $retval -eq $SUCCESS ] || return $FAILURE 106 else 107 f_struct_copy device_$devs device_media 108 fi 109 110 f_struct device_media || return $FAILURE 111} 112 113# f_media_init_ufs $device 114# 115# Initializes the UFS media device. Returns success if able to mount the UFS 116# partition device using mount(1). 117# 118f_media_init_ufs() 119{ 120 local funcname=f_media_init_ufs 121 local dev="$1" devname err 122 123 device_$dev get devname devname || return $FAILURE 124 f_dprintf "Init routine called for UFS device. devname=[%s]" \ 125 "$devname" 126 127 if [ "$UFS_MOUNTED" ]; then 128 f_dprintf "UFS device already mounted." 129 return $SUCCESS 130 fi 131 132 if [ ! -e "$devname" ]; then 133 f_show_msg "$msg_no_such_file_or_directory" \ 134 "f_media_init_ufs" "$devname" 135 return $FAILURE 136 fi 137 138 if [ ! -e "$MOUNTPOINT" ]; then 139 f_eval_catch $funcname mkdir 'mkdir -p "%s"' "$MOUNTPOINT" || 140 return $FAILURE 141 fi 142 143 if ! f_eval_catch -dk err $funcname mount \ 144 'mount "%s" "%s"' "$devname" "$MOUNTPOINT" 145 then 146 err="${err#mount: }"; err="${err#$devname : }" 147 f_show_msg "$msg_error_mounting_device" \ 148 "$devname" "$MOUNTPOINT" "$err" 149 return $FAILURE 150 fi 151 UFS_MOUNTED=1 152 return $SUCCESS 153} 154 155# f_media_get_ufs $device $file [$probe_type] 156# 157# Returns data from $file on a mounted UFS partition device. Similar to cat(1). 158# If $probe_type is present and non-NULL, returns success if $file exists. If 159# $probe_type is equal to $PROBE_SIZE, prints the size of $file in bytes to 160# standard-out. 161# 162f_media_get_ufs() 163{ 164 local dev="$1" file="$2" probe_type="$3" 165 166 f_dprintf "f_media_get_ufs: dev=[%s] file=[%s] probe_type=%s" \ 167 "$dev" "$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# 176f_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 196f_dprintf "%s: Successfully loaded." media/ufs.subr 197 198fi # ! $_MEDIA_UFS_SUBR 199