xref: /dragonfly/bin/dd/dd.h (revision cb2f0d05091f5dcfb3f85c1ff2d3bf3a5e6b26cf)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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  * $FreeBSD: head/bin/dd/dd.h 341257 2018-11-29 19:28:01Z sobomax $
37  */
38 
39 #include <sys/types.h>
40 #include <sys/time.h>
41 #include <stdint.h>
42 
43 /* Input/output stream state. */
44 typedef struct {
45           u_char              *db;                /* buffer address */
46           u_char              *dbp;               /* current buffer I/O address */
47           ssize_t             dbcnt;              /* current buffer byte count */
48           ssize_t             dbrcnt;             /* last read byte count */
49           ssize_t             dbsz;               /* block size */
50 
51 #define   ISCHR               0x01                /* character device (warn on short) */
52 #define   ISPIPE              0x02                /* pipe-like (see position.c) */
53 #define   ISTAPE              0x04                /* tape */
54 #define   ISSEEK              0x08                /* valid to seek on */
55 #define   NOREAD              0x10                /* not readable */
56 #define   ISTRUNC             0x20                /* valid to ftruncate() */
57           u_int               flags;
58 
59           const char          *name;              /* name */
60           int                 fd;                 /* file descriptor */
61           off_t               offset;             /* # of blocks to skip */
62           off_t               seek_offset;        /* offset of last seek past output hole */
63 } IO;
64 
65 typedef struct {
66           uintmax_t in_full;  /* # of full input blocks */
67           uintmax_t in_part;  /* # of partial input blocks */
68           uintmax_t out_full; /* # of full output blocks */
69           uintmax_t out_part; /* # of partial output blocks */
70           uintmax_t trunc;              /* # of truncated records */
71           uintmax_t swab;               /* # of odd-length swab blocks */
72           uintmax_t bytes;              /* # of bytes written */
73           struct timespec     start;              /* start time of dd */
74 } STAT;
75 
76 /* Flags (in ddflags). */
77 #define   C_ASCII             0x00000001
78 #define   C_BLOCK             0x00000002
79 #define   C_BS                0x00000004
80 #define   C_CBS               0x00000008
81 #define   C_COUNT             0x00000010
82 #define   C_EBCDIC  0x00000020
83 #define   C_FILES             0x00000040
84 #define   C_IBS               0x00000080
85 #define   C_IF                0x00000100
86 #define   C_LCASE             0x00000200
87 #define   C_NOERROR 0x00000400
88 #define   C_NOTRUNC 0x00000800
89 #define   C_OBS               0x00001000
90 #define   C_OF                0x00002000
91 #define   C_OSYNC             0x00004000
92 #define   C_PAREVEN 0x00008000
93 #define   C_PARNONE 0x00010000
94 #define   C_PARODD  0x00020000
95 #define   C_PARSET  0x00040000
96 #define   C_SEEK              0x00080000
97 #define   C_SKIP              0x00100000
98 #define   C_SPARSE  0x00200000
99 #define   C_SWAB              0x00400000
100 #define   C_SYNC              0x00800000
101 #define   C_UCASE             0x01000000
102 #define   C_UNBLOCK 0x02000000
103 #define   C_FILL              0x04000000
104 #define   C_STATUS  0x08000000
105 #define   C_NOXFER  0x10000000
106 #define   C_NOINFO  0x20000000
107 #define   C_PROGRESS          0x40000000
108 
109 #define   C_PARITY  (C_PAREVEN | C_PARODD | C_PARNONE | C_PARSET)
110 
111 #define   BISZERO(p, s)       ((s) > 0 && *((const char *)p) == 0 && \
112                                    !memcmp((const void *)(p), \
113                                         (const void *)((const char *)p + 1), \
114                                         (s) - 1))
115