server/completion.c

   1 /*
   2  * Server-side IO completion ports implementation
   3  *
   4  * Copyright (C) 2007 Andrey Turkin
   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
  22 /* FIXMEs:
  23  *  - built-in wait queues used which means:
  24  *    + threads are awaken FIFO and not LIFO as native does
  25  *    + "max concurrent active threads" parameter not used
  26  *    + completion handle is waitable, while native isn't
  27  */
  28
  29 #include "config.h"
  30 #include "wine/port.h"
  31
  32 #include <stdarg.h>
  33 #include <stdio.h>
  34
  35 #include "ntstatus.h"
  36 #define WIN32_NO_STATUS
  37 #include "windef.h"
  38 #include "winternl.h"
  39
  40 #include "wine/unicode.h"
  41 #include "object.h"
  42 #include "file.h"
  43 #include "handle.h"
  44 #include "request.h"
  45
  46
  47 struct completion
  48 {
  49     struct object  obj;
  50     struct list    queue;
  51     unsigned int   depth;
  52 };
  53
  54 static void completion_dump( struct object*, int );
  55 static struct object_type *completion_get_type( struct object *obj );
  56 static int completion_signaled( struct object *obj, struct wait_queue_entry *entry );
  57 static unsigned int completion_map_access( struct object *obj, unsigned int access );
  58 static void completion_destroy( struct object * );
  59
  60 static const struct object_ops completion_ops =
  61 {
  62     sizeof(struct completion), /* size */
  63     completion_dump,           /* dump */
  64     completion_get_type,       /* get_type */
  65     add_queue,                 /* add_queue */
  66     remove_queue,              /* remove_queue */
  67     completion_signaled,       /* signaled */
  68     no_satisfied,              /* satisfied */
  69     no_signal,                 /* signal */
  70     no_get_fd,                 /* get_fd */
  71     completion_map_access,     /* map_access */
  72     default_get_sd,            /* get_sd */
  73     default_set_sd,            /* set_sd */
  74     no_lookup_name,            /* lookup_name */
  75     directory_link_name,       /* link_name */
  76     default_unlink_name,       /* unlink_name */
  77     no_open_file,              /* open_file */
  78     no_kernel_obj_list,        /* get_kernel_obj_list */
  79     no_close_handle,           /* close_handle */
  80     completion_destroy         /* destroy */
  81 };
  82
  83 struct comp_msg
  84 {
  85     struct   list queue_entry;
  86     apc_param_t   ckey;
  87     apc_param_t   cvalue;
  88     apc_param_t   information;
  89     unsigned int  status;
  90 };
  91
  92 static void completion_destroy( struct object *obj)
  93 {
  94     struct completion *completion = (struct completion *) obj;
  95     struct comp_msg *tmp, *next;
  96
  97     LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &completion->queue, struct comp_msg, queue_entry )
  98     {
  99         free( tmp );
 100     }
 101 }
 102
 103 static void completion_dump( struct object *obj, int verbose )
 104 {
 105     struct completion *completion = (struct completion *) obj;
 106
 107     assert( obj->ops == &completion_ops );
 108     fprintf( stderr, "Completion depth=%u\n", completion->depth );
 109 }
 110
 111 static struct object_type *completion_get_type( struct object *obj )
 112 {
 113     static const WCHAR name[] = {'I','o','C','o','m','p','l','e','t','i','o','n'};
 114     static const struct unicode_str str = { name, sizeof(name) };
 115     return get_object_type( &str );
 116 }
 117
 118 static int completion_signaled( struct object *obj, struct wait_queue_entry *entry )
 119 {
 120     struct completion *completion = (struct completion *)obj;
 121
 122     return !list_empty( &completion->queue );
 123 }
 124
 125 static unsigned int completion_map_access( struct object *obj, unsigned int access )
 126 {
 127     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SYNCHRONIZE | IO_COMPLETION_QUERY_STATE;
 128     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE;
 129     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 130     if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | IO_COMPLETION_ALL_ACCESS;
 131     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 132 }
 133
 134 static struct completion *create_completion( struct object *root, const struct unicode_str *name,
 135                                              unsigned int attr, unsigned int concurrent,
 136                                              const struct security_descriptor *sd )
 137 {
 138     struct completion *completion;
 139
 140     if ((completion = create_named_object( root, &completion_ops, name, attr, sd )))
 141     {
 142         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 143         {
 144             list_init( &completion->queue );
 145             completion->depth = 0;
 146         }
 147     }
 148
 149     return completion;
 150 }
 151
 152 struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access )
 153 {
 154     return (struct completion *) get_handle_obj( process, handle, access, &completion_ops );
 155 }
 156
 157 void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
 158                      unsigned int status, apc_param_t information )
 159 {
 160     struct comp_msg *msg = mem_alloc( sizeof( *msg ) );
 161
 162     if (!msg)
 163         return;
 164
 165     msg->ckey = ckey;
 166     msg->cvalue = cvalue;
 167     msg->status = status;
 168     msg->information = information;
 169
 170     list_add_tail( &completion->queue, &msg->queue_entry );
 171     completion->depth++;
 172     wake_up( &completion->obj, 1 );
 173 }
 174
 175 /* create a completion */
 176 DECL_HANDLER(create_completion)
 177 {
 178     struct completion *completion;
 179     struct unicode_str name;
 180     struct object *root;
 181     const struct security_descriptor *sd;
 182     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 183
 184     if (!objattr) return;
 185
 186     if ((completion = create_completion( root, &name, objattr->attributes, req->concurrent, sd )))
 187     {
 188         reply->handle = alloc_handle( current->process, completion, req->access, objattr->attributes );
 189         release_object( completion );
 190     }
 191
 192     if (root) release_object( root );
 193 }
 194
 195 /* open a completion */
 196 DECL_HANDLER(open_completion)
 197 {
 198     struct unicode_str name = get_req_unicode_str();
 199
 200     reply->handle = open_object( current->process, req->rootdir, req->access,
 201                                  &completion_ops, &name, req->attributes );
 202 }
 203
 204
 205 /* add completion to completion port */
 206 DECL_HANDLER(add_completion)
 207 {
 208     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 209
 210     if (!completion) return;
 211
 212     add_completion( completion, req->ckey, req->cvalue, req->status, req->information );
 213
 214     release_object( completion );
 215 }
 216
 217 /* get completion from completion port */
 218 DECL_HANDLER(remove_completion)
 219 {
 220     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 221     struct list *entry;
 222     struct comp_msg *msg;
 223
 224     if (!completion) return;
 225
 226     entry = list_head( &completion->queue );
 227     if (!entry)
 228         set_error( STATUS_PENDING );
 229     else
 230     {
 231         list_remove( entry );
 232         completion->depth--;
 233         msg = LIST_ENTRY( entry, struct comp_msg, queue_entry );
 234         reply->ckey = msg->ckey;
 235         reply->cvalue = msg->cvalue;
 236         reply->status = msg->status;
 237         reply->information = msg->information;
 238         free( msg );
 239     }
 240
 241     release_object( completion );
 242 }
 243
 244 /* get queue depth for completion port */
 245 DECL_HANDLER(query_completion)
 246 {
 247     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_QUERY_STATE );
 248
 249     if (!completion) return;
 250
 251     reply->depth = completion->depth;
 252
 253     release_object( completion );
 254 }