cmdlgtst: Update Portuguese translation and convert to UTF8.
[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     int                 write_fd;
60     unsigned int        max_msgsize;
61     timeout_t           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 struct object *mailslot_open_file( struct object *obj, unsigned int access,
70                                           unsigned int sharing, unsigned int options );
71 static void mailslot_destroy( struct object * );
72
73 static const struct object_ops mailslot_ops =
74 {
75     sizeof(struct mailslot),   /* size */
76     mailslot_dump,             /* dump */
77     no_get_type,               /* get_type */
78     add_queue,                 /* add_queue */
79     remove_queue,              /* remove_queue */
80     default_fd_signaled,       /* signaled */
81     no_satisfied,              /* satisfied */
82     no_signal,                 /* signal */
83     mailslot_get_fd,           /* get_fd */
84     mailslot_map_access,       /* map_access */
85     default_get_sd,            /* get_sd */
86     default_set_sd,            /* set_sd */
87     no_lookup_name,            /* lookup_name */
88     mailslot_open_file,        /* open_file */
89     fd_close_handle,           /* close_handle */
90     mailslot_destroy           /* destroy */
91 };
92
93 static enum server_fd_type mailslot_get_fd_type( struct fd *fd );
94 static void mailslot_queue_async( struct fd *fd, const async_data_t *data, int type, int count );
95
96 static const struct fd_ops mailslot_fd_ops =
97 {
98     default_fd_get_poll_events, /* get_poll_events */
99     default_poll_event,         /* poll_event */
100     no_flush,                   /* flush */
101     mailslot_get_fd_type,       /* get_fd_type */
102     default_fd_ioctl,           /* ioctl */
103     mailslot_queue_async,       /* queue_async */
104     default_fd_reselect_async,  /* reselect_async */
105     default_fd_cancel_async     /* cancel_async */
106 };
107
108
109 struct mail_writer
110 {
111     struct object         obj;
112     struct fd            *fd;
113     struct mailslot      *mailslot;
114     struct list           entry;
115     unsigned int          access;
116     unsigned int          sharing;
117 };
118
119 static void mail_writer_dump( struct object *obj, int verbose );
120 static struct fd *mail_writer_get_fd( struct object *obj );
121 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access );
122 static void mail_writer_destroy( struct object *obj);
123
124 static const struct object_ops mail_writer_ops =
125 {
126     sizeof(struct mail_writer), /* size */
127     mail_writer_dump,           /* dump */
128     no_get_type,                /* get_type */
129     no_add_queue,               /* add_queue */
130     NULL,                       /* remove_queue */
131     NULL,                       /* signaled */
132     NULL,                       /* satisfied */
133     no_signal,                  /* signal */
134     mail_writer_get_fd,         /* get_fd */
135     mail_writer_map_access,     /* map_access */
136     default_get_sd,             /* get_sd */
137     default_set_sd,             /* set_sd */
138     no_lookup_name,             /* lookup_name */
139     no_open_file,               /* open_file */
140     fd_close_handle,            /* close_handle */
141     mail_writer_destroy         /* destroy */
142 };
143
144 static enum server_fd_type mail_writer_get_fd_type( struct fd *fd );
145
146 static const struct fd_ops mail_writer_fd_ops =
147 {
148     default_fd_get_poll_events,  /* get_poll_events */
149     default_poll_event,          /* poll_event */
150     no_flush,                    /* flush */
151     mail_writer_get_fd_type,     /* get_fd_type */
152     default_fd_ioctl,            /* ioctl */
153     default_fd_queue_async,      /* queue_async */
154     default_fd_reselect_async,   /* reselect_async */
155     default_fd_cancel_async      /* cancel_async */
156 };
157
158
159 struct mailslot_device
160 {
161     struct object       obj;         /* object header */
162     struct fd          *fd;          /* pseudo-fd for ioctls */
163     struct namespace   *mailslots;   /* mailslot namespace */
164 };
165
166 static void mailslot_device_dump( struct object *obj, int verbose );
167 static struct object_type *mailslot_device_get_type( struct object *obj );
168 static struct fd *mailslot_device_get_fd( struct object *obj );
169 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
170                                                    unsigned int attr );
171 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
172                                                  unsigned int sharing, unsigned int options );
173 static void mailslot_device_destroy( struct object *obj );
174 static enum server_fd_type mailslot_device_get_fd_type( struct fd *fd );
175
176 static const struct object_ops mailslot_device_ops =
177 {
178     sizeof(struct mailslot_device), /* size */
179     mailslot_device_dump,           /* dump */
180     mailslot_device_get_type,       /* get_type */
181     no_add_queue,                   /* add_queue */
182     NULL,                           /* remove_queue */
183     NULL,                           /* signaled */
184     no_satisfied,                   /* satisfied */
185     no_signal,                      /* signal */
186     mailslot_device_get_fd,         /* get_fd */
187     no_map_access,                  /* map_access */
188     default_get_sd,                 /* get_sd */
189     default_set_sd,                 /* set_sd */
190     mailslot_device_lookup_name,    /* lookup_name */
191     mailslot_device_open_file,      /* open_file */
192     fd_close_handle,                /* close_handle */
193     mailslot_device_destroy         /* destroy */
194 };
195
196 static const struct fd_ops mailslot_device_fd_ops =
197 {
198     default_fd_get_poll_events,     /* get_poll_events */
199     default_poll_event,             /* poll_event */
200     no_flush,                       /* flush */
201     mailslot_device_get_fd_type,    /* get_fd_type */
202     default_fd_ioctl,               /* ioctl */
203     default_fd_queue_async,         /* queue_async */
204     default_fd_reselect_async,      /* reselect_async */
205     default_fd_cancel_async         /* cancel_async */
206 };
207
208 static void mailslot_destroy( struct object *obj)
209 {
210     struct mailslot *mailslot = (struct mailslot *) obj;
211
212     assert( mailslot->fd );
213
214     if (mailslot->write_fd != -1)
215     {
216         shutdown( mailslot->write_fd, SHUT_RDWR );
217         close( mailslot->write_fd );
218     }
219     release_object( mailslot->fd );
220 }
221
222 static void mailslot_dump( struct object *obj, int verbose )
223 {
224     struct mailslot *mailslot = (struct mailslot *) obj;
225
226     assert( obj->ops == &mailslot_ops );
227     fprintf( stderr, "Mailslot max_msgsize=%d read_timeout=%s\n",
228              mailslot->max_msgsize, get_timeout_str(mailslot->read_timeout) );
229 }
230
231 static enum server_fd_type mailslot_get_fd_type( struct fd *fd )
232 {
233     return FD_TYPE_MAILSLOT;
234 }
235
236 static struct fd *mailslot_get_fd( struct object *obj )
237 {
238     struct mailslot *mailslot = (struct mailslot *) obj;
239
240     return (struct fd *)grab_object( mailslot->fd );
241 }
242
243 static unsigned int mailslot_map_access( struct object *obj, unsigned int access )
244 {
245     /* mailslots can only be read */
246     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
247     if (access & GENERIC_ALL)     access |= FILE_GENERIC_READ;
248     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
249 }
250
251 static struct object *mailslot_open_file( struct object *obj, unsigned int access,
252                                           unsigned int sharing, unsigned int options )
253 {
254     struct mailslot *mailslot = (struct mailslot *)obj;
255     struct mail_writer *writer;
256     int unix_fd;
257
258     if (!(sharing & FILE_SHARE_READ))
259     {
260         set_error( STATUS_SHARING_VIOLATION );
261         return NULL;
262     }
263
264     if (!list_empty( &mailslot->writers ))
265     {
266         /* Readers and writers cannot be mixed.
267          * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
268          */
269         writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
270
271         if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
272            !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
273         {
274             set_error( STATUS_SHARING_VIOLATION );
275             return NULL;
276         }
277     }
278
279     if ((unix_fd = dup( mailslot->write_fd )) == -1)
280     {
281         file_set_error();
282         return NULL;
283     }
284     if (!(writer = alloc_object( &mail_writer_ops )))
285     {
286         close( unix_fd );
287         return NULL;
288     }
289     grab_object( mailslot );
290     writer->mailslot = mailslot;
291     writer->access   = mail_writer_map_access( &writer->obj, access );
292     writer->sharing  = sharing;
293     list_add_head( &mailslot->writers, &writer->entry );
294
295     if (!(writer->fd = create_anonymous_fd( &mail_writer_fd_ops, unix_fd, &writer->obj, options )))
296     {
297         release_object( writer );
298         return NULL;
299     }
300     return &writer->obj;
301 }
302
303 static void mailslot_queue_async( struct fd *fd, const async_data_t *data, int type, int count )
304 {
305     struct mailslot *mailslot = get_fd_user( fd );
306     struct async *async;
307
308     assert(mailslot->obj.ops == &mailslot_ops);
309
310     if ((async = fd_queue_async( fd, data, type )))
311     {
312         async_set_timeout( async, mailslot->read_timeout ? mailslot->read_timeout : -1,
313                            STATUS_IO_TIMEOUT );
314         release_object( async );
315         set_error( STATUS_PENDING );
316     }
317 }
318
319 static void mailslot_device_dump( struct object *obj, int verbose )
320 {
321     assert( obj->ops == &mailslot_device_ops );
322     fprintf( stderr, "Mail slot device\n" );
323 }
324
325 static struct object_type *mailslot_device_get_type( struct object *obj )
326 {
327     static const WCHAR name[] = {'D','e','v','i','c','e'};
328     static const struct unicode_str str = { name, sizeof(name) };
329     return get_object_type( &str );
330 }
331
332 static struct fd *mailslot_device_get_fd( struct object *obj )
333 {
334     struct mailslot_device *device = (struct mailslot_device *)obj;
335     return (struct fd *)grab_object( device->fd );
336 }
337
338 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
339                                                    unsigned int attr )
340 {
341     struct mailslot_device *device = (struct mailslot_device*)obj;
342     struct object *found;
343
344     assert( obj->ops == &mailslot_device_ops );
345
346     if ((found = find_object( device->mailslots, name, attr | OBJ_CASE_INSENSITIVE )))
347         name->len = 0;
348
349     return found;
350 }
351
352 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
353                                                  unsigned int sharing, unsigned int options )
354 {
355     return grab_object( obj );
356 }
357
358 static void mailslot_device_destroy( struct object *obj )
359 {
360     struct mailslot_device *device = (struct mailslot_device*)obj;
361     assert( obj->ops == &mailslot_device_ops );
362     if (device->fd) release_object( device->fd );
363     free( device->mailslots );
364 }
365
366 static enum server_fd_type mailslot_device_get_fd_type( struct fd *fd )
367 {
368     return FD_TYPE_DEVICE;
369 }
370
371 void create_mailslot_device( struct directory *root, const struct unicode_str *name )
372 {
373     struct mailslot_device *dev;
374
375     if ((dev = create_named_object_dir( root, name, 0, &mailslot_device_ops )) &&
376         get_error() != STATUS_OBJECT_NAME_EXISTS)
377     {
378         dev->mailslots = NULL;
379         if (!(dev->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, &dev->obj, 0 )) ||
380             !(dev->mailslots = create_namespace( 7 )))
381         {
382             release_object( dev );
383             dev = NULL;
384         }
385     }
386     if (dev) make_object_static( &dev->obj );
387 }
388
389 static struct mailslot *create_mailslot( struct directory *root,
390                                          const struct unicode_str *name, unsigned int attr,
391                                          int max_msgsize, timeout_t read_timeout )
392 {
393     struct object *obj;
394     struct unicode_str new_name;
395     struct mailslot_device *dev;
396     struct mailslot *mailslot;
397     int fds[2];
398
399     if (!name || !name->len) return alloc_object( &mailslot_ops );
400
401     if (!(obj = find_object_dir( root, name, attr, &new_name )))
402     {
403         set_error( STATUS_OBJECT_NAME_INVALID );
404         return NULL;
405     }
406
407     if (!new_name.len)
408     {
409         if (attr & OBJ_OPENIF && obj->ops == &mailslot_ops)
410             /* it already exists - there can only be one mailslot to read from */
411             set_error( STATUS_OBJECT_NAME_EXISTS );
412         else if (attr & OBJ_OPENIF)
413             set_error( STATUS_OBJECT_TYPE_MISMATCH );
414         else
415             set_error( STATUS_OBJECT_NAME_COLLISION );
416         release_object( obj );
417         return NULL;
418     }
419
420     if (obj->ops != &mailslot_device_ops)
421     {
422         set_error( STATUS_OBJECT_NAME_INVALID );
423         release_object( obj );
424         return NULL;
425     }
426
427     dev = (struct mailslot_device *)obj;
428     mailslot = create_object( dev->mailslots, &mailslot_ops, &new_name, NULL );
429     release_object( dev );
430
431     if (!mailslot) return NULL;
432
433     mailslot->fd = NULL;
434     mailslot->write_fd = -1;
435     mailslot->max_msgsize = max_msgsize;
436     mailslot->read_timeout = read_timeout;
437     list_init( &mailslot->writers );
438
439     if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
440     {
441         fcntl( fds[0], F_SETFL, O_NONBLOCK );
442         fcntl( fds[1], F_SETFL, O_NONBLOCK );
443         shutdown( fds[0], SHUT_RD );
444         mailslot->write_fd = fds[0];
445         mailslot->fd = create_anonymous_fd( &mailslot_fd_ops, fds[1], &mailslot->obj,
446                                             FILE_SYNCHRONOUS_IO_NONALERT );
447         if (mailslot->fd) return mailslot;
448     }
449     else file_set_error();
450
451     release_object( mailslot );
452     return NULL;
453 }
454
455 static void mail_writer_dump( struct object *obj, int verbose )
456 {
457     fprintf( stderr, "Mailslot writer\n" );
458 }
459
460 static void mail_writer_destroy( struct object *obj)
461 {
462     struct mail_writer *writer = (struct mail_writer *) obj;
463
464     if (writer->fd) release_object( writer->fd );
465     list_remove( &writer->entry );
466     release_object( writer->mailslot );
467 }
468
469 static enum server_fd_type mail_writer_get_fd_type( struct fd *fd )
470 {
471     return FD_TYPE_MAILSLOT;
472 }
473
474 static struct fd *mail_writer_get_fd( struct object *obj )
475 {
476     struct mail_writer *writer = (struct mail_writer *) obj;
477     return (struct fd *)grab_object( writer->fd );
478 }
479
480 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
481 {
482     /* mailslot writers can only get write access */
483     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
484     if (access & GENERIC_ALL)     access |= FILE_GENERIC_WRITE;
485     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
486 }
487
488 static struct mailslot *get_mailslot_obj( struct process *process, obj_handle_t handle,
489                                           unsigned int access )
490 {
491     return (struct mailslot *)get_handle_obj( process, handle, access, &mailslot_ops );
492 }
493
494
495 /* create a mailslot */
496 DECL_HANDLER(create_mailslot)
497 {
498     struct mailslot *mailslot;
499     struct unicode_str name;
500     struct directory *root = NULL;
501
502     reply->handle = 0;
503     get_req_unicode_str( &name );
504     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
505         return;
506
507     if ((mailslot = create_mailslot( root, &name, req->attributes, req->max_msgsize,
508                                      req->read_timeout )))
509     {
510         reply->handle = alloc_handle( current->process, mailslot, req->access, req->attributes );
511         release_object( mailslot );
512     }
513
514     if (root) release_object( root );
515 }
516
517
518 /* set mailslot information */
519 DECL_HANDLER(set_mailslot_info)
520 {
521     struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
522
523     if (mailslot)
524     {
525         if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
526             mailslot->read_timeout = req->read_timeout;
527         reply->max_msgsize = mailslot->max_msgsize;
528         reply->read_timeout = mailslot->read_timeout;
529         release_object( mailslot );
530     }
531 }