1 /* IOHandler.c - TransparentIRC 0.1
2 * Copyright (C) 2011-2012 Philipp Kreil (pk910)
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 #include "IOHandler.h"
22 struct IODescriptor *first_descriptor = NULL;
23 struct IODescriptor *timer_priority = NULL;
25 void iohandler_log(enum IOLogType type, char *text, ...) {
27 char logBuf[MAXLOG+1];
30 va_start(arg_list, text);
31 pos = vsnprintf(logBuf, MAXLOG - 1, text, arg_list);
33 if (pos < 0 || pos > (MAXLOG - 1)) pos = MAXLOG - 1;
37 //do something with logBuf
42 extern struct IOEngine engine_select; /* select system call (should always be useable) */
43 extern struct IOEngine engine_kevent;
44 extern struct IOEngine engine_epoll;
46 struct IOEngine *engine = NULL;
48 static void iohandler_init_engine() {
50 if(!engine && engine_kevent.init && engine_kevent.init())
51 engine = &engine_kevent;
52 if(!engine && engine_epoll.init && engine_epoll.init())
53 engine = &engine_epoll;
56 if(engine_select.init())
57 engine = &engine_select;
59 iohandler_log(IOLOG_FATAL, "found no useable IO engine");
63 iohandler_log(IOLOG_DEBUG, "using %s IO engine", engine->name);
66 static void iohandler_append(struct IODescriptor *descriptor) {
67 struct timeval *timeout = ((descriptor->timeout.tv_sec || descriptor->timeout.tv_usec) ? &descriptor->timeout : NULL);
69 struct IODescriptor *iofd;
71 descriptor->timeout = *timeout;
73 iofd = timer_priority;
75 iofd = first_descriptor;
77 for(;;iofd = iofd->next) {
78 if(timeval_is_smaler(timeout, (&iofd->timeout))) {
79 descriptor->prev = iofd->prev;
80 descriptor->next = iofd;
81 iofd->prev = descriptor;
83 iofd->prev->next = descriptor;
85 timer_priority = descriptor;
88 if(iofd == timer_priority)
90 if(iofd->next == NULL) {
91 descriptor->next = NULL;
92 descriptor->prev = iofd;
93 iofd->next = descriptor;
95 timer_priority = descriptor;
100 descriptor->prev = NULL;
101 descriptor->next = NULL;
102 first_descriptor = descriptor;
103 timer_priority = descriptor;
107 descriptor->prev = NULL;
108 descriptor->next = first_descriptor;
110 first_descriptor->prev = descriptor;
111 first_descriptor = descriptor;
115 static void iohandler_remove(struct IODescriptor *descriptor, int engine_remove) {
116 //remove IODescriptor from the list
118 descriptor->prev->next = descriptor->next;
120 first_descriptor = descriptor->next;
122 descriptor->next->prev = descriptor->prev;
123 if(descriptor == timer_priority)
124 timer_priority = descriptor->next;
127 engine->remove(descriptor);
128 if(descriptor->readbuf.buffer)
129 free(descriptor->readbuf.buffer);
130 if(descriptor->writebuf.buffer)
131 free(descriptor->writebuf.buffer);
132 iohandler_log(IOLOG_DEBUG, "removed IODescriptor (%d) of type `%s`", descriptor->fd, iohandler_iotype_name(descriptor->type));
136 struct IODescriptor *iohandler_add(int sockfd, enum IOType type, struct timeval *timeout, iohandler_callback *callback) {
137 //just add a new IODescriptor
138 struct IODescriptor *descriptor = calloc(1, sizeof(*descriptor));
140 iohandler_log(IOLOG_ERROR, "could not allocate memory for IODescriptor in %s:%d", __FILE__, __LINE__);
143 descriptor->fd = sockfd;
144 descriptor->type = type;
145 descriptor->state = IO_CLOSED;
146 descriptor->callback = callback;
148 descriptor->timeout = *timeout;
149 if(type != IOTYPE_TIMER) {
150 descriptor->readbuf.buffer = malloc(IO_READ_BUFLEN + 2);
151 descriptor->readbuf.bufpos = 0;
152 descriptor->readbuf.buflen = IO_READ_BUFLEN;
153 descriptor->writebuf.buffer = malloc(IO_READ_BUFLEN + 2);
154 descriptor->writebuf.bufpos = 0;
155 descriptor->writebuf.buflen = IO_READ_BUFLEN;
159 iohandler_init_engine();
164 engine->add(descriptor);
166 //add IODescriptor to the list
167 iohandler_append(descriptor);
169 iohandler_log(IOLOG_DEBUG, "added custom socket descriptor (%d) as type `%s`", sockfd, iohandler_iotype_name(type));
173 void iohandler_set_timeout(struct IODescriptor *descriptor, struct timeval *timeout) {
175 descriptor->prev->next = descriptor->next;
177 first_descriptor = descriptor->next;
179 descriptor->next->prev = descriptor->prev;
180 if(descriptor == timer_priority)
181 timer_priority = descriptor->next;
183 descriptor->timeout = *timeout;
185 descriptor->timeout.tv_sec = 0;
186 descriptor->timeout.tv_usec = 0;
188 iohandler_append(descriptor);
191 static void iohandler_increase_iobuf(struct IOBuffer *iobuf, size_t required) {
192 if(iobuf->buflen >= required) return;
193 char *new_buf = realloc(iobuf->buffer, required + 2);
195 iobuf->buffer = new_buf;
196 iobuf->buflen = required;
200 struct IODescriptor *iohandler_timer(struct timeval timeout, iohandler_callback *callback) {
201 struct IODescriptor *descriptor;
202 descriptor = iohandler_add(-1, IOTYPE_TIMER, &timeout, callback);
204 iohandler_log(IOLOG_ERROR, "could not allocate memory for IODescriptor in %s:%d", __FILE__, __LINE__);
207 iohandler_log(IOLOG_DEBUG, "added timer descriptor (sec: %d; usec: %d)", timeout.tv_sec, timeout.tv_usec);
211 struct IODescriptor *iohandler_connect(const char *hostname, unsigned int port, int ssl, const char *bindhost, iohandler_callback *callback) {
212 //non-blocking connect
214 struct addrinfo hints, *res, *freeres;
215 struct sockaddr_in *ip4 = NULL;
216 struct sockaddr_in6 *ip6 = NULL;
218 struct sockaddr *dstaddr = NULL;
219 struct IODescriptor *descriptor;
221 memset (&hints, 0, sizeof (hints));
222 hints.ai_family = PF_UNSPEC;
223 hints.ai_socktype = SOCK_STREAM;
224 hints.ai_flags |= AI_CANONNAME;
225 if (getaddrinfo (hostname, NULL, &hints, &res)) {
226 iohandler_log(IOLOG_ERROR, "could not resolve %d to an IP address", hostname);
230 switch (res->ai_family) {
232 ip4 = (struct sockaddr_in *) res->ai_addr;
235 ip6 = (struct sockaddr_in6 *) res->ai_addr;
244 sockfd = socket(AF_INET6, SOCK_STREAM, 0);
246 iohandler_log(IOLOG_ERROR, "could not create socket in %s:%d", __FILE__, __LINE__);
250 ip6->sin6_family = AF_INET6;
251 ip6->sin6_port = htons(port);
253 struct sockaddr_in6 *ip6vhost = NULL;
254 if (bindhost && !getaddrinfo(bindhost, NULL, &hints, &res)) {
256 switch (res->ai_family) {
258 ip6vhost = (struct sockaddr_in6 *) res->ai_addr;
267 ip6vhost->sin6_family = AF_INET6;
268 ip6vhost->sin6_port = htons(0);
269 bind(sockfd, (struct sockaddr*)ip6vhost, sizeof(*ip6vhost));
271 dstaddr = (struct sockaddr*)ip6;
272 dstaddrlen = sizeof(*ip6);
274 sockfd = socket(AF_INET, SOCK_STREAM, 0);
276 iohandler_log(IOLOG_ERROR, "could not create socket in %s:%d", __FILE__, __LINE__);
280 ip4->sin_family = AF_INET;
281 ip4->sin_port = htons(port);
283 struct sockaddr_in *ip4vhost = NULL;
284 if (bindhost && !getaddrinfo(bindhost, NULL, &hints, &res)) {
286 switch (res->ai_family) {
288 ip4vhost = (struct sockaddr_in *) res->ai_addr;
297 ip4vhost->sin_family = AF_INET;
298 ip4vhost->sin_port = htons(0);
299 bind(sockfd, (struct sockaddr*)ip4vhost, sizeof(*ip4vhost));
301 dstaddr = (struct sockaddr*)ip4;
302 dstaddrlen = sizeof(*ip4);
305 //make sockfd unblocking
309 flags = fcntl(sockfd, F_GETFL);
310 fcntl(sockfd, F_SETFL, flags|O_NONBLOCK);
311 flags = fcntl(sockfd, F_GETFD);
312 fcntl(sockfd, F_SETFD, flags|FD_CLOEXEC);
315 /* I hope you're using the Win32 backend or something else that
316 * automatically marks the file descriptor non-blocking...
319 descriptor = iohandler_add(sockfd, IOTYPE_CLIENT, NULL, callback);
324 connect(sockfd, dstaddr, dstaddrlen); //returns EINPROGRESS here (nonblocking)
325 descriptor->state = IO_CONNECTING;
326 descriptor->read_lines = 1;
327 engine->update(descriptor);
328 iohandler_log(IOLOG_DEBUG, "added client socket (%d) connecting to %s:%d", sockfd, hostname, port);
332 struct IODescriptor *iohandler_listen(const char *hostname, unsigned int port, int ssl, iohandler_callback *callback) {
334 struct addrinfo hints, *res, *freeres;
335 struct sockaddr_in *ip4 = NULL;
336 struct sockaddr_in6 *ip6 = NULL;
337 struct IODescriptor *descriptor;
340 memset (&hints, 0, sizeof (hints));
341 hints.ai_family = PF_UNSPEC;
342 hints.ai_socktype = SOCK_STREAM;
343 hints.ai_flags |= AI_CANONNAME;
344 if (getaddrinfo (hostname, NULL, &hints, &res)) {
348 switch (res->ai_family) {
350 ip4 = (struct sockaddr_in *) res->ai_addr;
353 ip6 = (struct sockaddr_in6 *) res->ai_addr;
362 sockfd = socket(AF_INET6, SOCK_STREAM, 0);
363 if(sockfd == -1) return NULL;
366 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, (const char*)&opt, sizeof(opt));
368 ip6->sin6_family = AF_INET6;
369 ip6->sin6_port = htons(port);
371 bind(sockfd, (struct sockaddr*)ip6, sizeof(*ip6));
373 sockfd = socket(AF_INET, SOCK_STREAM, 0);
374 if(sockfd == -1) return NULL;
377 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, (const char*)&opt, sizeof(opt));
379 ip4->sin_family = AF_INET;
380 ip4->sin_port = htons(port);
382 bind(sockfd, (struct sockaddr*)ip4, sizeof(*ip4));
385 //make sockfd unblocking
389 flags = fcntl(sockfd, F_GETFL);
390 fcntl(sockfd, F_SETFL, flags|O_NONBLOCK);
391 flags = fcntl(sockfd, F_GETFD);
392 fcntl(sockfd, F_SETFD, flags|FD_CLOEXEC);
395 /* I hope you're using the Win32 backend or something else that
396 * automatically marks the file descriptor non-blocking...
399 descriptor = iohandler_add(sockfd, IOTYPE_SERVER, NULL, callback);
405 descriptor->state = IO_LISTENING;
406 engine->update(descriptor);
407 iohandler_log(IOLOG_DEBUG, "added server socket (%d) listening on %s:%d", sockfd, hostname, port);
411 void iohandler_write(struct IODescriptor *iofd, const char *line) {
412 size_t linelen = strlen(line);
413 iohandler_send(iofd, line, linelen);
416 void iohandler_send(struct IODescriptor *iofd, const char *data, size_t datalen) {
417 if(iofd->type == IOTYPE_TIMER || iofd->state == IO_CLOSED) {
418 iohandler_log(IOLOG_ERROR, "could not write to socket (%s)", (iofd->type == IOTYPE_TIMER ? "IOTYPE_TIMER" : "IO_CLOSED"));
421 iohandler_log(IOLOG_DEBUG, "add %d to writebuf (fd: %d): %s", datalen, iofd->fd, data);
422 if(iofd->writebuf.buflen < iofd->writebuf.bufpos + datalen) {
423 iohandler_log(IOLOG_DEBUG, "increase writebuf (curr: %d) to %d (+%d bytes)", iofd->writebuf.buflen, iofd->writebuf.bufpos + datalen, (iofd->writebuf.bufpos + datalen - iofd->writebuf.buflen));
424 iohandler_increase_iobuf(&iofd->writebuf, iofd->writebuf.bufpos + datalen);
425 if(iofd->writebuf.buflen < iofd->writebuf.bufpos + datalen) {
426 iohandler_log(IOLOG_ERROR, "increase writebuf (curr: %d) to %d (+%d bytes) FAILED", iofd->writebuf.buflen, iofd->writebuf.bufpos + datalen, (iofd->writebuf.bufpos + datalen - iofd->writebuf.buflen));
430 memcpy(iofd->writebuf.buffer + iofd->writebuf.bufpos, data, datalen);
431 iofd->writebuf.bufpos += datalen;
432 engine->update(iofd);
435 void iohandler_printf(struct IODescriptor *iofd, const char *text, ...) {
437 char sendBuf[LINELEN];
440 va_start(arg_list, text);
441 pos = vsnprintf(sendBuf, LINELEN - 2, text, arg_list);
443 if (pos < 0 || pos > (LINELEN - 2)) pos = LINELEN - 2;
445 sendBuf[pos+1] = '\0';
446 iohandler_send(iofd, sendBuf, pos+1);
449 void iohandler_try_write(struct IODescriptor *iofd) {
450 if(!iofd->writebuf.bufpos) return;
451 iohandler_log(IOLOG_DEBUG, "write writebuf (%d bytes) to socket (fd: %d)", iofd->writebuf.bufpos, iofd->fd);
452 int res = send(iofd->fd, iofd->writebuf.buffer, iofd->writebuf.bufpos, 0);
454 if (errno != EAGAIN) {
455 iohandler_log(IOLOG_ERROR, "could not write to socket (fd: %d): %d - %s", iofd->fd, errno, strerror(errno));
458 iofd->writebuf.bufpos -= res;
459 if(iofd->state != IO_CLOSED)
460 engine->update(iofd);
464 void iohandler_close(struct IODescriptor *iofd) {
465 int engine_remove = 1;
466 iofd->state = IO_CLOSED;
467 if(iofd->writebuf.bufpos) {
468 //try to send everything before closing
472 flags = fcntl(iofd->fd, F_GETFL);
473 fcntl(iofd->fd, F_SETFL, flags & ~O_NONBLOCK);
474 flags = fcntl(iofd->fd, F_GETFD);
475 fcntl(iofd->fd, F_SETFD, flags|FD_CLOEXEC);
479 engine->remove(iofd);
481 iohandler_try_write(iofd);
484 if(iofd->type == IOTYPE_SERVER || iofd->type == IOTYPE_CLIENT || iofd->type == IOTYPE_STDIN)
486 iohandler_remove(iofd, engine_remove);
489 void iohandler_update(struct IODescriptor *iofd) {
490 iohandler_log(IOLOG_DEBUG, "external call to iohandler_update (fd: %d)", iofd->fd);
491 engine->update(iofd);
494 static void iohandler_trigger_event(struct IOEvent *event) {
495 if(!event->iofd->callback) return;
496 iohandler_log(IOLOG_DEBUG, "triggering event (%s) for %s (fd: %d)", iohandler_ioeventtype_name(event->type), iohandler_iotype_name(event->iofd->type), event->iofd->fd);
497 event->iofd->callback(event);
500 void iohandler_events(struct IODescriptor *iofd, int readable, int writeable) {
501 struct IOEvent callback_event;
502 callback_event.type = IOEVENT_IGNORE;
503 callback_event.iofd = iofd;
504 switch(iofd->state) {
506 if(iofd->type == IOTYPE_TIMER)
507 callback_event.type = IOEVENT_TIMEOUT;
511 callback_event.data.accept_fd = accept(iofd->fd, NULL, 0);
512 if(callback_event.data.accept_fd < 0) {
513 iohandler_log(IOLOG_ERROR, "could not accept client (server fd: %d): %d - %s", iofd->fd, errno, strerror(errno));
515 callback_event.type = IOEVENT_ACCEPT;
519 if(readable) { //could not connect
520 callback_event.type = IOEVENT_NOTCONNECTED;
522 arglen = sizeof(callback_event.data.errid);
523 if (getsockopt(iofd->fd, SOL_SOCKET, SO_ERROR, &callback_event.data.errid, &arglen) < 0)
524 callback_event.data.errid = errno;
525 iofd->state = IO_CLOSED;
526 engine->update(iofd);
527 } else if(writeable) {
528 callback_event.type = IOEVENT_CONNECTED;
529 iofd->state = IO_CONNECTED;
530 engine->update(iofd);
535 if(iofd->read_lines) {
536 int bytes = recv(iofd->fd, iofd->readbuf.buffer + iofd->readbuf.bufpos, iofd->readbuf.buflen - iofd->readbuf.bufpos, 0);
538 if (errno != EAGAIN) {
539 iofd->state = IO_CLOSED;
540 engine->update(iofd);
541 callback_event.type = IOEVENT_CLOSED;
542 callback_event.data.errid = errno;
545 int i, used_bytes = 0;
546 iohandler_log(IOLOG_DEBUG, "received %d bytes (fd: %d). readbuf position: %d", bytes, iofd->fd, iofd->readbuf.bufpos);
547 iofd->readbuf.bufpos += bytes;
548 callback_event.type = IOEVENT_RECV;
549 for(i = 0; i < iofd->readbuf.bufpos; i++) {
550 if(iofd->readbuf.buffer[i] == '\r' && iofd->readbuf.buffer[i+1] == '\n')
551 iofd->readbuf.buffer[i] = 0;
552 else if(iofd->readbuf.buffer[i] == '\n' || iofd->readbuf.buffer[i] == '\r') {
553 iofd->readbuf.buffer[i] = 0;
554 callback_event.data.recv_str = iofd->readbuf.buffer + used_bytes;
555 iohandler_log(IOLOG_DEBUG, "parsed line (%d bytes): %s", i - used_bytes, iofd->readbuf.buffer + used_bytes);
557 iohandler_trigger_event(&callback_event);
558 } else if(i + 1 - used_bytes >= LINELEN) { //512 max
559 iofd->readbuf.buffer[i] = 0;
560 callback_event.data.recv_str = iofd->readbuf.buffer + used_bytes;
561 iohandler_log(IOLOG_DEBUG, "parsed and stripped line (%d bytes): %s", i - used_bytes, iofd->readbuf.buffer + used_bytes);
562 for(; i < iofd->readbuf.bufpos; i++) { //skip the rest of the line
563 if(iofd->readbuf.buffer[i] == '\n' || (iofd->readbuf.buffer[i] == '\r' && iofd->readbuf.buffer[i+1] != '\n')) {
568 iohandler_trigger_event(&callback_event);
572 if(used_bytes == iofd->readbuf.bufpos) {
573 iofd->readbuf.bufpos = 0;
574 iohandler_log(IOLOG_DEBUG, "readbuf fully processed (set buffer position to 0)");
576 iohandler_log(IOLOG_DEBUG, "readbuf rest: %d bytes (used %d bytes)", iofd->readbuf.bufpos - used_bytes, used_bytes);
577 memmove(iofd->readbuf.buffer, iofd->readbuf.buffer + used_bytes, iofd->readbuf.bufpos - used_bytes);
578 iofd->readbuf.bufpos -= used_bytes;
581 callback_event.type = IOEVENT_IGNORE;
584 callback_event.type = IOEVENT_READABLE;
587 iohandler_try_write(iofd);
591 if(callback_event.type == IOEVENT_IGNORE && !readable && !writeable)
592 callback_event.type = IOEVENT_TIMEOUT;
593 if(callback_event.type != IOEVENT_IGNORE)
594 iohandler_trigger_event(&callback_event);
597 void iohandler_poll() {
599 struct timeval timeout;
600 timeout.tv_sec = IO_MAX_TIMEOUT;
602 engine->loop(&timeout);
606 //debugging functions
607 char *iohandler_iotype_name(enum IOType type) {
610 return "IOTYPE_UNKNOWN";
612 return "IOTYPE_SERVER";
614 return "IOTYPE_CLIENT";
616 return "IOTYPE_STDIN";
618 return "IOTYPE_TIMER";
620 return "(UNDEFINED)";
624 char *iohandler_iostatus_name(enum IOStatus status) {
629 return "IO_LISTENING";
631 return "IO_CONNECTING";
633 return "IO_CONNECTED";
635 return "(UNDEFINED)";
639 char *iohandler_ioeventtype_name(enum IOEventType type) {
642 return "IOEVENT_IGNORE";
643 case IOEVENT_READABLE:
644 return "IOEVENT_READABLE";
646 return "IOEVENT_RECV";
647 case IOEVENT_CONNECTED:
648 return "IOEVENT_CONNECTED";
649 case IOEVENT_NOTCONNECTED:
650 return "IOEVENT_NOTCONNECTED";
652 return "IOEVENT_CLOSED";
654 return "IOEVENT_ACCEPT";
655 case IOEVENT_TIMEOUT:
656 return "IOEVENT_TIMEOUT";
658 return "(UNDEFINED)";