xref: /freebsd/bin/dd/misc.c (revision a0409676120c1e558d0ade943019934e0f15118d)
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 
36 #ifndef lint
37 #if 0
38 static char sccsid[] = "@(#)misc.c	8.3 (Berkeley) 4/2/94";
39 #endif
40 #endif /* not lint */
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
43 
44 #include <sys/types.h>
45 
46 #include <err.h>
47 #include <errno.h>
48 #include <inttypes.h>
49 #include <libutil.h>
50 #include <signal.h>
51 #include <stdio.h>
52 #include <stdlib.h>
53 #include <string.h>
54 #include <time.h>
55 #include <unistd.h>
56 
57 #include "dd.h"
58 #include "extern.h"
59 
60 double
61 secs_elapsed(void)
62 {
63 	struct timespec end, ts_res;
64 	double secs, res;
65 
66 	if (clock_gettime(CLOCK_MONOTONIC, &end))
67 		err(1, "clock_gettime");
68 	if (clock_getres(CLOCK_MONOTONIC, &ts_res))
69 		err(1, "clock_getres");
70 	secs = (end.tv_sec - st.start.tv_sec) + \
71 	       (end.tv_nsec - st.start.tv_nsec) * 1e-9;
72 	res = ts_res.tv_sec + ts_res.tv_nsec * 1e-9;
73 	if (secs < res)
74 		secs = res;
75 
76 	return (secs);
77 }
78 
79 void
80 summary(void)
81 {
82 	double secs;
83 
84 	if (ddflags & C_NOINFO)
85 		return;
86 
87 	if (ddflags & C_PROGRESS)
88 		fprintf(stderr, "\n");
89 
90 	secs = secs_elapsed();
91 
92 	(void)fprintf(stderr,
93 	    "%ju+%ju records in\n%ju+%ju records out\n",
94 	    st.in_full, st.in_part, st.out_full, st.out_part);
95 	if (st.swab)
96 		(void)fprintf(stderr, "%ju odd length swab %s\n",
97 		     st.swab, (st.swab == 1) ? "block" : "blocks");
98 	if (st.trunc)
99 		(void)fprintf(stderr, "%ju truncated %s\n",
100 		     st.trunc, (st.trunc == 1) ? "block" : "blocks");
101 	if (!(ddflags & C_NOXFER)) {
102 		(void)fprintf(stderr,
103 		    "%ju bytes transferred in %.6f secs (%.0f bytes/sec)\n",
104 		    st.bytes, secs, st.bytes / secs);
105 	}
106 	need_summary = 0;
107 }
108 
109 void
110 progress(void)
111 {
112 	static int outlen;
113 	char si[4 + 1 + 2 + 1];		/* 123 <space> <suffix> NUL */
114 	char iec[4 + 1 + 3 + 1];	/* 123 <space> <suffix> NUL */
115 	char persec[4 + 1 + 2 + 1];	/* 123 <space> <suffix> NUL */
116 	char *buf;
117 	double secs;
118 
119 	secs = secs_elapsed();
120 	humanize_number(si, sizeof(si), (int64_t)st.bytes, "B", HN_AUTOSCALE,
121 	    HN_DECIMAL | HN_DIVISOR_1000);
122 	humanize_number(iec, sizeof(iec), (int64_t)st.bytes, "B", HN_AUTOSCALE,
123 	    HN_DECIMAL | HN_IEC_PREFIXES);
124 	humanize_number(persec, sizeof(persec), (int64_t)(st.bytes / secs), "B",
125 	    HN_AUTOSCALE, HN_DECIMAL | HN_DIVISOR_1000);
126 	asprintf(&buf, "  %'ju bytes (%s, %s) transferred %.3fs, %s/s",
127 	    (uintmax_t)st.bytes, si, iec, secs, persec);
128 	outlen = fprintf(stderr, "%-*s\r", outlen, buf) - 1;
129 	fflush(stderr);
130 	free(buf);
131 	need_progress = 0;
132 }
133 
134 /* ARGSUSED */
135 void
136 siginfo_handler(int signo __unused)
137 {
138 
139 	need_summary = 1;
140 }
141 
142 /* ARGSUSED */
143 void
144 sigalarm_handler(int signo __unused)
145 {
146 
147 	need_progress = 1;
148 }
149 
150 /* ARGSUSED */
151 void
152 terminate(int sig)
153 {
154 
155 	summary();
156 	_exit(sig == 0 ? 0 : 1);
157 }
158