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     no_open_file,              /* open_file */
  76     no_close_handle,           /* close_handle */
  77     completion_destroy         /* destroy */
  78 };
  79
  80 struct comp_msg
  81 {
  82     struct   list queue_entry;
  83     apc_param_t   ckey;
  84     apc_param_t   cvalue;
  85     apc_param_t   information;
  86     unsigned int  status;
  87 };
  88
  89 static void completion_destroy( struct object *obj)
  90 {
  91     struct completion *completion = (struct completion *) obj;
  92     struct comp_msg *tmp, *next;
  93
  94     LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &completion->queue, struct comp_msg, queue_entry )
  95     {
  96         free( tmp );
  97     }
  98 }
  99
 100 static void completion_dump( struct object *obj, int verbose )
 101 {
 102     struct completion *completion = (struct completion *) obj;
 103
 104     assert( obj->ops == &completion_ops );
 105     fprintf( stderr, "Completion " );
 106     dump_object_name( &completion->obj );
 107     fprintf( stderr, " (%u packets pending)\n", completion->depth );
 108 }
 109
 110 static struct object_type *completion_get_type( struct object *obj )
 111 {
 112     static const WCHAR name[] = {'I','o','C','o','m','p','l','e','t','i','o','n'};
 113     static const struct unicode_str str = { name, sizeof(name) };
 114     return get_object_type( &str );
 115 }
 116
 117 static int completion_signaled( struct object *obj, struct wait_queue_entry *entry )
 118 {
 119     struct completion *completion = (struct completion *)obj;
 120
 121     return !list_empty( &completion->queue );
 122 }
 123
 124 static unsigned int completion_map_access( struct object *obj, unsigned int access )
 125 {
 126     if (access & GENERIC_READ)    access |= STANDARD_RIGHTS_READ | SYNCHRONIZE | IO_COMPLETION_QUERY_STATE;
 127     if (access & GENERIC_WRITE)   access |= STANDARD_RIGHTS_WRITE;
 128     if (access & GENERIC_EXECUTE) access |= STANDARD_RIGHTS_EXECUTE;
 129     if (access & GENERIC_ALL)     access |= STANDARD_RIGHTS_ALL | IO_COMPLETION_ALL_ACCESS;
 130     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 131 }
 132
 133 static struct completion *create_completion( struct directory *root, const struct unicode_str *name,
 134                                              unsigned int attr, unsigned int concurrent,
 135                                              const struct security_descriptor *sd )
 136 {
 137     struct completion *completion;
 138
 139     if ((completion = create_named_object_dir( root, name, attr, &completion_ops )))
 140     {
 141         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 142         {
 143             list_init( &completion->queue );
 144             completion->depth = 0;
 145             if (sd) default_set_sd( &completion->obj, sd,
 146                                     OWNER_SECURITY_INFORMATION | GROUP_SECURITY_INFORMATION |
 147                                     DACL_SECURITY_INFORMATION | SACL_SECURITY_INFORMATION );
 148         }
 149     }
 150
 151     return completion;
 152 }
 153
 154 struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access )
 155 {
 156     return (struct completion *) get_handle_obj( process, handle, access, &completion_ops );
 157 }
 158
 159 void add_completion( struct completion *completion, apc_param_t ckey, apc_param_t cvalue,
 160                      unsigned int status, apc_param_t information )
 161 {
 162     struct comp_msg *msg = mem_alloc( sizeof( *msg ) );
 163
 164     if (!msg)
 165         return;
 166
 167     msg->ckey = ckey;
 168     msg->cvalue = cvalue;
 169     msg->status = status;
 170     msg->information = information;
 171
 172     list_add_tail( &completion->queue, &msg->queue_entry );
 173     completion->depth++;
 174     wake_up( &completion->obj, 1 );
 175 }
 176
 177 /* create a completion */
 178 DECL_HANDLER(create_completion)
 179 {
 180     struct completion *completion;
 181     struct unicode_str name;
 182     struct directory *root = NULL;
 183     const struct security_descriptor *sd;
 184     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name );
 185
 186     if (!objattr) return;
 187     if (objattr->rootdir && !(root = get_directory_obj( current->process, objattr->rootdir, 0 ))) return;
 188
 189     if ((completion = create_completion( root, &name, objattr->attributes, req->concurrent, sd )))
 190     {
 191         reply->handle = alloc_handle( current->process, completion, req->access, objattr->attributes );
 192         release_object( completion );
 193     }
 194
 195     if (root) release_object( root );
 196 }
 197
 198 /* open a completion */
 199 DECL_HANDLER(open_completion)
 200 {
 201     struct completion *completion;
 202     struct unicode_str name;
 203     struct directory *root = NULL;
 204
 205     reply->handle = 0;
 206
 207     get_req_unicode_str( &name );
 208     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 209         return;
 210
 211     if ( (completion = open_object_dir( root, &name, req->attributes, &completion_ops )) != NULL )
 212     {
 213         reply->handle = alloc_handle( current->process, completion, req->access, req->attributes );
 214         release_object( completion );
 215     }
 216
 217     if (root) release_object( root );
 218 }
 219
 220
 221 /* add completion to completion port */
 222 DECL_HANDLER(add_completion)
 223 {
 224     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 225
 226     if (!completion) return;
 227
 228     add_completion( completion, req->ckey, req->cvalue, req->status, req->information );
 229
 230     release_object( completion );
 231 }
 232
 233 /* get completion from completion port */
 234 DECL_HANDLER(remove_completion)
 235 {
 236     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 237     struct list *entry;
 238     struct comp_msg *msg;
 239
 240     if (!completion) return;
 241
 242     entry = list_head( &completion->queue );
 243     if (!entry)
 244         set_error( STATUS_PENDING );
 245     else
 246     {
 247         list_remove( entry );
 248         completion->depth--;
 249         msg = LIST_ENTRY( entry, struct comp_msg, queue_entry );
 250         reply->ckey = msg->ckey;
 251         reply->cvalue = msg->cvalue;
 252         reply->status = msg->status;
 253         reply->information = msg->information;
 254         free( msg );
 255     }
 256
 257     release_object( completion );
 258 }
 259
 260 /* get queue depth for completion port */
 261 DECL_HANDLER(query_completion)
 262 {
 263     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_QUERY_STATE );
 264
 265     if (!completion) return;
 266
 267     reply->depth = completion->depth;
 268
 269     release_object( completion );
 270 }