xref: /freebsd/bin/dd/dd.h (revision 6a3d33ac)
1 /*-
2  * Copyright (c) 1991, 1993, 1994
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Keith Muller of the University of California, San Diego and Lance
7  * Visser of Convex Computer Corporation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)dd.h	8.3 (Berkeley) 4/2/94
38  * $FreeBSD$
39  */
40 
41 /* Input/output stream state. */
42 typedef struct {
43 	u_char		*db;		/* buffer address */
44 	u_char		*dbp;		/* current buffer I/O address */
45 	/* XXX ssize_t? */
46 	size_t		dbcnt;		/* current buffer byte count */
47 	size_t		dbrcnt;		/* last read byte count */
48 	size_t		dbsz;		/* buffer size */
49 
50 #define	ISCHR		0x01		/* character device (warn on short) */
51 #define	ISPIPE		0x02		/* pipe-like (see position.c) */
52 #define	ISTAPE		0x04		/* tape */
53 #define	ISSEEK		0x08		/* valid to seek on */
54 #define	NOREAD		0x10		/* not readable */
55 #define	ISTRUNC		0x20		/* valid to ftruncate() */
56 	u_int		flags;
57 
58 	const char 	*name;		/* name */
59 	int		fd;		/* file descriptor */
60 	off_t		offset;		/* # of blocks to skip */
61 
62 } IO;
63 
64 typedef struct {
65 	uintmax_t	in_full;	/* # of full input blocks */
66 	uintmax_t	in_part;	/* # of partial input blocks */
67 	uintmax_t	out_full;	/* # of full output blocks */
68 	uintmax_t	out_part;	/* # of partial output blocks */
69 	uintmax_t	trunc;		/* # of truncated records */
70 	uintmax_t	swab;		/* # of odd-length swab blocks */
71 	uintmax_t	bytes;		/* # of bytes written */
72 	double		start; 			/* start time of dd */
73 } STAT;
74 
75 /* Flags (in ddflags). */
76 #define	C_ASCII		0x00001
77 #define	C_BLOCK		0x00002
78 #define	C_BS		0x00004
79 #define	C_CBS		0x00008
80 #define	C_COUNT		0x00010
81 #define	C_EBCDIC	0x00020
82 #define	C_FILES		0x00040
83 #define	C_IBS		0x00080
84 #define	C_IF		0x00100
85 #define	C_LCASE		0x00200
86 #define	C_NOERROR	0x00400
87 #define	C_NOTRUNC	0x00800
88 #define	C_OBS		0x01000
89 #define	C_OF		0x02000
90 #define	C_SEEK		0x04000
91 #define	C_SKIP		0x08000
92 #define	C_SWAB		0x10000
93 #define	C_SYNC		0x20000
94 #define	C_UCASE		0x40000
95 #define	C_UNBLOCK	0x80000
96 #define	C_OSYNC		0x100000
97 #define	C_SPARSE	0x200000
98 #define C_PAREVEN	0x400000
99 #define C_PARODD	0x800000
100 #define C_PARSET	0x1000000
101 #define C_PARNONE	0x2000000
102 
103 #define C_PARITY	(C_PAREVEN|C_PARODD|C_PARSET|C_PARNONE)
104