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 "handle.h"
  43 #include "request.h"
  44
  45
  46 struct completion
  47 {
  48     struct object  obj;
  49     struct list    queue;
  50     unsigned int   depth;
  51 };
  52
  53 static void completion_dump( struct object*, int );
  54 static void completion_destroy( struct object * );
  55 static int  completion_signaled( struct object *obj, struct thread *thread );
  56
  57 static const struct object_ops completion_ops =
  58 {
  59     sizeof(struct completion), /* size */
  60     completion_dump,           /* dump */
  61     add_queue,                 /* add_queue */
  62     remove_queue,              /* remove_queue */
  63     completion_signaled,       /* signaled */
  64     no_satisfied,              /* satisfied */
  65     no_signal,                 /* signal */
  66     no_get_fd,                 /* get_fd */
  67     no_map_access,             /* map_access */
  68     no_lookup_name,            /* lookup_name */
  69     no_open_file,              /* open_file */
  70     no_close_handle,           /* close_handle */
  71     completion_destroy         /* destroy */
  72 };
  73
  74 struct comp_msg
  75 {
  76     struct   list queue_entry;
  77     unsigned long ckey;
  78     unsigned long cvalue;
  79     unsigned long information;
  80     unsigned int  status;
  81 };
  82
  83 static void completion_destroy( struct object *obj)
  84 {
  85     struct completion *completion = (struct completion *) obj;
  86     struct comp_msg *tmp, *next;
  87
  88     LIST_FOR_EACH_ENTRY_SAFE( tmp, next, &completion->queue, struct comp_msg, queue_entry )
  89     {
  90         free( tmp );
  91     }
  92 }
  93
  94 static void completion_dump( struct object *obj, int verbose )
  95 {
  96     struct completion *completion = (struct completion *) obj;
  97
  98     assert( obj->ops == &completion_ops );
  99     fprintf( stderr, "Completion " );
 100     dump_object_name( &completion->obj );
 101     fprintf( stderr, " (%u packets pending)\n", completion->depth );
 102 }
 103
 104 static int completion_signaled( struct object *obj, struct thread *thread )
 105 {
 106     struct completion *completion = (struct completion *)obj;
 107
 108     return !list_empty( &completion->queue );
 109 }
 110
 111 static struct completion *create_completion( struct directory *root, const struct unicode_str *name, unsigned int attr, unsigned int concurrent )
 112 {
 113     struct completion *completion;
 114
 115     if ((completion = create_named_object_dir( root, name, attr, &completion_ops )))
 116     {
 117         if (get_error() != STATUS_OBJECT_NAME_EXISTS)
 118         {
 119             list_init( &completion->queue );
 120             completion->depth = 0;
 121         }
 122     }
 123
 124     return completion;
 125 }
 126
 127 static struct completion *get_completion_obj( struct process *process, obj_handle_t handle, unsigned int access )
 128 {
 129     return (struct completion *) get_handle_obj( process, handle, access, &completion_ops );
 130 }
 131
 132 static void add_completion( struct completion *completion, unsigned long ckey, unsigned long cvalue, unsigned int status, unsigned long information )
 133 {
 134     struct comp_msg *msg = mem_alloc( sizeof( *msg ) );
 135
 136     if (!msg)
 137         return;
 138
 139     msg->ckey = ckey;
 140     msg->cvalue = cvalue;
 141     msg->status = status;
 142     msg->information = information;
 143
 144     list_add_tail( &completion->queue, &msg->queue_entry );
 145     completion->depth++;
 146     wake_up( &completion->obj, 1 );
 147 }
 148
 149 /* create a completion */
 150 DECL_HANDLER(create_completion)
 151 {
 152     struct completion *completion;
 153     struct unicode_str name;
 154     struct directory *root = NULL;
 155
 156     reply->handle = 0;
 157
 158     get_req_unicode_str( &name );
 159     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 160         return;
 161
 162     if ( (completion = create_completion( root, &name, req->attributes, req->concurrent )) != NULL )
 163     {
 164         reply->handle = alloc_handle( current->process, completion, req->access, req->attributes );
 165         release_object( completion );
 166     }
 167
 168     if (root) release_object( root );
 169 }
 170
 171 /* open a completion */
 172 DECL_HANDLER(open_completion)
 173 {
 174     struct completion *completion;
 175     struct unicode_str name;
 176     struct directory *root = NULL;
 177
 178     reply->handle = 0;
 179
 180     get_req_unicode_str( &name );
 181     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 182         return;
 183
 184     if ( (completion = open_object_dir( root, &name, req->attributes, &completion_ops )) != NULL )
 185     {
 186         reply->handle = alloc_handle( current->process, completion, req->access, req->attributes );
 187         release_object( completion );
 188     }
 189
 190     if (root) release_object( root );
 191 }
 192
 193
 194 /* add completion to completion port */
 195 DECL_HANDLER(add_completion)
 196 {
 197     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 198
 199     if (!completion) return;
 200
 201     add_completion( completion, req->ckey, req->cvalue, req->status, req->information );
 202
 203     release_object( completion );
 204 }
 205
 206 /* get completion from completion port */
 207 DECL_HANDLER(remove_completion)
 208 {
 209     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_MODIFY_STATE );
 210     struct list *entry;
 211     struct comp_msg *msg;
 212
 213     if (!completion) return;
 214
 215     entry = list_head( &completion->queue );
 216     if (!entry)
 217         set_error( STATUS_PENDING );
 218     else
 219     {
 220         list_remove( entry );
 221         completion->depth--;
 222         msg = LIST_ENTRY( entry, struct comp_msg, queue_entry );
 223         reply->ckey = msg->ckey;
 224         reply->cvalue = msg->cvalue;
 225         reply->status = msg->status;
 226         reply->information = msg->information;
 227         free( msg );
 228     }
 229
 230     release_object( completion );
 231 }
 232
 233 /* get queue depth for completion port */
 234 DECL_HANDLER(query_completion)
 235 {
 236     struct completion* completion = get_completion_obj( current->process, req->handle, IO_COMPLETION_QUERY_STATE );
 237
 238     if (!completion) return;
 239
 240     reply->depth = completion->depth;
 241
 242     release_object( completion );
 243 }