xref: /freebsd/tools/regression/aio/aiop/aiop.c (revision b9f654b163bce26de79705e77b872427c9f2afa1)
1 /*
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2002 Adrian Chadd <adrian@FreeBSD.org>.
5  * All rights reserved.
6  *
7  * This software was developed for the FreeBSD Project by Marshall
8  * Kirk McKusick and Network Associates Laboratories, the Security
9  * Research Division of Network Associates, Inc. under DARPA/SPAWAR
10  * contract N66001-01-C-8035 ("CBOSS"), as part of the DARPA CHATS
11  * research program.
12  *
13  * Copyright (c) 1980, 1989, 1993
14  *	The Regents of the University of California.  All rights reserved.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. Neither the name of the University nor the names of its contributors
25  *    may be used to endorse or promote products derived from this software
26  *    without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38  * SUCH DAMAGE.
39  */
40 
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
43 
44 #include <sys/types.h>
45 #include <sys/disk.h>
46 #include <sys/ioctl.h>
47 #include <sys/stat.h>
48 #include <sys/time.h>
49 #include <aio.h>
50 #include <assert.h>
51 #include <ctype.h>
52 #include <err.h>
53 #include <fcntl.h>
54 #include <stdint.h>
55 #include <stdio.h>
56 #include <stdlib.h>
57 #include <string.h>
58 #include <time.h>
59 #include <unistd.h>
60 
61 /*
62  * This is a bit of a quick hack to do parallel IO testing through POSIX AIO.
63  * Its specifically designed to work under FreeBSD and its derivatives;
64  * note how I cheat by using aio_waitcomplete().
65  *
66  * TODO:
67  *
68  * + Add write support; so we can make sure we're not hitting throughput issues
69  *   with read/modify/write of entire tracks of the disk
70  * + Add in per-op stats - time and offset - so one could start mapping out
71  *   the speed hotspots of the disk
72  * + Add in different distributions - random, normal, left/right skewed normal,
73  *   zipf, etc - and perhaps add the ability to run concurrent distributions
74  *   (so a normal and a zipf; and also a random read; zipf write, etc.)
75  *
76  * Adrian Chadd <adrian@creative.net.au>
77  */
78 
79 typedef enum {
80 	IOT_NONE = 0x00,
81 	IOT_READ = 0x01,
82 	IOT_WRITE = 0x02
83 } iot_t;
84 
85 static size_t
86 disk_getsize(int fd)
87 {
88 	off_t mediasize;
89 
90 	if (ioctl(fd, DIOCGMEDIASIZE, &mediasize) < 0)
91 		err(1, "ioctl(DIOCGMEDIASIZE)");
92 	return (mediasize);
93 }
94 
95 static iot_t
96 choose_aio(iot_t iomask)
97 {
98 	/* choose a random read or write event, limited by the mask */
99 	if (iomask == IOT_READ)
100 		return IOT_READ;
101 	else if (iomask == IOT_WRITE)
102 		return IOT_WRITE;
103 	return (random() & 0x01 ? IOT_READ : IOT_WRITE);
104 }
105 
106 static void
107 set_aio(struct aiocb *a, iot_t iot, int fd, off_t offset, int size, char *buf)
108 {
109 	int r;
110 	bzero(a, sizeof(*a));
111 	a->aio_fildes = fd;
112 	a->aio_nbytes = size;
113 	a->aio_offset = offset;
114 	a->aio_buf = buf;
115 	if (iot == IOT_READ)
116 		r = aio_read(a);
117 	else
118 		r = aio_write(a);
119 	if (r != 0)
120 		err(1, "set_aio call failed");
121 }
122 
123 int
124 main(int argc, char *argv[])
125 {
126 	int fd;
127 	struct stat sb;
128 	struct aiocb *aio;
129 	char **abuf;
130 	const char *fn;
131 	int aio_len;
132 	int io_size, nrun;
133 	off_t file_size, offset;
134 	struct aiocb *a;
135 	int i, n;
136 	struct timeval st, et, rt;
137 	float f_rt;
138 	iot_t iowhat;
139 
140 
141 	if (argc < 6) {
142 		printf("Usage: %s <file> <io size> <number of runs> <concurrency> <ro|wo|rw>\n",
143 		    argv[0]);
144 		exit(1);
145 	}
146 
147 	fn = argv[1];
148 	io_size = atoi(argv[2]);
149 	if (io_size <= 0)
150 		errx(1, "the I/O size must be >0");
151 	nrun = atoi(argv[3]);
152 	if (nrun <= 0)
153 		errx(1, "the number of runs must be >0");
154 	aio_len = atoi(argv[4]);
155 	if (aio_len <= 0)
156 		errx(1, "AIO concurrency must be >0");
157 	if (strcmp(argv[5], "ro") == 0)
158 		iowhat = IOT_READ;
159 	else if (strcmp(argv[5], "rw") == 0)
160 		iowhat = IOT_READ | IOT_WRITE;
161 	else if (strcmp(argv[5], "wo") == 0)
162 		iowhat = IOT_WRITE;
163 	else
164 		errx(1, "the I/O type needs to be \"ro\", \"rw\", or \"wo\"!\n");
165 
166 	/*
167 	 * Random returns values between 0 and (2^32)-1; only good for 4 gig.
168 	 * Lets instead treat random() as returning a block offset w/ block size
169 	 * being "io_size", so we can handle > 4 gig files.
170 	 */
171 	if (iowhat == IOT_READ)
172 		fd = open(fn, O_RDONLY | O_DIRECT);
173 	else if (iowhat == IOT_WRITE)
174 		fd = open(fn, O_WRONLY | O_DIRECT);
175 	else
176 		fd = open(fn, O_RDWR | O_DIRECT);
177 
178 	if (fd < 0)
179 		err(1, "open failed");
180 	if (fstat(fd, &sb) < 0)
181 		err(1, "fstat failed");
182 	if (S_ISREG(sb.st_mode)) {
183 		file_size = sb.st_size;
184 	} else if (S_ISBLK(sb.st_mode) || S_ISCHR(sb.st_mode)) {
185 		file_size = disk_getsize(fd);
186 	} else
187 		errx(1, "unknown file type");
188 	if (file_size <= 0)
189 		errx(1, "path provided too small");
190 
191 	printf("File: %s; File size %jd bytes\n", fn, (intmax_t)file_size);
192 
193 	aio = calloc(aio_len, sizeof(struct aiocb));
194 	abuf = calloc(aio_len, sizeof(char *));
195 	for (i = 0; i < aio_len; i++)
196 		abuf[i] = calloc(1, io_size * sizeof(char));
197 
198 	/* Fill with the initial contents */
199 	gettimeofday(&st, NULL);
200 	for (i = 0; i < aio_len; i++) {
201 		offset = random() % (file_size / io_size);
202 		offset *= io_size;
203 		set_aio(aio + i, choose_aio(iowhat), fd, offset, io_size, abuf[i]);
204 	}
205 
206 	for (i = 0; i < nrun; i++) {
207 		aio_waitcomplete(&a, NULL);
208 		n = a - aio;
209 		assert(n < aio_len);
210 		assert(n >= 0);
211 		offset = random() % (file_size / io_size);
212 		offset *= io_size;
213 		set_aio(aio + n, choose_aio(iowhat), fd, offset, io_size, abuf[n]);
214 	}
215 
216 	gettimeofday(&et, NULL);
217 	timersub(&et, &st, &rt);
218 	f_rt = ((float) (rt.tv_usec)) / 1000000.0;
219 	f_rt += (float) (rt.tv_sec);
220 	printf("Runtime: %.2f seconds, ", f_rt);
221 	printf("Op rate: %.2f ops/sec, ", ((float) (nrun))  / f_rt);
222 	printf("Avg transfer rate: %.2f bytes/sec\n", ((float) (nrun)) * ((float)io_size) / f_rt);
223 
224 
225 
226 	exit(0);
227 }
228