Add name_lookup function in object_ops.
[wine.git] / server / named_pipe.c
blob626c0e17d5a01d54fc96635f64c0fb239fa60f6b
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 "winternl.h"
48 #include "file.h"
49 #include "handle.h"
50 #include "thread.h"
51 #include "request.h"
53 enum pipe_state
55 ps_idle_server,
56 ps_wait_open,
57 ps_connected_server,
58 ps_wait_disconnect,
59 ps_disconnected_server,
60 ps_wait_connect
63 struct named_pipe;
65 struct pipe_server
67 struct object obj; /* object header */
68 struct fd *fd; /* pipe file descriptor */
69 struct list entry; /* entry in named pipe servers list */
70 enum pipe_state state; /* server state */
71 struct pipe_client *client; /* client that this server is connected to */
72 struct named_pipe *pipe;
73 struct timeout_user *flush_poll;
74 struct event *event;
75 struct list wait_q; /* only a single one can be queued */
76 unsigned int options; /* pipe options */
79 struct pipe_client
81 struct object obj; /* object header */
82 struct fd *fd; /* pipe file descriptor */
83 struct pipe_server *server; /* server that this client is connected to */
84 unsigned int flags; /* file flags */
87 struct named_pipe
89 struct object obj; /* object header */
90 unsigned int flags;
91 unsigned int maxinstances;
92 unsigned int outsize;
93 unsigned int insize;
94 unsigned int timeout;
95 unsigned int instances;
96 struct list servers; /* list of servers using this pipe */
97 struct list waiters; /* list of clients waiting to connect */
100 static void named_pipe_dump( struct object *obj, int verbose );
101 static void named_pipe_destroy( struct object *obj );
103 static const struct object_ops named_pipe_ops =
105 sizeof(struct named_pipe), /* size */
106 named_pipe_dump, /* dump */
107 no_add_queue, /* add_queue */
108 NULL, /* remove_queue */
109 NULL, /* signaled */
110 NULL, /* satisfied */
111 no_signal, /* signal */
112 no_get_fd, /* get_fd */
113 no_lookup_name, /* lookup_name */
114 no_close_handle, /* close_handle */
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 no_lookup_name, /* lookup_name */
136 no_close_handle, /* close_handle */
137 pipe_server_destroy /* destroy */
140 static const struct fd_ops pipe_server_fd_ops =
142 default_fd_get_poll_events, /* get_poll_events */
143 default_poll_event, /* poll_event */
144 pipe_server_flush, /* flush */
145 pipe_server_get_info, /* get_file_info */
146 default_fd_queue_async, /* queue_async */
147 default_fd_cancel_async, /* cancel_async */
150 /* client end functions */
151 static void pipe_client_dump( struct object *obj, int verbose );
152 static struct fd *pipe_client_get_fd( struct object *obj );
153 static void pipe_client_destroy( struct object *obj );
154 static int pipe_client_flush( struct fd *fd, struct event **event );
155 static int pipe_client_get_info( struct fd *fd );
157 static const struct object_ops pipe_client_ops =
159 sizeof(struct pipe_client), /* size */
160 pipe_client_dump, /* dump */
161 default_fd_add_queue, /* add_queue */
162 default_fd_remove_queue, /* remove_queue */
163 default_fd_signaled, /* signaled */
164 no_satisfied, /* satisfied */
165 no_signal, /* signal */
166 pipe_client_get_fd, /* get_fd */
167 no_lookup_name, /* lookup_name */
168 no_close_handle, /* close_handle */
169 pipe_client_destroy /* destroy */
172 static const struct fd_ops pipe_client_fd_ops =
174 default_fd_get_poll_events, /* get_poll_events */
175 default_poll_event, /* poll_event */
176 pipe_client_flush, /* flush */
177 pipe_client_get_info, /* get_file_info */
178 default_fd_queue_async, /* queue_async */
179 default_fd_cancel_async /* cancel_async */
182 static void named_pipe_dump( struct object *obj, int verbose )
184 struct named_pipe *pipe = (struct named_pipe *) obj;
185 assert( obj->ops == &named_pipe_ops );
186 fprintf( stderr, "Named pipe " );
187 dump_object_name( &pipe->obj );
188 fprintf( stderr, "\n" );
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 pipe=%p state=%d\n", server->pipe, server->state );
198 static void pipe_client_dump( struct object *obj, int verbose )
200 struct pipe_client *client = (struct pipe_client *) obj;
201 assert( obj->ops == &pipe_client_ops );
202 fprintf( stderr, "Named pipe client server=%p\n", client->server );
205 static void named_pipe_destroy( struct object *obj)
207 struct named_pipe *pipe = (struct named_pipe *) obj;
209 assert( list_empty( &pipe->servers ) );
210 assert( !pipe->instances );
211 async_terminate_queue( &pipe->waiters, STATUS_HANDLES_CLOSED );
214 static struct fd *pipe_client_get_fd( struct object *obj )
216 struct pipe_client *client = (struct pipe_client *) obj;
217 if (client->fd)
218 return (struct fd *) grab_object( client->fd );
219 set_error( STATUS_PIPE_DISCONNECTED );
220 return NULL;
223 static struct fd *pipe_server_get_fd( struct object *obj )
225 struct pipe_server *server = (struct pipe_server *) obj;
227 switch(server->state)
229 case ps_connected_server:
230 case ps_wait_disconnect:
231 assert( server->fd );
232 return (struct fd *) grab_object( server->fd );
234 case ps_wait_open:
235 case ps_idle_server:
236 set_error( STATUS_PIPE_LISTENING );
237 break;
239 case ps_disconnected_server:
240 case ps_wait_connect:
241 set_error( STATUS_PIPE_DISCONNECTED );
242 break;
244 return NULL;
248 static void notify_empty( struct pipe_server *server )
250 if (!server->flush_poll)
251 return;
252 assert( server->state == ps_connected_server );
253 assert( server->event );
254 remove_timeout_user( server->flush_poll );
255 server->flush_poll = NULL;
256 set_event( server->event );
257 release_object( server->event );
258 server->event = NULL;
261 static void do_disconnect( struct pipe_server *server )
263 /* we may only have a server fd, if the client disconnected */
264 if (server->client)
266 assert( server->client->server == server );
267 assert( server->client->fd );
268 release_object( server->client->fd );
269 server->client->fd = NULL;
271 assert( server->fd );
272 release_object( server->fd );
273 server->fd = NULL;
276 static void pipe_server_destroy( struct object *obj)
278 struct pipe_server *server = (struct pipe_server *)obj;
280 assert( obj->ops == &pipe_server_ops );
282 if (server->fd)
284 notify_empty( server );
285 do_disconnect( server );
288 if (server->client)
290 server->client->server = NULL;
291 server->client = NULL;
294 async_terminate_head( &server->wait_q, STATUS_HANDLES_CLOSED );
296 assert( server->pipe->instances );
297 server->pipe->instances--;
299 list_remove( &server->entry );
300 release_object( server->pipe );
303 static void pipe_client_destroy( struct object *obj)
305 struct pipe_client *client = (struct pipe_client *)obj;
306 struct pipe_server *server = client->server;
308 assert( obj->ops == &pipe_client_ops );
310 if (server)
312 notify_empty( server );
314 switch(server->state)
316 case ps_connected_server:
317 /* Don't destroy the server's fd here as we can't
318 do a successful flush without it. */
319 server->state = ps_wait_disconnect;
320 release_object( client->fd );
321 client->fd = NULL;
322 break;
323 case ps_disconnected_server:
324 server->state = ps_wait_connect;
325 break;
326 case ps_idle_server:
327 case ps_wait_open:
328 case ps_wait_disconnect:
329 case ps_wait_connect:
330 assert( 0 );
332 assert( server->client );
333 server->client = NULL;
334 client->server = NULL;
336 assert( !client->fd );
339 static int pipe_data_remaining( struct pipe_server *server )
341 struct pollfd pfd;
342 int fd;
344 assert( server->client );
346 fd = get_unix_fd( server->client->fd );
347 if (fd < 0)
348 return 0;
349 pfd.fd = fd;
350 pfd.events = POLLIN;
351 pfd.revents = 0;
353 if (0 > poll( &pfd, 1, 0 ))
354 return 0;
356 return pfd.revents&POLLIN;
359 static void check_flushed( void *arg )
361 struct pipe_server *server = (struct pipe_server*) arg;
363 assert( server->event );
364 if (pipe_data_remaining( server ))
366 struct timeval tv;
368 gettimeofday( &tv, NULL );
369 add_timeout( &tv, 100 );
370 server->flush_poll = add_timeout_user( &tv, check_flushed, server );
372 else
374 /* notify_empty( server ); */
375 server->flush_poll = NULL;
376 set_event( server->event );
377 release_object( server->event );
378 server->event = NULL;
382 static int pipe_server_flush( struct fd *fd, struct event **event )
384 struct pipe_server *server = get_fd_user( fd );
386 if (!server)
387 return 0;
389 if (server->state != ps_connected_server)
390 return 0;
392 /* FIXME: if multiple threads flush the same pipe,
393 maybe should create a list of processes to notify */
394 if (server->flush_poll)
395 return 0;
397 if (pipe_data_remaining( server ))
399 struct timeval tv;
401 /* this kind of sux -
402 there's no unix way to be alerted when a pipe becomes empty */
403 server->event = create_event( NULL, 0, 0, 0 );
404 if (!server->event)
405 return 0;
406 gettimeofday( &tv, NULL );
407 add_timeout( &tv, 100 );
408 server->flush_poll = add_timeout_user( &tv, check_flushed, server );
409 *event = server->event;
412 return 0;
415 static int pipe_client_flush( struct fd *fd, struct event **event )
417 /* FIXME: what do we have to do for this? */
418 return 0;
421 static inline int is_overlapped( unsigned int options )
423 return !(options & (FILE_SYNCHRONOUS_IO_ALERT | FILE_SYNCHRONOUS_IO_NONALERT));
426 static int pipe_server_get_info( struct fd *fd )
428 struct pipe_server *server = get_fd_user( fd );
429 int flags = FD_FLAG_AVAILABLE;
431 if (is_overlapped( server->options )) flags |= FD_FLAG_OVERLAPPED;
433 return flags;
436 static int pipe_client_get_info( struct fd *fd )
438 struct pipe_client *client = get_fd_user( fd );
439 int flags = FD_FLAG_AVAILABLE;
441 if (is_overlapped( client->flags )) flags |= FD_FLAG_OVERLAPPED;
443 return flags;
446 static struct named_pipe *create_named_pipe( const struct unicode_str *name, unsigned int attr )
448 struct named_pipe *pipe;
450 pipe = create_named_object( sync_namespace, &named_pipe_ops, name, attr | OBJ_OPENIF );
451 if (pipe)
453 if (get_error() != STATUS_OBJECT_NAME_EXISTS)
455 /* initialize it if it didn't already exist */
456 pipe->instances = 0;
457 list_init( &pipe->servers );
458 list_init( &pipe->waiters );
461 return pipe;
464 static struct named_pipe *open_named_pipe( const struct unicode_str *name, unsigned int attr )
466 struct object *obj;
468 if ((obj = find_object( sync_namespace, name, attr )))
470 if (obj->ops == &named_pipe_ops) return (struct named_pipe *)obj;
471 release_object( obj );
472 set_error( STATUS_OBJECT_TYPE_MISMATCH );
474 else set_error( STATUS_OBJECT_NAME_NOT_FOUND );
476 return NULL;
479 static struct pipe_server *get_pipe_server_obj( struct process *process,
480 obj_handle_t handle, unsigned int access )
482 struct object *obj;
483 obj = get_handle_obj( process, handle, access, &pipe_server_ops );
484 return (struct pipe_server *) obj;
487 static struct pipe_server *create_pipe_server( struct named_pipe *pipe, unsigned int options )
489 struct pipe_server *server;
491 server = alloc_object( &pipe_server_ops );
492 if (!server)
493 return NULL;
495 server->fd = NULL;
496 server->pipe = pipe;
497 server->state = ps_idle_server;
498 server->client = NULL;
499 server->flush_poll = NULL;
500 server->options = options;
501 list_init( &server->wait_q );
503 list_add_head( &pipe->servers, &server->entry );
504 grab_object( pipe );
506 return server;
509 static struct pipe_client *create_pipe_client( struct pipe_server *server, unsigned int flags )
511 struct pipe_client *client;
513 client = alloc_object( &pipe_client_ops );
514 if (!client)
515 return NULL;
517 client->fd = NULL;
518 client->server = server;
519 client->flags = flags;
521 return client;
524 static inline struct pipe_server *find_server( struct named_pipe *pipe, enum pipe_state state )
526 struct pipe_server *server;
528 LIST_FOR_EACH_ENTRY( server, &pipe->servers, struct pipe_server, entry )
530 if (server->state == state) return (struct pipe_server *)grab_object( server );
532 return NULL;
535 static inline struct pipe_server *find_server2( struct named_pipe *pipe,
536 enum pipe_state state1, enum pipe_state state2 )
538 struct pipe_server *server;
540 LIST_FOR_EACH_ENTRY( server, &pipe->servers, struct pipe_server, entry )
542 if (server->state == state1 || server->state == state2)
543 return (struct pipe_server *)grab_object( server );
545 return NULL;
548 DECL_HANDLER(create_named_pipe)
550 struct named_pipe *pipe;
551 struct pipe_server *server;
552 struct unicode_str name;
554 reply->handle = 0;
555 get_req_unicode_str( &name );
556 if (!(pipe = create_named_pipe( &name, req->attributes ))) return;
558 if (get_error() != STATUS_OBJECT_NAME_EXISTS)
560 pipe->insize = req->insize;
561 pipe->outsize = req->outsize;
562 pipe->maxinstances = req->maxinstances;
563 pipe->timeout = req->timeout;
564 pipe->flags = req->flags;
566 else
568 if (pipe->maxinstances <= pipe->instances)
570 set_error( STATUS_INSTANCE_NOT_AVAILABLE );
571 release_object( pipe );
572 return;
574 if ((pipe->maxinstances != req->maxinstances) ||
575 (pipe->timeout != req->timeout) ||
576 (pipe->flags != req->flags))
578 set_error( STATUS_ACCESS_DENIED );
579 release_object( pipe );
580 return;
582 set_error( 0 ); /* clear the name collision */
585 server = create_pipe_server( pipe, req->options );
586 if (server)
588 reply->handle = alloc_handle( current->process, server,
589 req->access, req->attributes & OBJ_INHERIT );
590 server->pipe->instances++;
591 release_object( server );
594 release_object( pipe );
597 DECL_HANDLER(open_named_pipe)
599 struct pipe_server *server;
600 struct pipe_client *client;
601 struct unicode_str name;
602 struct named_pipe *pipe;
603 int fds[2];
605 get_req_unicode_str( &name );
606 if (!(pipe = open_named_pipe( &name, req->attributes ))) return;
608 server = find_server2( pipe, ps_idle_server, ps_wait_open );
609 release_object( pipe );
611 if (!server)
613 set_error( STATUS_PIPE_NOT_AVAILABLE );
614 return;
617 client = create_pipe_client( server, req->flags );
618 if (client)
620 if (!socketpair( PF_UNIX, SOCK_STREAM, 0, fds ))
622 int res = 0;
624 assert( !client->fd );
625 assert( !server->fd );
627 /* for performance reasons, only set nonblocking mode when using
628 * overlapped I/O. Otherwise, we will be doing too much busy
629 * looping */
630 if (is_overlapped( req->flags ))
631 res = fcntl( fds[1], F_SETFL, O_NONBLOCK );
632 if ((res != -1) && is_overlapped( server->options ))
633 res = fcntl( fds[0], F_SETFL, O_NONBLOCK );
635 client->fd = create_anonymous_fd( &pipe_client_fd_ops,
636 fds[1], &client->obj );
637 server->fd = create_anonymous_fd( &pipe_server_fd_ops,
638 fds[0], &server->obj );
639 if (client->fd && server->fd && res != 1)
641 if (server->state == ps_wait_open)
642 async_terminate_head( &server->wait_q, STATUS_SUCCESS );
643 assert( list_empty( &server->wait_q ) );
644 server->state = ps_connected_server;
645 server->client = client;
646 client->server = server;
647 reply->handle = alloc_handle( current->process, client,
648 req->access, req->attributes & OBJ_INHERIT );
651 else
652 file_set_error();
654 release_object( client );
656 release_object( server );
659 DECL_HANDLER(connect_named_pipe)
661 struct pipe_server *server;
663 server = get_pipe_server_obj(current->process, req->handle, 0);
664 if (!server)
665 return;
667 switch(server->state)
669 case ps_idle_server:
670 case ps_wait_connect:
671 assert( !server->fd );
672 server->state = ps_wait_open;
673 create_async( current, NULL, &server->wait_q,
674 req->func, req->event, NULL );
675 async_terminate_queue( &server->pipe->waiters, STATUS_SUCCESS );
676 break;
677 case ps_connected_server:
678 assert( server->fd );
679 set_error( STATUS_PIPE_CONNECTED );
680 break;
681 case ps_disconnected_server:
682 set_error( STATUS_PIPE_BUSY );
683 break;
684 case ps_wait_disconnect:
685 set_error( STATUS_NO_DATA_DETECTED );
686 break;
687 case ps_wait_open:
688 set_error( STATUS_INVALID_HANDLE );
689 break;
692 release_object(server);
695 DECL_HANDLER(wait_named_pipe)
697 struct named_pipe *pipe;
698 struct pipe_server *server;
699 struct unicode_str name;
701 get_req_unicode_str( &name );
702 if (!(pipe = open_named_pipe( &name, OBJ_CASE_INSENSITIVE )))
704 set_error( STATUS_PIPE_NOT_AVAILABLE );
705 return;
707 server = find_server( pipe, ps_wait_open );
708 if (server)
710 /* there's already a server waiting for a client to connect */
711 thread_queue_apc( current, NULL, req->func, APC_ASYNC_IO,
712 1, req->overlapped, NULL, (void *)STATUS_SUCCESS );
713 release_object( server );
715 else
717 int timeout;
718 if (req->timeout == NMPWAIT_USE_DEFAULT_WAIT)
719 timeout = pipe->timeout;
720 else
721 timeout = req->timeout;
723 if (req->timeout == NMPWAIT_WAIT_FOREVER)
724 create_async( current, NULL, &pipe->waiters,
725 req->func, req->overlapped, NULL );
726 else
727 create_async( current, &timeout, &pipe->waiters,
728 req->func, req->overlapped, NULL );
731 release_object( pipe );
734 DECL_HANDLER(disconnect_named_pipe)
736 struct pipe_server *server;
738 reply->fd = -1;
739 server = get_pipe_server_obj( current->process, req->handle, 0 );
740 if (!server)
741 return;
742 switch(server->state)
744 case ps_connected_server:
745 assert( server->fd );
746 assert( server->client );
747 assert( server->client->fd );
749 notify_empty( server );
751 /* Dump the client and server fds, but keep the pointers
752 around - client loses all waiting data */
753 server->state = ps_disconnected_server;
754 do_disconnect( server );
755 reply->fd = flush_cached_fd( current->process, req->handle );
756 break;
758 case ps_wait_disconnect:
759 assert( !server->client );
760 assert( server->fd );
761 do_disconnect( server );
762 server->state = ps_wait_connect;
763 reply->fd = flush_cached_fd( current->process, req->handle );
764 break;
766 case ps_idle_server:
767 case ps_wait_open:
768 case ps_disconnected_server:
769 case ps_wait_connect:
770 set_error( STATUS_PIPE_DISCONNECTED );
771 break;
773 release_object( server );
776 DECL_HANDLER(get_named_pipe_info)
778 struct pipe_server *server;
780 server = get_pipe_server_obj( current->process, req->handle, 0 );
781 if (!server)
782 return;
784 reply->flags = server->pipe->flags;
785 reply->maxinstances = server->pipe->maxinstances;
786 reply->insize = server->pipe->insize;
787 reply->outsize = server->pipe->outsize;
789 release_object(server);