freebsd-nq/usr.sbin/bsdconfig/share/media/ufs.subr
Devin Teske 9ecd54f24f Implement GEOM based media device classification. You'll notice a few
different things from this commit:
+ More devices. Devices that were previously ignored are now present.
+ Faster device scanning. "There is no try, only Do" -- f_device_try()
  is no longer the basis of device scanning as GEOM provides [nearly]
  all devices (doesn't provide network devices).
+ More information available as non-root. Usually you have to be root
  to do things like taste filesystems, and that limits the amount of
  information available to non-root users; with GEOM, we see all even
  running unprivileged as the brunt of information (except for so-
  called ``dangerously dedicated'' file systems) is represented by the
  `kern.geom.confxml' sysctl(8) MIB.
NB: Only really useful for external scripts that use the API and run as
    non-root; where this code is used in bsdconfig(8) and bsdinstall(8)
    you are running as root so can detect even ``dangerously dedicated''
    file systems that are not present in GEOM; e.g., no PART class for
    a DOS filesystem written directly to disk without partition table).
+ No more use of legacy tools such as diskinfo(8) to get disk capacity
  or fdisk(8) to see partitions.

MFC after:	1 week
2014-04-23 22:04:04 +00:00

199 lines
5.7 KiB
Plaintext

if [ ! "$_MEDIA_UFS_SUBR" ]; then _MEDIA_UFS_SUBR=1
#
# Copyright (c) 2012-2013 Devin Teske
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$
#
############################################################ INCLUDES
BSDCFG_SHARE="/usr/share/bsdconfig"
. $BSDCFG_SHARE/common.subr || exit 1
f_dprintf "%s: loading includes..." media/ufs.subr
f_include $BSDCFG_SHARE/device.subr
f_include $BSDCFG_SHARE/dialog.subr
f_include $BSDCFG_SHARE/media/common.subr
f_include $BSDCFG_SHARE/struct.subr
f_include $BSDCFG_SHARE/variable.subr
BSDCFG_LIBE="/usr/libexec/bsdconfig"
f_include_lang $BSDCFG_LIBE/include/messages.subr
############################################################ GLOBALS
UFS_MOUNTED=
############################################################ FUNCTIONS
# f_media_set_ufs
#
# Return success if we both found and set the media type to be a UFS partition.
# Variables from variable.subr that can be used to script user input:
#
# VAR_UFS_PATH
# Path to a UFS character device node to be used with mount(8) in
# mounting a UFS formatted partition. Valid examples include:
# /dev/da0s1a
# /dev/ad4s1e
# However, other forms may be valid (see mount(8) for additional
# information).
#
f_media_set_ufs()
{
local ufs
f_media_close
local devs ndevs
f_device_find "" $DEVICE_TYPE_UFS devs
f_count ndevs $devs
if [ ${ndevs:=0} -eq 0 ]; then
f_variable_get_value $VAR_UFS_PATH \
"$msg_enter_the_device_name_of_a_ufs_formatted_partition"
f_getvar $VAR_UFS_PATH ufs
[ "$ufs" ] || return $FAILURE
local fstype
fstype=$( df -nT $ufs 2> /dev/null |
awk '!/Type/{print $2;exit}' )
f_struct_new DEVICE device_ufs
device_ufs set name ${fstype:-ufs}
device_ufs set devname "$ufs"
device_ufs set get f_media_get_ufs
device_ufs set init f_media_init_ufs
device_ufs set shutdown f_media_shutdown_ufs
device_ufs unset private
f_struct_copy device_ufs device_media
f_struct_free device_ufs
elif [ $ndevs -eq 1 ]; then
f_struct_copy $devs device_media
else
local dev
local title="$msg_choose_a_ufs_partition"
local prompt="$msg_please_select_ufs_partition"
local hline=""
dev=$( f_device_menu \
"$title" "$prompt" "$hline" $DEVICE_TYPE_UFS \
2>&1 >&$DIALOG_TERMINAL_PASSTHRU_FD ) ||
return $FAILURE
f_struct_copy "$dev" device_media
fi
f_struct device_media || return $FAILURE
}
# f_media_init_ufs $device
#
# Initializes the UFS media device. Returns success if able to mount the UFS
# partition device using mount(1).
#
f_media_init_ufs()
{
local funcname=f_media_init_ufs
local dev="$1" devname err
$dev get devname devname || return $FAILURE
f_dprintf "Init routine called for UFS device. devname=[%s]" \
"$devname"
if [ "$UFS_MOUNTED" ]; then
f_dprintf "UFS device already mounted."
return $SUCCESS
fi
if [ ! -e "$devname" ]; then
f_show_msg "$msg_no_such_file_or_directory" \
"f_media_init_ufs" "$devname"
return $FAILURE
fi
if [ ! -e "$MOUNTPOINT" ]; then
f_eval_catch $funcname mkdir 'mkdir -p "%s"' "$MOUNTPOINT" ||
return $FAILURE
fi
if ! f_eval_catch -dk err $funcname mount \
'mount "%s" "%s"' "$devname" "$MOUNTPOINT"
then
err="${err#mount: }"; err="${err#$devname : }"
f_show_msg "$msg_error_mounting_device" \
"$devname" "$MOUNTPOINT" "$err"
return $FAILURE
fi
UFS_MOUNTED=1
return $SUCCESS
}
# f_media_get_ufs $device $file [$probe_type]
#
# Returns data from $file on a mounted UFS partition device. Similar to cat(1).
# If $probe_type is present and non-NULL, returns success if $file exists. If
# $probe_type is equal to $PROBE_SIZE, prints the size of $file in bytes to
# standard-out.
#
f_media_get_ufs()
{
local dev="$1" file="$2" probe_type="$3"
local name
$dev get name name
f_dprintf "f_media_get_ufs: dev=[%s] file=[%s] probe_type=%s" \
"$name" "$file" "$probe_type"
f_media_generic_get "$MOUNTPOINT" "$file" "$probe_type"
}
# f_media_shutdown_ufs $device
#
# Shuts down the UFS device using umount(8). Return status should be ignored.
#
f_media_shutdown_ufs()
{
local funcname=f_media_shutdown_ufs
local dev="$1" err
[ "$UFS_MOUNTED" ] || return $FAILURE
if ! f_eval_catch -dk err $funcname umount \
'umount -f "%s"' "$MOUNTPOINT"
then
err="${err#umount: }"; err="${err#*: }"
f_show_msg "$msg_could_not_unmount_the_ufs_partition" \
"$MOUNTPOINT" "$err"
else
UFS_MOUNTED=
fi
}
############################################################ MAIN
f_dprintf "%s: Successfully loaded." media/ufs.subr
fi # ! $_MEDIA_UFS_SUBR