nsz Git - musl/blob - src/aio/aio.c

   1 #include <aio.h>
   2 #include <pthread.h>
   3 #include <semaphore.h>
   4 #include <limits.h>
   5 #include <errno.h>
   6 #include <unistd.h>
   7 #include <stdlib.h>
   8 #include <sys/auxv.h>
   9 #include "syscall.h"
  10 #include "atomic.h"
  11 #include "pthread_impl.h"
  12
  13 /* The following is a threads-based implementation of AIO with minimal
  14  * dependence on implementation details. Most synchronization is
  15  * performed with pthread primitives, but atomics and futex operations
  16  * are used for notification in a couple places where the pthread
  17  * primitives would be inefficient or impractical.
  18  *
  19  * For each fd with outstanding aio operations, an aio_queue structure
  20  * is maintained. These are reference-counted and destroyed by the last
  21  * aio worker thread to exit. Accessing any member of the aio_queue
  22  * structure requires a lock on the aio_queue. Adding and removing aio
  23  * queues themselves requires a write lock on the global map object,
  24  * a 4-level table mapping file descriptor numbers to aio queues. A
  25  * read lock on the map is used to obtain locks on existing queues by
  26  * excluding destruction of the queue by a different thread while it is
  27  * being locked.
  28  *
  29  * Each aio queue has a list of active threads/operations. Presently there
  30  * is a one to one relationship between threads and operations. The only
  31  * members of the aio_thread structure which are accessed by other threads
  32  * are the linked list pointers, op (which is immutable), running (which
  33  * is updated atomically), and err (which is synchronized via running),
  34  * so no locking is necessary. Most of the other other members are used
  35  * for sharing data between the main flow of execution and cancellation
  36  * cleanup handler.
  37  *
  38  * Taking any aio locks requires having all signals blocked. This is
  39  * necessary because aio_cancel is needed by close, and close is required
  40  * to be async-signal safe. All aio worker threads run with all signals
  41  * blocked permanently.
  42  */
  43
  44 struct aio_thread {
  45         pthread_t td;
  46         struct aiocb *cb;
  47         struct aio_thread *next, *prev;
  48         struct aio_queue *q;
  49         volatile int running;
  50         int err, op;
  51         ssize_t ret;
  52 };
  53
  54 struct aio_queue {
  55         int fd, seekable, append, ref, init;
  56         pthread_mutex_t lock;
  57         pthread_cond_t cond;
  58         struct aio_thread *head;
  59 };
  60
  61 struct aio_args {
  62         struct aiocb *cb;
  63         struct aio_queue *q;
  64         int op;
  65         sem_t sem;
  66 };
  67
  68 static pthread_rwlock_t maplock = PTHREAD_RWLOCK_INITIALIZER;
  69 static struct aio_queue *****map;
  70 static volatile int aio_fd_cnt;
  71 volatile int __aio_fut;
  72
  73 static struct aio_queue *__aio_get_queue(int fd, int need)
  74 {
  75         if (fd < 0) return 0;
  76         int a=fd>>24;
  77         unsigned char b=fd>>16, c=fd>>8, d=fd;
  78         struct aio_queue *q = 0;
  79         pthread_rwlock_rdlock(&maplock);
  80         if ((!map || !map[a] || !map[a][b] || !map[a][b][c] || !(q=map[a][b][c][d])) && need) {
  81                 pthread_rwlock_unlock(&maplock);
  82                 pthread_rwlock_wrlock(&maplock);
  83                 if (!map) map = calloc(sizeof *map, (-1U/2+1)>>24);
  84                 if (!map) goto out;
  85                 if (!map[a]) map[a] = calloc(sizeof **map, 256);
  86                 if (!map[a]) goto out;
  87                 if (!map[a][b]) map[a][b] = calloc(sizeof ***map, 256);
  88                 if (!map[a][b]) goto out;
  89                 if (!map[a][b][c]) map[a][b][c] = calloc(sizeof ****map, 256);
  90                 if (!map[a][b][c]) goto out;
  91                 if (!(q = map[a][b][c][d])) {
  92                         map[a][b][c][d] = q = calloc(sizeof *****map, 1);
  93                         if (q) {
  94                                 q->fd = fd;
  95                                 pthread_mutex_init(&q->lock, 0);
  96                                 pthread_cond_init(&q->cond, 0);
  97                                 a_inc(&aio_fd_cnt);
  98                         }
  99                 }
 100         }
 101         if (q) pthread_mutex_lock(&q->lock);
 102 out:
 103         pthread_rwlock_unlock(&maplock);
 104         return q;
 105 }
 106
 107 static void __aio_unref_queue(struct aio_queue *q)
 108 {
 109         if (q->ref > 1) {
 110                 q->ref--;
 111                 pthread_mutex_unlock(&q->lock);
 112                 return;
 113         }
 114
 115         /* This is potentially the last reference, but a new reference
 116          * may arrive since we cannot free the queue object without first
 117          * taking the maplock, which requires releasing the queue lock. */
 118         pthread_mutex_unlock(&q->lock);
 119         pthread_rwlock_wrlock(&maplock);
 120         pthread_mutex_lock(&q->lock);
 121         if (q->ref == 1) {
 122                 int fd=q->fd;
 123                 int a=fd>>24;
 124                 unsigned char b=fd>>16, c=fd>>8, d=fd;
 125                 map[a][b][c][d] = 0;
 126                 a_dec(&aio_fd_cnt);
 127                 pthread_rwlock_unlock(&maplock);
 128                 pthread_mutex_unlock(&q->lock);
 129                 free(q);
 130         } else {
 131                 q->ref--;
 132                 pthread_rwlock_unlock(&maplock);
 133                 pthread_mutex_unlock(&q->lock);
 134         }
 135 }
 136
 137 static void cleanup(void *ctx)
 138 {
 139         struct aio_thread *at = ctx;
 140         struct aio_queue *q = at->q;
 141         struct aiocb *cb = at->cb;
 142         struct sigevent sev = cb->aio_sigevent;
 143
 144         /* There are four potential types of waiters we could need to wake:
 145          *   1. Callers of aio_cancel/close.
 146          *   2. Callers of aio_suspend with a single aiocb.
 147          *   3. Callers of aio_suspend with a list.
 148          *   4. AIO worker threads waiting for sequenced operations.
 149          * Types 1-3 are notified via atomics/futexes, mainly for AS-safety
 150          * considerations. Type 4 is notified later via a cond var. */
 151
 152         cb->__ret = at->ret;
 153         if (a_swap(&at->running, 0) < 0)
 154                 __wake(&at->running, -1, 1);
 155         if (a_swap(&cb->__err, at->err) != EINPROGRESS)
 156                 __wake(&cb->__err, -1, 1);
 157         if (a_swap(&__aio_fut, 0))
 158                 __wake(&__aio_fut, -1, 1);
 159
 160         pthread_mutex_lock(&q->lock);
 161
 162         if (at->next) at->next->prev = at->prev;
 163         if (at->prev) at->prev->next = at->next;
 164         else q->head = at->next;
 165
 166         /* Signal aio worker threads waiting for sequenced operations. */
 167         pthread_cond_broadcast(&q->cond);
 168
 169         __aio_unref_queue(q);
 170
 171         if (sev.sigev_notify == SIGEV_SIGNAL) {
 172                 siginfo_t si = {
 173                         .si_signo = sev.sigev_signo,
 174                         .si_value = sev.sigev_value,
 175                         .si_code = SI_ASYNCIO,
 176                         .si_pid = getpid(),
 177                         .si_uid = getuid()
 178                 };
 179                 __syscall(SYS_rt_sigqueueinfo, si.si_pid, si.si_signo, &si);
 180         }
 181         if (sev.sigev_notify == SIGEV_THREAD) {
 182                 a_store(&__pthread_self()->cancel, 0);
 183                 sev.sigev_notify_function(sev.sigev_value);
 184         }
 185 }
 186
 187 static void *io_thread_func(void *ctx)
 188 {
 189         struct aio_thread at, *p;
 190
 191         struct aio_args *args = ctx;
 192         struct aiocb *cb = args->cb;
 193         int fd = cb->aio_fildes;
 194         int op = args->op;
 195         void *buf = (void *)cb->aio_buf;
 196         size_t len = cb->aio_nbytes;
 197         off_t off = cb->aio_offset;
 198
 199         struct aio_queue *q = args->q;
 200         ssize_t ret;
 201
 202         pthread_mutex_lock(&q->lock);
 203         sem_post(&args->sem);
 204
 205         at.op = op;
 206         at.running = 1;
 207         at.ret = -1;
 208         at.err = ECANCELED;
 209         at.q = q;
 210         at.td = __pthread_self();
 211         at.cb = cb;
 212         at.prev = 0;
 213         if ((at.next = q->head)) at.next->prev = &at;
 214         q->head = &at;
 215
 216         if (!q->init) {
 217                 int seekable = lseek(fd, 0, SEEK_CUR) >= 0;
 218                 q->seekable = seekable;
 219                 q->append = !seekable || (fcntl(fd, F_GETFL) & O_APPEND);
 220                 q->init = 1;
 221         }
 222
 223         pthread_cleanup_push(cleanup, &at);
 224
 225         /* Wait for sequenced operations. */
 226         if (op!=LIO_READ && (op!=LIO_WRITE || q->append)) {
 227                 for (;;) {
 228                         for (p=at.next; p && p->op!=LIO_WRITE; p=p->next);
 229                         if (!p) break;
 230                         pthread_cond_wait(&q->cond, &q->lock);
 231                 }
 232         }
 233
 234         pthread_mutex_unlock(&q->lock);
 235
 236         switch (op) {
 237         case LIO_WRITE:
 238                 ret = q->append ? write(fd, buf, len) : pwrite(fd, buf, len, off);
 239                 break;
 240         case LIO_READ:
 241                 ret = !q->seekable ? read(fd, buf, len) : pread(fd, buf, len, off);
 242                 break;
 243         case O_SYNC:
 244                 ret = fsync(fd);
 245                 break;
 246         case O_DSYNC:
 247                 ret = fdatasync(fd);
 248                 break;
 249         }
 250         at.ret = ret;
 251         at.err = ret<0 ? errno : 0;
 252
 253         pthread_cleanup_pop(1);
 254
 255         return 0;
 256 }
 257
 258 static size_t io_thread_stack_size = MINSIGSTKSZ+2048;
 259 static pthread_once_t init_stack_size_once;
 260
 261 static void init_stack_size()
 262 {
 263         unsigned long val = __getauxval(AT_MINSIGSTKSZ);
 264         if (val > MINSIGSTKSZ) io_thread_stack_size = val + 512;
 265 }
 266
 267 static int submit(struct aiocb *cb, int op)
 268 {
 269         int ret = 0;
 270         pthread_attr_t a;
 271         sigset_t allmask, origmask;
 272         pthread_t td;
 273         struct aio_queue *q = __aio_get_queue(cb->aio_fildes, 1);
 274         struct aio_args args = { .cb = cb, .op = op, .q = q };
 275         sem_init(&args.sem, 0, 0);
 276
 277         if (!q) {
 278                 if (cb->aio_fildes < 0) errno = EBADF;
 279                 else errno = EAGAIN;
 280                 return -1;
 281         }
 282         q->ref++;
 283         pthread_mutex_unlock(&q->lock);
 284
 285         if (cb->aio_sigevent.sigev_notify == SIGEV_THREAD) {
 286                 if (cb->aio_sigevent.sigev_notify_attributes)
 287                         a = *cb->aio_sigevent.sigev_notify_attributes;
 288                 else
 289                         pthread_attr_init(&a);
 290         } else {
 291                 pthread_once(&init_stack_size_once, init_stack_size);
 292                 pthread_attr_init(&a);
 293                 pthread_attr_setstacksize(&a, io_thread_stack_size);
 294                 pthread_attr_setguardsize(&a, 0);
 295         }
 296         pthread_attr_setdetachstate(&a, PTHREAD_CREATE_DETACHED);
 297         sigfillset(&allmask);
 298         pthread_sigmask(SIG_BLOCK, &allmask, &origmask);
 299         cb->__err = EINPROGRESS;
 300         if (pthread_create(&td, &a, io_thread_func, &args)) {
 301                 pthread_mutex_lock(&q->lock);
 302                 __aio_unref_queue(q);
 303                 errno = EAGAIN;
 304                 ret = -1;
 305         }
 306         pthread_sigmask(SIG_SETMASK, &origmask, 0);
 307
 308         if (!ret) {
 309                 while (sem_wait(&args.sem));
 310         }
 311
 312         return ret;
 313 }
 314
 315 int aio_read(struct aiocb *cb)
 316 {
 317         return submit(cb, LIO_READ);
 318 }
 319
 320 int aio_write(struct aiocb *cb)
 321 {
 322         return submit(cb, LIO_WRITE);
 323 }
 324
 325 int aio_fsync(int op, struct aiocb *cb)
 326 {
 327         if (op != O_SYNC && op != O_DSYNC) {
 328                 errno = EINVAL;
 329                 return -1;
 330         }
 331         return submit(cb, op);
 332 }
 333
 334 ssize_t aio_return(struct aiocb *cb)
 335 {
 336         return cb->__ret;
 337 }
 338
 339 int aio_error(const struct aiocb *cb)
 340 {
 341         a_barrier();
 342         return cb->__err & 0x7fffffff;
 343 }
 344
 345 int aio_cancel(int fd, struct aiocb *cb)
 346 {
 347         sigset_t allmask, origmask;
 348         int ret = AIO_ALLDONE;
 349         struct aio_thread *p;
 350         struct aio_queue *q;
 351
 352         /* Unspecified behavior case. Report an error. */
 353         if (cb && fd != cb->aio_fildes) {
 354                 errno = EINVAL;
 355                 return -1;
 356         }
 357
 358         sigfillset(&allmask);
 359         pthread_sigmask(SIG_BLOCK, &allmask, &origmask);
 360
 361         if (!(q = __aio_get_queue(fd, 0))) {
 362                 if (fcntl(fd, F_GETFD) < 0) ret = -1;
 363                 goto done;
 364         }
 365
 366         for (p = q->head; p; p = p->next) {
 367                 if (cb && cb != p->cb) continue;
 368                 /* Transition target from running to running-with-waiters */
 369                 if (a_cas(&p->running, 1, -1)) {
 370                         pthread_cancel(p->td);
 371                         __wait(&p->running, 0, -1, 1);
 372                         if (p->err == ECANCELED) ret = AIO_CANCELED;
 373                 }
 374         }
 375
 376         pthread_mutex_unlock(&q->lock);
 377 done:
 378         pthread_sigmask(SIG_SETMASK, &origmask, 0);
 379         return ret;
 380 }
 381
 382 int __aio_close(int fd)
 383 {
 384         a_barrier();
 385         if (aio_fd_cnt) aio_cancel(fd, 0);
 386         return fd;
 387 }
 388
 389 weak_alias(aio_cancel, aio_cancel64);
 390 weak_alias(aio_error, aio_error64);
 391 weak_alias(aio_fsync, aio_fsync64);
 392 weak_alias(aio_read, aio_read64);
 393 weak_alias(aio_write, aio_write64);
 394 weak_alias(aio_return, aio_return64);