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