bin/dd/dd.h

   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$
  37  */
  38
  39 /* Input/output stream state. */
  40 typedef struct {
  41         u_char          *db;            /* buffer address */
  42         u_char          *dbp;           /* current buffer I/O address */
  43         ssize_t         dbcnt;          /* current buffer byte count */
  44         ssize_t         dbrcnt;         /* last read byte count */
  45         ssize_t         dbsz;           /* block size */
  46
  47 #define ISCHR           0x01            /* character device (warn on short) */
  48 #define ISPIPE          0x02            /* pipe-like (see position.c) */
  49 #define ISTAPE          0x04            /* tape */
  50 #define ISSEEK          0x08            /* valid to seek on */
  51 #define NOREAD          0x10            /* not readable */
  52 #define ISTRUNC         0x20            /* valid to ftruncate() */
  53         u_int           flags;
  54
  55         const char      *name;          /* name */
  56         int             fd;             /* file descriptor */
  57         off_t           offset;         /* # of blocks to skip */
  58         off_t           seek_offset;    /* offset of last seek past output hole */
  59 } IO;
  60
  61 typedef struct {
  62         uintmax_t       in_full;        /* # of full input blocks */
  63         uintmax_t       in_part;        /* # of partial input blocks */
  64         uintmax_t       out_full;       /* # of full output blocks */
  65         uintmax_t       out_part;       /* # of partial output blocks */
  66         uintmax_t       trunc;          /* # of truncated records */
  67         uintmax_t       swab;           /* # of odd-length swab blocks */
  68         uintmax_t       bytes;          /* # of bytes written */
  69         struct timespec start;          /* start time of dd */
  70 } STAT;
  71
  72 /* Flags (in ddflags). */
  73 #define C_ASCII         0x0000000000000001ULL
  74 #define C_BLOCK         0x0000000000000002ULL
  75 #define C_BS            0x0000000000000004ULL
  76 #define C_CBS           0x0000000000000008ULL
  77 #define C_COUNT         0x0000000000000010ULL
  78 #define C_EBCDIC        0x0000000000000020ULL
  79 #define C_FILES         0x0000000000000040ULL
  80 #define C_IBS           0x0000000000000080ULL
  81 #define C_IF            0x0000000000000100ULL
  82 #define C_LCASE         0x0000000000000200ULL
  83 #define C_NOERROR       0x0000000000000400ULL
  84 #define C_NOTRUNC       0x0000000000000800ULL
  85 #define C_OBS           0x0000000000001000ULL
  86 #define C_OF            0x0000000000002000ULL
  87 #define C_OSYNC         0x0000000000004000ULL
  88 #define C_PAREVEN       0x0000000000008000ULL
  89 #define C_PARNONE       0x0000000000010000ULL
  90 #define C_PARODD        0x0000000000020000ULL
  91 #define C_PARSET        0x0000000000040000ULL
  92 #define C_SEEK          0x0000000000080000ULL
  93 #define C_SKIP          0x0000000000100000ULL
  94 #define C_SPARSE        0x0000000000200000ULL
  95 #define C_SWAB          0x0000000000400000ULL
  96 #define C_SYNC          0x0000000000800000ULL
  97 #define C_UCASE         0x0000000001000000ULL
  98 #define C_UNBLOCK       0x0000000002000000ULL
  99 #define C_FILL          0x0000000004000000ULL
 100 #define C_STATUS        0x0000000008000000ULL
 101 #define C_NOXFER        0x0000000010000000ULL
 102 #define C_NOINFO        0x0000000020000000ULL
 103 #define C_PROGRESS      0x0000000040000000ULL
 104 #define C_FSYNC         0x0000000080000000ULL
 105 #define C_FDATASYNC     0x0000000100000000ULL
 106 #define C_OFSYNC        0x0000000200000000ULL
 107 #define C_IFULLBLOCK    0x0000000400000000ULL
 108 #define C_IDIRECT       0x0000000800000000ULL
 109 #define C_ODIRECT       0x0000001000000000ULL
 110
 111 #define C_PARITY        (C_PAREVEN | C_PARODD | C_PARNONE | C_PARSET)
 112
 113 #define BISZERO(p, s)   ((s) > 0 && *((const char *)p) == 0 && !memcmp( \
 114                             (const void *)(p), (const void *) \
 115                             ((const char *)p + 1), (s) - 1))