arch/um/os-Linux/aio.c

   1 /*
   2  * Copyright (C) 2004 Jeff Dike (jdike@addtoit.com)
   3  * Licensed under the GPL
   4  */
   5
   6 #include <stdlib.h>
   7 #include <unistd.h>
   8 #include <signal.h>
   9 #include <errno.h>
  10 #include <sched.h>
  11 #include <sys/syscall.h>
  12 #include "os.h"
  13 #include "aio.h"
  14 #include "init.h"
  15 #include "user.h"
  16 #include "mode.h"
  17
  18 struct aio_thread_req {
  19         enum aio_type type;
  20         int io_fd;
  21         unsigned long long offset;
  22         char *buf;
  23         int len;
  24         struct aio_context *aio;
  25 };
  26
  27 #if defined(HAVE_AIO_ABI)
  28 #include <linux/aio_abi.h>
  29
  30 /* If we have the headers, we are going to build with AIO enabled.
  31  * If we don't have aio in libc, we define the necessary stubs here.
  32  */
  33
  34 #if !defined(HAVE_AIO_LIBC)
  35
  36 static long io_setup(int n, aio_context_t *ctxp)
  37 {
  38         return syscall(__NR_io_setup, n, ctxp);
  39 }
  40
  41 static long io_submit(aio_context_t ctx, long nr, struct iocb **iocbpp)
  42 {
  43         return syscall(__NR_io_submit, ctx, nr, iocbpp);
  44 }
  45
  46 static long io_getevents(aio_context_t ctx_id, long min_nr, long nr,
  47                          struct io_event *events, struct timespec *timeout)
  48 {
  49         return syscall(__NR_io_getevents, ctx_id, min_nr, nr, events, timeout);
  50 }
  51
  52 #endif
  53
  54 /* The AIO_MMAP cases force the mmapped page into memory here
  55  * rather than in whatever place first touches the data.  I used
  56  * to do this by touching the page, but that's delicate because
  57  * gcc is prone to optimizing that away.  So, what's done here
  58  * is we read from the descriptor from which the page was
  59  * mapped.  The caller is required to pass an offset which is
  60  * inside the page that was mapped.  Thus, when the read
  61  * returns, we know that the page is in the page cache, and
  62  * that it now backs the mmapped area.
  63  */
  64
  65 static int do_aio(aio_context_t ctx, enum aio_type type, int fd, char *buf,
  66                   int len, unsigned long long offset, struct aio_context *aio)
  67 {
  68         struct iocb iocb, *iocbp = &iocb;
  69         char c;
  70         int err;
  71
  72         iocb = ((struct iocb) { .aio_data       = (unsigned long) aio,
  73                                 .aio_reqprio    = 0,
  74                                 .aio_fildes     = fd,
  75                                 .aio_buf        = (unsigned long) buf,
  76                                 .aio_nbytes     = len,
  77                                 .aio_offset     = offset,
  78                                 .aio_reserved1  = 0,
  79                                 .aio_reserved2  = 0,
  80                                 .aio_reserved3  = 0 });
  81
  82         switch(type){
  83         case AIO_READ:
  84                 iocb.aio_lio_opcode = IOCB_CMD_PREAD;
  85                 err = io_submit(ctx, 1, &iocbp);
  86                 break;
  87         case AIO_WRITE:
  88                 iocb.aio_lio_opcode = IOCB_CMD_PWRITE;
  89                 err = io_submit(ctx, 1, &iocbp);
  90                 break;
  91         case AIO_MMAP:
  92                 iocb.aio_lio_opcode = IOCB_CMD_PREAD;
  93                 iocb.aio_buf = (unsigned long) &c;
  94                 iocb.aio_nbytes = sizeof(c);
  95                 err = io_submit(ctx, 1, &iocbp);
  96                 break;
  97         default:
  98                 printk("Bogus op in do_aio - %d\n", type);
  99                 err = -EINVAL;
 100                 break;
 101         }
 102
 103         if(err > 0)
 104                 err = 0;
 105         else
 106                 err = -errno;
 107
 108         return err;
 109 }
 110
 111 /* Initialized in an initcall and unchanged thereafter */
 112 static aio_context_t ctx = 0;
 113
 114 static int aio_thread(void *arg)
 115 {
 116         struct aio_thread_reply reply;
 117         struct io_event event;
 118         int err, n, reply_fd;
 119
 120         signal(SIGWINCH, SIG_IGN);
 121
 122         while(1){
 123                 n = io_getevents(ctx, 1, 1, &event, NULL);
 124                 if(n < 0){
 125                         if(errno == EINTR)
 126                                 continue;
 127                         printk("aio_thread - io_getevents failed, "
 128                                "errno = %d\n", errno);
 129                 }
 130                 else {
 131                         reply = ((struct aio_thread_reply)
 132                                 { .data = (void *) (long) event.data,
 133                                                 .err    = event.res });
 134                         reply_fd = ((struct aio_context *) reply.data)->reply_fd;
 135                         err = write(reply_fd, &reply, sizeof(reply));
 136                         if(err != sizeof(reply))
 137                                 printk("aio_thread - write failed, fd = %d, "
 138                                        "err = %d\n", reply_fd, errno);
 139                 }
 140         }
 141         return 0;
 142 }
 143
 144 #endif
 145
 146 static int do_not_aio(struct aio_thread_req *req)
 147 {
 148         char c;
 149         unsigned long long actual;
 150         int n;
 151
 152         actual = lseek64(req->io_fd, req->offset, SEEK_SET);
 153         if(actual != req->offset)
 154                 return -errno;
 155
 156         switch(req->type){
 157         case AIO_READ:
 158                 n = read(req->io_fd, req->buf, req->len);
 159                 break;
 160         case AIO_WRITE:
 161                 n = write(req->io_fd, req->buf, req->len);
 162                 break;
 163         case AIO_MMAP:
 164                 n = read(req->io_fd, &c, sizeof(c));
 165                 break;
 166         default:
 167                 printk("do_not_aio - bad request type : %d\n", req->type);
 168                 return -EINVAL;
 169         }
 170
 171         if(n < 0)
 172                 return -errno;
 173         return 0;
 174 }
 175
 176 /* These are initialized in initcalls and not changed */
 177 static int aio_req_fd_r = -1;
 178 static int aio_req_fd_w = -1;
 179 static int aio_pid = -1;
 180 static unsigned long aio_stack;
 181
 182 static int not_aio_thread(void *arg)
 183 {
 184         struct aio_thread_req req;
 185         struct aio_thread_reply reply;
 186         int err;
 187
 188         signal(SIGWINCH, SIG_IGN);
 189         while(1){
 190                 err = read(aio_req_fd_r, &req, sizeof(req));
 191                 if(err != sizeof(req)){
 192                         if(err < 0)
 193                                 printk("not_aio_thread - read failed, "
 194                                        "fd = %d, err = %d\n", aio_req_fd_r,
 195                                        errno);
 196                         else {
 197                                 printk("not_aio_thread - short read, fd = %d, "
 198                                        "length = %d\n", aio_req_fd_r, err);
 199                         }
 200                         continue;
 201                 }
 202                 err = do_not_aio(&req);
 203                 reply = ((struct aio_thread_reply) { .data      = req.aio,
 204                                                      .err       = err });
 205                 err = write(req.aio->reply_fd, &reply, sizeof(reply));
 206                 if(err != sizeof(reply))
 207                         printk("not_aio_thread - write failed, fd = %d, "
 208                                "err = %d\n", req.aio->reply_fd, errno);
 209         }
 210
 211         return 0;
 212 }
 213
 214 static int init_aio_24(void)
 215 {
 216         int fds[2], err;
 217
 218         err = os_pipe(fds, 1, 1);
 219         if(err)
 220                 goto out;
 221
 222         aio_req_fd_w = fds[0];
 223         aio_req_fd_r = fds[1];
 224
 225         err = os_set_fd_block(aio_req_fd_w, 0);
 226         if(err)
 227                 goto out_close_pipe;
 228
 229         err = run_helper_thread(not_aio_thread, NULL,
 230                                 CLONE_FILES | CLONE_VM | SIGCHLD, &aio_stack);
 231         if(err < 0)
 232                 goto out_close_pipe;
 233
 234         aio_pid = err;
 235         goto out;
 236
 237 out_close_pipe:
 238         os_close_file(fds[0]);
 239         os_close_file(fds[1]);
 240         aio_req_fd_w = -1;
 241         aio_req_fd_r = -1;
 242 out:
 243 #ifndef HAVE_AIO_ABI
 244         printk("/usr/include/linux/aio_abi.h not present during build\n");
 245 #endif
 246         printk("2.6 host AIO support not used - falling back to I/O "
 247                "thread\n");
 248         return 0;
 249 }
 250
 251 #ifdef HAVE_AIO_ABI
 252 #define DEFAULT_24_AIO 0
 253 static int init_aio_26(void)
 254 {
 255         int err;
 256
 257         if(io_setup(256, &ctx)){
 258                 err = -errno;
 259                 printk("aio_thread failed to initialize context, err = %d\n",
 260                        errno);
 261                 return err;
 262         }
 263
 264         err = run_helper_thread(aio_thread, NULL,
 265                                 CLONE_FILES | CLONE_VM | SIGCHLD, &aio_stack);
 266         if(err < 0)
 267                 return err;
 268
 269         aio_pid = err;
 270
 271         printk("Using 2.6 host AIO\n");
 272         return 0;
 273 }
 274
 275 static int submit_aio_26(enum aio_type type, int io_fd, char *buf, int len,
 276                          unsigned long long offset, struct aio_context *aio)
 277 {
 278         struct aio_thread_reply reply;
 279         int err;
 280
 281         err = do_aio(ctx, type, io_fd, buf, len, offset, aio);
 282         if(err){
 283                 reply = ((struct aio_thread_reply) { .data = aio,
 284                                          .err  = err });
 285                 err = write(aio->reply_fd, &reply, sizeof(reply));
 286                 if(err != sizeof(reply)){
 287                         err = -errno;
 288                         printk("submit_aio_26 - write failed, "
 289                                "fd = %d, err = %d\n", aio->reply_fd, -err);
 290                 }
 291                 else err = 0;
 292         }
 293
 294         return err;
 295 }
 296
 297 #else
 298 #define DEFAULT_24_AIO 1
 299 static int init_aio_26(void)
 300 {
 301         return -ENOSYS;
 302 }
 303
 304 static int submit_aio_26(enum aio_type type, int io_fd, char *buf, int len,
 305                          unsigned long long offset, struct aio_context *aio)
 306 {
 307         return -ENOSYS;
 308 }
 309 #endif
 310
 311 /* Initialized in an initcall and unchanged thereafter */
 312 static int aio_24 = DEFAULT_24_AIO;
 313
 314 static int __init set_aio_24(char *name, int *add)
 315 {
 316         aio_24 = 1;
 317         return 0;
 318 }
 319
 320 __uml_setup("aio=2.4", set_aio_24,
 321 "aio=2.4\n"
 322 "    This is used to force UML to use 2.4-style AIO even when 2.6 AIO is\n"
 323 "    available.  2.4 AIO is a single thread that handles one request at a\n"
 324 "    time, synchronously.  2.6 AIO is a thread which uses the 2.6 AIO \n"
 325 "    interface to handle an arbitrary number of pending requests.  2.6 AIO \n"
 326 "    is not available in tt mode, on 2.4 hosts, or when UML is built with\n"
 327 "    /usr/include/linux/aio_abi.h not available.  Many distributions don't\n"
 328 "    include aio_abi.h, so you will need to copy it from a kernel tree to\n"
 329 "    your /usr/include/linux in order to build an AIO-capable UML\n\n"
 330 );
 331
 332 static int init_aio(void)
 333 {
 334         int err;
 335
 336         CHOOSE_MODE(({ if(!aio_24){
 337                             printk("Disabling 2.6 AIO in tt mode\n");
 338                             aio_24 = 1;
 339                     } }), (void) 0);
 340
 341         if(!aio_24){
 342                 err = init_aio_26();
 343                 if(err && (errno == ENOSYS)){
 344                         printk("2.6 AIO not supported on the host - "
 345                                "reverting to 2.4 AIO\n");
 346                         aio_24 = 1;
 347                 }
 348                 else return err;
 349         }
 350
 351         if(aio_24)
 352                 return init_aio_24();
 353
 354         return 0;
 355 }
 356
 357 /* The reason for the __initcall/__uml_exitcall asymmetry is that init_aio
 358  * needs to be called when the kernel is running because it calls run_helper,
 359  * which needs get_free_page.  exit_aio is a __uml_exitcall because the generic
 360  * kernel does not run __exitcalls on shutdown, and can't because many of them
 361  * break when called outside of module unloading.
 362  */
 363 __initcall(init_aio);
 364
 365 static void exit_aio(void)
 366 {
 367         if (aio_pid != -1) {
 368                 os_kill_process(aio_pid, 1);
 369                 free_stack(aio_stack, 0);
 370         }
 371 }
 372
 373 __uml_exitcall(exit_aio);
 374
 375 static int submit_aio_24(enum aio_type type, int io_fd, char *buf, int len,
 376                          unsigned long long offset, struct aio_context *aio)
 377 {
 378         struct aio_thread_req req = { .type             = type,
 379                                       .io_fd            = io_fd,
 380                                       .offset           = offset,
 381                                       .buf              = buf,
 382                                       .len              = len,
 383                                       .aio              = aio,
 384         };
 385         int err;
 386
 387         err = write(aio_req_fd_w, &req, sizeof(req));
 388         if(err == sizeof(req))
 389                 err = 0;
 390         else err = -errno;
 391
 392         return err;
 393 }
 394
 395 int submit_aio(enum aio_type type, int io_fd, char *buf, int len,
 396                unsigned long long offset, int reply_fd,
 397                struct aio_context *aio)
 398 {
 399         aio->reply_fd = reply_fd;
 400         if(aio_24)
 401                 return submit_aio_24(type, io_fd, buf, len, offset, aio);
 402         else {
 403                 return submit_aio_26(type, io_fd, buf, len, offset, aio);
 404         }
 405 }