1 /* udscs.c Unix Domain Socket Client Server framework. A framework for quickly
2 creating select() based servers capable of handling multiple clients and
3 matching select() based clients using variable size messages.
5 Copyright 2010 Red Hat, Inc.
8 Hans de Goede <hdegoede@redhat.com>
10 This program is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
32 #include <sys/socket.h>
41 struct udscs_buf
*next
;
44 struct udscs_connection
{
46 const char * const *type_to_string
;
49 struct ucred peer_cred
;
52 /* Read stuff, single buffer, separate header and data buffer */
54 struct udscs_message_header header
;
55 struct udscs_buf data
;
57 /* Writes are stored in a linked list of buffers, with both the header
58 + data for a single message in 1 buffer. */
59 struct udscs_buf
*write_buf
;
62 udscs_read_callback read_callback
;
63 udscs_disconnect_callback disconnect_callback
;
65 struct udscs_connection
*next
;
66 struct udscs_connection
*prev
;
71 const char * const *type_to_string
;
74 struct udscs_connection connections_head
;
75 udscs_connect_callback connect_callback
;
76 udscs_read_callback read_callback
;
77 udscs_disconnect_callback disconnect_callback
;
80 static void udscs_do_write(struct udscs_connection
**connp
);
81 static void udscs_do_read(struct udscs_connection
**connp
);
84 struct udscs_server
*udscs_create_server(const char *socketname
,
85 udscs_connect_callback connect_callback
,
86 udscs_read_callback read_callback
,
87 udscs_disconnect_callback disconnect_callback
,
88 const char * const type_to_string
[], int no_types
, int debug
)
91 struct sockaddr_un address
;
92 struct udscs_server
*server
;
94 server
= calloc(1, sizeof(*server
));
98 server
->type_to_string
= type_to_string
;
99 server
->no_types
= no_types
;
100 server
->debug
= debug
;
102 server
->fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
103 if (server
->fd
== -1) {
104 syslog(LOG_ERR
, "creating unix domain socket: %m");
109 address
.sun_family
= AF_UNIX
;
110 snprintf(address
.sun_path
, sizeof(address
.sun_path
), "%s", socketname
);
111 c
= bind(server
->fd
, (struct sockaddr
*)&address
, sizeof(address
));
113 syslog(LOG_ERR
, "bind %s: %m", socketname
);
118 c
= listen(server
->fd
, 5);
120 syslog(LOG_ERR
, "listen: %m");
125 server
->connect_callback
= connect_callback
;
126 server
->read_callback
= read_callback
;
127 server
->disconnect_callback
= disconnect_callback
;
132 void udscs_destroy_server(struct udscs_server
*server
)
134 struct udscs_connection
*conn
, *next_conn
;
139 conn
= server
->connections_head
.next
;
141 next_conn
= conn
->next
;
142 udscs_destroy_connection(&conn
);
149 struct udscs_connection
*udscs_connect(const char *socketname
,
150 udscs_read_callback read_callback
,
151 udscs_disconnect_callback disconnect_callback
,
152 const char * const type_to_string
[], int no_types
, int debug
)
155 struct sockaddr_un address
;
156 struct udscs_connection
*conn
;
158 conn
= calloc(1, sizeof(*conn
));
162 conn
->type_to_string
= type_to_string
;
163 conn
->no_types
= no_types
;
166 conn
->fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
167 if (conn
->fd
== -1) {
168 syslog(LOG_ERR
, "creating unix domain socket: %m");
173 address
.sun_family
= AF_UNIX
;
174 snprintf(address
.sun_path
, sizeof(address
.sun_path
), "%s", socketname
);
175 c
= connect(conn
->fd
, (struct sockaddr
*)&address
, sizeof(address
));
178 syslog(LOG_DEBUG
, "connect %s: %m", socketname
);
184 conn
->read_callback
= read_callback
;
185 conn
->disconnect_callback
= disconnect_callback
;
188 syslog(LOG_DEBUG
, "%p connected to %s", conn
, socketname
);
193 void udscs_destroy_connection(struct udscs_connection
**connp
)
195 struct udscs_buf
*wbuf
, *next_wbuf
;
196 struct udscs_connection
*conn
= *connp
;
201 if (conn
->disconnect_callback
)
202 conn
->disconnect_callback(conn
);
204 wbuf
= conn
->write_buf
;
206 next_wbuf
= wbuf
->next
;
212 free(conn
->data
.buf
);
215 conn
->next
->prev
= conn
->prev
;
217 conn
->prev
->next
= conn
->next
;
222 syslog(LOG_DEBUG
, "%p disconnected", conn
);
228 struct ucred
udscs_get_peer_cred(struct udscs_connection
*conn
)
230 return conn
->peer_cred
;
233 int udscs_server_fill_fds(struct udscs_server
*server
, fd_set
*readfds
,
236 struct udscs_connection
*conn
;
237 int nfds
= server
->fd
+ 1;
242 FD_SET(server
->fd
, readfds
);
244 conn
= server
->connections_head
.next
;
246 int conn_nfds
= udscs_client_fill_fds(conn
, readfds
, writefds
);
247 if (conn_nfds
> nfds
)
256 int udscs_client_fill_fds(struct udscs_connection
*conn
, fd_set
*readfds
,
262 FD_SET(conn
->fd
, readfds
);
264 FD_SET(conn
->fd
, writefds
);
269 static void udscs_server_accept(struct udscs_server
*server
) {
270 struct udscs_connection
*new_conn
, *conn
;
271 struct sockaddr_un address
;
272 socklen_t length
= sizeof(address
);
275 fd
= accept(server
->fd
, (struct sockaddr
*)&address
, &length
);
279 syslog(LOG_ERR
, "accept: %m");
283 new_conn
= calloc(1, sizeof(*conn
));
285 syslog(LOG_ERR
, "out of memory, disconnecting new client");
291 new_conn
->type_to_string
= server
->type_to_string
;
292 new_conn
->no_types
= server
->no_types
;
293 new_conn
->debug
= server
->debug
;
294 new_conn
->read_callback
= server
->read_callback
;
295 new_conn
->disconnect_callback
= server
->disconnect_callback
;
297 length
= sizeof(new_conn
->peer_cred
);
298 r
= getsockopt(fd
, SOL_SOCKET
, SO_PEERCRED
, &new_conn
->peer_cred
, &length
);
300 syslog(LOG_ERR
, "Could not get peercred, disconnecting new client");
306 conn
= &server
->connections_head
;
310 new_conn
->prev
= conn
;
311 conn
->next
= new_conn
;
314 syslog(LOG_DEBUG
, "new client accepted: %p, pid: %d",
315 new_conn
, (int)new_conn
->peer_cred
.pid
);
317 if (server
->connect_callback
)
318 server
->connect_callback(new_conn
);
321 void udscs_server_handle_fds(struct udscs_server
*server
, fd_set
*readfds
,
324 struct udscs_connection
*conn
, *next_conn
;
329 if (FD_ISSET(server
->fd
, readfds
))
330 udscs_server_accept(server
);
332 conn
= server
->connections_head
.next
;
334 /* conn maybe destroyed by udscs_client_handle_fds (when disconnected),
335 so get the next connection first. */
336 next_conn
= conn
->next
;
337 udscs_client_handle_fds(&conn
, readfds
, writefds
);
342 void udscs_client_handle_fds(struct udscs_connection
**connp
, fd_set
*readfds
,
348 if (FD_ISSET((*connp
)->fd
, readfds
))
349 udscs_do_read(connp
);
351 if (*connp
&& FD_ISSET((*connp
)->fd
, writefds
))
352 udscs_do_write(connp
);
355 int udscs_write(struct udscs_connection
*conn
, uint32_t type
, uint32_t arg1
,
356 uint32_t arg2
, const uint8_t *data
, uint32_t size
)
358 struct udscs_buf
*wbuf
, *new_wbuf
;
359 struct udscs_message_header header
;
361 new_wbuf
= malloc(sizeof(*new_wbuf
));
366 new_wbuf
->size
= sizeof(header
) + size
;
367 new_wbuf
->next
= NULL
;
368 new_wbuf
->buf
= malloc(new_wbuf
->size
);
369 if (!new_wbuf
->buf
) {
379 memcpy(new_wbuf
->buf
, &header
, sizeof(header
));
380 memcpy(new_wbuf
->buf
+ sizeof(header
), data
, size
);
383 if (type
< conn
->no_types
)
384 syslog(LOG_DEBUG
, "%p sent %s, arg1: %u, arg2: %u, size %u",
385 conn
, conn
->type_to_string
[type
], arg1
, arg2
, size
);
388 "%p sent invalid message %u, arg1: %u, arg2: %u, size %u",
389 conn
, type
, arg1
, arg2
, size
);
392 if (!conn
->write_buf
) {
393 conn
->write_buf
= new_wbuf
;
397 /* maybe we should limit the write_buf stack depth ? */
398 wbuf
= conn
->write_buf
;
402 wbuf
->next
= new_wbuf
;
407 int udscs_server_write_all(struct udscs_server
*server
,
408 uint32_t type
, uint32_t arg1
, uint32_t arg2
,
409 const uint8_t *data
, uint32_t size
)
411 struct udscs_connection
*conn
;
413 conn
= server
->connections_head
.next
;
415 if (udscs_write(conn
, type
, arg1
, arg2
, data
, size
))
423 int udscs_server_for_all_clients(struct udscs_server
*server
,
424 udscs_for_all_clients_callback func
, void *priv
)
427 struct udscs_connection
*conn
, *next_conn
;
432 conn
= server
->connections_head
.next
;
434 /* Get next conn as func may destroy the current conn */
435 next_conn
= conn
->next
;
436 r
+= func(&conn
, priv
);
442 static void udscs_read_complete(struct udscs_connection
**connp
)
444 struct udscs_connection
*conn
= *connp
;
447 if (conn
->header
.type
< conn
->no_types
)
449 "%p received %s, arg1: %u, arg2: %u, size %u",
450 conn
, conn
->type_to_string
[conn
->header
.type
],
451 conn
->header
.arg1
, conn
->header
.arg2
, conn
->header
.size
);
454 "%p received invalid message %u, arg1: %u, arg2: %u, size %u",
455 conn
, conn
->header
.type
, conn
->header
.arg1
, conn
->header
.arg2
,
459 if (conn
->read_callback
) {
460 conn
->read_callback(connp
, &conn
->header
, conn
->data
.buf
);
461 if (!*connp
) /* Was the connection disconnected by the callback ? */
465 conn
->header_read
= 0;
466 memset(&conn
->data
, 0, sizeof(conn
->data
));
469 static void udscs_do_read(struct udscs_connection
**connp
)
474 struct udscs_connection
*conn
= *connp
;
476 if (conn
->header_read
< sizeof(conn
->header
)) {
477 to_read
= sizeof(conn
->header
) - conn
->header_read
;
478 dest
= (uint8_t *)&conn
->header
+ conn
->header_read
;
480 to_read
= conn
->data
.size
- conn
->data
.pos
;
481 dest
= conn
->data
.buf
+ conn
->data
.pos
;
484 n
= read(conn
->fd
, dest
, to_read
);
488 syslog(LOG_ERR
, "reading unix domain socket: %m, disconnecting %p",
492 udscs_destroy_connection(connp
);
496 if (conn
->header_read
< sizeof(conn
->header
)) {
497 conn
->header_read
+= n
;
498 if (conn
->header_read
== sizeof(conn
->header
)) {
499 if (conn
->header
.size
== 0) {
500 udscs_read_complete(connp
);
504 conn
->data
.size
= conn
->header
.size
;
505 conn
->data
.buf
= malloc(conn
->data
.size
);
506 if (!conn
->data
.buf
) {
507 syslog(LOG_ERR
, "out of memory, disconnecting %p", conn
);
508 udscs_destroy_connection(connp
);
514 if (conn
->data
.pos
== conn
->data
.size
)
515 udscs_read_complete(connp
);
519 static void udscs_do_write(struct udscs_connection
**connp
)
523 struct udscs_connection
*conn
= *connp
;
525 struct udscs_buf
* wbuf
= conn
->write_buf
;
528 "%p do_write called on a connection without a write buf ?!",
533 to_write
= wbuf
->size
- wbuf
->pos
;
534 n
= write(conn
->fd
, wbuf
->buf
+ wbuf
->pos
, to_write
);
538 syslog(LOG_ERR
, "writing to unix domain socket: %m, disconnecting %p",
540 udscs_destroy_connection(connp
);
545 if (wbuf
->pos
== wbuf
->size
) {
546 conn
->write_buf
= wbuf
->next
;
552 void udscs_set_user_data(struct udscs_connection
*conn
, void *data
)
554 conn
->user_data
= data
;
557 void *udscs_get_user_data(struct udscs_connection
*conn
)
562 return conn
->user_data
;