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
26 #include "wine/port.h"
35 #include <sys/types.h>
36 #ifdef HAVE_SYS_SOCKET_H
37 #include <sys/socket.h>
57 ps_disconnected_server
,
63 struct thread
*thread
;
74 enum pipe_state state
;
75 struct pipe_client
*client
;
76 struct named_pipe
*pipe
;
77 struct pipe_server
*next
;
78 struct pipe_server
*prev
;
79 struct timeout_user
*flush_poll
;
81 struct wait_info wait
;
88 struct pipe_server
*server
;
89 struct wait_info wait
;
94 struct wait_info wait
;
95 struct connect_wait
*next
;
100 struct object obj
; /* object header */
101 unsigned int pipemode
;
102 unsigned int maxinstances
;
103 unsigned int outsize
;
105 unsigned int timeout
;
106 unsigned int instances
;
107 struct pipe_server
*servers
;
108 struct connect_wait
*connect_waiters
;
111 static void named_pipe_dump( struct object
*obj
, int verbose
);
112 static void named_pipe_destroy( struct object
*obj
);
114 static const struct object_ops named_pipe_ops
=
116 sizeof(struct named_pipe
), /* size */
117 named_pipe_dump
, /* dump */
118 no_add_queue
, /* add_queue */
119 NULL
, /* remove_queue */
121 NULL
, /* satisfied */
122 no_get_fd
, /* get_fd */
123 named_pipe_destroy
/* destroy */
126 /* common to clients and servers */
127 static int pipe_end_get_poll_events( struct fd
*fd
);
128 static int pipe_end_get_info( struct fd
*fd
, int *flags
);
130 /* server end functions */
131 static void pipe_server_dump( struct object
*obj
, int verbose
);
132 static struct fd
*pipe_server_get_fd( struct object
*obj
);
133 static void pipe_server_destroy( struct object
*obj
);
134 static int pipe_server_flush( struct fd
*fd
, struct event
**event
);
136 static const struct object_ops pipe_server_ops
=
138 sizeof(struct pipe_server
), /* size */
139 pipe_server_dump
, /* dump */
140 default_fd_add_queue
, /* add_queue */
141 default_fd_remove_queue
, /* remove_queue */
142 default_fd_signaled
, /* signaled */
143 no_satisfied
, /* satisfied */
144 pipe_server_get_fd
, /* get_fd */
145 pipe_server_destroy
/* destroy */
148 static const struct fd_ops pipe_server_fd_ops
=
150 pipe_end_get_poll_events
, /* get_poll_events */
151 default_poll_event
, /* poll_event */
152 pipe_server_flush
, /* flush */
153 pipe_end_get_info
, /* get_file_info */
154 no_queue_async
/* queue_async */
157 /* client end functions */
158 static void pipe_client_dump( struct object
*obj
, int verbose
);
159 static struct fd
*pipe_client_get_fd( struct object
*obj
);
160 static void pipe_client_destroy( struct object
*obj
);
161 static int pipe_client_flush( struct fd
*fd
, struct event
**event
);
163 static const struct object_ops pipe_client_ops
=
165 sizeof(struct pipe_client
), /* size */
166 pipe_client_dump
, /* dump */
167 default_fd_add_queue
, /* add_queue */
168 default_fd_remove_queue
, /* remove_queue */
169 default_fd_signaled
, /* signaled */
170 no_satisfied
, /* satisfied */
171 pipe_client_get_fd
, /* get_fd */
172 pipe_client_destroy
/* destroy */
175 static const struct fd_ops pipe_client_fd_ops
=
177 pipe_end_get_poll_events
, /* get_poll_events */
178 default_poll_event
, /* poll_event */
179 pipe_client_flush
, /* flush */
180 pipe_end_get_info
, /* get_file_info */
181 no_queue_async
/* queue_async */
184 static void named_pipe_dump( struct object
*obj
, int verbose
)
186 struct named_pipe
*pipe
= (struct named_pipe
*) obj
;
187 assert( obj
->ops
== &named_pipe_ops
);
188 fprintf( stderr
, "named pipe %p\n" ,pipe
);
191 static void pipe_server_dump( struct object
*obj
, int verbose
)
193 struct pipe_server
*server
= (struct pipe_server
*) obj
;
194 assert( obj
->ops
== &pipe_server_ops
);
195 fprintf( stderr
, "named pipe server %p (state %d)\n",
196 server
, server
->state
);
199 static void pipe_client_dump( struct object
*obj
, int verbose
)
201 struct pipe_client
*client
= (struct pipe_client
*) obj
;
202 assert( obj
->ops
== &pipe_server_ops
);
203 fprintf( stderr
, "named pipe client %p (server state %d)\n",
204 client
, client
->server
->state
);
207 static void named_pipe_destroy( struct object
*obj
)
209 struct named_pipe
*pipe
= (struct named_pipe
*) obj
;
210 assert( !pipe
->servers
);
211 assert( !pipe
->instances
);
214 static void notify_waiter( struct wait_info
*wait
, unsigned int status
)
216 if( wait
->thread
&& wait
->func
&& wait
->overlapped
)
218 /* queue a system APC, to notify a waiting thread */
219 thread_queue_apc( wait
->thread
, NULL
, wait
->func
, APC_ASYNC
,
220 1, wait
->overlapped
, (void *)status
, NULL
);
222 if( wait
->thread
) release_object( wait
->thread
);
226 static void set_waiter( struct wait_info
*wait
, void *func
, void *ov
)
228 wait
->thread
= (struct thread
*) grab_object( current
);
230 wait
->overlapped
= ov
;
233 static void notify_connect_waiters( struct named_pipe
*pipe
)
235 struct connect_wait
*cw
, **x
= &pipe
->connect_waiters
;
240 notify_waiter( &cw
->wait
, STATUS_SUCCESS
);
241 release_object( pipe
);
247 static void queue_connect_waiter( struct named_pipe
*pipe
,
248 void *func
, void *overlapped
)
250 struct connect_wait
*waiter
;
252 waiter
= mem_alloc( sizeof(*waiter
) );
255 set_waiter( &waiter
->wait
, func
, overlapped
);
256 waiter
->next
= pipe
->connect_waiters
;
257 pipe
->connect_waiters
= waiter
;
262 static struct fd
*pipe_client_get_fd( struct object
*obj
)
264 struct pipe_client
*client
= (struct pipe_client
*) obj
;
266 return (struct fd
*) grab_object( client
->fd
);
267 set_error( STATUS_PIPE_DISCONNECTED
);
271 static struct fd
*pipe_server_get_fd( struct object
*obj
)
273 struct pipe_server
*server
= (struct pipe_server
*) obj
;
275 switch(server
->state
)
277 case ps_connected_server
:
278 case ps_wait_disconnect
:
279 assert( server
->fd
);
280 return (struct fd
*) grab_object( server
->fd
);
284 set_error( STATUS_PIPE_LISTENING
);
287 case ps_disconnected_server
:
288 case ps_wait_connect
:
289 set_error( STATUS_PIPE_DISCONNECTED
);
299 static void notify_empty( struct pipe_server
*server
)
301 if( !server
->flush_poll
)
303 assert( server
->state
== ps_connected_server
);
304 assert( server
->event
);
305 remove_timeout_user( server
->flush_poll
);
306 server
->flush_poll
= NULL
;
307 set_event( server
->event
);
308 release_object( server
->event
);
309 server
->event
= NULL
;
312 static void do_disconnect( struct pipe_server
*server
)
314 /* we may only have a server fd, if the client disconnected */
317 assert( server
->client
->server
== server
);
318 assert( server
->client
->fd
);
319 release_object( server
->client
->fd
);
320 server
->client
->fd
= NULL
;
322 assert( server
->fd
);
323 release_object( server
->fd
);
327 static void pipe_server_destroy( struct object
*obj
)
329 struct pipe_server
*server
= (struct pipe_server
*)obj
;
331 assert( obj
->ops
== &pipe_server_ops
);
335 notify_empty( server
);
336 do_disconnect( server
);
341 server
->client
->server
= NULL
;
342 server
->client
= NULL
;
345 notify_waiter( &server
->wait
, STATUS_HANDLES_CLOSED
);
347 assert( server
->pipe
->instances
);
348 server
->pipe
->instances
--;
350 /* remove server from pipe's server list */
351 if( server
->next
) server
->next
->prev
= server
->prev
;
352 if( server
->prev
) server
->prev
->next
= server
->next
;
353 else server
->pipe
->servers
= server
->next
;
354 release_object( server
->pipe
);
357 static void pipe_client_destroy( struct object
*obj
)
359 struct pipe_client
*client
= (struct pipe_client
*)obj
;
360 struct pipe_server
*server
= client
->server
;
362 assert( obj
->ops
== &pipe_client_ops
);
364 notify_waiter( &client
->wait
, STATUS_HANDLES_CLOSED
);
368 notify_empty( server
);
370 switch( server
->state
)
372 case ps_connected_server
:
373 /* Don't destroy the server's fd here as we can't
374 do a successful flush without it. */
375 server
->state
= ps_wait_disconnect
;
376 release_object( client
->fd
);
379 case ps_disconnected_server
:
380 server
->state
= ps_wait_connect
;
385 assert( server
->client
);
386 server
->client
= NULL
;
387 client
->server
= NULL
;
389 assert( !client
->fd
);
392 static int pipe_end_get_poll_events( struct fd
*fd
)
394 return POLLIN
| POLLOUT
; /* FIXME */
397 static int pipe_data_remaining( struct pipe_server
*server
)
402 assert( server
->client
);
404 fd
= get_unix_fd( server
->client
->fd
);
411 if( 0 > poll( &pfd
, 1, 0 ) )
414 return pfd
.revents
&POLLIN
;
417 static void check_flushed( void *arg
)
419 struct pipe_server
*server
= (struct pipe_server
*) arg
;
421 assert( server
->event
);
422 if( pipe_data_remaining( server
) )
426 gettimeofday( &tv
, 0 );
427 add_timeout( &tv
, 100 );
428 server
->flush_poll
= add_timeout_user( &tv
, check_flushed
, server
);
432 /* notify_empty( server ); */
433 server
->flush_poll
= NULL
;
434 set_event( server
->event
);
435 release_object( server
->event
);
436 server
->event
= NULL
;
440 static int pipe_server_flush( struct fd
*fd
, struct event
**event
)
442 struct pipe_server
*server
= get_fd_user( fd
);
447 if( server
->state
!= ps_connected_server
)
450 /* FIXME: if multiple threads flush the same pipe,
451 maybe should create a list of processes to notify */
452 if( server
->flush_poll
)
455 if( pipe_data_remaining( server
) )
459 /* this kind of sux -
460 there's no unix way to be alerted when a pipe becomes empty */
461 server
->event
= create_event( NULL
, 0, 0, 0 );
464 gettimeofday( &tv
, 0 );
465 add_timeout( &tv
, 100 );
466 server
->flush_poll
= add_timeout_user( &tv
, check_flushed
, server
);
467 *event
= server
->event
;
473 static int pipe_client_flush( struct fd
*fd
, struct event
**event
)
475 /* FIXME: what do we have to do for this? */
479 static int pipe_end_get_info( struct fd
*fd
, int *flags
)
482 return FD_TYPE_DEFAULT
;
485 static struct named_pipe
*create_named_pipe( const WCHAR
*name
, size_t len
)
487 struct named_pipe
*pipe
;
489 pipe
= create_named_object( sync_namespace
, &named_pipe_ops
, name
, len
);
492 if( get_error() != STATUS_OBJECT_NAME_COLLISION
)
494 /* initialize it if it didn't already exist */
497 pipe
->connect_waiters
= NULL
;
503 static struct named_pipe
*open_named_pipe( const WCHAR
*name
, size_t len
)
507 if ((obj
= find_object( sync_namespace
, name
, len
)))
509 if (obj
->ops
== &named_pipe_ops
) return (struct named_pipe
*)obj
;
510 release_object( obj
);
511 set_error( STATUS_OBJECT_TYPE_MISMATCH
);
513 else set_error( STATUS_OBJECT_NAME_NOT_FOUND
);
518 static struct pipe_server
*get_pipe_server_obj( struct process
*process
,
519 obj_handle_t handle
, unsigned int access
)
522 obj
= get_handle_obj( process
, handle
, access
, &pipe_server_ops
);
523 return (struct pipe_server
*) obj
;
526 static struct pipe_server
*create_pipe_server( struct named_pipe
*pipe
)
528 struct pipe_server
*server
;
530 server
= alloc_object( &pipe_server_ops
);
536 server
->state
= ps_none
;
537 server
->client
= NULL
;
538 server
->flush_poll
= NULL
;
539 server
->wait
.thread
= NULL
;
541 /* add to list of pipe servers */
542 if ((server
->next
= pipe
->servers
)) server
->next
->prev
= server
;
544 pipe
->servers
= server
;
551 static struct pipe_client
*create_pipe_client( struct pipe_server
*server
)
553 struct pipe_client
*client
;
555 client
= alloc_object( &pipe_client_ops
);
560 client
->server
= server
;
561 client
->wait
.thread
= NULL
;
566 static struct pipe_server
*find_server( struct named_pipe
*pipe
,
567 enum pipe_state state
)
569 struct pipe_server
*x
;
571 for( x
= pipe
->servers
; x
; x
= x
->next
)
572 if( x
->state
== state
)
578 return (struct pipe_server
*) grab_object( x
);
581 DECL_HANDLER(create_named_pipe
)
583 struct named_pipe
*pipe
;
584 struct pipe_server
*server
;
587 pipe
= create_named_pipe( get_req_data(), get_req_data_size() );
591 if( get_error() != STATUS_OBJECT_NAME_COLLISION
)
593 pipe
->insize
= req
->insize
;
594 pipe
->outsize
= req
->outsize
;
595 pipe
->maxinstances
= req
->maxinstances
;
596 pipe
->timeout
= req
->timeout
;
597 pipe
->pipemode
= req
->pipemode
;
601 set_error( 0 ); /* clear the name collision */
602 if( pipe
->maxinstances
<= pipe
->instances
)
604 set_error( STATUS_PIPE_BUSY
);
605 release_object( pipe
);
608 if( ( pipe
->maxinstances
!= req
->maxinstances
) ||
609 ( pipe
->timeout
!= req
->timeout
) ||
610 ( pipe
->pipemode
!= req
->pipemode
) )
612 set_error( STATUS_ACCESS_DENIED
);
613 release_object( pipe
);
618 server
= create_pipe_server( pipe
);
621 server
->state
= ps_idle_server
;
622 reply
->handle
= alloc_handle( current
->process
, server
,
623 GENERIC_READ
|GENERIC_WRITE
, req
->inherit
);
624 server
->pipe
->instances
++;
625 release_object( server
);
628 release_object( pipe
);
631 DECL_HANDLER(open_named_pipe
)
633 struct pipe_server
*server
;
634 struct pipe_client
*client
;
635 struct named_pipe
*pipe
;
640 pipe
= open_named_pipe( get_req_data(), get_req_data_size() );
643 set_error( STATUS_NO_SUCH_FILE
);
647 for( server
= pipe
->servers
; server
; server
= server
->next
)
648 if( ( server
->state
==ps_idle_server
) ||
649 ( server
->state
==ps_wait_open
) )
651 release_object( pipe
);
655 set_error( STATUS_PIPE_NOT_AVAILABLE
);
659 client
= create_pipe_client( server
);
662 if( !socketpair( PF_UNIX
, SOCK_STREAM
, 0, fds
) )
664 assert( !client
->fd
);
665 assert( !server
->fd
);
666 client
->fd
= create_anonymous_fd( &pipe_server_fd_ops
,
667 fds
[1], &client
->obj
);
668 server
->fd
= create_anonymous_fd( &pipe_server_fd_ops
,
669 fds
[0], &server
->obj
);
670 if (client
->fd
&& server
->fd
)
672 if( server
->state
== ps_wait_open
)
673 notify_waiter( &server
->wait
, STATUS_SUCCESS
);
674 assert( !server
->wait
.thread
);
675 server
->state
= ps_connected_server
;
676 server
->client
= client
;
677 client
->server
= server
;
678 reply
->handle
= alloc_handle( current
->process
, client
,
679 req
->access
, req
->inherit
);
685 release_object( client
);
689 DECL_HANDLER(connect_named_pipe
)
691 struct pipe_server
*server
;
693 server
= get_pipe_server_obj(current
->process
, req
->handle
, 0);
697 switch( server
->state
)
700 case ps_wait_connect
:
701 assert( !server
->fd
);
702 server
->state
= ps_wait_open
;
703 set_waiter( &server
->wait
, req
->func
, req
->overlapped
);
704 notify_connect_waiters( server
->pipe
);
706 case ps_connected_server
:
707 assert( server
->fd
);
708 set_error( STATUS_PIPE_CONNECTED
);
710 case ps_disconnected_server
:
711 set_error( STATUS_PIPE_BUSY
);
713 case ps_wait_disconnect
:
714 set_error( STATUS_NO_DATA_DETECTED
);
717 set_error( STATUS_INVALID_HANDLE
);
721 release_object(server
);
724 DECL_HANDLER(wait_named_pipe
)
726 struct named_pipe
*pipe
;
727 struct pipe_server
*server
;
729 if (!(pipe
= open_named_pipe( get_req_data(), get_req_data_size() )))
731 set_error( STATUS_PIPE_NOT_AVAILABLE
);
734 server
= find_server( pipe
, ps_wait_open
);
737 /* there's already a server waiting for a client to connect */
738 struct wait_info wait
;
739 set_waiter( &wait
, req
->func
, req
->overlapped
);
740 notify_waiter( &wait
, STATUS_SUCCESS
);
741 release_object( server
);
744 queue_connect_waiter( pipe
, req
->func
, req
->overlapped
);
746 release_object( pipe
);
749 DECL_HANDLER(disconnect_named_pipe
)
751 struct pipe_server
*server
;
754 server
= get_pipe_server_obj( current
->process
, req
->handle
, 0 );
757 switch( server
->state
)
759 case ps_connected_server
:
760 assert( server
->fd
);
761 assert( server
->client
);
762 assert( server
->client
->fd
);
764 notify_empty( server
);
765 notify_waiter( &server
->client
->wait
, STATUS_PIPE_DISCONNECTED
);
767 /* Dump the client and server fds, but keep the pointers
768 around - client loses all waiting data */
769 server
->state
= ps_disconnected_server
;
770 do_disconnect( server
);
771 reply
->fd
= flush_cached_fd( current
->process
, req
->handle
);
774 case ps_wait_disconnect
:
775 assert( !server
->client
);
776 assert( server
->fd
);
777 do_disconnect( server
);
778 server
->state
= ps_wait_connect
;
779 reply
->fd
= flush_cached_fd( current
->process
, req
->handle
);
783 set_error( STATUS_PIPE_DISCONNECTED
);
785 release_object( server
);
788 DECL_HANDLER(get_named_pipe_info
)
790 struct pipe_server
*server
;
792 server
= get_pipe_server_obj( current
->process
, req
->handle
, 0 );
796 reply
->flags
= server
->pipe
->pipemode
;
797 reply
->maxinstances
= server
->pipe
->maxinstances
;
798 reply
->insize
= server
->pipe
->insize
;
799 reply
->outsize
= server
->pipe
->outsize
;
801 release_object(server
);