server: Queue an IRP_MJ_CLOSE request on file destruction.
[wine.git] / server / device.c
blob2bdf82a0a61c76554ebc0c08bd2125f503273f48
1 /*
2 * Server-side device support
4 * Copyright (C) 2007 Alexandre Julliard
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.
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.
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
21 #include "config.h"
22 #include "wine/port.h"
24 #include <assert.h>
25 #include <fcntl.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <stdarg.h>
30 #include "ntstatus.h"
31 #define WIN32_NO_STATUS
32 #include "windef.h"
33 #include "winternl.h"
34 #include "ddk/wdm.h"
36 #include "object.h"
37 #include "file.h"
38 #include "handle.h"
39 #include "request.h"
40 #include "process.h"
42 /* IRP object */
44 struct irp_call
46 struct object obj; /* object header */
47 struct list dev_entry; /* entry in device queue */
48 struct list mgr_entry; /* entry in manager queue */
49 struct device_file *file; /* file containing this irp */
50 struct thread *thread; /* thread that queued the irp */
51 client_ptr_t user_arg; /* user arg used to identify the request */
52 struct async *async; /* pending async op */
53 unsigned int status; /* resulting status (or STATUS_PENDING) */
54 irp_params_t params; /* irp parameters */
55 data_size_t result; /* size of result (input or output depending on the type) */
56 data_size_t in_size; /* size of input data */
57 void *in_data; /* input data */
58 data_size_t out_size; /* size of output data */
59 void *out_data; /* output data */
62 static void irp_call_dump( struct object *obj, int verbose );
63 static int irp_call_signaled( struct object *obj, struct wait_queue_entry *entry );
64 static void irp_call_destroy( struct object *obj );
66 static const struct object_ops irp_call_ops =
68 sizeof(struct irp_call), /* size */
69 irp_call_dump, /* dump */
70 no_get_type, /* get_type */
71 add_queue, /* add_queue */
72 remove_queue, /* remove_queue */
73 irp_call_signaled, /* signaled */
74 no_satisfied, /* satisfied */
75 no_signal, /* signal */
76 no_get_fd, /* get_fd */
77 no_map_access, /* map_access */
78 default_get_sd, /* get_sd */
79 default_set_sd, /* set_sd */
80 no_lookup_name, /* lookup_name */
81 no_open_file, /* open_file */
82 no_close_handle, /* close_handle */
83 irp_call_destroy /* destroy */
87 /* device manager (a list of devices managed by the same client process) */
89 struct device_manager
91 struct object obj; /* object header */
92 struct list devices; /* list of devices */
93 struct list requests; /* list of pending irps across all devices */
96 static void device_manager_dump( struct object *obj, int verbose );
97 static int device_manager_signaled( struct object *obj, struct wait_queue_entry *entry );
98 static void device_manager_destroy( struct object *obj );
100 static const struct object_ops device_manager_ops =
102 sizeof(struct device_manager), /* size */
103 device_manager_dump, /* dump */
104 no_get_type, /* get_type */
105 add_queue, /* add_queue */
106 remove_queue, /* remove_queue */
107 device_manager_signaled, /* signaled */
108 no_satisfied, /* satisfied */
109 no_signal, /* signal */
110 no_get_fd, /* get_fd */
111 no_map_access, /* map_access */
112 default_get_sd, /* get_sd */
113 default_set_sd, /* set_sd */
114 no_lookup_name, /* lookup_name */
115 no_open_file, /* open_file */
116 no_close_handle, /* close_handle */
117 device_manager_destroy /* destroy */
121 /* device (a single device object) */
123 struct device
125 struct object obj; /* object header */
126 struct device_manager *manager; /* manager for this device (or NULL if deleted) */
127 char *unix_path; /* path to unix device if any */
128 client_ptr_t user_ptr; /* opaque ptr for client side */
129 struct list entry; /* entry in device manager list */
130 struct list files; /* list of open files */
133 static void device_dump( struct object *obj, int verbose );
134 static struct object_type *device_get_type( struct object *obj );
135 static void device_destroy( struct object *obj );
136 static struct object *device_open_file( struct object *obj, unsigned int access,
137 unsigned int sharing, unsigned int options );
139 static const struct object_ops device_ops =
141 sizeof(struct device), /* size */
142 device_dump, /* dump */
143 device_get_type, /* get_type */
144 no_add_queue, /* add_queue */
145 NULL, /* remove_queue */
146 NULL, /* signaled */
147 no_satisfied, /* satisfied */
148 no_signal, /* signal */
149 no_get_fd, /* get_fd */
150 default_fd_map_access, /* map_access */
151 default_get_sd, /* get_sd */
152 default_set_sd, /* set_sd */
153 no_lookup_name, /* lookup_name */
154 device_open_file, /* open_file */
155 no_close_handle, /* close_handle */
156 device_destroy /* destroy */
160 /* device file (an open file handle to a device) */
162 struct device_file
164 struct object obj; /* object header */
165 struct device *device; /* device for this file */
166 struct fd *fd; /* file descriptor for irp */
167 struct list entry; /* entry in device list */
168 struct list requests; /* list of pending irp requests */
171 static void device_file_dump( struct object *obj, int verbose );
172 static struct fd *device_file_get_fd( struct object *obj );
173 static int device_file_close_handle( struct object *obj, struct process *process, obj_handle_t handle );
174 static void device_file_destroy( struct object *obj );
175 static enum server_fd_type device_file_get_fd_type( struct fd *fd );
176 static obj_handle_t device_file_read( struct fd *fd, const async_data_t *async_data, int blocking,
177 file_pos_t pos );
178 static obj_handle_t device_file_write( struct fd *fd, const async_data_t *async_data, int blocking,
179 file_pos_t pos, data_size_t *written );
180 static obj_handle_t device_file_flush( struct fd *fd, const async_data_t *async_data, int blocking );
181 static obj_handle_t device_file_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async_data,
182 int blocking );
184 static const struct object_ops device_file_ops =
186 sizeof(struct device_file), /* size */
187 device_file_dump, /* dump */
188 no_get_type, /* get_type */
189 add_queue, /* add_queue */
190 remove_queue, /* remove_queue */
191 default_fd_signaled, /* signaled */
192 no_satisfied, /* satisfied */
193 no_signal, /* signal */
194 device_file_get_fd, /* get_fd */
195 default_fd_map_access, /* map_access */
196 default_get_sd, /* get_sd */
197 default_set_sd, /* set_sd */
198 no_lookup_name, /* lookup_name */
199 no_open_file, /* open_file */
200 device_file_close_handle, /* close_handle */
201 device_file_destroy /* destroy */
204 static const struct fd_ops device_file_fd_ops =
206 default_fd_get_poll_events, /* get_poll_events */
207 default_poll_event, /* poll_event */
208 device_file_get_fd_type, /* get_fd_type */
209 device_file_read, /* read */
210 device_file_write, /* write */
211 device_file_flush, /* flush */
212 device_file_ioctl, /* ioctl */
213 default_fd_queue_async, /* queue_async */
214 default_fd_reselect_async, /* reselect_async */
215 default_fd_cancel_async /* cancel_async */
219 static void irp_call_dump( struct object *obj, int verbose )
221 struct irp_call *irp = (struct irp_call *)obj;
222 fprintf( stderr, "IRP call file=%p\n", irp->file );
225 static int irp_call_signaled( struct object *obj, struct wait_queue_entry *entry )
227 struct irp_call *irp = (struct irp_call *)obj;
229 return !irp->file; /* file is cleared once the irp has completed */
232 static void irp_call_destroy( struct object *obj )
234 struct irp_call *irp = (struct irp_call *)obj;
236 free( irp->in_data );
237 free( irp->out_data );
238 if (irp->async)
240 async_terminate( irp->async, STATUS_CANCELLED );
241 release_object( irp->async );
243 if (irp->file) release_object( irp->file );
244 release_object( irp->thread );
247 static struct irp_call *create_irp( struct device_file *file, const irp_params_t *params,
248 const void *in_data, data_size_t in_size, data_size_t out_size )
250 struct irp_call *irp;
252 if (!file->device->manager) /* it has been deleted */
254 set_error( STATUS_FILE_DELETED );
255 return NULL;
258 if ((irp = alloc_object( &irp_call_ops )))
260 irp->file = (struct device_file *)grab_object( file );
261 irp->async = NULL;
262 irp->params = *params;
263 irp->status = STATUS_PENDING;
264 irp->result = 0;
265 irp->in_size = in_size;
266 irp->in_data = NULL;
267 irp->out_size = out_size;
268 irp->out_data = NULL;
270 if (irp->in_size && !(irp->in_data = memdup( in_data, in_size )))
272 release_object( irp );
273 irp = NULL;
276 return irp;
279 static void set_irp_result( struct irp_call *irp, unsigned int status,
280 const void *out_data, data_size_t out_size, data_size_t result )
282 struct device_file *file = irp->file;
284 if (!file) return; /* already finished */
286 /* FIXME: handle the STATUS_PENDING case */
287 irp->status = status;
288 irp->result = result;
289 irp->out_size = min( irp->out_size, out_size );
290 if (irp->out_size && !(irp->out_data = memdup( out_data, irp->out_size )))
291 irp->out_size = 0;
292 irp->file = NULL;
293 if (irp->async)
295 if (result) status = STATUS_ALERTED;
296 async_terminate( irp->async, status );
297 release_object( irp->async );
298 irp->async = NULL;
300 wake_up( &irp->obj, 0 );
302 if (status != STATUS_ALERTED)
304 /* remove it from the device queue */
305 /* (for STATUS_ALERTED this will be done in get_irp_result) */
306 list_remove( &irp->dev_entry );
307 release_object( irp ); /* no longer on the device queue */
309 release_object( file );
313 static void device_dump( struct object *obj, int verbose )
315 struct device *device = (struct device *)obj;
317 fprintf( stderr, "Device " );
318 dump_object_name( &device->obj );
319 fputc( '\n', stderr );
322 static struct object_type *device_get_type( struct object *obj )
324 static const WCHAR name[] = {'D','e','v','i','c','e'};
325 static const struct unicode_str str = { name, sizeof(name) };
326 return get_object_type( &str );
329 static void device_destroy( struct object *obj )
331 struct device *device = (struct device *)obj;
333 assert( list_empty( &device->files ));
335 free( device->unix_path );
336 if (device->manager) list_remove( &device->entry );
339 static void add_irp_to_queue( struct device_file *file, struct irp_call *irp )
341 struct device_manager *manager = file->device->manager;
343 assert( manager );
345 grab_object( irp ); /* grab reference for queued irp */
346 irp->thread = (struct thread *)grab_object( current );
347 list_add_tail( &file->requests, &irp->dev_entry );
348 list_add_tail( &manager->requests, &irp->mgr_entry );
349 if (list_head( &manager->requests ) == &irp->mgr_entry) wake_up( &manager->obj, 0 ); /* first one */
352 static struct object *device_open_file( struct object *obj, unsigned int access,
353 unsigned int sharing, unsigned int options )
355 struct device *device = (struct device *)obj;
356 struct device_file *file;
358 if (!(file = alloc_object( &device_file_ops ))) return NULL;
360 file->device = (struct device *)grab_object( device );
361 list_init( &file->requests );
362 list_add_tail( &device->files, &file->entry );
363 if (device->unix_path)
365 mode_t mode = 0666;
366 access = file->obj.ops->map_access( &file->obj, access );
367 file->fd = open_fd( NULL, device->unix_path, O_NONBLOCK | O_LARGEFILE,
368 &mode, access, sharing, options );
369 if (file->fd) set_fd_user( file->fd, &device_file_fd_ops, &file->obj );
371 else file->fd = alloc_pseudo_fd( &device_file_fd_ops, &file->obj, 0 );
373 if (!file->fd)
375 release_object( file );
376 return NULL;
379 if (device->manager)
381 struct irp_call *irp;
382 irp_params_t params;
384 params.create.major = IRP_MJ_CREATE;
385 params.create.access = access;
386 params.create.sharing = sharing;
387 params.create.options = options;
388 params.create.device = file->device->user_ptr;
390 if ((irp = create_irp( file, &params, NULL, 0, 0 )))
392 add_irp_to_queue( file, irp );
393 release_object( irp );
396 return &file->obj;
399 static void device_file_dump( struct object *obj, int verbose )
401 struct device_file *file = (struct device_file *)obj;
403 fprintf( stderr, "File on device %p\n", file->device );
406 static struct fd *device_file_get_fd( struct object *obj )
408 struct device_file *file = (struct device_file *)obj;
410 return (struct fd *)grab_object( file->fd );
413 static int device_file_close_handle( struct object *obj, struct process *process, obj_handle_t handle )
415 struct device_file *file = (struct device_file *)obj;
417 if (file->device->manager && obj->handle_count == 1) /* last handle */
419 struct irp_call *irp;
420 irp_params_t params;
422 params.close.major = IRP_MJ_CLOSE;
423 params.close.device = file->device->user_ptr;
425 if ((irp = create_irp( file, &params, NULL, 0, 0 )))
427 add_irp_to_queue( file, irp );
428 release_object( irp );
431 return 1;
434 static void device_file_destroy( struct object *obj )
436 struct device_file *file = (struct device_file *)obj;
437 struct irp_call *irp, *next;
439 LIST_FOR_EACH_ENTRY_SAFE( irp, next, &file->requests, struct irp_call, dev_entry )
441 list_remove( &irp->dev_entry );
442 release_object( irp ); /* no longer on the device queue */
444 if (file->fd) release_object( file->fd );
445 list_remove( &file->entry );
446 release_object( file->device );
449 static struct irp_call *find_irp_call( struct device_file *file, struct thread *thread,
450 client_ptr_t user_arg )
452 struct irp_call *irp;
454 LIST_FOR_EACH_ENTRY( irp, &file->requests, struct irp_call, dev_entry )
455 if (irp->thread == thread && irp->user_arg == user_arg) return irp;
457 set_error( STATUS_INVALID_PARAMETER );
458 return NULL;
461 /* queue an irp to the device */
462 static obj_handle_t queue_irp( struct device_file *file, struct irp_call *irp,
463 const async_data_t *async_data, int blocking )
465 obj_handle_t handle = 0;
467 if (blocking && !(handle = alloc_handle( current->process, irp, SYNCHRONIZE, 0 ))) return 0;
469 if (!(irp->async = fd_queue_async( file->fd, async_data, ASYNC_TYPE_WAIT )))
471 if (handle) close_handle( current->process, handle );
472 return 0;
474 irp->user_arg = async_data->arg;
475 add_irp_to_queue( file, irp );
476 set_error( STATUS_PENDING );
477 return handle;
480 static enum server_fd_type device_file_get_fd_type( struct fd *fd )
482 return FD_TYPE_DEVICE;
485 static obj_handle_t device_file_read( struct fd *fd, const async_data_t *async_data, int blocking,
486 file_pos_t pos )
488 struct device_file *file = get_fd_user( fd );
489 struct irp_call *irp;
490 obj_handle_t handle;
491 irp_params_t params;
493 params.read.major = IRP_MJ_READ;
494 params.read.key = 0;
495 params.read.pos = pos;
496 params.read.device = file->device->user_ptr;
498 irp = create_irp( file, &params, NULL, 0, get_reply_max_size() );
499 if (!irp) return 0;
501 handle = queue_irp( file, irp, async_data, blocking );
502 release_object( irp );
503 return handle;
506 static obj_handle_t device_file_write( struct fd *fd, const async_data_t *async_data, int blocking,
507 file_pos_t pos, data_size_t *written )
509 struct device_file *file = get_fd_user( fd );
510 struct irp_call *irp;
511 obj_handle_t handle;
512 irp_params_t params;
514 params.write.major = IRP_MJ_WRITE;
515 params.write.key = 0;
516 params.write.pos = pos;
517 params.write.device = file->device->user_ptr;
519 irp = create_irp( file, &params, get_req_data(), get_req_data_size(), 0 );
520 if (!irp) return 0;
522 handle = queue_irp( file, irp, async_data, blocking );
523 release_object( irp );
524 return handle;
527 static obj_handle_t device_file_flush( struct fd *fd, const async_data_t *async_data, int blocking )
529 struct device_file *file = get_fd_user( fd );
530 struct irp_call *irp;
531 obj_handle_t handle;
532 irp_params_t params;
534 params.flush.major = IRP_MJ_FLUSH_BUFFERS;
535 params.flush.device = file->device->user_ptr;
537 irp = create_irp( file, &params, NULL, 0, 0 );
538 if (!irp) return 0;
540 handle = queue_irp( file, irp, async_data, blocking );
541 release_object( irp );
542 return handle;
545 static obj_handle_t device_file_ioctl( struct fd *fd, ioctl_code_t code, const async_data_t *async_data,
546 int blocking )
548 struct device_file *file = get_fd_user( fd );
549 struct irp_call *irp;
550 obj_handle_t handle;
551 irp_params_t params;
553 params.ioctl.major = IRP_MJ_DEVICE_CONTROL;
554 params.ioctl.code = code;
555 params.ioctl.device = file->device->user_ptr;
557 irp = create_irp( file, &params, get_req_data(), get_req_data_size(),
558 get_reply_max_size() );
559 if (!irp) return 0;
561 handle = queue_irp( file, irp, async_data, blocking );
562 release_object( irp );
563 return handle;
566 static struct device *create_device( struct directory *root, const struct unicode_str *name,
567 struct device_manager *manager, unsigned int attr )
569 struct device *device;
571 if ((device = create_named_object_dir( root, name, attr, &device_ops )))
573 if (get_error() != STATUS_OBJECT_NAME_EXISTS)
575 /* initialize it if it didn't already exist */
576 device->unix_path = NULL;
577 device->manager = manager;
578 list_add_tail( &manager->devices, &device->entry );
579 list_init( &device->files );
582 return device;
585 struct device *create_unix_device( struct directory *root, const struct unicode_str *name,
586 const char *unix_path )
588 struct device *device;
590 if ((device = create_named_object_dir( root, name, 0, &device_ops )))
592 device->unix_path = strdup( unix_path );
593 device->manager = NULL; /* no manager, requests go straight to the Unix device */
594 list_init( &device->files );
595 make_object_static( &device->obj );
597 return device;
601 /* terminate requests when the underlying device is deleted */
602 static void delete_file( struct device_file *file )
604 struct irp_call *irp, *next;
606 /* terminate all pending requests */
607 LIST_FOR_EACH_ENTRY_SAFE( irp, next, &file->requests, struct irp_call, dev_entry )
609 list_remove( &irp->mgr_entry );
610 set_irp_result( irp, STATUS_FILE_DELETED, NULL, 0, 0 );
614 static void delete_device( struct device *device )
616 struct device_file *file, *next;
618 if (!device->manager) return; /* already deleted */
620 LIST_FOR_EACH_ENTRY_SAFE( file, next, &device->files, struct device_file, entry )
621 delete_file( file );
623 unlink_named_object( &device->obj );
624 list_remove( &device->entry );
625 device->manager = NULL;
629 static void device_manager_dump( struct object *obj, int verbose )
631 fprintf( stderr, "Device manager\n" );
634 static int device_manager_signaled( struct object *obj, struct wait_queue_entry *entry )
636 struct device_manager *manager = (struct device_manager *)obj;
638 return !list_empty( &manager->requests );
641 static void device_manager_destroy( struct object *obj )
643 struct device_manager *manager = (struct device_manager *)obj;
644 struct list *ptr;
646 while ((ptr = list_head( &manager->devices )))
648 struct device *device = LIST_ENTRY( ptr, struct device, entry );
649 delete_device( device );
653 static struct device_manager *create_device_manager(void)
655 struct device_manager *manager;
657 if ((manager = alloc_object( &device_manager_ops )))
659 list_init( &manager->devices );
660 list_init( &manager->requests );
662 return manager;
666 /* create a device manager */
667 DECL_HANDLER(create_device_manager)
669 struct device_manager *manager = create_device_manager();
671 if (manager)
673 reply->handle = alloc_handle( current->process, manager, req->access, req->attributes );
674 release_object( manager );
679 /* create a device */
680 DECL_HANDLER(create_device)
682 struct device *device;
683 struct unicode_str name;
684 struct device_manager *manager;
685 struct directory *root = NULL;
687 if (!(manager = (struct device_manager *)get_handle_obj( current->process, req->manager,
688 0, &device_manager_ops )))
689 return;
691 get_req_unicode_str( &name );
692 if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
694 release_object( manager );
695 return;
698 if ((device = create_device( root, &name, manager, req->attributes )))
700 device->user_ptr = req->user_ptr;
701 reply->handle = alloc_handle( current->process, device, req->access, req->attributes );
702 release_object( device );
705 if (root) release_object( root );
706 release_object( manager );
710 /* delete a device */
711 DECL_HANDLER(delete_device)
713 struct device *device;
715 if ((device = (struct device *)get_handle_obj( current->process, req->handle, 0, &device_ops )))
717 delete_device( device );
718 release_object( device );
723 /* retrieve the next pending device irp request */
724 DECL_HANDLER(get_next_device_request)
726 struct irp_call *irp;
727 struct device_manager *manager;
728 struct list *ptr;
730 reply->params.major = IRP_MJ_MAXIMUM_FUNCTION + 1;
732 if (!(manager = (struct device_manager *)get_handle_obj( current->process, req->manager,
733 0, &device_manager_ops )))
734 return;
736 if (req->prev)
738 if ((irp = (struct irp_call *)get_handle_obj( current->process, req->prev, 0, &irp_call_ops )))
740 set_irp_result( irp, req->status, NULL, 0, 0 );
741 close_handle( current->process, req->prev ); /* avoid an extra round-trip for close */
742 release_object( irp );
744 clear_error();
747 if ((ptr = list_head( &manager->requests )))
749 irp = LIST_ENTRY( ptr, struct irp_call, mgr_entry );
750 reply->params = irp->params;
751 reply->client_pid = get_process_id( irp->thread->process );
752 reply->client_tid = get_thread_id( irp->thread );
753 reply->in_size = irp->in_size;
754 reply->out_size = irp->out_size;
755 if (irp->in_size > get_reply_max_size()) set_error( STATUS_BUFFER_OVERFLOW );
756 else if ((reply->next = alloc_handle( current->process, irp, 0, 0 )))
758 set_reply_data_ptr( irp->in_data, irp->in_size );
759 irp->in_data = NULL;
760 irp->in_size = 0;
761 list_remove( &irp->mgr_entry );
762 list_init( &irp->mgr_entry );
765 else set_error( STATUS_PENDING );
767 release_object( manager );
771 /* store results of an async irp */
772 DECL_HANDLER(set_irp_result)
774 struct irp_call *irp;
775 struct device_manager *manager;
777 if (!(manager = (struct device_manager *)get_handle_obj( current->process, req->manager,
778 0, &device_manager_ops )))
779 return;
781 if ((irp = (struct irp_call *)get_handle_obj( current->process, req->handle, 0, &irp_call_ops )))
783 set_irp_result( irp, req->status, get_req_data(), get_req_data_size(), req->size );
784 close_handle( current->process, req->handle ); /* avoid an extra round-trip for close */
785 release_object( irp );
787 release_object( manager );
791 /* retrieve results of an async irp */
792 DECL_HANDLER(get_irp_result)
794 struct device_file *file;
795 struct irp_call *irp;
797 if (!(file = (struct device_file *)get_handle_obj( current->process, req->handle,
798 0, &device_file_ops )))
799 return;
801 if ((irp = find_irp_call( file, current, req->user_arg )))
803 if (irp->out_data)
805 data_size_t size = min( irp->out_size, get_reply_max_size() );
806 if (size)
808 set_reply_data_ptr( irp->out_data, size );
809 irp->out_data = NULL;
812 reply->size = irp->result;
813 set_error( irp->status );
814 list_remove( &irp->dev_entry );
815 release_object( irp ); /* no longer on the device queue */
817 release_object( file );