xref: /freebsd/bin/dd/dd.h (revision 41059135ce931c0f1014a999ffabc6bc470ce856)
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. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	@(#)dd.h	8.3 (Berkeley) 4/2/94
34  * $FreeBSD$
35  */
36 
37 /* Input/output stream state. */
38 typedef struct {
39 	u_char		*db;		/* buffer address */
40 	u_char		*dbp;		/* current buffer I/O address */
41 	/* XXX ssize_t? */
42 	size_t		dbcnt;		/* current buffer byte count */
43 	size_t		dbrcnt;		/* last read byte count */
44 	size_t		dbsz;		/* block size */
45 
46 #define	ISCHR		0x01		/* character device (warn on short) */
47 #define	ISPIPE		0x02		/* pipe-like (see position.c) */
48 #define	ISTAPE		0x04		/* tape */
49 #define	ISSEEK		0x08		/* valid to seek on */
50 #define	NOREAD		0x10		/* not readable */
51 #define	ISTRUNC		0x20		/* valid to ftruncate() */
52 	u_int		flags;
53 
54 	const char	*name;		/* name */
55 	int		fd;		/* file descriptor */
56 	off_t		offset;		/* # of blocks to skip */
57 	off_t		seek_offset;	/* offset of last seek past output hole */
58 } IO;
59 
60 typedef struct {
61 	uintmax_t	in_full;	/* # of full input blocks */
62 	uintmax_t	in_part;	/* # of partial input blocks */
63 	uintmax_t	out_full;	/* # of full output blocks */
64 	uintmax_t	out_part;	/* # of partial output blocks */
65 	uintmax_t	trunc;		/* # of truncated records */
66 	uintmax_t	swab;		/* # of odd-length swab blocks */
67 	uintmax_t	bytes;		/* # of bytes written */
68 	struct timespec	start;		/* start time of dd */
69 } STAT;
70 
71 /* Flags (in ddflags). */
72 #define	C_ASCII		0x00000001
73 #define	C_BLOCK		0x00000002
74 #define	C_BS		0x00000004
75 #define	C_CBS		0x00000008
76 #define	C_COUNT		0x00000010
77 #define	C_EBCDIC	0x00000020
78 #define	C_FILES		0x00000040
79 #define	C_IBS		0x00000080
80 #define	C_IF		0x00000100
81 #define	C_LCASE		0x00000200
82 #define	C_NOERROR	0x00000400
83 #define	C_NOTRUNC	0x00000800
84 #define	C_OBS		0x00001000
85 #define	C_OF		0x00002000
86 #define	C_OSYNC		0x00004000
87 #define	C_PAREVEN	0x00008000
88 #define	C_PARNONE	0x00010000
89 #define	C_PARODD	0x00020000
90 #define	C_PARSET	0x00040000
91 #define	C_SEEK		0x00080000
92 #define	C_SKIP		0x00100000
93 #define	C_SPARSE	0x00200000
94 #define	C_SWAB		0x00400000
95 #define	C_SYNC		0x00800000
96 #define	C_UCASE		0x01000000
97 #define	C_UNBLOCK	0x02000000
98 #define	C_FILL		0x04000000
99 #define	C_STATUS	0x08000000
100 #define	C_NOXFER	0x10000000
101 #define	C_NOINFO	0x20000000
102 
103 #define	C_PARITY	(C_PAREVEN | C_PARODD | C_PARNONE | C_PARSET)
104