git.oblomov.eu Git - wine/blob - 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 *fd, const async_data_t *data, int type, int count );
  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, const async_data_t *data, 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, data, type, count, &when );
 263     }
 264     else fd_queue_async_timeout( fd, data, 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 enum server_fd_type mailslot_device_get_file_info( struct fd *fd, int *flags )
 302 {
 303     *flags = 0;
 304     return FD_TYPE_DEVICE;
 305 }
 306
 307 void create_mailslot_device( struct directory *root, const struct unicode_str *name )
 308 {
 309     struct mailslot_device *dev;
 310
 311     if ((dev = create_named_object_dir( root, name, 0, &mailslot_device_ops )) &&
 312         get_error() != STATUS_OBJECT_NAME_EXISTS)
 313     {
 314         dev->mailslots = NULL;
 315         if (!(dev->fd = alloc_pseudo_fd( &mailslot_device_fd_ops, &dev->obj )) ||
 316             !(dev->mailslots = create_namespace( 7 )))
 317         {
 318             release_object( dev );
 319             dev = NULL;
 320         }
 321     }
 322     if (dev) make_object_static( &dev->obj );
 323 }
 324
 325 static struct mailslot *create_mailslot( struct directory *root,
 326                                          const struct unicode_str *name, unsigned int attr,
 327                                          int max_msgsize, int read_timeout )
 328 {
 329     struct object *obj;
 330     struct unicode_str new_name;
 331     struct mailslot_device *dev;
 332     struct mailslot *mailslot;
 333     int fds[2];
 334
 335     if (!name || !name->len) return alloc_object( &mailslot_ops );
 336
 337     if (!(obj = find_object_dir( root, name, attr, &new_name ))) return NULL;
 338
 339     if (!new_name.len)
 340     {
 341         if (attr & OBJ_OPENIF && obj->ops == &mailslot_ops)
 342             /* it already exists - there can only be one mailslot to read from */
 343             set_error( STATUS_OBJECT_NAME_EXISTS );
 344         else if (attr & OBJ_OPENIF)
 345             set_error( STATUS_OBJECT_TYPE_MISMATCH );
 346         else
 347             set_error( STATUS_OBJECT_NAME_COLLISION );
 348         release_object( obj );
 349         return NULL;
 350     }
 351
 352     if (obj->ops != &mailslot_device_ops)
 353     {
 354         set_error( STATUS_OBJECT_TYPE_MISMATCH );
 355         release_object( obj );
 356         return NULL;
 357     }
 358
 359     dev = (struct mailslot_device *)obj;
 360     mailslot = create_object( dev->mailslots, &mailslot_ops, &new_name, NULL );
 361     release_object( dev );
 362
 363     if (!mailslot) return NULL;
 364
 365     mailslot->fd = NULL;
 366     mailslot->write_fd = NULL;
 367     mailslot->max_msgsize = max_msgsize;
 368     mailslot->read_timeout = read_timeout;
 369     list_init( &mailslot->writers );
 370
 371     if (!socketpair( PF_UNIX, SOCK_DGRAM, 0, fds ))
 372     {
 373         fcntl( fds[0], F_SETFL, O_NONBLOCK );
 374         fcntl( fds[1], F_SETFL, O_NONBLOCK );
 375         mailslot->fd = create_anonymous_fd( &mailslot_fd_ops,
 376                                 fds[1], &mailslot->obj );
 377         mailslot->write_fd = create_anonymous_fd( &mail_writer_fd_ops,
 378                                 fds[0], &mailslot->obj );
 379         if (mailslot->fd && mailslot->write_fd) return mailslot;
 380     }
 381     else file_set_error();
 382
 383     release_object( mailslot );
 384     return NULL;
 385 }
 386
 387 static void mail_writer_dump( struct object *obj, int verbose )
 388 {
 389     fprintf( stderr, "Mailslot writer\n" );
 390 }
 391
 392 static void mail_writer_destroy( struct object *obj)
 393 {
 394     struct mail_writer *writer = (struct mail_writer *) obj;
 395
 396     list_remove( &writer->entry );
 397     release_object( writer->mailslot );
 398 }
 399
 400 static enum server_fd_type mail_writer_get_info( struct fd *fd, int *flags )
 401 {
 402     *flags = 0;
 403     return FD_TYPE_MAILSLOT;
 404 }
 405
 406 static struct fd *mail_writer_get_fd( struct object *obj )
 407 {
 408     struct mail_writer *writer = (struct mail_writer *) obj;
 409
 410     return (struct fd *)grab_object( writer->mailslot->write_fd );
 411 }
 412
 413 static unsigned int mail_writer_map_access( struct object *obj, unsigned int access )
 414 {
 415     if (access & GENERIC_READ)    access |= FILE_GENERIC_READ;
 416     if (access & GENERIC_WRITE)   access |= FILE_GENERIC_WRITE;
 417     if (access & GENERIC_EXECUTE) access |= FILE_GENERIC_EXECUTE;
 418     if (access & GENERIC_ALL)     access |= FILE_ALL_ACCESS;
 419     return access & ~(GENERIC_READ | GENERIC_WRITE | GENERIC_EXECUTE | GENERIC_ALL);
 420 }
 421
 422 /*
 423  * Readers and writers cannot be mixed.
 424  * If there's more than one writer, all writers must open with FILE_SHARE_WRITE
 425  */
 426 static struct mail_writer *create_mail_writer( struct mailslot *mailslot, unsigned int access,
 427                                                unsigned int sharing )
 428 {
 429     struct mail_writer *writer;
 430
 431     if (!list_empty( &mailslot->writers ))
 432     {
 433         writer = LIST_ENTRY( list_head(&mailslot->writers), struct mail_writer, entry );
 434
 435         if (((access & (GENERIC_WRITE|FILE_WRITE_DATA)) || (writer->access & FILE_WRITE_DATA)) &&
 436            !((sharing & FILE_SHARE_WRITE) && (writer->sharing & FILE_SHARE_WRITE)))
 437         {
 438             set_error( STATUS_SHARING_VIOLATION );
 439             return NULL;
 440         }
 441     }
 442
 443     writer = alloc_object( &mail_writer_ops );
 444     if (!writer)
 445         return NULL;
 446
 447     grab_object( mailslot );
 448     writer->mailslot = mailslot;
 449     writer->access   = mail_writer_map_access( &writer->obj, access );
 450     writer->sharing  = sharing;
 451
 452     list_add_head( &mailslot->writers, &writer->entry );
 453
 454     return writer;
 455 }
 456
 457 static struct mailslot *get_mailslot_obj( struct process *process, obj_handle_t handle,
 458                                           unsigned int access )
 459 {
 460     return (struct mailslot *)get_handle_obj( process, handle, access, &mailslot_ops );
 461 }
 462
 463
 464 /* create a mailslot */
 465 DECL_HANDLER(create_mailslot)
 466 {
 467     struct mailslot *mailslot;
 468     struct unicode_str name;
 469     struct directory *root = NULL;
 470
 471     reply->handle = 0;
 472     get_req_unicode_str( &name );
 473     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 474         return;
 475
 476     if ((mailslot = create_mailslot( root, &name, req->attributes, req->max_msgsize,
 477                                      req->read_timeout )))
 478     {
 479         reply->handle = alloc_handle( current->process, mailslot, req->access, req->attributes );
 480         release_object( mailslot );
 481     }
 482
 483     if (root) release_object( root );
 484 }
 485
 486
 487 /* open an existing mailslot */
 488 DECL_HANDLER(open_mailslot)
 489 {
 490     struct mailslot *mailslot;
 491     struct unicode_str name;
 492     struct directory *root = NULL;
 493
 494     reply->handle = 0;
 495     get_req_unicode_str( &name );
 496
 497     if (!(req->sharing & FILE_SHARE_READ))
 498     {
 499         set_error( STATUS_SHARING_VIOLATION );
 500         return;
 501     }
 502
 503     if (req->rootdir && !(root = get_directory_obj( current->process, req->rootdir, 0 )))
 504         return;
 505     mailslot = open_object_dir( root, &name, req->attributes, &mailslot_ops );
 506     if (root) release_object( root );
 507
 508     if (mailslot)
 509     {
 510         struct mail_writer *writer;
 511
 512         writer = create_mail_writer( mailslot, req->access, req->sharing );
 513         if (writer)
 514         {
 515             reply->handle = alloc_handle( current->process, writer, req->access, req->attributes );
 516             release_object( writer );
 517         }
 518         release_object( mailslot );
 519     }
 520     else
 521         set_error( STATUS_NO_SUCH_FILE );
 522 }
 523
 524
 525 /* set mailslot information */
 526 DECL_HANDLER(set_mailslot_info)
 527 {
 528     struct mailslot *mailslot = get_mailslot_obj( current->process, req->handle, 0 );
 529
 530     if (mailslot)
 531     {
 532         if (req->flags & MAILSLOT_SET_READ_TIMEOUT)
 533             mailslot->read_timeout = req->read_timeout;
 534         reply->max_msgsize = mailslot->max_msgsize;
 535         reply->read_timeout = mailslot->read_timeout;
 536         release_object( mailslot );
 537     }
 538 }