Home | History | Annotate | Line # | Download | only in dd
      1 /*	$NetBSD: dd.h,v 1.16 2015/03/18 13:23:49 manu Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1991, 1993, 1994
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * This code is derived from software contributed to Berkeley by
      8  * Keith Muller of the University of California, San Diego and Lance
      9  * Visser of Convex Computer Corporation.
     10  *
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice, this list of conditions and the following disclaimer.
     16  * 2. Redistributions in binary form must reproduce the above copyright
     17  *    notice, this list of conditions and the following disclaimer in the
     18  *    documentation and/or other materials provided with the distribution.
     19  * 3. Neither the name of the University nor the names of its contributors
     20  *    may be used to endorse or promote products derived from this software
     21  *    without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  *	@(#)dd.h	8.3 (Berkeley) 4/2/94
     36  */
     37 
     38 #include <sys/stat.h>
     39 
     40 struct ddfops {
     41 	int (*op_init)(void);
     42 
     43 	int (*op_open)(const char *, int, ...);
     44 	int (*op_close)(int);
     45 
     46 	int (*op_fcntl)(int, int, ...);
     47 	int (*op_ioctl)(int, unsigned long, ...);
     48 
     49 	int (*op_fstat)(int, struct stat *);
     50 	int (*op_fsync)(int);
     51 	int (*op_ftruncate)(int, off_t);
     52 
     53 	off_t (*op_lseek)(int, off_t, int);
     54 
     55 	ssize_t (*op_read)(int, void *, size_t);
     56 	ssize_t (*op_write)(int, const void *, size_t);
     57 };
     58 
     59 #define ddop_open(dir, a1, a2, ...)	dir.ops->op_open(a1, a2, __VA_ARGS__)
     60 #define ddop_close(dir, a1)		dir.ops->op_close(a1)
     61 #define ddop_fcntl(dir, a1, a2, ...)	dir.ops->op_fcntl(a1, a2, __VA_ARGS__)
     62 #define ddop_ioctl(dir, a1, a2, ...)	dir.ops->op_ioctl(a1, a2, __VA_ARGS__)
     63 #define ddop_fsync(dir, a1)		dir.ops->op_fsync(a1)
     64 #define ddop_ftruncate(dir, a1, a2)	dir.ops->op_ftruncate(a1, a2)
     65 #define ddop_lseek(dir, a1, a2, a3)	dir.ops->op_lseek(a1, a2, a3)
     66 #define ddop_read(dir, a1, a2, a3)	dir.ops->op_read(a1, a2, a3)
     67 #define ddop_write(dir, a1, a2, a3)	dir.ops->op_write(a1, a2, a3)
     68 
     69 /* Input/output stream state. */
     70 typedef struct {
     71 	u_char		*db;		/* buffer address */
     72 	u_char		*dbp;		/* current buffer I/O address */
     73 	uint64_t	dbcnt;		/* current buffer byte count */
     74 	int64_t		dbrcnt;		/* last read byte count */
     75 	uint64_t	dbsz;		/* buffer size */
     76 
     77 #define	ISCHR		0x01		/* character device (warn on short) */
     78 #define	ISPIPE		0x02		/* pipe (not truncatable) */
     79 #define	ISTAPE		0x04		/* tape (not seekable) */
     80 #define	NOREAD		0x08		/* not readable */
     81 	u_int		flags;
     82 
     83 	const char  	*name;		/* name */
     84 	int		fd;		/* file descriptor */
     85 	uint64_t	offset;		/* # of blocks to skip */
     86 	struct ddfops	const *ops;	/* ops to use with fd */
     87 } IO;
     88 
     89 typedef struct {
     90 	uint64_t	in_full;	/* # of full input blocks */
     91 	uint64_t	in_part;	/* # of partial input blocks */
     92 	uint64_t	out_full;	/* # of full output blocks */
     93 	uint64_t	out_part;	/* # of partial output blocks */
     94 	uint64_t	trunc;		/* # of truncated records */
     95 	uint64_t	swab;		/* # of odd-length swab blocks */
     96 	uint64_t	sparse;		/* # of sparse output blocks */
     97 	uint64_t	bytes;		/* # of bytes written */
     98 	struct timeval	start;		/* start time of dd */
     99 } STAT;
    100 
    101 /* Flags (in ddflags, iflag and oflag). */
    102 #define	C_NONE		0x00000
    103 #define	C_ASCII		0x00001
    104 #define	C_BLOCK		0x00002
    105 #define	C_BS		0x00004
    106 #define	C_CBS		0x00008
    107 #define	C_COUNT		0x00010
    108 #define	C_EBCDIC	0x00020
    109 #define	C_FILES		0x00040
    110 #define	C_IBS		0x00080
    111 #define	C_IF		0x00100
    112 #define	C_LCASE		0x00200
    113 #define	C_NOERROR	0x00400
    114 #define	C_NOTRUNC	0x00800
    115 #define	C_OBS		0x01000
    116 #define	C_OF		0x02000
    117 #define	C_SEEK		0x04000
    118 #define	C_SKIP		0x08000
    119 #define	C_SWAB		0x10000
    120 #define	C_SYNC		0x20000
    121 #define	C_UCASE		0x40000
    122 #define	C_UNBLOCK	0x80000
    123 #define	C_OSYNC		0x100000
    124 #define	C_SPARSE	0x200000
    125 #define	C_IFLAG		0x400000
    126 #define	C_OFLAG		0x800000
    127