History log of /freebsd-current/usr.bin/mt/mt.c
Revision Date Author Comments
# 0b8224d1 24-Nov-2023 Warner Losh <imp@FreeBSD.org>

Remove copyright strings ifdef'd out

We've ifdef'd out the copyright strings for some time now. Go ahead and
remove the ifdefs. Plus whatever other detritis was left over from other
recent removals. These copyright strings are present in the comments and
are largely from CSRG's attempt at adding their copyright to every
binary file (which modern interpretations of the license doesn't
require).

Sponsored by: Netflix


# bdcbfde3 23-Nov-2023 Warner Losh <imp@FreeBSD.org>

usr.bin: Remove ancient SCCS tags.

Remove ancient SCCS tags from the tree, automated scripting, with two
minor fixup to keep things compiling. All the common forms in the tree
were removed with a perl script.

Sponsored by: Netflix


# 1d386b48 16-Aug-2023 Warner Losh <imp@FreeBSD.org>

Remove $FreeBSD$: one-line .c pattern

Remove /^[\s*]*__FBSDID\("\$FreeBSD\$"\);?\s*\n/


# 1a7ac2bd 07-Jul-2023 Alfonso Gregory <gfunni234@gmail.com>

Mark usage function as __dead2 in programs where it does not return

In most cases, usage does not return, so mark them as __dead2. For the
cases where they do return, they have not been marked __dead2.

Reviewed by: imp
Pull Request: https://github.com/freebsd/freebsd-src/pull/735


# 9a55543f 20-Jun-2023 John Baldwin <jhb@FreeBSD.org>

mt: Remove a set but unused variable.

The variable is unused because the -v (verbose) flag to
'mt getdensity' is a no-op.

Reported by: GCC
Reviewed by: ken
Differential Revision: https://reviews.freebsd.org/D40653


# 8a16b7a1 20-Nov-2017 Pedro F. Giffuni <pfg@FreeBSD.org>

General further adoption of SPDX licensing ID tags.

Mainly focus on files that use BSD 3-Clause license.

The Software Package Data Exchange (SPDX) group provides a specification
to make it easier for automated tools to detect and summarize well known
opensource licenses. We are gradually adopting the specification, noting
that the tags are considered only advisory and do not, in any way,
superceed or replace the license texts.

Special thanks to Wind River for providing access to "The Duke of
Highlander" tool: an older (2014) run over FreeBSD tree was useful as a
starting point.


# fbbd9655 28-Feb-2017 Warner Losh <imp@FreeBSD.org>

Renumber copyright clause 4

Renumber cluase 4 to 3, per what everybody else did when BSD granted
them permission to remove clause 3. My insistance on keeping the same
numbering for legal reasons is too pedantic, so give up on that point.

Submitted by: Jan Schaumann <jschauma@stevens.edu>
Pull Request: https://github.com/freebsd/freebsd/pull/96


# 463a577b 20-Oct-2015 Eitan Adler <eadler@FreeBSD.org>

Fix a ton of speelling errors

arc lint is helpful

Reviewed By: allanjude, wblock, #manpages, chris@bsdjunk.com
Differential Revision: https://reviews.freebsd.org/D3337


# b6f4a0a1 09-Apr-2015 Baptiste Daroussin <bapt@FreeBSD.org>

Remove uneeded sbuf header


# d788649d 18-Mar-2015 Kenneth D. Merry <ken@FreeBSD.org>

Improve the mt(1) rblim display.

The granularity reported by READ BLOCK LIMITS is an exponent, not a
byte value. So a granularity of 0 means 2^0, or 1 byte. A
granularity of 1 means 2^1, or 2 bytes.

Print out the individual block limits on separate lines to improve
readability and avoid exceeding 80 columns.

usr.bin/mt/mt.c:
Fix and improve the 'mt rblim' output. Add a MT_PLURAL()
macro so we can print "byte" or "bytes" as appropriate.

Sponsored by: Spectra Logic
MFC after: 4 days


# 74a177ac 18-Mar-2015 Kenneth D. Merry <ken@FreeBSD.org>

Fix a couple of problems in the sa(4) media type reports.

The only drives I have discovered so far that support medium type
reports are newer HP LTO (LTO-5 and LTO-6) drives. IBM drives
only support the density reports.

sys/cam/scsi/scsi_sa.h:
The number of possible density codes in the medium type
report is 9, not 8. This caused problems parsing all of
the medium type report after this point in the structure.

usr.bin/mt/mt.c:
Run the density codes returned in the medium type report
through denstostring(), just like the primary and secondary
density codes in the density report. This will print the
density code in hex, and give a text description if it
is available.

Thanks to Rudolf Cejka for doing extensive testing with HP LTO drives
and Bacula and discovering these problems.

Tested by: Rudolf Cejka <cejkar at fit.vutbr.cz>
Sponsored by: Spectra Logic
MFC after: 4 days


# 7b7c7a05 24-Feb-2015 Kenneth D. Merry <ken@FreeBSD.org>

Fix several problems found by Coverity.

lib/libmt/mtlib.c:
In mt_start_element(), make sure we don't overflow the
cur_sb array. CID 1271325

usr.bin/mt/mt.c:
In main(), bzero the mt_com structure so that we aren't
using any uninitialized stack variables. CID 1271319

In mt_param(), only allow one -s and one -p argument. This
will prevent a memory leak caused by overwriting the
param_name and/or param_value variables. CID 1271320 and
CID 1271322

To make things simpler in mt_param(), make sure there
there is only one exit path for the function. Make sure
the arguments are explicitly freed.

Sponsored by: Spectra Logic
Pointed out by: emaste
MFC after: 1 month


# 43518607 23-Feb-2015 Kenneth D. Merry <ken@FreeBSD.org>

Significant upgrades to sa(4) and mt(1).

The primary focus of these changes is to modernize FreeBSD's
tape infrastructure so that we can take advantage of some of the
features of modern tape drives and allow support for LTFS.

Significant changes and new features include:

o sa(4) driver status and parameter information is now exported via an
XML structure. This will allow for changes and improvements later
on that will not break userland applications. The old MTIOCGET
status ioctl remains, so applications using the existing interface
will not break.

o 'mt status' now reports drive-reported tape position information
as well as the previously available calculated tape position
information. These numbers will be different at times, because
the drive-reported block numbers are relative to BOP (Beginning
of Partition), but the block numbers calculated previously via
sa(4) (and still provided) are relative to the last filemark.
Both numbers are now provided. 'mt status' now also shows the
drive INQUIRY information, serial number and any position flags
(BOP, EOT, etc.) provided with the tape position information.
'mt status -v' adds information on the maximum possible I/O size,
and the underlying values used to calculate it.

o The extra sa(4) /dev entries (/dev/saN.[0-3]) have been removed.

The extra devices were originally added as place holders for
density-specific device nodes. Some OSes (NetBSD, NetApp's OnTap
and Solaris) have had device nodes that, when you write to them,
will automatically select a given density for particular tape drives.

This is a convenient way of switching densities, but it was never
implemented in FreeBSD. Only the device nodes were there, and that
sometimes confused users.

For modern tape devices, the density is generally not selectable
(e.g. with LTO) or defaults to the highest availble density when
the tape is rewritten from BOT (e.g. TS11X0). So, for most users,
density selection won't be necessary. If they do need to select
the density, it is easy enough to use 'mt density' to change it.

o Protection information is now supported. This is either a
Reed-Solomon CRC or CRC32 that is included at the end of each block
read and written. On write, the tape drive verifies the CRC, and
on read, the tape drive provides a CRC for the userland application
to verify.

o New, extensible tape driver parameter get/set interface.

o Density reporting information. For drives that support it,
'mt getdensity' will show detailed information on what formats the
tape drive supports, and what formats the tape drive supports.

o Some mt(1) functionality moved into a new mt(3) library so that
external applications can reuse the code.

o The new mt(3) library includes helper routines to aid in parsing
the XML output of the sa(4) driver, and build a tree of driver
metadata.

o Support for the MTLOAD (load a tape in the drive) and MTWEOFI
(write filemark immediate) ioctls needed by IBM's LTFS
implementation.

o Improve device departure behavior for the sa(4) driver. The previous
implementation led to hangs when the device was open.

o This has been tested on the following types of drives:
IBM TS1150
IBM TS1140
IBM LTO-6
IBM LTO-5
HP LTO-2
Seagate DDS-4
Quantum DLT-4000
Exabyte 8505
Sony DDS-2

contrib/groff/tmac/doc-syms,
share/mk/bsd.libnames.mk,
lib/Makefile,
Add libmt.

lib/libmt/Makefile,
lib/libmt/mt.3,
lib/libmt/mtlib.c,
lib/libmt/mtlib.h,
New mt(3) library that contains functions moved from mt(1) and
new functions needed to interact with the updated sa(4) driver.

This includes XML parser helper functions that application writers
can use when writing code to query tape parameters.

rescue/rescue/Makefile:
Add -lmt to CRUNCH_LIBS.

src/share/man/man4/mtio.4
Clarify this man page a bit, and since it contains what is
essentially the mtio.h header file, add new ioctls and structure
definitions from mtio.h.

src/share/man/man4/sa.4
Update BUGS and maintainer section.

sys/cam/scsi/scsi_all.c,
sys/cam/scsi/scsi_all.h:
Add SCSI SECURITY PROTOCOL IN/OUT CDB definitions and CDB building
functions.

sys/cam/scsi/scsi_sa.c
sys/cam/scsi/scsi_sa.h
Many tape driver changes, largely outlined above.

Increase the sa(4) driver read/write timeout from 4 to 32
minutes. This is based on the recommended values for IBM LTO
5/6 drives. This may also avoid timeouts for other tape
hardware that can take a long time to do retries and error
recovery. Longer term, a better way to handle this is to ask
the drive for recommended timeout values using the REPORT
SUPPORTED OPCODES command. Modern IBM and Oracle tape drives
at least support that command, and it would allow for more
accurate timeout values.

Add XML status generation. This is done with a series of
macros to eliminate as much duplicate code as possible. The
new XML-based status values are reported through the new
MTIOCEXTGET ioctl.

Add XML driver parameter reporting, using the new MTIOCPARAMGET
ioctl.

Add a new driver parameter setting interface, using the new
MTIOCPARAMSET and MTIOCSETLIST ioctls.

Add a new MTIOCRBLIM ioctl to get block limits information.

Add CCB/CDB building routines scsi_locate_16, scsi_locate_10,
and scsi_read_position_10().

scsi_locate_10 implements the LOCATE command, as does the
existing scsi_set_position() command. It just supports
additional arguments and features. If/when we figure out a
good way to provide backward compatibility for older
applications using the old function API, we can just revamp
scsi_set_position(). The same goes for
scsi_read_position_10() and the existing scsi_read_position()
function.

Revamp sasetpos() to take the new mtlocate structure as an
argument. It now will use either scsi_locate_10() or
scsi_locate_16(), depending upon the arguments the user
supplies. As before, once we change position we don't have a
clear idea of what the current logical position of the tape
drive is.

For tape drives that support long form position data, we
read the current position and store that for later reporting
after changing the position. This should help applications
like Bacula speed tape access under FreeBSD once they are
modified to support the new ioctls.

Add a new quirk, SA_QUIRK_NO_LONG_POS, that is set for all
drives that report SCSI-2 or older, as well as drives that
report an Illegal Request type error for READ POSITION with
the long format. So we should automatically detect drives
that don't support the long form and stop asking for it after
an initial try.

Add a partition number to the sa(4) softc.

Improve device departure handling. The previous implementation
led to hangs when the device was open.

If an application had the sa(4) driver open, and attempted to
close it after it went away, the cam_periph_release() call in
saclose() would cause the periph to get destroyed because that
was the last reference to it. Because destroy_dev() was
called from the sa(4) driver's cleanup routine (sacleanup()),
and would block waiting for the close to happen, a deadlock
would result.

So instead of calling destroy_dev() from the cleanup routine,
call destroy_dev_sched_cb() from saoninvalidate() and wait for
the callback.

Acquire a reference for devfs in saregister(), and release it
in the new sadevgonecb() routine when all devfs devices for
the particular sa(4) driver instance are gone.

Add a new function, sasetupdev(), to centralize setting
per-instance devfs device parameters instead of repeating the
code in saregister().

Add an open count to the softc, so we know how many
peripheral driver references are a result of open
sessions.

Add the D_TRACKCLOSE flag to the cdevsw flags so
that we get a 1:1 mapping of open to close calls
instead of a N:1 mapping.

This should be a no-op for everything except the
control device, since we don't allow more than one
open on non-control devices.

However, since we do allow multiple opens on the
control device, the combination of the open count
and the D_TRACKCLOSE flag should result in an
accurate peripheral driver reference count, and an
accurate open count.

The accurate open count allows us to release all
peripheral driver references that are the result
of open contexts once we get the callback from devfs.

sys/sys/mtio.h:
Add a number of new mt(4) ioctls and the requisite data
structures. None of the existing interfaces been removed
or changed.

This includes definitions for the following new ioctls:

MTIOCRBLIM /* get block limits */
MTIOCEXTLOCATE /* seek to position */
MTIOCEXTGET /* get tape status */
MTIOCPARAMGET /* get tape params */
MTIOCPARAMSET /* set tape params */
MTIOCSETLIST /* set N params */

usr.bin/mt/Makefile:
mt(1) now depends on libmt, libsbuf and libbsdxml.

usr.bin/mt/mt.1:
Document new mt(1) features and subcommands.

usr.bin/mt/mt.c:
Implement support for mt(1) subcommands that need to
use getopt(3) for their arguments.

Implement a new 'mt status' command to replace the old
'mt status' command. The old status command has been
renamed 'ostatus'.

The new status function uses the MTIOCEXTGET ioctl, and
therefore parses the XML data to determine drive status.
The -x argument to 'mt status' allows the user to dump out
the raw XML reported by the kernel.

The new status display is mostly the same as the old status
display, except that it doesn't print the redundant density
mode information, and it does print the current partition
number and position flags.

Add a new command, 'mt locate', that will supersede the
old 'mt setspos' and 'mt sethpos' commands. 'mt locate'
implements all of the functionality of the MTIOCEXTLOCATE
ioctl, and allows the user to change the logical position
of the tape drive in a number of ways. (Partition,
block number, file number, set mark number, end of data.)
The immediate bit and the explicit address bits are
implemented, but not documented in the man page.

Add a new 'mt weofi' command to use the new MTWEOFI ioctl.
This allows the user to ask the drive to write a filemark
without waiting around for the operation to complete.

Add a new 'mt getdensity' command that gets the XML-based
tape drive density report from the sa(4) driver and displays
it. This uses the SCSI REPORT DENSITY SUPPORT command
to get comprehensive information from the tape drive about
what formats it is able to read and write.

Add a new 'mt protect' command that allows getting and setting
tape drive protection information. The protection information
is a CRC tacked on to the end of every read/write from and to
the tape drive.

Sponsored by: Spectra Logic
MFC after: 1 month


# f3fbaba1 16-Dec-2011 Dimitry Andric <dim@FreeBSD.org>

In usr.bin/mt/mt.c, the c_code member of struct commands should really
be an unsigned long, since it will contain values of ioctl request
codes. On 64-bit arches, these will not fit into an int.

MFC after: 1 week


# 0e5d3f8e 06-Nov-2011 Ed Schouten <ed@FreeBSD.org>

Add missing static keywords to mt(1)


# da52b4ca 11-Dec-2010 Joel Dahl <joel@FreeBSD.org>

Remove the advertising clause from UCB copyrighted files in usr.bin. This
is in accordance with the information provided at
ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change

Also add $FreeBSD$ to a few files to keep svn happy.

Discussed with: imp, rwatson


# a7d5f7eb 19-Oct-2010 Jamie Gritton <jamie@FreeBSD.org>

A new jail(8) with a configuration file, to replace the work currently done
by /etc/rc.d/jail.


# fe0506d7 09-Mar-2010 Marcel Moolenaar <marcel@FreeBSD.org>

Create the altix project branch. The altix project will add support
for the SGI Altix 350 to FreeBSD/ia64. The hardware used for porting
is a two-module system, consisting of a base compute module and a
CPU expansion module. SGI's NUMAFlex architecture can be an excellent
platform to test CPU affinity and NUMA-aware features in FreeBSD.


# d7f03759 19-Oct-2008 Ulf Lilleengen <lulf@FreeBSD.org>

- Import the HEAD csup code which is the basis for the cvsmode work.


# 93aa4a76 13-Nov-2005 David Malone <dwmalone@FreeBSD.org>

Const poision, deregister and use ANSI definitions.


# 1aefe0e3 09-Apr-2004 Maxime Henrion <mux@FreeBSD.org>

Backout previous commit. It seems this comment applied to something
else than I thought, and thus really needs to go away.

Noticed by: ru


# 92375a1c 09-Apr-2004 Maxime Henrion <mux@FreeBSD.org>

Reintroduce a comment that was wrongly removed in revision 1.34.


# 1a490c95 13-Mar-2004 Ruslan Ermilov <ru@FreeBSD.org>

Catch up with the removal of the wt(4) driver.


# 75e861d6 14-Oct-2002 Joerg Wunsch <joerg@FreeBSD.org>

Add information about the SDLT density codes.

Submitted by: "Stewart MacLund" <sundie@lunaticfringe.org>
MFC after: 1 week


# bd275d1a 09-Jul-2002 Joerg Wunsch <joerg@FreeBSD.org>

Add definitions for the industry-standard DLT density codes.

Obtained from: Quantum DLT8000 manual
MFC after: 1 week


# 71510873 12-Apr-2002 Philippe Charnier <charnier@FreeBSD.org>

Make `make WARNS=3' succeed, notably, use %d to printf daddr_t value.
Use `.Nm Ns .' instead of `.Nm .' Add FBSDID. Do not put spaces inside []
in usage string.


# d3cb5ded 21-Mar-2002 Warner Losh <imp@FreeBSD.org>

remove __P


# d485631b 20-Mar-2002 Poul-Henning Kamp <phk@FreeBSD.org>

Unifdef __FreeBSD__

MD5 checksum of binary unchanged.


# c3103863 20-Jan-2001 Matt Jacob <mjacob@FreeBSD.org>

Print out resid portion of MTIOCGET returned data.


# 40c06817 26-Nov-2000 Kris Kennaway <kris@FreeBSD.org>

Constify


# c3aac50f 27-Aug-1999 Peter Wemm <peter@FreeBSD.org>

$Id$ -> $FreeBSD$


# dc06ef27 10-May-1999 Matt Jacob <mjacob@FreeBSD.org>

add and document seteotmodel and geteotmodel commands


# e945d9a0 10-Mar-1999 Matt Jacob <mjacob@FreeBSD.org>

Fixes alignment of blocksize field to be prettier if
longest density code && density name is used.
Obtained from: Ken Merry


# 3460adb2 09-Mar-1999 Matt Jacob <mjacob@FreeBSD.org>

get rid of space padding for compression


# c4e8e42c 01-Mar-1999 Matt Jacob <mjacob@FreeBSD.org>

Print actual density code as well as string for density- I dunno about others,
but I sure remember 0x15 easier than 'ECMA 17'. Also handle density codes
0 (default) and 0x7f ('same') as special cases.


# 4338f206 04-Feb-1999 Matt Jacob <mjacob@FreeBSD.org>

Print relative (mt_fileno, mt_blkno) position, if known.
Print driver state if not NIL.


# 2331285d 22-Dec-1998 Matt Jacob <mjacob@FreeBSD.org>

Print out latched cdb's correlated to latched errors in MTIOCERRSTAT case.

Complete the addition of the setmark support
(from Martin.Birgmeier@aon.at).


# 9b37fcd2 19-Dec-1998 Matt Jacob <mjacob@FreeBSD.org>

add in new errstat subcommand (MTIOCSERRSTAT)


# 50916429 18-Dec-1998 Matt Jacob <mjacob@FreeBSD.org>

Made changes suggested by bruce, plus a couple of others which made -Wall work.
Obtained from:bde@freebsd.org


# 69765472 17-Dec-1998 Matt Jacob <mjacob@FreeBSD.org>

1) Clarify that a weof count of zero is allowed (flush buffers).
2) Add in the set of {sethpos,setspos,rdhpos,rdspos) commands to implement the
Hardware && SCSI Logical Block position ioctls.


# fe3c6c18 03-Oct-1998 Doug Rabson <dfr@FreeBSD.org>

Don't bother trying to support Wangtek tapes on the alpha.


# bb7f7804 15-Sep-1998 Justin T. Gibbs <gibbs@FreeBSD.org>

Augment compression and blocksize support. Update table of known densities.


# f934279d 19-Apr-1998 Poul-Henning Kamp <phk@FreeBSD.org>

mt should report the compression status.

PR: 5276
Reviewed by: phk
Submitted by: Matt Dillon <dillon@best.net>


# 0ee7623d 20-Aug-1997 Joerg Wunsch <joerg@FreeBSD.org>

Implement "eod" as an alias for "eom". HP-UX uses this name, for
example.

Also cleaned up the man page a little.


# ff456ca4 29-Jul-1997 Philippe Charnier <charnier@FreeBSD.org>

Use err(3) instead of local redefinition.


# 1c8af878 28-Mar-1997 Warner Losh <imp@FreeBSD.org>

compare return value from getopt against -1 rather than EOF, per the final
posix standard on the topic.


# df3f5d9d 11-Mar-1997 Peter Wemm <peter@FreeBSD.org>

Merge from Lite2


# 0da30e9a 11-Mar-1997 Peter Wemm <peter@FreeBSD.org>

Import some parts of CSRG 4.4BSD-Lite2 usr.bin sources to fix tree build.


# 9408e822 21-Feb-1996 Joerg Wunsch <joerg@FreeBSD.org>

. cast the error and status registers properly to (unsigned short),
to avoid misinterpreting the 0x8000 bit as a negative sign,

. use the <machine/wtio.h> register def's to print them.


# a7710e48 12-Jan-1996 Joerg Wunsch <joerg@FreeBSD.org>

Rename the `retens' command into `retension', to follow existing de-facto
standards.


# 8348d96a 07-Jan-1996 Joerg Wunsch <joerg@FreeBSD.org>

Add `retens', the user frontend for MTRETENS.


# 49f544b5 21-Oct-1995 Bruce Evans <bde@FreeBSD.org>

Return early in printreg() when the pointer is NULL. For FreeBSD, the
strings describing the drive status and error bits are so deficient
that the pointer is always NULL.

Reported by: Philippe Charnier <charnier@lirmm.fr>


# a471a8c3 16-Jul-1995 Joerg Wunsch <joerg@FreeBSD.org>

Remove the dangerous "eof" command that used to be an alias for "weof"
but usually got confused with "eom". It didn't ring the warning bell
saying: "You are probably going to mark your whole tape as deleted
right now."

A warning message pointing to "weof" and "eom" is issued instead.


# 77023b92 18-Apr-1995 Joerg Wunsch <joerg@FreeBSD.org>

Make mt(1) orthogonal: now that we print the densities as strings
instead of hex, make it accept density names for input, too.


# 1146dede 17-Apr-1995 Joerg Wunsch <joerg@FreeBSD.org>

Round #1 of my st(1) -> mt(1) merge. All the commands should be
covered now, and i've attempted to give textual representations
instead of magic numbers.

The st(4) driver still misses some pieces; i'm going to implement the
EOM functionality RSN.

Any takers for the MTCOMP command? Seems to have never been implemented.


# 24619560 28-Oct-1994 Jordan K. Hubbard <jkh@FreeBSD.org>

Andreas Klemm's tape erase patches from 1.1.5.1.
Submitted by: andreas


# 9b50d902 26-May-1994 Rodney W. Grimes <rgrimes@FreeBSD.org>

BSD 4.4 Lite Usr.bin Sources