lib-sys/evtloop.c

   1 /*
   2  *  This program is free software; you can redistribute it and/or modify
   3  *  it under the terms of the GNU General Public License as published by
   4  *  the Free Software Foundation; either version 2 of the License, or (at
   5  *  your option) any later version.
   6  *
   7  *  This program is distributed in the hope that it will be useful, but
   8  *  WITHOUT ANY WARRANTY; without even the implied warranty of
   9  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10  *  General Public License for more details.
  11  *
  12  *  You should have received a copy of the GNU General Public License
  13  *  along with this program; if not, write to the Free Software
  14  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  15  *  MA 02110-1301, USA.
  16  *
  17  *  Copyright © 2006 Pierre Habouzit
  18  */
  19
  20 #include <pthread.h>
  21 #include <sys/epoll.h>
  22 #include <sys/socket.h>
  23 #ifndef EPOLLRDHUP
  24 #  include <linux/poll.h>
  25 #  ifdef POLLRDHUP
  26 #    define EPOLLRDHUP POLLRDHUP
  27 #  else
  28 #    define EPOLLRDHUP 0
  29 #  endif
  30 #endif
  31 #include "evtloop.h"
  32 #include "mutt.h"
  33 #include "mutt_ssl.li"
  34
  35 DO_ARRAY_TYPE(job_t, job);
  36
  37 static int epollfd = -1;
  38 static job_array jobs;
  39
  40 static int el_job_setemode(job_t *w, el_mode emode)
  41 {
  42     static int const evtmode_to_epoll[] = {
  43         [EL_NEW]     = EPOLLRDHUP,
  44         [EL_READING] = EPOLLIN,
  45         [EL_WRITING] = EPOLLOUT,
  46         [EL_RDWR]    = EPOLLIN | EPOLLOUT,
  47         [EL_IDLE]    = EPOLLRDHUP,
  48     };
  49
  50     assert (w->mode == emode || emode == EL_WRITING || emode == EL_READING);
  51
  52     if (emode != w->emode) {
  53         struct epoll_event event = {
  54             .data.ptr = w,
  55             .events   = evtmode_to_epoll[emode],
  56         };
  57         int action = w->emode == EL_NEW ? EPOLL_CTL_ADD : EPOLL_CTL_MOD;
  58         if (epoll_ctl(epollfd, action, w->fd, &event) < 0) {
  59             return el_job_release(w, true);
  60         }
  61     }
  62     w->emode = emode;
  63     return 0;
  64 }
  65
  66 int el_job_setmode(job_t *w, el_mode mode)
  67 {
  68     if (w->mode == w->emode) {
  69         w->mode = mode;
  70         return el_job_setemode(w, mode);
  71     } else {
  72         w->mode = mode;
  73         return 0;
  74     }
  75 }
  76
  77 void job_wipe(job_t *w)
  78 {
  79     if (w->xcred)
  80         gnutls_certificate_free_credentials(w->xcred);
  81     if (w->session)
  82         gnutls_deinit(w->session);
  83 }
  84
  85 static void job_arrau_dtor(job_t **j)
  86 {
  87     if (*j)
  88         IGNORE(el_job_release(*j, EL_KILLED));
  89 }
  90
  91 DO_ARRAY_FUNCS(job_t, job, job_arrau_dtor);
  92
  93 static void job_array_remove(job_array *arr, job_t *j)
  94 {
  95     for (int i = 0; i < arr->len; i++) {
  96         if (arr->arr[i] == j) {
  97             job_array_take(arr, i);
  98             break;
  99         }
 100     }
 101 }
 102
 103 job_t *el_job_start(const machine_t *m, void *cfg)
 104 {
 105     job_t *w = job_new();
 106     w->m = m;
 107     job_array_append(&jobs, w);
 108     return m->setup(w, cfg) < 0 ? NULL : w;
 109 }
 110
 111 int el_job_release(job_t *w, el_status reason)
 112 {
 113     w->state = EL_LLP_FINI;
 114     if (w->m && w->m->finalize) {
 115         w->m->finalize(w, reason);
 116     }
 117     if (w->fd >= 0) {
 118         if (w->session)
 119             gnutls_bye(w->session, GNUTLS_SHUT_RDWR);
 120         close(w->fd);
 121     }
 122     job_array_remove(&jobs, w);
 123     job_delete(&w);
 124     return -1;
 125 }
 126
 127 static int el_job_tlsing(job_t *w, int starttls)
 128 {
 129     int err = gnutls_handshake(w->session);
 130     if (err < 0 && !gnutls_error_is_fatal(err)) {
 131         int wr = gnutls_record_get_direction(w->session);
 132         return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 133     }
 134     if (err < 0)
 135         return el_job_release(w, EL_RDHUP);
 136
 137 #if 0
 138     if (!tls_check_certificate (conn))
 139         return -1;
 140 #endif
 141
 142     /* set Security Strength Factor (SSF) for SASL */
 143     /* NB: gnutls_cipher_get_key_size() returns key length in bytes */
 144     w->ssf   = gnutls_cipher_get_key_size(gnutls_cipher_get(w->session)) * 8;
 145     w->state = EL_LLP_READY;
 146     if (starttls)
 147         return el_job_setemode(w, w->mode);
 148     return w->m->on_event(w, EL_EVT_RUNNING);
 149 }
 150
 151 static int el_job_starttlsing(job_t *w)
 152 {
 153     return el_job_tlsing(w, true);
 154 }
 155
 156 static int el_job_connecting_ssl(job_t *w)
 157 {
 158     return el_job_tlsing(w, false);
 159 }
 160
 161 static int el_job_connecting(job_t *w)
 162 {
 163     int err = 0;
 164     socklen_t len = sizeof(err);
 165
 166     if (getsockopt(w->fd, SOL_SOCKET, SO_ERROR, (void *)&err, &len) || err)
 167         return el_job_release(w, EL_ERROR);
 168
 169     if (w->session) {
 170         w->llp = &el_job_connecting_ssl;
 171         return w->llp(w);
 172     }
 173     w->state = EL_LLP_READY;
 174     return w->m->on_event(w, EL_EVT_RUNNING);
 175 }
 176
 177 static int tls_negotiate(job_t *w)
 178 {
 179     static int protocol_priority[] = { GNUTLS_TLS1, GNUTLS_SSL3, 0 };
 180
 181     if (gnutls_certificate_allocate_credentials(&w->xcred) < 0)
 182         return -1;
 183
 184     /* ignore errors, maybe file doesn't exist yet */
 185     gnutls_certificate_set_x509_trust_file(w->xcred, mod_ssl.cert_file,
 186                                            GNUTLS_X509_FMT_PEM);
 187
 188     if (mod_ssl.ca_certificates_file) {
 189         gnutls_certificate_set_x509_trust_file(w->xcred,
 190             mod_ssl.ca_certificates_file, GNUTLS_X509_FMT_PEM);
 191     }
 192     gnutls_init(&w->session, GNUTLS_CLIENT);
 193
 194     /* set socket */
 195     gnutls_transport_set_ptr(w->session, (gnutls_transport_ptr)(intptr_t)w->fd);
 196
 197     /* disable TLS/SSL protocols as needed */
 198     if (!mod_ssl.use_sslv3) {
 199         protocol_priority[1] = 0;
 200     }
 201
 202     /* We use default priorities (see gnutls documentation),
 203        except for protocol version */
 204     gnutls_set_default_priority(w->session);
 205     gnutls_protocol_set_priority(w->session, protocol_priority);
 206     gnutls_credentials_set(w->session, GNUTLS_CRD_CERTIFICATE, w->xcred);
 207     return 0;
 208 }
 209
 210 int el_job_connect(job_t *w, struct sockaddr *addr, socklen_t len,
 211                    int type, int proto, int ssl)
 212 {
 213     int res, sock = socket(addr->sa_family, type, proto);
 214
 215     if (sock < 0)
 216         goto error;
 217
 218     res = fcntl(sock, F_GETFL);
 219     if (res < 0)
 220         goto error;
 221     if (fcntl(sock, F_SETFL, res | O_NONBLOCK) < 0)
 222         goto error;
 223     if (connect(sock, addr, len) < 0)
 224         goto error;
 225
 226     w->fd  = sock;
 227     if (ssl && tls_negotiate(w) < 0)
 228         goto error;
 229
 230     w->llp = &el_job_connecting;
 231     return el_job_setmode(w, EL_WRITING);
 232
 233   error:
 234     close(sock);
 235     return el_job_release(w, EL_ERROR);
 236 }
 237
 238 int el_job_starttls(job_t *w)
 239 {
 240     if (tls_negotiate(w) < 0)
 241         return el_job_release(w, EL_RDHUP);
 242     w->state = EL_LLP_INIT;
 243     w->llp   = &el_job_starttlsing;
 244     return w->llp(w);
 245 }
 246
 247 ssize_t el_job_read(job_t *w, buffer_t *buf)
 248 {
 249     ssize_t nr;
 250
 251     buffer_ensure(buf, BUFSIZ);
 252
 253     if (w->session) {
 254         nr = gnutls_record_recv(w->session, buf->data + buf->len, BUFSIZ);
 255         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 256             int wr = gnutls_record_get_direction(w->session);
 257             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 258         }
 259         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 260     } else {
 261         nr = read(w->fd, buf->data + buf->len, BUFSIZ);
 262         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 263             return 0;
 264     }
 265     if (nr <= 0)
 266         return el_job_release(w, EL_RDHUP);
 267     buffer_extend(buf, nr);
 268     return nr;
 269 }
 270
 271 ssize_t el_job_write(job_t *w, buffer_t *buf)
 272 {
 273     ssize_t nr;
 274
 275     if (buf->len == 0)
 276         return 0;
 277
 278     if (w->session) {
 279         nr = gnutls_record_send(w->session, buf->data, buf->len);
 280         if (nr < 0 && !gnutls_error_is_fatal(nr)) {
 281             int wr = gnutls_record_get_direction(w->session);
 282             return el_job_setemode(w, wr ? EL_WRITING : EL_READING);
 283         }
 284         EL_JOB_CHECK(el_job_setemode(w, w->mode));
 285     } else {
 286         nr = write(w->fd, buf->data, buf->len);
 287         if (nr < 0 && (errno == EINTR || errno == EAGAIN))
 288             return 0;
 289     }
 290     if (nr <= 0)
 291         return el_job_release(w, EL_RDHUP);
 292     buffer_splice(buf, 0, nr, NULL, 0);
 293     return nr;
 294 }
 295
 296 int el_dispatch(int timeout)
 297 {
 298     struct epoll_event events[FD_SETSIZE];
 299     int count = epoll_wait(epollfd, events, countof(events), timeout);
 300
 301     if (count < 0) {
 302         if (errno == EAGAIN || errno == EINTR)
 303             return 0;
 304         mutt_error("epoll_wait");
 305         mutt_exit(EXIT_FAILURE);
 306     }
 307
 308     while (--count >= 0) {
 309         job_t *w  = events[count].data.ptr;
 310         int event = events[count].events;
 311         int evt   = 0;
 312
 313         gettimeofday(&w->mru, NULL);
 314         switch (w->state) {
 315           case EL_LLP_INIT:
 316             w->llp(w);
 317             break;
 318
 319           case EL_LLP_READY:
 320             if (event & EPOLLRDHUP) {
 321                 IGNORE(el_job_release(w, EL_RDHUP));
 322             } else if (w->mode != w->emode) {
 323                 IGNORE(w->m->on_event(w, EL_EVT_INOUT ^ w->emode));
 324             } else {
 325                 if (event & EPOLLIN)
 326                     evt |= EL_EVT_IN;
 327                 if (event & EPOLLOUT)
 328                     evt |= EL_EVT_OUT;
 329                 IGNORE(w->m->on_event(w, evt));
 330             }
 331             break;
 332
 333           default:
 334             IGNORE(el_job_release(w, EL_ERROR));
 335             break;
 336         }
 337     }
 338
 339     return 0;
 340 }
 341
 342 void *el_loop(void *data)
 343 {
 344     time_t sec = time(NULL);
 345
 346     for (;;) {
 347         struct timeval now;
 348
 349         el_dispatch(100);
 350         pthread_testcancel();
 351
 352         gettimeofday(&now, NULL);
 353         if (sec >= now.tv_sec)
 354             continue;
 355         sec = now.tv_sec;
 356         now.tv_sec -= 10;
 357         for (int i = jobs.len - 1; i >= 0; --i) {
 358             job_t *w = jobs.arr[i];
 359             if (timercmp(&now, &w->mru, >))
 360                 IGNORE(w->m->on_event(w, EL_EVT_WAKEUP));
 361         }
 362     }
 363 }
 364
 365 void el_initialize(void)
 366 {
 367     gnutls_global_init();
 368     epollfd = epoll_create(1024);
 369     if (epollfd < 0) {
 370         mutt_error("epoll_create");
 371         mutt_exit(EXIT_FAILURE);
 372     }
 373     job_array_init(&jobs);
 374 }
 375
 376 void el_shutdown(void)
 377 {
 378     job_array_wipe(&jobs);
 379     close(epollfd);
 380     gnutls_global_deinit();
 381 }