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 int mailslot_get_info( struct fd * );
  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 int mail_writer_get_info( struct fd *fd );
 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 int mailslot_device_get_file_info( struct fd *fd );
 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 int mailslot_get_info( struct fd *fd )
 216 {
 217     struct mailslot *mailslot = get_fd_user( fd );
 218     assert( mailslot->obj.ops == &mailslot_ops );
 219     return FD_FLAG_TIMEOUT | FD_FLAG_AVAILABLE;
 220 }
 221
 222 static struct fd *mailslot_get_fd( struct object *obj )
 223 {
 224     struct mailslot *mailslot = (struct mailslot *) obj;
 225
 226     return (struct fd *)grab_object( mailslot->fd );
 227 }
 228
 229 static unsigned int mailslot_map_access( struct object *obj, unsigned int access )
 230 {
 231     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
 232     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
 233     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
 234     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
 235     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 236 }
 237
 238 static void mailslot_queue_async( struct fd *fd, void *apc, void *user,
 239                                   void *iosb, int type, int count )
 240 {
 241     struct mailslot *mailslot = get_fd_user( fd );
 242
 243     assert(mailslot->obj.ops == &mailslot_ops);
 244
 245     if (type != ASYNC_TYPE_READ)
 246     {
 247         set_error(STATUS_INVALID_PARAMETER);
 248         return;
 249     }
 250
 251     if (list_empty( &mailslot->writers ) ||
 252         !mailslot_message_count( mailslot ))
 253     {
 254         set_error(STATUS_IO_TIMEOUT);
 255         return;
 256     }
 257
 258     if (mailslot->read_timeout != -1)
 259     {
 260         struct timeval when = current_time;
 261         add_timeout( &when, mailslot->read_timeout );
 262         fd_queue_async_timeout( fd, apc, user, iosb, type, count, &when );
 263     }
 264     else fd_queue_async_timeout( fd, apc, user, iosb, type, count, NULL );
 265 }
 266
 267 static void mailslot_device_dump( struct object *obj, int verbose )
 268 {
 269     assert( obj->ops == &mailslot_device_ops );
 270     fprintf( stderr, "Mail slot device\n" );
 271 }
 272
 273 static struct fd *mailslot_device_get_fd( struct object *obj )
 274 {
 275     struct mailslot_device *device = (struct mailslot_device *)obj;
 276     return (struct fd *)grab_object( device->fd );
 277 }
 278
 279 static struct object *mailslot_device_lookup_name( struct object *obj, struct unicode_str *name,
 280                                                    unsigned int attr )
 281 {
 282     struct mailslot_device *device = (struct mailslot_device*)obj;
 283     struct object *found;
 284
 285     assert( obj->ops == &mailslot_device_ops );
 286
 287     if ((found = find_object( device->mailslots, name, attr | OBJ_CASE_INSENSITIVE )))
 288         name->len = 0;
 289
 290     return found;
 291 }
 292
 293 static void mailslot_device_destroy( struct object *obj )
 294 {
 295     struct mailslot_device *device = (struct mailslot_device*)obj;
 296     assert( obj->ops == &mailslot_device_ops );
 297     if (device->fd) release_object( device->fd );
 298     free( device->mailslots );
 299 }
 300
 301 static int mailslot_device_get_file_info( struct fd *fd )
 302 {
 303     return 0;
 304 }
 305
 306 void create_mailslot_device( struct directory *root, const struct unicode_str *name )
 307 {
 308     struct mailslot_device *dev;
 309
 310     if ((dev = create_named_object_dir( root, name, 0, &mailslot_device_ops )) &&
 311         get_error() != STATUS_OBJECT_NAME_EXISTS)
 312     {
 313         dev->mailslots = NULL;
 314         if (!(dev->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, &dev->obj )) ||
 315             !(dev->mailslots = create_namespace( 7 )))
 316         {
 317             release_object( dev );
 318             dev = NULL;
 319         }
 320     }
 321     if (dev) make_object_static( &dev->obj );
 322 }
 323
 324 static struct mailslot *create_mailslot( struct directory *root,
 325                                          const struct unicode_str *name, unsigned int attr,
 326                                          int max_msgsize, int read_timeout )
 327 {
 328     struct object *obj;
 329     struct unicode_str new_name;
 330     struct mailslot_device *dev;
 331     struct mailslot *mailslot;
 332     int fds[2];
 333
 334     if (!name || !name->len) return alloc_object( &mailslot_ops );
 335
 336     if (!(obj = find_object_dir( root, name, attr, &new_name ))) return NULL;
 337
 338     if (!new_name.len)
 339     {
 340         if (attr & OBJ_OPENIF && obj->ops == &mailslot_ops)
 341             /* it already exists - there can only be one mailslot to read from */
 342             set_error( STATUS_OBJECT_NAME_EXISTS );
 343         else if (attr & OBJ_OPENIF)
 344             set_error( STATUS_OBJECT_TYPE_MISMATCH );
 345         else
 346             set_error( STATUS_OBJECT_NAME_COLLISION );
 347         release_object( obj );
 348         return NULL;
 349     }
 350
 351     if (obj->ops != &mailslot_device_ops)
 352     {
 353         set_error( STATUS_OBJECT_TYPE_MISMATCH );
 354         release_object( obj );
 355         return NULL;
 356     }
 357
 358     dev = (struct mailslot_device *)obj;
 359     mailslot = create_object( dev->mailslots, &mailslot_ops, &new_name, NULL );
 360     release_object( dev );
 361
 362     if (!mailslot) return NULL;
 363
 364     mailslot->fd = NULL;
 365     mailslot->write_fd = NULL;
 366     mailslot->max_msgsize = max_msgsize;
 367     mailslot->read_timeout = read_timeout;
 368     list_init( &mailslot->writers );
 369
 370     if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
 371     {
 372         fcntl( fds[0], F_SETFL, O_NONBLOCK );
 373         fcntl( fds[1], F_SETFL, O_NONBLOCK );
 374         mailslot->fd = create_anonymous_fd( &mailslot_fd_ops,
 375                                 fds[1], &mailslot->obj );
 376         mailslot->write_fd = create_anonymous_fd( &mail_writer_fd_ops,
 377                                 fds[0], &mailslot->obj );
 378         if (mailslot->fd && mailslot->write_fd) return mailslot;
 379     }
 380     else file_set_error();
 381
 382     release_object( mailslot );
 383     return NULL;
 384 }
 385
 386 static void mail_writer_dump( struct object *obj, int verbose )
 387 {
 388     fprintf( stderr, "Mailslot writer\n" );
 389 }
 390
 391 static void mail_writer_destroy( struct object *obj)
 392 {
 393     struct mail_writer *writer = (struct mail_writer *) obj;
 394
 395     list_remove( &writer->entry );
 396     release_object( writer->mailslot );
 397 }
 398
 399 static int mail_writer_get_info( struct fd *fd )
 400 {
 401     return 0;
 402 }
 403
 404 static struct fd *mail_writer_get_fd( struct object *obj )
 405 {
 406     struct mail_writer *writer = (struct mail_writer *) obj;
 407
 408     return (struct fd *)grab_object( writer->mailslot->write_fd );
 409 }
 410
 411 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
 412 {
 413     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
 414     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
 415     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
 416     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
 417     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 418 }
 419
 420 /*
 421  * Readers and writers cannot be mixed.
 422  * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
 423  */
 424 static struct mail_writer *create_mail_writer( struct mailslot *mailslot, unsigned int access,
 425                                                unsigned int sharing )
 426 {
 427     struct mail_writer *writer;
 428
 429     if (!list_empty( &mailslot->writers ))
 430     {
 431         writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
 432
 433         if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
 434            !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
 435         {
 436             set_error( STATUS_SHARING_VIOLATION );
 437             return NULL;
 438         }
 439     }
 440
 441     writer = alloc_object( &mail_writer_ops );
 442     if (!writer)
 443         return NULL;
 444
 445     grab_object( mailslot );
 446     writer->mailslot = mailslot;
 447     writer->access   = mail_writer_map_access( &writer->obj, access );
 448     writer->sharing  = sharing;
 449
 450     list_add_head( &mailslot->writers, &writer->entry );
 451
 452     return writer;
 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 /* open an existing mailslot */
 486 DECL_HANDLER(open_mailslot)
 487 {
 488     struct mailslot *mailslot;
 489     struct unicode_str name;
 490     struct directory *root = NULL;
 491
 492     reply->handle = 0;
 493     get_req_unicode_str( &name );
 494
 495     if (!(req->sharing & FILE_SHARE_READ))
 496     {
 497         set_error( STATUS_SHARING_VIOLATION );
 498         return;
 499     }
 500
 501     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 502         return;
 503     mailslot = open_object_dir( root, &name, req->attributes, &mailslot_ops );
 504     if (root) release_object( root );
 505
 506     if (mailslot)
 507     {
 508         struct mail_writer *writer;
 509
 510         writer = create_mail_writer( mailslot, req->access, req->sharing );
 511         if (writer)
 512         {
 513             reply->handle = alloc_handle( current->process, writer, req->access, req->attributes );
 514             release_object( writer );
 515         }
 516         release_object( mailslot );
 517     }
 518     else
 519         set_error( STATUS_NO_SUCH_FILE );
 520 }
 521
 522
 523 /* set mailslot information */
 524 DECL_HANDLER(set_mailslot_info)
 525 {
 526     struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
 527
 528     if (mailslot)
 529     {
 530         if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
 531             mailslot->read_timeout = req->read_timeout;
 532         reply->max_msgsize = mailslot->max_msgsize;
 533         reply->read_timeout = mailslot->read_timeout;
 534         release_object( mailslot );
 535     }
 536 }