Add timestamp to json output
[fio.git] / engines / mmap.c
... / ...
CommitLineData
1/*
2 * mmap engine
3 *
4 * IO engine that reads/writes from files by doing memcpy to/from
5 * a memory mapped region of the file.
6 *
7 */
8#include <stdio.h>
9#include <stdlib.h>
10#include <unistd.h>
11#include <errno.h>
12#include <sys/mman.h>
13
14#include "../fio.h"
15#include "../verify.h"
16
17/*
18 * Limits us to 1GB of mapped files in total
19 */
20#define MMAP_TOTAL_SZ (1 * 1024 * 1024 * 1024UL)
21
22static unsigned long mmap_map_size;
23static unsigned long mmap_map_mask;
24
25struct fio_mmap_data {
26 void *mmap_ptr;
27 size_t mmap_sz;
28 off_t mmap_off;
29};
30
31static int fio_mmap_file(struct thread_data *td, struct fio_file *f,
32 size_t length, off_t off)
33{
34 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
35 int flags = 0;
36
37 if (td_rw(td))
38 flags = PROT_READ | PROT_WRITE;
39 else if (td_write(td)) {
40 flags = PROT_WRITE;
41
42 if (td->o.verify != VERIFY_NONE)
43 flags |= PROT_READ;
44 } else
45 flags = PROT_READ;
46
47 fmd->mmap_ptr = mmap(NULL, length, flags, MAP_SHARED, f->fd, off);
48 if (fmd->mmap_ptr == MAP_FAILED) {
49 fmd->mmap_ptr = NULL;
50 td_verror(td, errno, "mmap");
51 goto err;
52 }
53
54 if (!td_random(td)) {
55 if (posix_madvise(fmd->mmap_ptr, length, POSIX_MADV_SEQUENTIAL) < 0) {
56 td_verror(td, errno, "madvise");
57 goto err;
58 }
59 } else {
60 if (posix_madvise(fmd->mmap_ptr, length, POSIX_MADV_RANDOM) < 0) {
61 td_verror(td, errno, "madvise");
62 goto err;
63 }
64 }
65
66err:
67 if (td->error && fmd->mmap_ptr)
68 munmap(fmd->mmap_ptr, length);
69
70 return td->error;
71}
72
73/*
74 * Just mmap an appropriate portion, we cannot mmap the full extent
75 */
76static int fio_mmapio_prep_limited(struct thread_data *td, struct io_u *io_u)
77{
78 struct fio_file *f = io_u->file;
79 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
80
81 if (io_u->buflen > mmap_map_size) {
82 log_err("fio: bs too big for mmap engine\n");
83 return EIO;
84 }
85
86 fmd->mmap_sz = mmap_map_size;
87 if (fmd->mmap_sz > f->io_size)
88 fmd->mmap_sz = f->io_size;
89
90 fmd->mmap_off = io_u->offset;
91
92 return fio_mmap_file(td, f, fmd->mmap_sz, fmd->mmap_off);
93}
94
95/*
96 * Attempt to mmap the entire file
97 */
98static int fio_mmapio_prep_full(struct thread_data *td, struct io_u *io_u)
99{
100 struct fio_file *f = io_u->file;
101 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
102 int ret;
103
104 if (fio_file_partial_mmap(f))
105 return EINVAL;
106 if (io_u->offset != (size_t) io_u->offset ||
107 f->io_size != (size_t) f->io_size) {
108 fio_file_set_partial_mmap(f);
109 return EINVAL;
110 }
111
112 fmd->mmap_sz = f->io_size;
113 fmd->mmap_off = 0;
114
115 ret = fio_mmap_file(td, f, fmd->mmap_sz, fmd->mmap_off);
116 if (ret)
117 fio_file_set_partial_mmap(f);
118
119 return ret;
120}
121
122static int fio_mmapio_prep(struct thread_data *td, struct io_u *io_u)
123{
124 struct fio_file *f = io_u->file;
125 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
126 int ret;
127
128 /*
129 * It fits within existing mapping, use it
130 */
131 if (io_u->offset >= fmd->mmap_off &&
132 io_u->offset + io_u->buflen < fmd->mmap_off + fmd->mmap_sz)
133 goto done;
134
135 /*
136 * unmap any existing mapping
137 */
138 if (fmd->mmap_ptr) {
139 if (munmap(fmd->mmap_ptr, fmd->mmap_sz) < 0)
140 return errno;
141 fmd->mmap_ptr = NULL;
142 }
143
144 if (fio_mmapio_prep_full(td, io_u)) {
145 td_clear_error(td);
146 ret = fio_mmapio_prep_limited(td, io_u);
147 if (ret)
148 return ret;
149 }
150
151done:
152 io_u->mmap_data = fmd->mmap_ptr + io_u->offset - fmd->mmap_off -
153 f->file_offset;
154 return 0;
155}
156
157static int fio_mmapio_queue(struct thread_data *td, struct io_u *io_u)
158{
159 struct fio_file *f = io_u->file;
160 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
161
162 fio_ro_check(td, io_u);
163
164 if (io_u->ddir == DDIR_READ)
165 memcpy(io_u->xfer_buf, io_u->mmap_data, io_u->xfer_buflen);
166 else if (io_u->ddir == DDIR_WRITE)
167 memcpy(io_u->mmap_data, io_u->xfer_buf, io_u->xfer_buflen);
168 else if (ddir_sync(io_u->ddir)) {
169 if (msync(fmd->mmap_ptr, fmd->mmap_sz, MS_SYNC)) {
170 io_u->error = errno;
171 td_verror(td, io_u->error, "msync");
172 }
173 } else if (io_u->ddir == DDIR_TRIM) {
174 int ret = do_io_u_trim(td, io_u);
175
176 if (!ret)
177 td_verror(td, io_u->error, "trim");
178 }
179
180
181 /*
182 * not really direct, but should drop the pages from the cache
183 */
184 if (td->o.odirect && ddir_rw(io_u->ddir)) {
185 if (msync(io_u->mmap_data, io_u->xfer_buflen, MS_SYNC) < 0) {
186 io_u->error = errno;
187 td_verror(td, io_u->error, "msync");
188 }
189 if (posix_madvise(io_u->mmap_data, io_u->xfer_buflen, POSIX_MADV_DONTNEED) < 0) {
190 io_u->error = errno;
191 td_verror(td, io_u->error, "madvise");
192 }
193 }
194
195 return FIO_Q_COMPLETED;
196}
197
198static int fio_mmapio_init(struct thread_data *td)
199{
200 struct thread_options *o = &td->o;
201 unsigned long shift, mask;
202
203 if ((td->o.rw_min_bs & page_mask) &&
204 (o->odirect || o->fsync_blocks || o->fdatasync_blocks)) {
205 log_err("fio: mmap options dictate a minimum block size of "
206 "%llu bytes\n", (unsigned long long) page_size);
207 return 1;
208 }
209
210 mmap_map_size = MMAP_TOTAL_SZ / td->o.nr_files;
211 mask = mmap_map_size;
212 shift = 0;
213 do {
214 mask >>= 1;
215 if (!mask)
216 break;
217 shift++;
218 } while (1);
219
220 mmap_map_mask = 1UL << shift;
221 return 0;
222}
223
224static int fio_mmapio_open_file(struct thread_data *td, struct fio_file *f)
225{
226 struct fio_mmap_data *fmd;
227 int ret;
228
229 ret = generic_open_file(td, f);
230 if (ret)
231 return ret;
232
233 fmd = calloc(1, sizeof(*fmd));
234 if (!fmd) {
235 int fio_unused ret;
236 ret = generic_close_file(td, f);
237 return 1;
238 }
239
240 FILE_SET_ENG_DATA(f, fmd);
241 return 0;
242}
243
244static int fio_mmapio_close_file(struct thread_data *td, struct fio_file *f)
245{
246 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
247
248 FILE_SET_ENG_DATA(f, NULL);
249 free(fmd);
250 fio_file_clear_partial_mmap(f);
251
252 return generic_close_file(td, f);
253}
254
255static int fio_mmapio_invalidate(struct thread_data *td, struct fio_file *f)
256{
257 struct fio_mmap_data *fmd = FILE_ENG_DATA(f);
258 int ret;
259
260 ret = posix_madvise(fmd->mmap_ptr, fmd->mmap_sz, POSIX_MADV_DONTNEED);
261#ifdef FIO_MADV_FREE
262 if (f->filetype == FIO_TYPE_BD)
263 (void) posix_madvise(fmd->mmap_ptr, fmd->mmap_sz, FIO_MADV_FREE);
264#endif
265
266 return ret;
267}
268
269static struct ioengine_ops ioengine = {
270 .name = "mmap",
271 .version = FIO_IOOPS_VERSION,
272 .init = fio_mmapio_init,
273 .prep = fio_mmapio_prep,
274 .queue = fio_mmapio_queue,
275 .open_file = fio_mmapio_open_file,
276 .close_file = fio_mmapio_close_file,
277 .invalidate = fio_mmapio_invalidate,
278 .get_file_size = generic_get_file_size,
279 .flags = FIO_SYNCIO | FIO_NOEXTEND,
280};
281
282static void fio_init fio_mmapio_register(void)
283{
284 register_ioengine(&ioengine);
285}
286
287static void fio_exit fio_mmapio_unregister(void)
288{
289 unregister_ioengine(&ioengine);
290}