43518607b2
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 |
||
---|---|---|
.. | ||
contrib | ||
doc | ||
font | ||
man | ||
src | ||
tmac | ||
aclocal.m4 | ||
BUG-REPORT | ||
ChangeLog | ||
ChangeLog.115 | ||
ChangeLog.116 | ||
ChangeLog.117 | ||
ChangeLog.118 | ||
configure | ||
configure.ac | ||
COPYING | ||
FDL | ||
FREEBSD-upgrade | ||
FREEBSD-Xlist | ||
gendef.sh | ||
INSTALL | ||
install-sh | ||
INSTALL.gen | ||
LICENSE | ||
Makefile | ||
Makefile.ccpg | ||
Makefile.comm | ||
Makefile.cpg | ||
Makefile.dev | ||
Makefile.in | ||
Makefile.init | ||
Makefile.lib | ||
Makefile.man | ||
Makefile.sub | ||
MANIFEST | ||
mdate.sh | ||
mkinstalldirs | ||
MORE.STUFF | ||
NEWS | ||
PROBLEMS | ||
PROJECTS | ||
README | ||
README.MinGW | ||
REVISION | ||
stamp-h.in | ||
test-groff.in | ||
TODO | ||
VERSION |
This is the GNU `groff' document formatting system. The version number is given in the file VERSION. Included in this release are implementations of `troff', `pic', `eqn', `tbl', `grn', `refer', `-man', `-mdoc', `-mom', and `-ms' macros, and drivers for `PostScript', `TeX dvi' format, `HP LaserJet 4' printers, `Canon CAPSL' printers, `HTML' format (beta status), and typewriter-like devices. Also included is a modified version of the Berkeley `-me' macros, the enhanced version `gxditview' of the X11 `xditview' previewer, and an implementation of the `-mm' macros contributed by Joergen Haegg (jh@axis.se). See the file `INSTALL' for installation instructions. You will require a C++ compiler. The file `NEWS' describes recent user-visible changes to `groff'. `groff' is free software. See the file `COPYING' for copying permission. The file `PROBLEMS' describes various problems that have been encountered in compiling, installing, and running `groff'. The most recent released version of `groff' is always available by anonymous ftp from `ftp.gnu.org' in the directory `gnu/groff'. The current development version of `groff' is available from a `CVS' repository. You can access it by first selecting a parent directory in which to create a working copy (call it, say, `~/cvswork'), and then executing the commands cd ~/cvswork CVS_RSH=ssh; export CVS_RSH cvs -d:ext:anoncvs@savannah.gnu.org/cvsroot/groff -z5 co groff (Note that you need an `ssh' client for security reasons.) This will create a subdirectory, `~/cvswork/groff', with a "checked out" copy of the `CVS' repository. An update of this working copy may be achieved, at any later time by invoking the commands cd ~/cvswork/groff CVS_RSH=ssh cvs -z5 update -dP Please read the `CVS' info pages for further details. Finally, it is possible to access the `CVS' with a web browser by pointing it to http://savannah.gnu.org/cvs/?group=groff Alternatively, you can download snapshots (which are updated twice a day). The complete `groff' source as a single file is available at http://groff.ffii.org/groff/devel/groff-current.tar.gz A diff file relative to `groff-<version>', the latest official `groff' release is available at http://groff.ffii.org/groff/devel/groff-<version>-current.diff.gz Assuming that `groff-<version>.tar.gz' and `groff-<version>-current.diff.gz' are in the same directory, do the following to apply the diff file: tar xzvf groff-<version>.tar.gz cd groff-<version> gunzip -c ../groff-<version>-current.diff.gz | patch -p1 Depending on your requirements, you may need at least some of the following tools to build `groff' directly from its source: ghostscript the psutils package the netpbm package texinfo 4.8 bison >= 1.875b or byacc Note that `texinfo' and `bison' or `byacc' are required only for building from `CVS' sources (either a checked out working copy, or a daily snapshot). They are not required for building from a stable release tarball. Also note that the version numbers stated are the minimum supported. No version of `texinfo' < 4.8 will work, and the original release of `bison' 1.875 is known not to work; you *may* find that `bison' releases < 1.875 will work, but in case of difficulty, please update to a later version *before* posting a bug report. For *all* sources, you need ghostscript for creation of either `PDF' or `HTML' output; the `netpbm' and `psutils' packages are required only for `HTML' output. If you don't intend to produce output in either of these formats, then these packages are unnecessary. In Linux Debian, the installation of `texinfo' is dangerous. For it creates a file `install-info' that will block the system installation. So the created `/usr/local/bin/install-info' must be renamed. The `groff' configure script searches for the X11 headers and libraries `Xaw' and `Xmu'. So the corresponding developer packages of your system must be installed, otherwise `groff' does not install `gxditview' and the `-TX*' devices. In Debian, the developer packages are `libxaw7-dev' and `libxmu-dev'. Please report bugs using the form in the file `BUG-REPORT'; the idea of this is to make sure that FSF has all the information it needs to fix the bug. At the very least, read the `BUG-REPORT' form and make sure that you supply all the information that it asks for. Even if you are not sure that something is a bug, report it using `BUG-REPORT': this will enable us to determine whether it really is a bug or not. Three mailing lists are available: bug-groff@gnu.org for reporting bugs groff@gnu.org for general discussion of groff groff-commit@gnu.org a read-only list showing commitments to the CVS repository You can post mails directly to the `bug-groff' list, without subscribing; to post mails to the `groff' list you must subscribe to it. To subscribe, send a mail to <list>-request@<domain> (example: groff-request@gnu.org for the `groff' list) with the word `subscribe' in either the subject or body of the email (don't include the quotes). Alternatively, you may subscribe by visiting the web pages at http://lists.gnu.org/mailman/listinfo/bug-groff http://lists.gnu.org/mailman/listinfo/groff http://lists.gnu.org/mailman/listinfo/groff-commit Each of these web pages also provides a link to a browseable archive of postings to the corresponding mailing list. GNU `groff' was written by James Clark <jjc@jclark.com>. It is now maintained by Ted Harding <ted.harding@nessie.mcc.ac.uk> and Werner Lemberg <wl@gnu.org>.