Implement overlapped I/O with named pipes.
[wine/hacks.git] / server / named_pipe.c
blob27cc6c047fa7b69b13a1dfdcf53417f11966f6bd
1 /*
2 * Server-side pipe management
4 * Copyright (C) 1998 Alexandre Julliard
5 * Copyright (C) 2001 Mike McCormack
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * TODO:
22 * message mode
25 #include "config.h"
26 #include "wine/port.h"
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 #ifdef HAVE_SYS_SOCKET_H
37 #include <sys/socket.h>
38 #endif
39 #include <time.h>
40 #include <unistd.h>
41 #ifdef HAVE_POLL_H
42 #include <poll.h>
43 #endif
45 #include "windef.h"
46 #include "winbase.h"
47 #include "winreg.h"
48 #include "winternl.h"
50 #include "file.h"
51 #include "handle.h"
52 #include "thread.h"
53 #include "request.h"
55 enum pipe_state
57 ps_idle_server,
58 ps_wait_open,
59 ps_connected_server,
60 ps_wait_disconnect,
61 ps_disconnected_server,
62 ps_wait_connect
65 struct named_pipe;
67 struct pipe_server
69 struct object obj; /* object header */
70 struct fd *fd; /* pipe file descriptor */
71 struct list entry; /* entry in named pipe servers list */
72 enum pipe_state state; /* server state */
73 struct pipe_client *client; /* client that this server is connected to */
74 struct named_pipe *pipe;
75 struct timeout_user *flush_poll;
76 struct event *event;
77 struct list wait_q; /* only a single one can be queued */
78 unsigned int options; /* pipe options */
81 struct pipe_client
83 struct object obj; /* object header */
84 struct fd *fd; /* pipe file descriptor */
85 struct pipe_server *server; /* server that this client is connected to */
86 unsigned int flags; /* file flags */
89 struct named_pipe
91 struct object obj; /* object header */
92 unsigned int flags;
93 unsigned int maxinstances;
94 unsigned int outsize;
95 unsigned int insize;
96 unsigned int timeout;
97 unsigned int instances;
98 struct list servers; /* list of servers using this pipe */
99 struct list waiters; /* list of clients waiting to connect */
102 static void named_pipe_dump( struct object *obj, int verbose );
103 static void named_pipe_destroy( struct object *obj );
105 static const struct object_ops named_pipe_ops =
107 sizeof(struct named_pipe), /* size */
108 named_pipe_dump, /* dump */
109 no_add_queue, /* add_queue */
110 NULL, /* remove_queue */
111 NULL, /* signaled */
112 NULL, /* satisfied */
113 no_signal, /* signal */
114 no_get_fd, /* get_fd */
115 named_pipe_destroy /* destroy */
118 /* server end functions */
119 static void pipe_server_dump( struct object *obj, int verbose );
120 static struct fd *pipe_server_get_fd( struct object *obj );
121 static void pipe_server_destroy( struct object *obj);
122 static int pipe_server_flush( struct fd *fd, struct event **event );
123 static int pipe_server_get_info( struct fd *fd );
125 static const struct object_ops pipe_server_ops =
127 sizeof(struct pipe_server), /* size */
128 pipe_server_dump, /* dump */
129 default_fd_add_queue, /* add_queue */
130 default_fd_remove_queue, /* remove_queue */
131 default_fd_signaled, /* signaled */
132 no_satisfied, /* satisfied */
133 no_signal, /* signal */
134 pipe_server_get_fd, /* get_fd */
135 pipe_server_destroy /* destroy */
138 static const struct fd_ops pipe_server_fd_ops =
140 default_fd_get_poll_events, /* get_poll_events */
141 default_poll_event, /* poll_event */
142 pipe_server_flush, /* flush */
143 pipe_server_get_info, /* get_file_info */
144 default_fd_queue_async, /* queue_async */
145 default_fd_cancel_async, /* cancel_async */
148 /* client end functions */
149 static void pipe_client_dump( struct object *obj, int verbose );
150 static struct fd *pipe_client_get_fd( struct object *obj );
151 static void pipe_client_destroy( struct object *obj );
152 static int pipe_client_flush( struct fd *fd, struct event **event );
153 static int pipe_client_get_info( struct fd *fd );
155 static const struct object_ops pipe_client_ops =
157 sizeof(struct pipe_client), /* size */
158 pipe_client_dump, /* dump */
159 default_fd_add_queue, /* add_queue */
160 default_fd_remove_queue, /* remove_queue */
161 default_fd_signaled, /* signaled */
162 no_satisfied, /* satisfied */
163 no_signal, /* signal */
164 pipe_client_get_fd, /* get_fd */
165 pipe_client_destroy /* destroy */
168 static const struct fd_ops pipe_client_fd_ops =
170 default_fd_get_poll_events, /* get_poll_events */
171 default_poll_event, /* poll_event */
172 pipe_client_flush, /* flush */
173 pipe_client_get_info, /* get_file_info */
174 default_fd_queue_async, /* queue_async */
175 default_fd_cancel_async /* cancel_async */
178 static void named_pipe_dump( struct object *obj, int verbose )
180 struct named_pipe *pipe = (struct named_pipe *) obj;
181 assert( obj->ops == &named_pipe_ops );
182 fprintf( stderr, "Named pipe " );
183 dump_object_name( &pipe->obj );
184 fprintf( stderr, "\n" );
187 static void pipe_server_dump( struct object *obj, int verbose )
189 struct pipe_server *server = (struct pipe_server *) obj;
190 assert( obj->ops == &pipe_server_ops );
191 fprintf( stderr, "Named pipe server pipe=%p state=%d\n", server->pipe, server->state );
194 static void pipe_client_dump( struct object *obj, int verbose )
196 struct pipe_client *client = (struct pipe_client *) obj;
197 assert( obj->ops == &pipe_client_ops );
198 fprintf( stderr, "Named pipe client server=%p\n", client->server );
201 static void named_pipe_destroy( struct object *obj)
203 struct named_pipe *pipe = (struct named_pipe *) obj;
205 assert( list_empty( &pipe->servers ) );
206 assert( !pipe->instances );
207 async_terminate_queue( &pipe->waiters, STATUS_HANDLES_CLOSED );
210 static struct fd *pipe_client_get_fd( struct object *obj )
212 struct pipe_client *client = (struct pipe_client *) obj;
213 if( client->fd )
214 return (struct fd *) grab_object( client->fd );
215 set_error( STATUS_PIPE_DISCONNECTED );
216 return NULL;
219 static struct fd *pipe_server_get_fd( struct object *obj )
221 struct pipe_server *server = (struct pipe_server *) obj;
223 switch(server->state)
225 case ps_connected_server:
226 case ps_wait_disconnect:
227 assert( server->fd );
228 return (struct fd *) grab_object( server->fd );
230 case ps_wait_open:
231 case ps_idle_server:
232 set_error( STATUS_PIPE_LISTENING );
233 break;
235 case ps_disconnected_server:
236 case ps_wait_connect:
237 set_error( STATUS_PIPE_DISCONNECTED );
238 break;
240 return NULL;
244 static void notify_empty( struct pipe_server *server )
246 if( !server->flush_poll )
247 return;
248 assert( server->state == ps_connected_server );
249 assert( server->event );
250 remove_timeout_user( server->flush_poll );
251 server->flush_poll = NULL;
252 set_event( server->event );
253 release_object( server->event );
254 server->event = NULL;
257 static void do_disconnect( struct pipe_server *server )
259 /* we may only have a server fd, if the client disconnected */
260 if( server->client )
262 assert( server->client->server == server );
263 assert( server->client->fd );
264 release_object( server->client->fd );
265 server->client->fd = NULL;
267 assert( server->fd );
268 release_object( server->fd );
269 server->fd = NULL;
272 static void pipe_server_destroy( struct object *obj)
274 struct pipe_server *server = (struct pipe_server *)obj;
276 assert( obj->ops == &pipe_server_ops );
278 if( server->fd )
280 notify_empty( server );
281 do_disconnect( server );
284 if( server->client )
286 server->client->server = NULL;
287 server->client = NULL;
290 async_terminate_head( &server->wait_q, STATUS_HANDLES_CLOSED );
292 assert( server->pipe->instances );
293 server->pipe->instances--;
295 list_remove( &server->entry );
296 release_object( server->pipe );
299 static void pipe_client_destroy( struct object *obj)
301 struct pipe_client *client = (struct pipe_client *)obj;
302 struct pipe_server *server = client->server;
304 assert( obj->ops == &pipe_client_ops );
306 if( server )
308 notify_empty( server );
310 switch( server->state )
312 case ps_connected_server:
313 /* Don't destroy the server's fd here as we can't
314 do a successful flush without it. */
315 server->state = ps_wait_disconnect;
316 release_object( client->fd );
317 client->fd = NULL;
318 break;
319 case ps_disconnected_server:
320 server->state = ps_wait_connect;
321 break;
322 case ps_idle_server:
323 case ps_wait_open:
324 case ps_wait_disconnect:
325 case ps_wait_connect:
326 assert( 0 );
328 assert( server->client );
329 server->client = NULL;
330 client->server = NULL;
332 assert( !client->fd );
335 static int pipe_data_remaining( struct pipe_server *server )
337 struct pollfd pfd;
338 int fd;
340 assert( server->client );
342 fd = get_unix_fd( server->client->fd );
343 if( fd < 0 )
344 return 0;
345 pfd.fd = fd;
346 pfd.events = POLLIN;
347 pfd.revents = 0;
349 if( 0 > poll( &pfd, 1, 0 ) )
350 return 0;
352 return pfd.revents&POLLIN;
355 static void check_flushed( void *arg )
357 struct pipe_server *server = (struct pipe_server*) arg;
359 assert( server->event );
360 if( pipe_data_remaining( server ) )
362 struct timeval tv;
364 gettimeofday( &tv, NULL );
365 add_timeout( &tv, 100 );
366 server->flush_poll = add_timeout_user( &tv, check_flushed, server );
368 else
370 /* notify_empty( server ); */
371 server->flush_poll = NULL;
372 set_event( server->event );
373 release_object( server->event );
374 server->event = NULL;
378 static int pipe_server_flush( struct fd *fd, struct event **event )
380 struct pipe_server *server = get_fd_user( fd );
382 if( !server )
383 return 0;
385 if( server->state != ps_connected_server )
386 return 0;
388 /* FIXME: if multiple threads flush the same pipe,
389 maybe should create a list of processes to notify */
390 if( server->flush_poll )
391 return 0;
393 if( pipe_data_remaining( server ) )
395 struct timeval tv;
397 /* this kind of sux -
398 there's no unix way to be alerted when a pipe becomes empty */
399 server->event = create_event( NULL, 0, 0, 0 );
400 if( !server->event )
401 return 0;
402 gettimeofday( &tv, NULL );
403 add_timeout( &tv, 100 );
404 server->flush_poll = add_timeout_user( &tv, check_flushed, server );
405 *event = server->event;
408 return 0;
411 static int pipe_client_flush( struct fd *fd, struct event **event )
413 /* FIXME: what do we have to do for this? */
414 return 0;
417 static inline int is_overlapped( unsigned int options )
419 return !(options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
422 static int pipe_server_get_info( struct fd *fd )
424 struct pipe_server *server = get_fd_user( fd );
425 int flags = FD_FLAG_AVAILABLE;
427 if (is_overlapped( server->options )) flags |= FD_FLAG_OVERLAPPED;
429 return flags;
432 static int pipe_client_get_info( struct fd *fd )
434 struct pipe_client *client = get_fd_user( fd );
435 int flags = FD_FLAG_AVAILABLE;
437 if (is_overlapped( client->flags )) flags |= FD_FLAG_OVERLAPPED;
439 return flags;
442 static struct named_pipe *create_named_pipe( const WCHAR *name, size_t len )
444 struct named_pipe *pipe;
446 pipe = create_named_object( sync_namespace, &named_pipe_ops, name, len );
447 if( pipe )
449 if( get_error() != STATUS_OBJECT_NAME_COLLISION )
451 /* initialize it if it didn't already exist */
452 pipe->instances = 0;
453 list_init( &pipe->servers );
454 list_init( &pipe->waiters );
457 return pipe;
460 static struct named_pipe *open_named_pipe( const WCHAR *name, size_t len )
462 struct object *obj;
464 if ((obj = find_object( sync_namespace, name, len )))
466 if (obj->ops == &named_pipe_ops) return (struct named_pipe *)obj;
467 release_object( obj );
468 set_error( STATUS_OBJECT_TYPE_MISMATCH );
470 else set_error( STATUS_OBJECT_NAME_NOT_FOUND );
472 return NULL;
475 static struct pipe_server *get_pipe_server_obj( struct process *process,
476 obj_handle_t handle, unsigned int access )
478 struct object *obj;
479 obj = get_handle_obj( process, handle, access, &pipe_server_ops );
480 return (struct pipe_server *) obj;
483 static struct pipe_server *create_pipe_server( struct named_pipe *pipe, unsigned int options )
485 struct pipe_server *server;
487 server = alloc_object( &pipe_server_ops );
488 if( !server )
489 return NULL;
491 server->fd = NULL;
492 server->pipe = pipe;
493 server->state = ps_idle_server;
494 server->client = NULL;
495 server->flush_poll = NULL;
496 server->options = options;
497 list_init( &server->wait_q );
499 list_add_head( &pipe->servers, &server->entry );
500 grab_object( pipe );
502 return server;
505 static struct pipe_client *create_pipe_client( struct pipe_server *server, unsigned int flags )
507 struct pipe_client *client;
509 client = alloc_object( &pipe_client_ops );
510 if( !client )
511 return NULL;
513 client->fd = NULL;
514 client->server = server;
515 client->flags = flags;
517 return client;
520 static inline struct pipe_server *find_server( struct named_pipe *pipe, enum pipe_state state )
522 struct pipe_server *server;
524 LIST_FOR_EACH_ENTRY( server, &pipe->servers, struct pipe_server, entry )
526 if (server->state == state) return (struct pipe_server *)grab_object( server );
528 return NULL;
531 static inline struct pipe_server *find_server2( struct named_pipe *pipe,
532 enum pipe_state state1, enum pipe_state state2 )
534 struct pipe_server *server;
536 LIST_FOR_EACH_ENTRY( server, &pipe->servers, struct pipe_server, entry )
538 if (server->state == state1 || server->state == state2)
539 return (struct pipe_server *)grab_object( server );
541 return NULL;
544 DECL_HANDLER(create_named_pipe)
546 struct named_pipe *pipe;
547 struct pipe_server *server;
549 reply->handle = 0;
550 pipe = create_named_pipe( get_req_data(), get_req_data_size() );
551 if( !pipe )
552 return;
554 if( get_error() != STATUS_OBJECT_NAME_COLLISION )
556 pipe->insize = req->insize;
557 pipe->outsize = req->outsize;
558 pipe->maxinstances = req->maxinstances;
559 pipe->timeout = req->timeout;
560 pipe->flags = req->flags;
562 else
564 set_error( 0 ); /* clear the name collision */
565 if( pipe->maxinstances <= pipe->instances )
567 set_error( STATUS_PIPE_BUSY );
568 release_object( pipe );
569 return;
571 if( ( pipe->maxinstances != req->maxinstances ) ||
572 ( pipe->timeout != req->timeout ) ||
573 ( pipe->flags != req->flags ) )
575 set_error( STATUS_ACCESS_DENIED );
576 release_object( pipe );
577 return;
581 server = create_pipe_server( pipe, req->options );
582 if(server)
584 reply->handle = alloc_handle( current->process, server,
585 GENERIC_READ|GENERIC_WRITE, req->inherit );
586 server->pipe->instances++;
587 release_object( server );
590 release_object( pipe );
593 DECL_HANDLER(open_named_pipe)
595 struct pipe_server *server;
596 struct pipe_client *client;
597 struct named_pipe *pipe;
598 int fds[2];
600 pipe = open_named_pipe( get_req_data(), get_req_data_size() );
601 if ( !pipe )
603 set_error( STATUS_NO_SUCH_FILE );
604 return;
607 server = find_server2( pipe, ps_idle_server, ps_wait_open );
608 release_object( pipe );
610 if ( !server )
612 set_error( STATUS_PIPE_NOT_AVAILABLE );
613 return;
616 client = create_pipe_client( server, req->flags );
617 if( client )
619 if( !socketpair( PF_UNIX, SOCK_STREAM, 0, fds ) &&
620 (fcntl( fds[0], F_SETFL, O_NONBLOCK ) != -1) &&
621 (fcntl( fds[1], F_SETFL, O_NONBLOCK ) != -1))
623 assert( !client->fd );
624 assert( !server->fd );
625 client->fd = create_anonymous_fd( &pipe_client_fd_ops,
626 fds[1], &client->obj );
627 server->fd = create_anonymous_fd( &pipe_server_fd_ops,
628 fds[0], &server->obj );
629 if (client->fd && server->fd)
631 if( server->state == ps_wait_open )
632 async_terminate_head( &server->wait_q, STATUS_SUCCESS );
633 assert( list_empty( &server->wait_q ) );
634 server->state = ps_connected_server;
635 server->client = client;
636 client->server = server;
637 reply->handle = alloc_handle( current->process, client,
638 req->access, req->inherit );
641 else
642 file_set_error();
644 release_object( client );
646 release_object( server );
649 DECL_HANDLER(connect_named_pipe)
651 struct pipe_server *server;
653 server = get_pipe_server_obj(current->process, req->handle, 0);
654 if(!server)
655 return;
657 switch( server->state )
659 case ps_idle_server:
660 case ps_wait_connect:
661 assert( !server->fd );
662 server->state = ps_wait_open;
663 create_async( current, NULL, &server->wait_q,
664 req->func, req->overlapped, NULL );
665 async_terminate_queue( &server->pipe->waiters, STATUS_SUCCESS );
666 break;
667 case ps_connected_server:
668 assert( server->fd );
669 set_error( STATUS_PIPE_CONNECTED );
670 break;
671 case ps_disconnected_server:
672 set_error( STATUS_PIPE_BUSY );
673 break;
674 case ps_wait_disconnect:
675 set_error( STATUS_NO_DATA_DETECTED );
676 break;
677 case ps_wait_open:
678 set_error( STATUS_INVALID_HANDLE );
679 break;
682 release_object(server);
685 DECL_HANDLER(wait_named_pipe)
687 struct named_pipe *pipe;
688 struct pipe_server *server;
690 if (!(pipe = open_named_pipe( get_req_data(), get_req_data_size() )))
692 set_error( STATUS_PIPE_NOT_AVAILABLE );
693 return;
695 server = find_server( pipe, ps_wait_open );
696 if( server )
698 /* there's already a server waiting for a client to connect */
699 thread_queue_apc( current, NULL, req->func, APC_ASYNC_IO,
700 1, req->overlapped, NULL, (void *)STATUS_SUCCESS );
701 release_object( server );
703 else
705 unsigned int timeout;
706 if (req->timeout == NMPWAIT_USE_DEFAULT_WAIT)
707 timeout = pipe->timeout;
708 else
709 timeout = req->timeout;
711 if (req->timeout == NMPWAIT_WAIT_FOREVER)
712 create_async( current, NULL, &pipe->waiters,
713 req->func, req->overlapped, NULL );
714 else
715 create_async( current, &timeout, &pipe->waiters,
716 req->func, req->overlapped, NULL );
719 release_object( pipe );
722 DECL_HANDLER(disconnect_named_pipe)
724 struct pipe_server *server;
726 reply->fd = -1;
727 server = get_pipe_server_obj( current->process, req->handle, 0 );
728 if( !server )
729 return;
730 switch( server->state )
732 case ps_connected_server:
733 assert( server->fd );
734 assert( server->client );
735 assert( server->client->fd );
737 notify_empty( server );
739 /* Dump the client and server fds, but keep the pointers
740 around - client loses all waiting data */
741 server->state = ps_disconnected_server;
742 do_disconnect( server );
743 reply->fd = flush_cached_fd( current->process, req->handle );
744 break;
746 case ps_wait_disconnect:
747 assert( !server->client );
748 assert( server->fd );
749 do_disconnect( server );
750 server->state = ps_wait_connect;
751 reply->fd = flush_cached_fd( current->process, req->handle );
752 break;
754 case ps_idle_server:
755 case ps_wait_open:
756 case ps_disconnected_server:
757 case ps_wait_connect:
758 set_error( STATUS_PIPE_DISCONNECTED );
759 break;
761 release_object( server );
764 DECL_HANDLER(get_named_pipe_info)
766 struct pipe_server *server;
768 server = get_pipe_server_obj( current->process, req->handle, 0 );
769 if(!server)
770 return;
772 reply->flags = server->pipe->flags;
773 reply->maxinstances = server->pipe->maxinstances;
774 reply->insize = server->pipe->insize;
775 reply->outsize = server->pipe->outsize;
777 release_object(server);