2 * Server-side mailslot management
4 * Copyright (C) 1998 Alexandre Julliard
5 * Copyright (C) 2005 Mike McCormack
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #include "wine/port.h"
26 #define WIN32_NO_STATUS
27 #include "wine/unicode.h"
36 #include <sys/types.h>
38 #ifdef HAVE_SYS_IOCTL_H
39 #include <sys/ioctl.h>
41 #ifdef HAVE_SYS_SOCKET_H
42 #include <sys/socket.h>
44 #ifdef HAVE_SYS_FILIO_H
45 #include <sys/filio.h>
60 unsigned int max_msgsize;
65 /* mailslot functions */
66 static void mailslot_dump( struct object*, int );
67 static struct fd *mailslot_get_fd( struct object * );
68 static unsigned int mailslot_map_access( struct object *obj, unsigned int access );
69 static void mailslot_destroy( struct object * );
71 static const struct object_ops mailslot_ops =
73 sizeof(struct mailslot), /* size */
74 mailslot_dump, /* dump */
75 default_fd_add_queue, /* add_queue */
76 default_fd_remove_queue, /* remove_queue */
77 default_fd_signaled, /* signaled */
78 no_satisfied, /* satisfied */
79 no_signal, /* signal */
80 mailslot_get_fd, /* get_fd */
81 mailslot_map_access, /* map_access */
82 no_lookup_name, /* lookup_name */
83 no_close_handle, /* close_handle */
84 mailslot_destroy /* destroy */
87 static int mailslot_get_info( struct fd * );
88 static void mailslot_queue_async( struct fd *, void*, void*, void*, int, int );
90 static const struct fd_ops mailslot_fd_ops =
92 default_fd_get_poll_events, /* get_poll_events */
93 default_poll_event, /* poll_event */
95 mailslot_get_info, /* get_file_info */
96 mailslot_queue_async, /* queue_async */
97 default_fd_cancel_async /* cancel_async */
104 struct mailslot *mailslot;
107 unsigned int sharing;
110 static void mail_writer_dump( struct object *obj, int verbose );
111 static struct fd *mail_writer_get_fd( struct object *obj );
112 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access );
113 static void mail_writer_destroy( struct object *obj);
115 static const struct object_ops mail_writer_ops =
117 sizeof(struct mail_writer), /* size */
118 mail_writer_dump, /* dump */
119 no_add_queue, /* add_queue */
120 NULL, /* remove_queue */
122 NULL, /* satisfied */
123 no_signal, /* signal */
124 mail_writer_get_fd, /* get_fd */
125 mail_writer_map_access, /* map_access */
126 no_lookup_name, /* lookup_name */
127 no_close_handle, /* close_handle */
128 mail_writer_destroy /* destroy */
131 static int mail_writer_get_info( struct fd *fd );
133 static const struct fd_ops mail_writer_fd_ops =
135 NULL, /* get_poll_events */
136 NULL, /* poll_event */
137 no_flush, /* flush */
138 mail_writer_get_info, /* get_file_info */
139 no_queue_async, /* queue_async */
140 NULL /* cancel_async */
144 struct mailslot_device
146 struct object obj; /* object header */
147 struct fd *fd; /* pseudo-fd for ioctls */
148 struct namespace *mailslots; /* mailslot namespace */
151 static void mailslot_device_dump( struct object *obj, int verbose );
152 static struct fd *mailslot_device_get_fd( struct object *obj );
153 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
155 static void mailslot_device_destroy( struct object *obj );
156 static int mailslot_device_get_file_info( struct fd *fd );
158 static const struct object_ops mailslot_device_ops =
160 sizeof(struct mailslot_device), /* size */
161 mailslot_device_dump, /* dump */
162 no_add_queue, /* add_queue */
163 NULL, /* remove_queue */
165 no_satisfied, /* satisfied */
166 no_signal, /* signal */
167 mailslot_device_get_fd, /* get_fd */
168 no_map_access, /* map_access */
169 mailslot_device_lookup_name, /* lookup_name */
170 no_close_handle, /* close_handle */
171 mailslot_device_destroy /* destroy */
174 static const struct fd_ops mailslot_device_fd_ops =
176 default_fd_get_poll_events, /* get_poll_events */
177 default_poll_event, /* poll_event */
178 no_flush, /* flush */
179 mailslot_device_get_file_info, /* get_file_info */
180 default_fd_queue_async, /* queue_async */
181 default_fd_cancel_async /* cancel_async */
184 static void mailslot_destroy( struct object *obj)
186 struct mailslot *mailslot = (struct mailslot *) obj;
188 assert( mailslot->fd );
189 assert( mailslot->write_fd );
191 release_object( mailslot->fd );
192 release_object( mailslot->write_fd );
195 static void mailslot_dump( struct object *obj, int verbose )
197 struct mailslot *mailslot = (struct mailslot *) obj;
199 assert( obj->ops == &mailslot_ops );
200 fprintf( stderr, "Mailslot max_msgsize=%d read_timeout=%d\n",
201 mailslot->max_msgsize, mailslot->read_timeout );
204 static int mailslot_message_count(struct mailslot *mailslot)
208 /* poll the socket to see if there's any messages */
209 pfd.fd = get_unix_fd( mailslot->fd );
212 return (poll( &pfd, 1, 0 ) == 1) ? 1 : 0;
215 static int mailslot_next_msg_size( struct mailslot *mailslot )
220 fd = get_unix_fd( mailslot->fd );
221 ioctl( fd, FIONREAD, &size );
225 static int mailslot_get_info( struct fd *fd )
227 struct mailslot *mailslot = get_fd_user( fd );
228 assert( mailslot->obj.ops == &mailslot_ops );
229 return FD_FLAG_TIMEOUT | FD_FLAG_AVAILABLE;
232 static struct fd *mailslot_get_fd( struct object *obj )
234 struct mailslot *mailslot = (struct mailslot *) obj;
236 return (struct fd *)grab_object( mailslot->fd );
239 static unsigned int mailslot_map_access( struct object *obj, unsigned int access )
241 if (access & GENERIC_READ) access |= FILE_GENERIC_READ;
242 if (access & GENERIC_WRITE) access |= FILE_GENERIC_WRITE;
243 if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
244 if (access & GENERIC_ALL) access |= FILE_ALL_ACCESS;
245 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
248 static void mailslot_queue_async( struct fd *fd, void *apc, void *user,
249 void *iosb, int type, int count )
251 struct mailslot *mailslot = get_fd_user( fd );
253 assert(mailslot->obj.ops == &mailslot_ops);
255 if (type != ASYNC_TYPE_READ)
257 set_error(STATUS_INVALID_PARAMETER);
261 if (list_empty( &mailslot->writers ) ||
262 !mailslot_message_count( mailslot ))
264 set_error(STATUS_IO_TIMEOUT);
268 if (mailslot->read_timeout != -1)
270 struct timeval when = current_time;
271 add_timeout( &when, mailslot->read_timeout );
272 fd_queue_async_timeout( fd, apc, user, iosb, type, count, &when );
274 else fd_queue_async_timeout( fd, apc, user, iosb, type, count, NULL );
277 static void mailslot_device_dump( struct object *obj, int verbose )
279 assert( obj->ops == &mailslot_device_ops );
280 fprintf( stderr, "Mail slot device\n" );
283 static struct fd *mailslot_device_get_fd( struct object *obj )
285 struct mailslot_device *device = (struct mailslot_device *)obj;
286 return (struct fd *)grab_object( device->fd );
289 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
292 struct mailslot_device *device = (struct mailslot_device*)obj;
293 struct object *found;
295 assert( obj->ops == &mailslot_device_ops );
297 if ((found = find_object( device->mailslots, name, attr | OBJ_CASE_INSENSITIVE )))
303 static void mailslot_device_destroy( struct object *obj )
305 struct mailslot_device *device = (struct mailslot_device*)obj;
306 assert( obj->ops == &mailslot_device_ops );
307 if (device->fd) release_object( device->fd );
308 if (device->mailslots) free( device->mailslots );
311 static int mailslot_device_get_file_info( struct fd *fd )
316 void create_mailslot_device( struct directory *root, const struct unicode_str *name )
318 struct mailslot_device *dev;
320 if ((dev = create_named_object_dir( root, name, 0, &mailslot_device_ops )) &&
321 get_error() != STATUS_OBJECT_NAME_EXISTS)
323 dev->mailslots = NULL;
324 if (!(dev->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, &dev->obj )) ||
325 !(dev->mailslots = create_namespace( 7 )))
327 release_object( dev );
331 if (dev) make_object_static( &dev->obj );
334 static struct mailslot *create_mailslot( struct directory *root,
335 const struct unicode_str *name, unsigned int attr,
336 int max_msgsize, int read_timeout )
339 struct unicode_str new_name;
340 struct mailslot_device *dev;
341 struct mailslot *mailslot;
344 if (!name || !name->len) return alloc_object( &mailslot_ops );
346 if (!(obj = find_object_dir( root, name, attr, &new_name ))) return NULL;
350 if (attr & OBJ_OPENIF && obj->ops == &mailslot_ops)
351 /* it already exists - there can only be one mailslot to read from */
352 set_error( STATUS_OBJECT_NAME_EXISTS );
353 else if (attr & OBJ_OPENIF)
354 set_error( STATUS_OBJECT_TYPE_MISMATCH );
356 set_error( STATUS_OBJECT_NAME_COLLISION );
357 release_object( obj );
361 if (obj->ops != &mailslot_device_ops)
363 set_error( STATUS_OBJECT_TYPE_MISMATCH );
364 release_object( obj );
368 dev = (struct mailslot_device *)obj;
369 mailslot = create_object( dev->mailslots, &mailslot_ops, &new_name, NULL );
370 release_object( dev );
372 if (!mailslot) return NULL;
375 mailslot->write_fd = NULL;
376 mailslot->max_msgsize = max_msgsize;
377 mailslot->read_timeout = read_timeout;
378 list_init( &mailslot->writers );
380 if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
382 fcntl( fds[0], F_SETFL, O_NONBLOCK );
383 fcntl( fds[1], F_SETFL, O_NONBLOCK );
384 mailslot->fd = create_anonymous_fd( &mailslot_fd_ops,
385 fds[1], &mailslot->obj );
386 mailslot->write_fd = create_anonymous_fd( &mail_writer_fd_ops,
387 fds[0], &mailslot->obj );
388 if (mailslot->fd && mailslot->write_fd) return mailslot;
390 else file_set_error();
392 release_object( mailslot );
396 static void mail_writer_dump( struct object *obj, int verbose )
398 fprintf( stderr, "Mailslot writer\n" );
401 static void mail_writer_destroy( struct object *obj)
403 struct mail_writer *writer = (struct mail_writer *) obj;
405 list_remove( &writer->entry );
406 release_object( writer->mailslot );
409 static int mail_writer_get_info( struct fd *fd )
414 static struct fd *mail_writer_get_fd( struct object *obj )
416 struct mail_writer *writer = (struct mail_writer *) obj;
418 return (struct fd *)grab_object( writer->mailslot->write_fd );
421 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
423 if (access & GENERIC_READ) access |= FILE_GENERIC_READ;
424 if (access & GENERIC_WRITE) access |= FILE_GENERIC_WRITE;
425 if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
426 if (access & GENERIC_ALL) access |= FILE_ALL_ACCESS;
427 return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
431 * Readers and writers cannot be mixed.
432 * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
434 static struct mail_writer *create_mail_writer( struct mailslot *mailslot, unsigned int access,
435 unsigned int sharing )
437 struct mail_writer *writer;
439 if (!list_empty( &mailslot->writers ))
441 writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
443 if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
444 !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
446 set_error( STATUS_SHARING_VIOLATION );
451 writer = alloc_object( &mail_writer_ops );
455 grab_object( mailslot );
456 writer->mailslot = mailslot;
457 writer->access = mail_writer_map_access( &writer->obj, access );
458 writer->sharing = sharing;
460 list_add_head( &mailslot->writers, &writer->entry );
465 static struct mailslot *get_mailslot_obj( struct process *process, obj_handle_t handle,
466 unsigned int access )
468 return (struct mailslot *)get_handle_obj( process, handle, access, &mailslot_ops );
472 /* create a mailslot */
473 DECL_HANDLER(create_mailslot)
475 struct mailslot *mailslot;
476 struct unicode_str name;
477 struct directory *root = NULL;
480 get_req_unicode_str( &name );
481 if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
484 if ((mailslot = create_mailslot( root, &name, req->attributes, req->max_msgsize,
485 req->read_timeout )))
487 reply->handle = alloc_handle( current->process, mailslot, req->access, req->attributes );
488 release_object( mailslot );
491 if (root) release_object( root );
495 /* open an existing mailslot */
496 DECL_HANDLER(open_mailslot)
498 struct mailslot *mailslot;
499 struct unicode_str name;
500 struct directory *root = NULL;
503 get_req_unicode_str( &name );
505 if (!(req->sharing & FILE_SHARE_READ))
507 set_error( STATUS_SHARING_VIOLATION );
511 if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
513 mailslot = open_object_dir( root, &name, req->attributes, &mailslot_ops );
514 if (root) release_object( root );
518 struct mail_writer *writer;
520 writer = create_mail_writer( mailslot, req->access, req->sharing );
523 reply->handle = alloc_handle( current->process, writer, req->access, req->attributes );
524 release_object( writer );
526 release_object( mailslot );
529 set_error( STATUS_NO_SUCH_FILE );
533 /* set mailslot information */
534 DECL_HANDLER(set_mailslot_info)
536 struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
540 if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
541 mailslot->read_timeout = req->read_timeout;
542 reply->max_msgsize = mailslot->max_msgsize;
543 reply->read_timeout = mailslot->read_timeout;
544 reply->msg_count = mailslot_message_count(mailslot);
546 /* get the size of the next message */
547 if (reply->msg_count)
548 reply->next_msgsize = mailslot_next_msg_size(mailslot);
550 reply->next_msgsize = MAILSLOT_NO_MESSAGE;
552 release_object( mailslot );