server/async.c

   1 /*
   2  * Server-side async I/O support
   3  *
   4  * Copyright (C) 2007 Alexandre Julliard
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <assert.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <stdarg.h>
  25
  26 #include "ntstatus.h"
  27 #define WIN32_NO_STATUS
  28 #include "windef.h"
  29 #include "winternl.h"
  30
  31 #include "object.h"
  32 #include "file.h"
  33 #include "request.h"
  34 #include "process.h"
  35 #include "handle.h"
  36
  37 struct async
  38 {
  39     struct object        obj;             /* object header */
  40     struct thread       *thread;          /* owning thread */
  41     struct list          queue_entry;     /* entry in async queue list */
  42     struct list          process_entry;   /* entry in process list */
  43     struct async_queue  *queue;           /* queue containing this async */
  44     unsigned int         status;          /* current status */
  45     struct timeout_user *timeout;
  46     unsigned int         timeout_status;  /* status to report upon timeout */
  47     int                  signaled;
  48     struct event        *event;
  49     async_data_t         data;            /* data for async I/O call */
  50     struct iosb         *iosb;            /* I/O status block */
  51 };
  52
  53 static void async_dump( struct object *obj, int verbose );
  54 static int async_signaled( struct object *obj, struct wait_queue_entry *entry );
  55 static void async_destroy( struct object *obj );
  56
  57 static const struct object_ops async_ops =
  58 {
  59     sizeof(struct async),      /* size */
  60     async_dump,                /* dump */
  61     no_get_type,               /* get_type */
  62     add_queue,                 /* add_queue */
  63     remove_queue,              /* remove_queue */
  64     async_signaled,            /* signaled */
  65     no_satisfied,              /* satisfied */
  66     no_signal,                 /* signal */
  67     no_get_fd,                 /* get_fd */
  68     no_map_access,             /* map_access */
  69     default_get_sd,            /* get_sd */
  70     default_set_sd,            /* set_sd */
  71     no_lookup_name,            /* lookup_name */
  72     no_link_name,              /* link_name */
  73     NULL,                      /* unlink_name */
  74     no_open_file,              /* open_file */
  75     no_close_handle,           /* close_handle */
  76     async_destroy              /* destroy */
  77 };
  78
  79
  80 struct async_queue
  81 {
  82     struct object        obj;             /* object header */
  83     struct fd           *fd;              /* file descriptor owning this queue */
  84     struct completion   *completion;      /* completion associated with a recently closed file descriptor */
  85     apc_param_t          comp_key;        /* completion key associated with a recently closed file descriptor */
  86     struct list          queue;           /* queue of async objects */
  87 };
  88
  89 static void async_queue_dump( struct object *obj, int verbose );
  90 static void async_queue_destroy( struct object *obj );
  91
  92 static const struct object_ops async_queue_ops =
  93 {
  94     sizeof(struct async_queue),      /* size */
  95     async_queue_dump,                /* dump */
  96     no_get_type,                     /* get_type */
  97     no_add_queue,                    /* add_queue */
  98     NULL,                            /* remove_queue */
  99     NULL,                            /* signaled */
 100     NULL,                            /* satisfied */
 101     no_signal,                       /* signal */
 102     no_get_fd,                       /* get_fd */
 103     no_map_access,                   /* map_access */
 104     default_get_sd,                  /* get_sd */
 105     default_set_sd,                  /* set_sd */
 106     no_lookup_name,                  /* lookup_name */
 107     no_link_name,                    /* link_name */
 108     NULL,                            /* unlink_name */
 109     no_open_file,                    /* open_file */
 110     no_close_handle,                 /* close_handle */
 111     async_queue_destroy              /* destroy */
 112 };
 113
 114
 115 static inline void async_reselect( struct async *async )
 116 {
 117     if (async->queue && async->queue->fd) fd_reselect_async( async->queue->fd, async->queue );
 118 }
 119
 120 static void async_dump( struct object *obj, int verbose )
 121 {
 122     struct async *async = (struct async *)obj;
 123     assert( obj->ops == &async_ops );
 124     fprintf( stderr, "Async thread=%p\n", async->thread );
 125 }
 126
 127 static int async_signaled( struct object *obj, struct wait_queue_entry *entry )
 128 {
 129     struct async *async = (struct async *)obj;
 130     assert( obj->ops == &async_ops );
 131     return async->signaled;
 132 }
 133
 134 static void async_destroy( struct object *obj )
 135 {
 136     struct async *async = (struct async *)obj;
 137     assert( obj->ops == &async_ops );
 138
 139     list_remove( &async->process_entry );
 140
 141     if (async->queue)
 142     {
 143         list_remove( &async->queue_entry );
 144         async_reselect( async );
 145         release_object( async->queue );
 146     }
 147
 148     if (async->timeout) remove_timeout_user( async->timeout );
 149     if (async->event) release_object( async->event );
 150     if (async->iosb) release_object( async->iosb );
 151     release_object( async->thread );
 152 }
 153
 154 static void async_queue_dump( struct object *obj, int verbose )
 155 {
 156     struct async_queue *async_queue = (struct async_queue *)obj;
 157     assert( obj->ops == &async_queue_ops );
 158     fprintf( stderr, "Async queue fd=%p\n", async_queue->fd );
 159 }
 160
 161 static void async_queue_destroy( struct object *obj )
 162 {
 163     struct async_queue *async_queue = (struct async_queue *)obj;
 164     assert( obj->ops == &async_queue_ops );
 165     if (async_queue->completion) release_object( async_queue->completion );
 166 }
 167
 168 /* notifies client thread of new status of its async request */
 169 void async_terminate( struct async *async, unsigned int status )
 170 {
 171     assert( status != STATUS_PENDING );
 172
 173     if (async->status != STATUS_PENDING)
 174     {
 175         /* already terminated, just update status */
 176         async->status = status;
 177         return;
 178     }
 179
 180     async->status = status;
 181     if (async->iosb && async->iosb->status == STATUS_PENDING) async->iosb->status = status;
 182
 183     if (async->data.user)
 184     {
 185         apc_call_t data;
 186
 187         memset( &data, 0, sizeof(data) );
 188         data.type            = APC_ASYNC_IO;
 189         data.async_io.user   = async->data.user;
 190         data.async_io.sb     = async->data.iosb;
 191         data.async_io.status = status;
 192         thread_queue_apc( async->thread, &async->obj, &data );
 193     }
 194     else async_set_result( &async->obj, STATUS_SUCCESS, 0 );
 195
 196     async_reselect( async );
 197     if (async->queue) release_object( async );  /* so that it gets destroyed when the async is done */
 198 }
 199
 200 /* callback for timeout on an async request */
 201 static void async_timeout( void *private )
 202 {
 203     struct async *async = private;
 204
 205     async->timeout = NULL;
 206     async_terminate( async, async->timeout_status );
 207 }
 208
 209 /* create a new async queue for a given fd */
 210 struct async_queue *create_async_queue( struct fd *fd )
 211 {
 212     struct async_queue *queue = alloc_object( &async_queue_ops );
 213
 214     if (queue)
 215     {
 216         queue->fd = fd;
 217         queue->completion = NULL;
 218         list_init( &queue->queue );
 219     }
 220     return queue;
 221 }
 222
 223 /* free an async queue, cancelling all async operations */
 224 void free_async_queue( struct async_queue *queue )
 225 {
 226     if (!queue) return;
 227     if (queue->fd) queue->completion = fd_get_completion( queue->fd, &queue->comp_key );
 228     queue->fd = NULL;
 229     async_wake_up( queue, STATUS_HANDLES_CLOSED );
 230     release_object( queue );
 231 }
 232
 233 void queue_async( struct async_queue *queue, struct async *async )
 234 {
 235     async->queue = (struct async_queue *)grab_object( queue );
 236
 237     grab_object( async );
 238     list_add_tail( &queue->queue, &async->queue_entry );
 239
 240     if (queue->fd) set_fd_signaled( queue->fd, 0 );
 241 }
 242
 243 /* create an async on a given queue of a fd */
 244 struct async *create_async( struct thread *thread, const async_data_t *data, struct iosb *iosb )
 245 {
 246     struct event *event = NULL;
 247     struct async *async;
 248
 249     if (data->event && !(event = get_event_obj( thread->process, data->event, EVENT_MODIFY_STATE )))
 250         return NULL;
 251
 252     if (!(async = alloc_object( &async_ops )))
 253     {
 254         if (event) release_object( event );
 255         return NULL;
 256     }
 257
 258     async->thread  = (struct thread *)grab_object( thread );
 259     async->event   = event;
 260     async->status  = STATUS_PENDING;
 261     async->data    = *data;
 262     async->timeout = NULL;
 263     async->queue   = NULL;
 264     async->signaled = 0;
 265
 266     if (iosb) async->iosb = (struct iosb *)grab_object( iosb );
 267     else async->iosb = NULL;
 268
 269     list_add_head( &thread->process->asyncs, &async->process_entry );
 270     if (event) reset_event( event );
 271
 272     return async;
 273 }
 274
 275 /* create an async associated with iosb for async-based requests */
 276 struct async *create_request_async( struct thread *thread, const async_data_t *data )
 277 {
 278     struct async *async;
 279     struct iosb *iosb;
 280
 281     if (!(iosb = create_iosb( get_req_data(), get_req_data_size(), get_reply_max_size() )))
 282         return NULL;
 283
 284     async = create_async( current, data, iosb );
 285     release_object( iosb );
 286     return async;
 287 }
 288
 289 /* set the timeout of an async operation */
 290 void async_set_timeout( struct async *async, timeout_t timeout, unsigned int status )
 291 {
 292     if (async->timeout) remove_timeout_user( async->timeout );
 293     if (timeout != TIMEOUT_INFINITE) async->timeout = add_timeout_user( timeout, async_timeout, async );
 294     else async->timeout = NULL;
 295     async->timeout_status = status;
 296 }
 297
 298 static void add_async_completion( struct async_queue *queue, apc_param_t cvalue, unsigned int status,
 299                                   apc_param_t information )
 300 {
 301     if (queue->fd)
 302     {
 303         apc_param_t ckey;
 304         struct completion *completion = fd_get_completion( queue->fd, &ckey );
 305
 306         if (completion)
 307         {
 308             add_completion( completion, ckey, cvalue, status, information );
 309             release_object( completion );
 310         }
 311     }
 312     else if (queue->completion) add_completion( queue->completion, queue->comp_key,
 313                                                 cvalue, status, information );
 314 }
 315
 316 /* store the result of the client-side async callback */
 317 void async_set_result( struct object *obj, unsigned int status, apc_param_t total )
 318 {
 319     struct async *async = (struct async *)obj;
 320
 321     if (obj->ops != &async_ops) return;  /* in case the client messed up the APC results */
 322
 323     assert( async->status != STATUS_PENDING );  /* it must have been woken up if we get a result */
 324
 325     if (status == STATUS_PENDING)  /* restart it */
 326     {
 327         status = async->status;
 328         async->status = STATUS_PENDING;
 329         grab_object( async );
 330
 331         if (status != STATUS_ALERTED)  /* it was terminated in the meantime */
 332             async_terminate( async, status );
 333         else
 334             async_reselect( async );
 335     }
 336     else
 337     {
 338         if (async->timeout) remove_timeout_user( async->timeout );
 339         async->timeout = NULL;
 340         async->status = status;
 341         if (status == STATUS_MORE_PROCESSING_REQUIRED) return;  /* don't report the completion */
 342
 343         if (async->queue && !async->data.apc && async->data.apc_context)
 344             add_async_completion( async->queue, async->data.apc_context, status, total );
 345         if (async->data.apc)
 346         {
 347             apc_call_t data;
 348             memset( &data, 0, sizeof(data) );
 349             data.type         = APC_USER;
 350             data.user.func    = async->data.apc;
 351             data.user.args[0] = async->data.apc_context;
 352             data.user.args[1] = async->data.iosb;
 353             data.user.args[2] = 0;
 354             thread_queue_apc( async->thread, NULL, &data );
 355         }
 356         if (async->event) set_event( async->event );
 357         else if (async->queue && async->queue->fd) set_fd_signaled( async->queue->fd, 1 );
 358         async->signaled = 1;
 359         wake_up( &async->obj, 0 );
 360     }
 361 }
 362
 363 /* check if there are any queued async operations */
 364 int async_queued( struct async_queue *queue )
 365 {
 366     return queue && list_head( &queue->queue );
 367 }
 368
 369 /* check if an async operation is waiting to be alerted */
 370 int async_waiting( struct async_queue *queue )
 371 {
 372     struct list *ptr;
 373     struct async *async;
 374
 375     if (!queue) return 0;
 376     if (!(ptr = list_head( &queue->queue ))) return 0;
 377     async = LIST_ENTRY( ptr, struct async, queue_entry );
 378     return async->status == STATUS_PENDING;
 379 }
 380
 381 static int cancel_async( struct process *process, struct object *obj, struct thread *thread, client_ptr_t iosb )
 382 {
 383     struct async *async;
 384     int woken = 0;
 385
 386 restart:
 387     LIST_FOR_EACH_ENTRY( async, &process->asyncs, struct async, process_entry )
 388     {
 389         if (async->status == STATUS_CANCELLED) continue;
 390         if ((!obj || (async->queue && async->queue->fd && get_fd_user( async->queue->fd ) == obj)) &&
 391             (!thread || async->thread == thread) &&
 392             (!iosb || async->data.iosb == iosb))
 393         {
 394             async_terminate( async, STATUS_CANCELLED );
 395             woken++;
 396             goto restart;
 397         }
 398     }
 399     return woken;
 400 }
 401
 402 void cancel_process_asyncs( struct process *process )
 403 {
 404     cancel_async( process, NULL, NULL, 0 );
 405 }
 406
 407 /* wake up async operations on the queue */
 408 void async_wake_up( struct async_queue *queue, unsigned int status )
 409 {
 410     struct list *ptr, *next;
 411
 412     if (!queue) return;
 413
 414     LIST_FOR_EACH_SAFE( ptr, next, &queue->queue )
 415     {
 416         struct async *async = LIST_ENTRY( ptr, struct async, queue_entry );
 417         async_terminate( async, status );
 418         if (status == STATUS_ALERTED) break;  /* only wake up the first one */
 419     }
 420 }
 421
 422 static void iosb_dump( struct object *obj, int verbose );
 423 static void iosb_destroy( struct object *obj );
 424
 425 static const struct object_ops iosb_ops =
 426 {
 427     sizeof(struct iosb),      /* size */
 428     iosb_dump,                /* dump */
 429     no_get_type,              /* get_type */
 430     no_add_queue,             /* add_queue */
 431     NULL,                     /* remove_queue */
 432     NULL,                     /* signaled */
 433     NULL,                     /* satisfied */
 434     no_signal,                /* signal */
 435     no_get_fd,                /* get_fd */
 436     no_map_access,            /* map_access */
 437     default_get_sd,           /* get_sd */
 438     default_set_sd,           /* set_sd */
 439     no_lookup_name,           /* lookup_name */
 440     no_link_name,             /* link_name */
 441     NULL,                     /* unlink_name */
 442     no_open_file,             /* open_file */
 443     no_close_handle,          /* close_handle */
 444     iosb_destroy              /* destroy */
 445 };
 446
 447 static void iosb_dump( struct object *obj, int verbose )
 448 {
 449     assert( obj->ops == &iosb_ops );
 450     fprintf( stderr, "I/O status block\n" );
 451 }
 452
 453 static void iosb_destroy( struct object *obj )
 454 {
 455     struct iosb *iosb = (struct iosb *)obj;
 456
 457     free( iosb->in_data );
 458     free( iosb->out_data );
 459 }
 460
 461 /* allocate iosb struct */
 462 struct iosb *create_iosb( const void *in_data, data_size_t in_size, data_size_t out_size )
 463 {
 464     struct iosb *iosb;
 465
 466     if (!(iosb = alloc_object( &iosb_ops ))) return NULL;
 467
 468     iosb->status = STATUS_PENDING;
 469     iosb->result = 0;
 470     iosb->in_size = in_size;
 471     iosb->in_data = NULL;
 472     iosb->out_size = out_size;
 473     iosb->out_data = NULL;
 474
 475     if (in_size && !(iosb->in_data = memdup( in_data, in_size )))
 476     {
 477         release_object( iosb );
 478         iosb = NULL;
 479     }
 480
 481     return iosb;
 482 }
 483
 484 struct iosb *async_get_iosb( struct async *async )
 485 {
 486     return async->iosb ? (struct iosb *)grab_object( async->iosb ) : NULL;
 487 }
 488
 489 int async_is_blocking( struct async *async )
 490 {
 491     return !async->event && !async->data.apc && !async->data.apc_context;
 492 }
 493
 494 /* find the first pending async in queue */
 495 struct async *find_pending_async( struct async_queue *queue )
 496 {
 497     struct async *async;
 498     if (queue) LIST_FOR_EACH_ENTRY( async, &queue->queue, struct async, queue_entry )
 499         if (async->status == STATUS_PENDING) return (struct async *)grab_object( async );
 500     return NULL;
 501 }
 502
 503 /* cancels all async I/O */
 504 DECL_HANDLER(cancel_async)
 505 {
 506     struct object *obj = get_handle_obj( current->process, req->handle, 0, NULL );
 507     struct thread *thread = req->only_thread ? current : NULL;
 508
 509     if (obj)
 510     {
 511         int count = cancel_async( current->process, obj, thread, req->iosb );
 512         if (!count && req->iosb) set_error( STATUS_NOT_FOUND );
 513         release_object( obj );
 514     }
 515 }
 516
 517 /* get async result from associated iosb */
 518 DECL_HANDLER(get_async_result)
 519 {
 520     struct iosb *iosb = NULL;
 521     struct async *async;
 522
 523     LIST_FOR_EACH_ENTRY( async, &current->process->asyncs, struct async, process_entry )
 524         if (async->data.user == req->user_arg)
 525         {
 526             iosb = async->iosb;
 527             break;
 528         }
 529
 530     if (!iosb)
 531     {
 532         set_error( STATUS_INVALID_PARAMETER );
 533         return;
 534     }
 535
 536     if (iosb->out_data)
 537     {
 538         data_size_t size = min( iosb->out_size, get_reply_max_size() );
 539         if (size)
 540         {
 541             set_reply_data_ptr( iosb->out_data, size );
 542             iosb->out_data = NULL;
 543         }
 544     }
 545     reply->size = iosb->result;
 546     set_error( iosb->status );
 547 }