server: Don't enforce mailslots path format in ntdll, only in the server.
[wine] / server / mailslot.c
1 /*
2  * Server-side mailslot management
3  *
4  * Copyright (C) 1998 Alexandre Julliard
5  * Copyright (C) 2005 Mike McCormack
6  *
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.
11  *
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.
16  *
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
20  *
21  */
22
23 #include "config.h"
24 #include "wine/port.h"
25 #include "ntstatus.h"
26 #define WIN32_NO_STATUS
27 #include "wine/unicode.h"
28
29 #include <assert.h>
30 #include <fcntl.h>
31 #include <string.h>
32 #include <stdarg.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <sys/time.h>
36 #include <sys/types.h>
37
38 #ifdef HAVE_SYS_IOCTL_H
39 #include <sys/ioctl.h>
40 #endif
41 #ifdef HAVE_SYS_SOCKET_H
42 #include <sys/socket.h>
43 #endif
44 #ifdef HAVE_SYS_FILIO_H
45 #include <sys/filio.h>
46 #endif
47 #include "windef.h"
48 #include "winternl.h"
49
50 #include "file.h"
51 #include "handle.h"
52 #include "thread.h"
53 #include "request.h"
54
55 struct mailslot
56 {
57     struct object       obj;
58     struct fd          *fd;
59     struct fd          *write_fd;
60     unsigned int        max_msgsize;
61     int                 read_timeout;
62     struct list         writers;
63 };
64
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 * );
70
71 static const struct object_ops mailslot_ops =
72 {
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_open_file,              /* open_file */
84     fd_close_handle,           /* close_handle */
85     mailslot_destroy           /* destroy */
86 };
87
88 static enum server_fd_type mailslot_get_info( struct fd *fd, int *flags );
89 static void mailslot_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
90
91 static const struct fd_ops mailslot_fd_ops =
92 {
93     default_fd_get_poll_events, /* get_poll_events */
94     default_poll_event,         /* poll_event */
95     no_flush,                   /* flush */
96     mailslot_get_info,          /* get_file_info */
97     mailslot_queue_async,       /* queue_async */
98     default_fd_cancel_async     /* cancel_async */
99 };
100
101
102 struct mail_writer
103 {
104     struct object         obj;
105     struct mailslot      *mailslot;
106     struct list           entry;
107     unsigned int          access;
108     unsigned int          sharing;
109 };
110
111 static void mail_writer_dump( struct object *obj, int verbose );
112 static struct fd *mail_writer_get_fd( struct object *obj );
113 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access );
114 static void mail_writer_destroy( struct object *obj);
115
116 static const struct object_ops mail_writer_ops =
117 {
118     sizeof(struct mail_writer), /* size */
119     mail_writer_dump,           /* dump */
120     no_add_queue,               /* add_queue */
121     NULL,                       /* remove_queue */
122     NULL,                       /* signaled */
123     NULL,                       /* satisfied */
124     no_signal,                  /* signal */
125     mail_writer_get_fd,         /* get_fd */
126     mail_writer_map_access,     /* map_access */
127     no_lookup_name,             /* lookup_name */
128     no_open_file,               /* open_file */
129     fd_close_handle,            /* close_handle */
130     mail_writer_destroy         /* destroy */
131 };
132
133 static enum server_fd_type mail_writer_get_info( struct fd *fd, int *flags );
134
135 static const struct fd_ops mail_writer_fd_ops =
136 {
137     NULL,                        /* get_poll_events */
138     NULL,                        /* poll_event */
139     no_flush,                    /* flush */
140     mail_writer_get_info,        /* get_file_info */
141     no_queue_async,              /* queue_async */
142     NULL                         /* cancel_async */
143 };
144
145
146 struct mailslot_device
147 {
148     struct object       obj;         /* object header */
149     struct fd          *fd;          /* pseudo-fd for ioctls */
150     struct namespace   *mailslots;   /* mailslot namespace */
151 };
152
153 static void mailslot_device_dump( struct object *obj, int verbose );
154 static struct fd *mailslot_device_get_fd( struct object *obj );
155 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
156                                                    unsigned int attr );
157 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
158                                                  unsigned int sharing, unsigned int options );
159 static void mailslot_device_destroy( struct object *obj );
160 static enum server_fd_type mailslot_device_get_file_info( struct fd *fd, int *flags );
161
162 static const struct object_ops mailslot_device_ops =
163 {
164     sizeof(struct mailslot_device), /* size */
165     mailslot_device_dump,           /* dump */
166     no_add_queue,                   /* add_queue */
167     NULL,                           /* remove_queue */
168     NULL,                           /* signaled */
169     no_satisfied,                   /* satisfied */
170     no_signal,                      /* signal */
171     mailslot_device_get_fd,         /* get_fd */
172     no_map_access,                  /* map_access */
173     mailslot_device_lookup_name,    /* lookup_name */
174     mailslot_device_open_file,      /* open_file */
175     fd_close_handle,                /* close_handle */
176     mailslot_device_destroy         /* destroy */
177 };
178
179 static const struct fd_ops mailslot_device_fd_ops =
180 {
181     default_fd_get_poll_events,     /* get_poll_events */
182     default_poll_event,             /* poll_event */
183     no_flush,                       /* flush */
184     mailslot_device_get_file_info,  /* get_file_info */
185     default_fd_queue_async,         /* queue_async */
186     default_fd_cancel_async         /* cancel_async */
187 };
188
189 static void mailslot_destroy( struct object *obj)
190 {
191     struct mailslot *mailslot = (struct mailslot *) obj;
192
193     assert( mailslot->fd );
194     assert( mailslot->write_fd );
195
196     release_object( mailslot->fd );
197     release_object( mailslot->write_fd );
198 }
199
200 static void mailslot_dump( struct object *obj, int verbose )
201 {
202     struct mailslot *mailslot = (struct mailslot *) obj;
203
204     assert( obj->ops == &mailslot_ops );
205     fprintf( stderr, "Mailslot max_msgsize=%d read_timeout=%d\n",
206              mailslot->max_msgsize, mailslot->read_timeout );
207 }
208
209 static int mailslot_message_count(struct mailslot *mailslot)
210 {
211     struct pollfd pfd;
212
213     /* poll the socket to see if there's any messages */
214     pfd.fd = get_unix_fd( mailslot->fd );
215     pfd.events = POLLIN;
216     pfd.revents = 0;
217     return (poll( &pfd, 1, 0 ) == 1) ? 1 : 0;
218 }
219
220 static enum server_fd_type mailslot_get_info( struct fd *fd, int *flags )
221 {
222     struct mailslot *mailslot = get_fd_user( fd );
223     assert( mailslot->obj.ops == &mailslot_ops );
224     *flags = FD_FLAG_TIMEOUT | FD_FLAG_AVAILABLE;
225     return FD_TYPE_MAILSLOT;
226 }
227
228 static struct fd *mailslot_get_fd( struct object *obj )
229 {
230     struct mailslot *mailslot = (struct mailslot *) obj;
231
232     return (struct fd *)grab_object( mailslot->fd );
233 }
234
235 static unsigned int mailslot_map_access( struct object *obj, unsigned int access )
236 {
237     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
238     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
239     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
240     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
241     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
242 }
243
244 static void mailslot_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
245 {
246     struct mailslot *mailslot = get_fd_user( fd );
247
248     assert(mailslot->obj.ops == &mailslot_ops);
249
250     if (type != ASYNC_TYPE_READ)
251     {
252         set_error(STATUS_INVALID_PARAMETER);
253         return;
254     }
255
256     if (list_empty( &mailslot->writers ) ||
257         !mailslot_message_count( mailslot ))
258     {
259         set_error(STATUS_IO_TIMEOUT);
260         return;
261     }
262
263     if (mailslot->read_timeout != -1)
264     {
265         struct timeval when = current_time;
266         add_timeout( &when, mailslot->read_timeout );
267         fd_queue_async_timeout( fd, data, type, count, &when );
268     }
269     else fd_queue_async_timeout( fd, data, type, count, NULL );
270 }
271
272 static void mailslot_device_dump( struct object *obj, int verbose )
273 {
274     assert( obj->ops == &mailslot_device_ops );
275     fprintf( stderr, "Mail slot device\n" );
276 }
277
278 static struct fd *mailslot_device_get_fd( struct object *obj )
279 {
280     struct mailslot_device *device = (struct mailslot_device *)obj;
281     return (struct fd *)grab_object( device->fd );
282 }
283
284 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
285                                                    unsigned int attr )
286 {
287     struct mailslot_device *device = (struct mailslot_device*)obj;
288     struct object *found;
289
290     assert( obj->ops == &mailslot_device_ops );
291
292     if ((found = find_object( device->mailslots, name, attr | OBJ_CASE_INSENSITIVE )))
293         name->len = 0;
294
295     return found;
296 }
297
298 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
299                                                  unsigned int sharing, unsigned int options )
300 {
301     return grab_object( obj );
302 }
303
304 static void mailslot_device_destroy( struct object *obj )
305 {
306     struct mailslot_device *device = (struct mailslot_device*)obj;
307     assert( obj->ops == &mailslot_device_ops );
308     if (device->fd) release_object( device->fd );
309     free( device->mailslots );
310 }
311
312 static enum server_fd_type mailslot_device_get_file_info( struct fd *fd, int *flags )
313 {
314     *flags = 0;
315     return FD_TYPE_DEVICE;
316 }
317
318 void create_mailslot_device( struct directory *root, const struct unicode_str *name )
319 {
320     struct mailslot_device *dev;
321
322     if ((dev = create_named_object_dir( root, name, 0, &mailslot_device_ops )) &&
323         get_error() != STATUS_OBJECT_NAME_EXISTS)
324     {
325         dev->mailslots = NULL;
326         if (!(dev->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, &dev->obj )) ||
327             !(dev->mailslots = create_namespace( 7 )))
328         {
329             release_object( dev );
330             dev = NULL;
331         }
332     }
333     if (dev) make_object_static( &dev->obj );
334 }
335
336 static struct mailslot *create_mailslot( struct directory *root,
337                                          const struct unicode_str *name, unsigned int attr,
338                                          int max_msgsize, int read_timeout )
339 {
340     struct object *obj;
341     struct unicode_str new_name;
342     struct mailslot_device *dev;
343     struct mailslot *mailslot;
344     int fds[2];
345
346     if (!name || !name->len) return alloc_object( &mailslot_ops );
347
348     if (!(obj = find_object_dir( root, name, attr, &new_name )))
349     {
350         set_error( STATUS_OBJECT_NAME_INVALID );
351         return NULL;
352     }
353
354     if (!new_name.len)
355     {
356         if (attr & OBJ_OPENIF && obj->ops == &mailslot_ops)
357             /* it already exists - there can only be one mailslot to read from */
358             set_error( STATUS_OBJECT_NAME_EXISTS );
359         else if (attr & OBJ_OPENIF)
360             set_error( STATUS_OBJECT_TYPE_MISMATCH );
361         else
362             set_error( STATUS_OBJECT_NAME_COLLISION );
363         release_object( obj );
364         return NULL;
365     }
366
367     if (obj->ops != &mailslot_device_ops)
368     {
369         set_error( STATUS_OBJECT_NAME_INVALID );
370         release_object( obj );
371         return NULL;
372     }
373
374     dev = (struct mailslot_device *)obj;
375     mailslot = create_object( dev->mailslots, &mailslot_ops, &new_name, NULL );
376     release_object( dev );
377
378     if (!mailslot) return NULL;
379
380     mailslot->fd = NULL;
381     mailslot->write_fd = NULL;
382     mailslot->max_msgsize = max_msgsize;
383     mailslot->read_timeout = read_timeout;
384     list_init( &mailslot->writers );
385
386     if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
387     {
388         fcntl( fds[0], F_SETFL, O_NONBLOCK );
389         fcntl( fds[1], F_SETFL, O_NONBLOCK );
390         mailslot->fd = create_anonymous_fd( &mailslot_fd_ops,
391                                 fds[1], &mailslot->obj );
392         mailslot->write_fd = create_anonymous_fd( &mail_writer_fd_ops,
393                                 fds[0], &mailslot->obj );
394         if (mailslot->fd && mailslot->write_fd) return mailslot;
395     }
396     else file_set_error();
397
398     release_object( mailslot );
399     return NULL;
400 }
401
402 static void mail_writer_dump( struct object *obj, int verbose )
403 {
404     fprintf( stderr, "Mailslot writer\n" );
405 }
406
407 static void mail_writer_destroy( struct object *obj)
408 {
409     struct mail_writer *writer = (struct mail_writer *) obj;
410
411     list_remove( &writer->entry );
412     release_object( writer->mailslot );
413 }
414
415 static enum server_fd_type mail_writer_get_info( struct fd *fd, int *flags )
416 {
417     *flags = 0;
418     return FD_TYPE_MAILSLOT;
419 }
420
421 static struct fd *mail_writer_get_fd( struct object *obj )
422 {
423     struct mail_writer *writer = (struct mail_writer *) obj;
424
425     return (struct fd *)grab_object( writer->mailslot->write_fd );
426 }
427
428 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
429 {
430     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
431     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
432     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
433     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
434     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
435 }
436
437 /*
438  * Readers and writers cannot be mixed.
439  * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
440  */
441 static struct mail_writer *create_mail_writer( struct mailslot *mailslot, unsigned int access,
442                                                unsigned int sharing )
443 {
444     struct mail_writer *writer;
445
446     if (!list_empty( &mailslot->writers ))
447     {
448         writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
449
450         if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
451            !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
452         {
453             set_error( STATUS_SHARING_VIOLATION );
454             return NULL;
455         }
456     }
457
458     writer = alloc_object( &mail_writer_ops );
459     if (!writer)
460         return NULL;
461
462     grab_object( mailslot );
463     writer->mailslot = mailslot;
464     writer->access   = mail_writer_map_access( &writer->obj, access );
465     writer->sharing  = sharing;
466
467     list_add_head( &mailslot->writers, &writer->entry );
468
469     return writer;
470 }
471
472 static struct mailslot *get_mailslot_obj( struct process *process, obj_handle_t handle,
473                                           unsigned int access )
474 {
475     return (struct mailslot *)get_handle_obj( process, handle, access, &mailslot_ops );
476 }
477
478
479 /* create a mailslot */
480 DECL_HANDLER(create_mailslot)
481 {
482     struct mailslot *mailslot;
483     struct unicode_str name;
484     struct directory *root = NULL;
485
486     reply->handle = 0;
487     get_req_unicode_str( &name );
488     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
489         return;
490
491     if ((mailslot = create_mailslot( root, &name, req->attributes, req->max_msgsize,
492                                      req->read_timeout )))
493     {
494         reply->handle = alloc_handle( current->process, mailslot, req->access, req->attributes );
495         release_object( mailslot );
496     }
497
498     if (root) release_object( root );
499 }
500
501
502 /* open an existing mailslot */
503 DECL_HANDLER(open_mailslot)
504 {
505     struct mailslot *mailslot;
506     struct unicode_str name;
507     struct directory *root = NULL;
508
509     reply->handle = 0;
510     get_req_unicode_str( &name );
511
512     if (!(req->sharing & FILE_SHARE_READ))
513     {
514         set_error( STATUS_SHARING_VIOLATION );
515         return;
516     }
517
518     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
519         return;
520     mailslot = open_object_dir( root, &name, req->attributes, &mailslot_ops );
521     if (root) release_object( root );
522
523     if (mailslot)
524     {
525         struct mail_writer *writer;
526
527         writer = create_mail_writer( mailslot, req->access, req->sharing );
528         if (writer)
529         {
530             reply->handle = alloc_handle( current->process, writer, req->access, req->attributes );
531             release_object( writer );
532         }
533         release_object( mailslot );
534     }
535     else
536         set_error( STATUS_NO_SUCH_FILE );
537 }
538
539
540 /* set mailslot information */
541 DECL_HANDLER(set_mailslot_info)
542 {
543     struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
544
545     if (mailslot)
546     {
547         if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
548             mailslot->read_timeout = req->read_timeout;
549         reply->max_msgsize = mailslot->max_msgsize;
550         reply->read_timeout = mailslot->read_timeout;
551         release_object( mailslot );
552     }
553 }