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