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
  28 #include <assert.h>
  29 #include <fcntl.h>
  30 #include <string.h>
  31 #include <stdarg.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <sys/time.h>
  35 #include <sys/types.h>
  36
  37 #ifdef HAVE_SYS_IOCTL_H
  38 #include <sys/ioctl.h>
  39 #endif
  40 #ifdef HAVE_SYS_SOCKET_H
  41 #include <sys/socket.h>
  42 #endif
  43 #ifdef HAVE_SYS_FILIO_H
  44 #include <sys/filio.h>
  45 #endif
  46 #include "windef.h"
  47 #include "winternl.h"
  48
  49 #include "file.h"
  50 #include "handle.h"
  51 #include "thread.h"
  52 #include "request.h"
  53
  54 struct mailslot
  55 {
  56     struct object       obj;
  57     struct fd          *fd;
  58     int                 write_fd;
  59     unsigned int        max_msgsize;
  60     timeout_t           read_timeout;
  61     struct list         writers;
  62 };
  63
  64 /* mailslot functions */
  65 static void mailslot_dump( struct object*, int );
  66 static struct fd *mailslot_get_fd( struct object * );
  67 static unsigned int mailslot_map_access( struct object *obj, unsigned int access );
  68 static int mailslot_link_name( struct object *obj, struct object_name *name, struct object *parent );
  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     &file_type,                /* type */
  77     mailslot_dump,             /* dump */
  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     default_get_full_name,     /* get_full_name */
  88     no_lookup_name,            /* lookup_name */
  89     mailslot_link_name,        /* link_name */
  90     default_unlink_name,       /* unlink_name */
  91     mailslot_open_file,        /* open_file */
  92     no_kernel_obj_list,        /* get_kernel_obj_list */
  93     fd_close_handle,           /* close_handle */
  94     mailslot_destroy           /* destroy */
  95 };
  96
  97 static enum server_fd_type mailslot_get_fd_type( struct fd *fd );
  98 static void mailslot_queue_async( struct fd *fd, struct async *async, int type, int count );
  99
 100 static const struct fd_ops mailslot_fd_ops =
 101 {
 102     default_fd_get_poll_events, /* get_poll_events */
 103     default_poll_event,         /* poll_event */
 104     mailslot_get_fd_type,       /* get_fd_type */
 105     no_fd_read,                 /* read */
 106     no_fd_write,                /* write */
 107     no_fd_flush,                /* flush */
 108     default_fd_get_file_info,   /* get_file_info */
 109     no_fd_get_volume_info,      /* get_volume_info */
 110     default_fd_ioctl,           /* ioctl */
 111     mailslot_queue_async,       /* queue_async */
 112     default_fd_reselect_async   /* reselect_async */
 113 };
 114
 115
 116 struct mail_writer
 117 {
 118     struct object         obj;
 119     struct fd            *fd;
 120     struct mailslot      *mailslot;
 121     struct list           entry;
 122     unsigned int          access;
 123     unsigned int          sharing;
 124 };
 125
 126 static void mail_writer_dump( struct object *obj, int verbose );
 127 static struct fd *mail_writer_get_fd( struct object *obj );
 128 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access );
 129 static void mail_writer_destroy( struct object *obj);
 130
 131 static const struct object_ops mail_writer_ops =
 132 {
 133     sizeof(struct mail_writer), /* size */
 134     &file_type,                 /* type */
 135     mail_writer_dump,           /* dump */
 136     no_add_queue,               /* add_queue */
 137     NULL,                       /* remove_queue */
 138     NULL,                       /* signaled */
 139     NULL,                       /* satisfied */
 140     no_signal,                  /* signal */
 141     mail_writer_get_fd,         /* get_fd */
 142     mail_writer_map_access,     /* map_access */
 143     default_get_sd,             /* get_sd */
 144     default_set_sd,             /* set_sd */
 145     no_get_full_name,           /* get_full_name */
 146     no_lookup_name,             /* lookup_name */
 147     no_link_name,               /* link_name */
 148     NULL,                       /* unlink_name */
 149     no_open_file,               /* open_file */
 150     no_kernel_obj_list,         /* get_kernel_obj_list */
 151     fd_close_handle,            /* close_handle */
 152     mail_writer_destroy         /* destroy */
 153 };
 154
 155 static enum server_fd_type mail_writer_get_fd_type( struct fd *fd );
 156
 157 static const struct fd_ops mail_writer_fd_ops =
 158 {
 159     default_fd_get_poll_events,  /* get_poll_events */
 160     default_poll_event,          /* poll_event */
 161     mail_writer_get_fd_type,     /* get_fd_type */
 162     no_fd_read,                  /* read */
 163     no_fd_write,                 /* write */
 164     no_fd_flush,                 /* flush */
 165     default_fd_get_file_info,    /* get_file_info */
 166     no_fd_get_volume_info,       /* get_volume_info */
 167     default_fd_ioctl,            /* ioctl */
 168     default_fd_queue_async,      /* queue_async */
 169     default_fd_reselect_async    /* reselect_async */
 170 };
 171
 172
 173 struct mailslot_device
 174 {
 175     struct object       obj;         /* object header */
 176     struct namespace   *mailslots;   /* mailslot namespace */
 177 };
 178
 179 struct mailslot_device_file
 180 {
 181     struct object           obj;    /* object header */
 182     struct fd              *fd;     /* pseudo-fd for ioctls */
 183     struct mailslot_device *device; /* mailslot device */
 184 };
 185
 186 static void mailslot_device_dump( struct object *obj, int verbose );
 187 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
 188                                                    unsigned int attr, struct object *root );
 189 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
 190                                                  unsigned int sharing, unsigned int options );
 191 static void mailslot_device_destroy( struct object *obj );
 192
 193 static const struct object_ops mailslot_device_ops =
 194 {
 195     sizeof(struct mailslot_device), /* size */
 196     &device_type,                   /* type */
 197     mailslot_device_dump,           /* dump */
 198     no_add_queue,                   /* add_queue */
 199     NULL,                           /* remove_queue */
 200     NULL,                           /* signaled */
 201     no_satisfied,                   /* satisfied */
 202     no_signal,                      /* signal */
 203     no_get_fd,                      /* get_fd */
 204     default_map_access,             /* map_access */
 205     default_get_sd,                 /* get_sd */
 206     default_set_sd,                 /* set_sd */
 207     default_get_full_name,          /* get_full_name */
 208     mailslot_device_lookup_name,    /* lookup_name */
 209     directory_link_name,            /* link_name */
 210     default_unlink_name,            /* unlink_name */
 211     mailslot_device_open_file,      /* open_file */
 212     no_kernel_obj_list,             /* get_kernel_obj_list */
 213     no_close_handle,                /* close_handle */
 214     mailslot_device_destroy         /* destroy */
 215 };
 216
 217 static void mailslot_device_file_dump( struct object *obj, int verbose );
 218 static struct fd *mailslot_device_file_get_fd( struct object *obj );
 219 static WCHAR *mailslot_device_file_get_full_name( struct object *obj, data_size_t *len );
 220 static void mailslot_device_file_destroy( struct object *obj );
 221 static enum server_fd_type mailslot_device_file_get_fd_type( struct fd *fd );
 222
 223 static const struct object_ops mailslot_device_file_ops =
 224 {
 225     sizeof(struct mailslot_device_file),    /* size */
 226     &file_type,                             /* type */
 227     mailslot_device_file_dump,              /* dump */
 228     add_queue,                              /* add_queue */
 229     remove_queue,                           /* remove_queue */
 230     default_fd_signaled,                    /* signaled */
 231     no_satisfied,                           /* satisfied */
 232     no_signal,                              /* signal */
 233     mailslot_device_file_get_fd,            /* get_fd */
 234     default_map_access,                     /* map_access */
 235     default_get_sd,                         /* get_sd */
 236     default_set_sd,                         /* set_sd */
 237     mailslot_device_file_get_full_name,     /* get_full_name */
 238     no_lookup_name,                         /* lookup_name */
 239     no_link_name,                           /* link_name */
 240     NULL,                                   /* unlink_name */
 241     no_open_file,                           /* open_file */
 242     no_kernel_obj_list,                     /* get_kernel_obj_list */
 243     fd_close_handle,                        /* close_handle */
 244     mailslot_device_file_destroy            /* destroy */
 245 };
 246
 247 static const struct fd_ops mailslot_device_fd_ops =
 248 {
 249     default_fd_get_poll_events,         /* get_poll_events */
 250     default_poll_event,                 /* poll_event */
 251     mailslot_device_file_get_fd_type,   /* get_fd_type */
 252     no_fd_read,                         /* read */
 253     no_fd_write,                        /* write */
 254     no_fd_flush,                        /* flush */
 255     default_fd_get_file_info,           /* get_file_info */
 256     no_fd_get_volume_info,              /* get_volume_info */
 257     default_fd_ioctl,                   /* ioctl */
 258     default_fd_queue_async,             /* queue_async */
 259     default_fd_reselect_async           /* reselect_async */
 260 };
 261
 262 static void mailslot_destroy( struct object *obj)
 263 {
 264     struct mailslot *mailslot = (struct mailslot *) obj;
 265
 266     assert( mailslot->fd );
 267
 268     if (mailslot->write_fd != -1)
 269     {
 270         shutdown( mailslot->write_fd, SHUT_RDWR );
 271         close( mailslot->write_fd );
 272     }
 273     release_object( mailslot->fd );
 274 }
 275
 276 static void mailslot_dump( struct object *obj, int verbose )
 277 {
 278     struct mailslot *mailslot = (struct mailslot *) obj;
 279
 280     assert( obj->ops == &mailslot_ops );
 281     fprintf( stderr, "Mailslot max_msgsize=%d read_timeout=%s\n",
 282              mailslot->max_msgsize, get_timeout_str(mailslot->read_timeout) );
 283 }
 284
 285 static enum server_fd_type mailslot_get_fd_type( struct fd *fd )
 286 {
 287     return FD_TYPE_MAILSLOT;
 288 }
 289
 290 static struct fd *mailslot_get_fd( struct object *obj )
 291 {
 292     struct mailslot *mailslot = (struct mailslot *) obj;
 293
 294     return (struct fd *)grab_object( mailslot->fd );
 295 }
 296
 297 static unsigned int mailslot_map_access( struct object *obj, unsigned int access )
 298 {
 299     /* mailslots can only be read */
 300     return default_map_access( obj, access ) & FILE_GENERIC_READ;
 301 }
 302
 303 static int mailslot_link_name( struct object *obj, struct object_name *name, struct object *parent )
 304 {
 305     struct mailslot_device *dev = (struct mailslot_device *)parent;
 306
 307     if (parent->ops != &mailslot_device_ops)
 308     {
 309         set_error( STATUS_OBJECT_NAME_INVALID );
 310         return 0;
 311     }
 312     namespace_add( dev->mailslots, name );
 313     name->parent = grab_object( parent );
 314     return 1;
 315 }
 316
 317 static struct object *mailslot_open_file( struct object *obj, unsigned int access,
 318                                           unsigned int sharing, unsigned int options )
 319 {
 320     struct mailslot *mailslot = (struct mailslot *)obj;
 321     struct mail_writer *writer;
 322     int unix_fd;
 323
 324     if (!(sharing & FILE_SHARE_READ))
 325     {
 326         set_error( STATUS_SHARING_VIOLATION );
 327         return NULL;
 328     }
 329
 330     if (!list_empty( &mailslot->writers ))
 331     {
 332         /* Readers and writers cannot be mixed.
 333          * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
 334          */
 335         writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
 336
 337         if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
 338            !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
 339         {
 340             set_error( STATUS_SHARING_VIOLATION );
 341             return NULL;
 342         }
 343     }
 344
 345     if ((unix_fd = dup( mailslot->write_fd )) == -1)
 346     {
 347         file_set_error();
 348         return NULL;
 349     }
 350     if (!(writer = alloc_object( &mail_writer_ops )))
 351     {
 352         close( unix_fd );
 353         return NULL;
 354     }
 355     grab_object( mailslot );
 356     writer->mailslot = mailslot;
 357     writer->access   = mail_writer_map_access( &writer->obj, access );
 358     writer->sharing  = sharing;
 359     list_add_head( &mailslot->writers, &writer->entry );
 360
 361     if (!(writer->fd = create_anonymous_fd( &mail_writer_fd_ops, unix_fd, &writer->obj, options )))
 362     {
 363         release_object( writer );
 364         return NULL;
 365     }
 366     allow_fd_caching( writer->fd );
 367     return &writer->obj;
 368 }
 369
 370 static void mailslot_queue_async( struct fd *fd, struct async *async, int type, int count )
 371 {
 372     struct mailslot *mailslot = get_fd_user( fd );
 373
 374     assert(mailslot->obj.ops == &mailslot_ops);
 375
 376     fd_queue_async( fd, async, type );
 377     async_set_timeout( async, mailslot->read_timeout ? mailslot->read_timeout : -1,
 378                        STATUS_IO_TIMEOUT );
 379     set_error( STATUS_PENDING );
 380 }
 381
 382 static void mailslot_device_dump( struct object *obj, int verbose )
 383 {
 384     fputs( "Mailslot device\n", stderr );
 385 }
 386
 387 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
 388                                                    unsigned int attr, struct object *root )
 389 {
 390     struct mailslot_device *device = (struct mailslot_device*)obj;
 391     struct object *found;
 392
 393     assert( obj->ops == &mailslot_device_ops );
 394
 395     if (!name) return NULL;  /* open the device itself */
 396
 397     if ((found = find_object( device->mailslots, name, attr | OBJ_CASE_INSENSITIVE )))
 398         name->len = 0;
 399
 400     return found;
 401 }
 402
 403 static struct object *mailslot_device_open_file( struct object *obj, unsigned int access,
 404                                                  unsigned int sharing, unsigned int options )
 405 {
 406     struct mailslot_device_file *file;
 407
 408     if (!(file = alloc_object( &mailslot_device_file_ops ))) return NULL;
 409     file->device = (struct mailslot_device *)grab_object( obj );
 410     if (!(file->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, obj, options )))
 411     {
 412         release_object( file );
 413         return NULL;
 414     }
 415     allow_fd_caching( file->fd );
 416     return &file->obj;
 417 }
 418
 419 static void mailslot_device_destroy( struct object *obj )
 420 {
 421     struct mailslot_device *device = (struct mailslot_device*)obj;
 422     assert( obj->ops == &mailslot_device_ops );
 423     free( device->mailslots );
 424 }
 425
 426 struct object *create_mailslot_device( struct object *root, const struct unicode_str *name,
 427                                        unsigned int attr, const struct security_descriptor *sd )
 428 {
 429     struct mailslot_device *dev;
 430
 431     if ((dev = create_named_object( root, &mailslot_device_ops, name, attr, sd )) &&
 432         get_error() != STATUS_OBJECT_NAME_EXISTS)
 433     {
 434         dev->mailslots = NULL;
 435         if (!(dev->mailslots = create_namespace( 7 )))
 436         {
 437             release_object( dev );
 438             dev = NULL;
 439         }
 440     }
 441     return &dev->obj;
 442 }
 443
 444 static void mailslot_device_file_dump( struct object *obj, int verbose )
 445 {
 446     struct mailslot_device_file *file = (struct mailslot_device_file *)obj;
 447
 448     fprintf( stderr, "File on mailslot device %p\n", file->device );
 449 }
 450
 451 static struct fd *mailslot_device_file_get_fd( struct object *obj )
 452 {
 453     struct mailslot_device_file *file = (struct mailslot_device_file *)obj;
 454     return (struct fd *)grab_object( file->fd );
 455 }
 456
 457 static WCHAR *mailslot_device_file_get_full_name( struct object *obj, data_size_t *len )
 458 {
 459     struct mailslot_device_file *file = (struct mailslot_device_file *)obj;
 460     return file->device->obj.ops->get_full_name( &file->device->obj, len );
 461 }
 462
 463 static void mailslot_device_file_destroy( struct object *obj )
 464 {
 465     struct mailslot_device_file *file = (struct mailslot_device_file*)obj;
 466     assert( obj->ops == &mailslot_device_file_ops );
 467     if (file->fd) release_object( file->fd );
 468     release_object( file->device );
 469 }
 470
 471 static enum server_fd_type mailslot_device_file_get_fd_type( struct fd *fd )
 472 {
 473     return FD_TYPE_DEVICE;
 474 }
 475
 476 static struct mailslot *create_mailslot( struct object *root,
 477                                          const struct unicode_str *name, unsigned int attr,
 478                                          int max_msgsize, timeout_t read_timeout,
 479                                          const struct security_descriptor *sd )
 480 {
 481     struct mailslot *mailslot;
 482     int fds[2];
 483
 484     if (!(mailslot = create_named_object( root, &mailslot_ops, name, attr, sd ))) return NULL;
 485
 486     mailslot->fd = NULL;
 487     mailslot->write_fd = -1;
 488     mailslot->max_msgsize = max_msgsize;
 489     mailslot->read_timeout = read_timeout;
 490     list_init( &mailslot->writers );
 491
 492     if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
 493     {
 494         fcntl( fds[0], F_SETFL, O_NONBLOCK );
 495         fcntl( fds[1], F_SETFL, O_NONBLOCK );
 496         shutdown( fds[0], SHUT_RD );
 497         mailslot->write_fd = fds[0];
 498         if ((mailslot->fd = create_anonymous_fd( &mailslot_fd_ops, fds[1], &mailslot->obj,
 499                                                  FILE_SYNCHRONOUS_IO_NONALERT )))
 500         {
 501             allow_fd_caching( mailslot->fd );
 502             return mailslot;
 503         }
 504     }
 505     else file_set_error();
 506
 507     release_object( mailslot );
 508     return NULL;
 509 }
 510
 511 static void mail_writer_dump( struct object *obj, int verbose )
 512 {
 513     fprintf( stderr, "Mailslot writer\n" );
 514 }
 515
 516 static void mail_writer_destroy( struct object *obj)
 517 {
 518     struct mail_writer *writer = (struct mail_writer *) obj;
 519
 520     if (writer->fd) release_object( writer->fd );
 521     list_remove( &writer->entry );
 522     release_object( writer->mailslot );
 523 }
 524
 525 static enum server_fd_type mail_writer_get_fd_type( struct fd *fd )
 526 {
 527     return FD_TYPE_MAILSLOT;
 528 }
 529
 530 static struct fd *mail_writer_get_fd( struct object *obj )
 531 {
 532     struct mail_writer *writer = (struct mail_writer *) obj;
 533     return (struct fd *)grab_object( writer->fd );
 534 }
 535
 536 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
 537 {
 538     /* mailslot writers can only get write access */
 539     return default_map_access( obj, access ) & FILE_GENERIC_WRITE;
 540 }
 541
 542 static struct mailslot *get_mailslot_obj( struct process *process, obj_handle_t handle,
 543                                           unsigned int access )
 544 {
 545     return (struct mailslot *)get_handle_obj( process, handle, access, &mailslot_ops );
 546 }
 547
 548
 549 /* create a mailslot */
 550 DECL_HANDLER(create_mailslot)
 551 {
 552     struct mailslot *mailslot;
 553     struct unicode_str name;
 554     struct object *root;
 555     const struct security_descriptor *sd;
 556     const struct object_attributes *objattr = get_req_object_attributes( &sd, &name, &root );
 557
 558     if (!objattr) return;
 559
 560     if (!name.len)  /* mailslots need a root directory even without a name */
 561     {
 562         if (!objattr->rootdir)
 563         {
 564             set_error( STATUS_OBJECT_PATH_SYNTAX_BAD );
 565             return;
 566         }
 567         if (!(root = get_directory_obj( current->process, objattr->rootdir ))) return;
 568     }
 569
 570     if ((mailslot = create_mailslot( root, &name, objattr->attributes, req->max_msgsize,
 571                                      req->read_timeout, sd )))
 572     {
 573         reply->handle = alloc_handle( current->process, mailslot, req->access, objattr->attributes );
 574         release_object( mailslot );
 575     }
 576
 577     if (root) release_object( root );
 578 }
 579
 580
 581 /* set mailslot information */
 582 DECL_HANDLER(set_mailslot_info)
 583 {
 584     struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
 585
 586     if (mailslot)
 587     {
 588         if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
 589             mailslot->read_timeout = req->read_timeout;
 590         reply->max_msgsize = mailslot->max_msgsize;
 591         reply->read_timeout = mailslot->read_timeout;
 592         release_object( mailslot );
 593     }
 594 }