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