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