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