splice: don't use void* for pointer arithmetic (gcc)
[fio.git] / engines / splice.c
1 /*
2  * splice engine
3  *
4  * IO engine that transfers data by doing splices to/from pipes and
5  * the files.
6  *
7  */
8 #include <stdio.h>
9 #include <stdlib.h>
10 #include <unistd.h>
11 #include <errno.h>
12 #include <assert.h>
13 #include <sys/poll.h>
14 #include <sys/mman.h>
15
16 #include "../fio.h"
17
18 struct spliceio_data {
19         int pipe[2];
20         int vmsplice_to_user;
21         int vmsplice_to_user_map;
22 };
23
24 /*
25  * vmsplice didn't use to support splicing to user space, this is the old
26  * variant of getting that job done. Doesn't make a lot of sense, but it
27  * uses splices to move data from the source into a pipe.
28  */
29 static int fio_splice_read_old(struct thread_data *td, struct io_u *io_u)
30 {
31         struct spliceio_data *sd = td->io_ops_data;
32         struct fio_file *f = io_u->file;
33         int ret, ret2, buflen;
34         off_t offset;
35         char *p;
36
37         offset = io_u->offset;
38         buflen = io_u->xfer_buflen;
39         p = io_u->xfer_buf;
40         while (buflen) {
41                 int this_len = buflen;
42
43                 if (this_len > SPLICE_DEF_SIZE)
44                         this_len = SPLICE_DEF_SIZE;
45
46                 ret = splice(f->fd, &offset, sd->pipe[1], NULL, this_len, SPLICE_F_MORE);
47                 if (ret < 0) {
48                         if (errno == ENODATA || errno == EAGAIN)
49                                 continue;
50
51                         return -errno;
52                 }
53
54                 buflen -= ret;
55
56                 while (ret) {
57                         ret2 = read(sd->pipe[0], p, ret);
58                         if (ret2 < 0)
59                                 return -errno;
60
61                         ret -= ret2;
62                         p += ret2;
63                 }
64         }
65
66         return io_u->xfer_buflen;
67 }
68
69 /*
70  * We can now vmsplice into userspace, so do the transfer by splicing into
71  * a pipe and vmsplicing that into userspace.
72  */
73 static int fio_splice_read(struct thread_data *td, struct io_u *io_u)
74 {
75         struct spliceio_data *sd = td->io_ops_data;
76         struct fio_file *f = io_u->file;
77         struct iovec iov;
78         int ret , buflen, mmap_len;
79         off_t offset;
80         void *map;
81         char *p;
82
83         ret = 0;
84         offset = io_u->offset;
85         mmap_len = buflen = io_u->xfer_buflen;
86
87         if (sd->vmsplice_to_user_map) {
88                 map = mmap(io_u->xfer_buf, buflen, PROT_READ, MAP_PRIVATE|OS_MAP_ANON, 0, 0);
89                 if (map == MAP_FAILED) {
90                         td_verror(td, errno, "mmap io_u");
91                         return -1;
92                 }
93
94                 p = map;
95         } else {
96                 map = NULL;
97                 p = io_u->xfer_buf;
98         }
99
100         while (buflen) {
101                 int this_len = buflen;
102                 int flags = 0;
103
104                 if (this_len > SPLICE_DEF_SIZE) {
105                         this_len = SPLICE_DEF_SIZE;
106                         flags = SPLICE_F_MORE;
107                 }
108
109                 ret = splice(f->fd, &offset, sd->pipe[1], NULL, this_len,flags);
110                 if (ret < 0) {
111                         if (errno == ENODATA || errno == EAGAIN)
112                                 continue;
113
114                         td_verror(td, errno, "splice-from-fd");
115                         break;
116                 }
117
118                 buflen -= ret;
119                 iov.iov_base = p;
120                 iov.iov_len = ret;
121
122                 while (iov.iov_len) {
123                         ret = vmsplice(sd->pipe[0], &iov, 1, SPLICE_F_MOVE);
124                         if (ret < 0) {
125                                 if (errno == EFAULT &&
126                                     sd->vmsplice_to_user_map) {
127                                         sd->vmsplice_to_user_map = 0;
128                                         munmap(map, mmap_len);
129                                         map = NULL;
130                                         p = io_u->xfer_buf;
131                                         iov.iov_base = p;
132                                         continue;
133                                 }
134                                 if (errno == EBADF) {
135                                         ret = -EBADF;
136                                         break;
137                                 }
138                                 td_verror(td, errno, "vmsplice");
139                                 break;
140                         } else if (!ret) {
141                                 td_verror(td, ENODATA, "vmsplice");
142                                 ret = -1;
143                                 break;
144                         }
145
146                         iov.iov_len -= ret;
147                         iov.iov_base += ret;
148                         p += ret;
149                 }
150                 if (ret < 0)
151                         break;
152         }
153
154         if (sd->vmsplice_to_user_map && munmap(map, mmap_len) < 0) {
155                 td_verror(td, errno, "munnap io_u");
156                 return -1;
157         }
158         if (ret < 0)
159                 return ret;
160
161         return io_u->xfer_buflen;
162 }
163
164 /*
165  * For splice writing, we can vmsplice our data buffer directly into a
166  * pipe and then splice that to a file.
167  */
168 static int fio_splice_write(struct thread_data *td, struct io_u *io_u)
169 {
170         struct spliceio_data *sd = td->io_ops_data;
171         struct iovec iov = {
172                 .iov_base = io_u->xfer_buf,
173                 .iov_len = io_u->xfer_buflen,
174         };
175         struct pollfd pfd = { .fd = sd->pipe[1], .events = POLLOUT, };
176         struct fio_file *f = io_u->file;
177         off_t off = io_u->offset;
178         int ret, ret2;
179
180         while (iov.iov_len) {
181                 if (poll(&pfd, 1, -1) < 0)
182                         return errno;
183
184                 ret = vmsplice(sd->pipe[1], &iov, 1, SPLICE_F_NONBLOCK);
185                 if (ret < 0)
186                         return -errno;
187
188                 iov.iov_len -= ret;
189                 iov.iov_base += ret;
190
191                 while (ret) {
192                         ret2 = splice(sd->pipe[0], NULL, f->fd, &off, ret, 0);
193                         if (ret2 < 0)
194                                 return -errno;
195
196                         ret -= ret2;
197                 }
198         }
199
200         return io_u->xfer_buflen;
201 }
202
203 static int fio_spliceio_queue(struct thread_data *td, struct io_u *io_u)
204 {
205         struct spliceio_data *sd = td->io_ops_data;
206         int ret = 0;
207
208         fio_ro_check(td, io_u);
209
210         if (io_u->ddir == DDIR_READ) {
211                 if (sd->vmsplice_to_user) {
212                         ret = fio_splice_read(td, io_u);
213                         /*
214                          * This kernel doesn't support vmsplice to user
215                          * space. Reset the vmsplice_to_user flag, so that
216                          * we retry below and don't hit this path again.
217                          */
218                         if (ret == -EBADF)
219                                 sd->vmsplice_to_user = 0;
220                 }
221                 if (!sd->vmsplice_to_user)
222                         ret = fio_splice_read_old(td, io_u);
223         } else if (io_u->ddir == DDIR_WRITE)
224                 ret = fio_splice_write(td, io_u);
225         else if (io_u->ddir == DDIR_TRIM)
226                 ret = do_io_u_trim(td, io_u);
227         else
228                 ret = do_io_u_sync(td, io_u);
229
230         if (ret != (int) io_u->xfer_buflen) {
231                 if (ret >= 0) {
232                         io_u->resid = io_u->xfer_buflen - ret;
233                         io_u->error = 0;
234                         return FIO_Q_COMPLETED;
235                 } else
236                         io_u->error = errno;
237         }
238
239         if (io_u->error) {
240                 td_verror(td, io_u->error, "xfer");
241                 if (io_u->error == EINVAL)
242                         log_err("fio: looks like splice doesn't work on this"
243                                         " file system\n");
244         }
245
246         return FIO_Q_COMPLETED;
247 }
248
249 static void fio_spliceio_cleanup(struct thread_data *td)
250 {
251         struct spliceio_data *sd = td->io_ops_data;
252
253         if (sd) {
254                 close(sd->pipe[0]);
255                 close(sd->pipe[1]);
256                 free(sd);
257         }
258 }
259
260 static int fio_spliceio_init(struct thread_data *td)
261 {
262         struct spliceio_data *sd = malloc(sizeof(*sd));
263
264         if (pipe(sd->pipe) < 0) {
265                 td_verror(td, errno, "pipe");
266                 free(sd);
267                 return 1;
268         }
269
270         /*
271          * Assume this work, we'll reset this if it doesn't
272          */
273         sd->vmsplice_to_user = 1;
274
275         /*
276          * Works with "real" vmsplice to user, eg mapping pages directly.
277          * Reset if we fail.
278          */
279         sd->vmsplice_to_user_map = 1;
280
281         /*
282          * And if vmsplice_to_user works, we definitely need aligned
283          * buffers. Just set ->odirect to force that.
284          */
285         if (td_read(td))
286                 td->o.mem_align = 1;
287
288         td->io_ops_data = sd;
289         return 0;
290 }
291
292 static struct ioengine_ops ioengine = {
293         .name           = "splice",
294         .version        = FIO_IOOPS_VERSION,
295         .init           = fio_spliceio_init,
296         .queue          = fio_spliceio_queue,
297         .cleanup        = fio_spliceio_cleanup,
298         .open_file      = generic_open_file,
299         .close_file     = generic_close_file,
300         .get_file_size  = generic_get_file_size,
301         .flags          = FIO_SYNCIO | FIO_PIPEIO,
302 };
303
304 static void fio_init fio_spliceio_register(void)
305 {
306         register_ioengine(&ioengine);
307 }
308
309 static void fio_exit fio_spliceio_unregister(void)
310 {
311         unregister_ioengine(&ioengine);
312 }