source3/lib/events.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Timed event library.
   4    Copyright (C) Andrew Tridgell 1992-1998
   5    Copyright (C) Volker Lendecke 2005
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program 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
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "includes.h"
  22 #include <tevent_internal.h>
  23
  24 void event_fd_set_writeable(struct tevent_fd *fde)
  25 {
  26         TEVENT_FD_WRITEABLE(fde);
  27 }
  28
  29 void event_fd_set_not_writeable(struct tevent_fd *fde)
  30 {
  31         TEVENT_FD_NOT_WRITEABLE(fde);
  32 }
  33
  34 void event_fd_set_readable(struct tevent_fd *fde)
  35 {
  36         TEVENT_FD_READABLE(fde);
  37 }
  38
  39 void event_fd_set_not_readable(struct tevent_fd *fde)
  40 {
  41         TEVENT_FD_NOT_READABLE(fde);
  42 }
  43
  44 /*
  45  * Return if there's something in the queue
  46  */
  47
  48 bool event_add_to_select_args(struct tevent_context *ev,
  49                               const struct timeval *now,
  50                               fd_set *read_fds, fd_set *write_fds,
  51                               struct timeval *timeout, int *maxfd)
  52 {
  53         struct tevent_fd *fde;
  54         struct timeval diff;
  55         bool ret = false;
  56
  57         for (fde = ev->fd_events; fde; fde = fde->next) {
  58                 if (fde->flags & EVENT_FD_READ) {
  59                         FD_SET(fde->fd, read_fds);
  60                         ret = true;
  61                 }
  62                 if (fde->flags & EVENT_FD_WRITE) {
  63                         FD_SET(fde->fd, write_fds);
  64                         ret = true;
  65                 }
  66
  67                 if ((fde->flags & (EVENT_FD_READ|EVENT_FD_WRITE))
  68                     && (fde->fd > *maxfd)) {
  69                         *maxfd = fde->fd;
  70                 }
  71         }
  72
  73         if (ev->timer_events == NULL) {
  74                 return ret;
  75         }
  76
  77         diff = timeval_until(now, &ev->timer_events->next_event);
  78         *timeout = timeval_min(timeout, &diff);
  79
  80         return true;
  81 }
  82
  83 bool run_events(struct tevent_context *ev,
  84                 int selrtn, fd_set *read_fds, fd_set *write_fds)
  85 {
  86         struct tevent_fd *fde;
  87         struct timeval now;
  88
  89         if (ev->signal_events &&
  90             tevent_common_check_signal(ev)) {
  91                 return true;
  92         }
  93
  94         if (ev->immediate_events &&
  95             tevent_common_loop_immediate(ev)) {
  96                 return true;
  97         }
  98
  99         GetTimeOfDay(&now);
 100
 101         if ((ev->timer_events != NULL)
 102             && (timeval_compare(&now, &ev->timer_events->next_event) >= 0)) {
 103
 104                 DEBUG(10, ("Running timed event \"%s\" %p\n",
 105                            ev->timer_events->handler_name, ev->timer_events));
 106
 107                 ev->timer_events->handler(ev, ev->timer_events, now,
 108                                           ev->timer_events->private_data);
 109                 return true;
 110         }
 111
 112         if (selrtn == 0) {
 113                 /*
 114                  * No fd ready
 115                  */
 116                 return false;
 117         }
 118
 119         for (fde = ev->fd_events; fde; fde = fde->next) {
 120                 uint16 flags = 0;
 121
 122                 if (FD_ISSET(fde->fd, read_fds)) flags |= EVENT_FD_READ;
 123                 if (FD_ISSET(fde->fd, write_fds)) flags |= EVENT_FD_WRITE;
 124
 125                 if (flags & fde->flags) {
 126                         fde->handler(ev, fde, flags, fde->private_data);
 127                         return true;
 128                 }
 129         }
 130
 131         return false;
 132 }
 133
 134
 135 struct timeval *get_timed_events_timeout(struct tevent_context *ev,
 136                                          struct timeval *to_ret)
 137 {
 138         struct timeval now;
 139
 140         if (ev->timer_events == NULL) {
 141                 return NULL;
 142         }
 143
 144         now = timeval_current();
 145         *to_ret = timeval_until(&now, &ev->timer_events->next_event);
 146
 147         DEBUG(10, ("timed_events_timeout: %d/%d\n", (int)to_ret->tv_sec,
 148                 (int)to_ret->tv_usec));
 149
 150         return to_ret;
 151 }
 152
 153 static int s3_event_loop_once(struct tevent_context *ev, const char *location)
 154 {
 155         struct timeval now, to;
 156         fd_set r_fds, w_fds;
 157         int maxfd = 0;
 158         int ret;
 159
 160         FD_ZERO(&r_fds);
 161         FD_ZERO(&w_fds);
 162
 163         to.tv_sec = 9999;       /* Max timeout */
 164         to.tv_usec = 0;
 165
 166         if (run_events(ev, 0, NULL, NULL)) {
 167                 return 0;
 168         }
 169
 170         GetTimeOfDay(&now);
 171
 172         if (!event_add_to_select_args(ev, &now, &r_fds, &w_fds, &to, &maxfd)) {
 173                 return -1;
 174         }
 175
 176         ret = sys_select(maxfd+1, &r_fds, &w_fds, NULL, &to);
 177
 178         if (ret == -1 && errno != EINTR) {
 179                 tevent_debug(ev, TEVENT_DEBUG_FATAL,
 180                              "sys_select() failed: %d:%s\n",
 181                              errno, strerror(errno));
 182                 return -1;
 183         }
 184
 185         run_events(ev, ret, &r_fds, &w_fds);
 186         return 0;
 187 }
 188
 189 void event_context_reinit(struct tevent_context *ev)
 190 {
 191         tevent_common_context_destructor(ev);
 192         return;
 193 }
 194
 195 static int s3_event_context_init(struct tevent_context *ev)
 196 {
 197         return 0;
 198 }
 199
 200 void dump_event_list(struct tevent_context *ev)
 201 {
 202         struct tevent_timer *te;
 203         struct tevent_fd *fe;
 204         struct timeval evt, now;
 205
 206         if (!ev) {
 207                 return;
 208         }
 209
 210         now = timeval_current();
 211
 212         DEBUG(10,("dump_event_list:\n"));
 213
 214         for (te = ev->timer_events; te; te = te->next) {
 215
 216                 evt = timeval_until(&now, &te->next_event);
 217
 218                 DEBUGADD(10,("Timed Event \"%s\" %p handled in %d seconds (at %s)\n",
 219                            te->handler_name,
 220                            te,
 221                            (int)evt.tv_sec,
 222                            http_timestring(talloc_tos(), te->next_event.tv_sec)));
 223         }
 224
 225         for (fe = ev->fd_events; fe; fe = fe->next) {
 226
 227                 DEBUGADD(10,("FD Event %d %p, flags: 0x%04x\n",
 228                            fe->fd,
 229                            fe,
 230                            fe->flags));
 231         }
 232 }
 233
 234 static const struct tevent_ops s3_event_ops = {
 235         .context_init           = s3_event_context_init,
 236         .add_fd                 = tevent_common_add_fd,
 237         .set_fd_close_fn        = tevent_common_fd_set_close_fn,
 238         .get_fd_flags           = tevent_common_fd_get_flags,
 239         .set_fd_flags           = tevent_common_fd_set_flags,
 240         .add_timer              = tevent_common_add_timer,
 241         .schedule_immediate     = tevent_common_schedule_immediate,
 242         .add_signal             = tevent_common_add_signal,
 243         .loop_once              = s3_event_loop_once,
 244         .loop_wait              = tevent_common_loop_wait,
 245 };
 246
 247 static bool s3_tevent_init(void)
 248 {
 249         static bool initialized;
 250         if (initialized) {
 251                 return true;
 252         }
 253         initialized = tevent_register_backend("s3", &s3_event_ops);
 254         tevent_set_default_backend("s3");
 255         return initialized;
 256 }
 257
 258 /*
 259   this is used to catch debug messages from events
 260 */
 261 static void s3_event_debug(void *context, enum tevent_debug_level level,
 262                            const char *fmt, va_list ap)  PRINTF_ATTRIBUTE(3,0);
 263
 264 static void s3_event_debug(void *context, enum tevent_debug_level level,
 265                            const char *fmt, va_list ap)
 266 {
 267         int samba_level = -1;
 268         char *s = NULL;
 269         switch (level) {
 270         case TEVENT_DEBUG_FATAL:
 271                 samba_level = 0;
 272                 break;
 273         case TEVENT_DEBUG_ERROR:
 274                 samba_level = 1;
 275                 break;
 276         case TEVENT_DEBUG_WARNING:
 277                 samba_level = 2;
 278                 break;
 279         case TEVENT_DEBUG_TRACE:
 280                 samba_level = 10;
 281                 break;
 282
 283         };
 284         if (vasprintf(&s, fmt, ap) == -1) {
 285                 return;
 286         }
 287         DEBUG(samba_level, ("s3_event: %s", s));
 288         free(s);
 289 }
 290
 291 struct tevent_context *s3_tevent_context_init(TALLOC_CTX *mem_ctx)
 292 {
 293         struct tevent_context *ev;
 294
 295         s3_tevent_init();
 296
 297         ev = tevent_context_init_byname(mem_ctx, "s3");
 298         if (ev) {
 299                 tevent_set_debug(ev, s3_event_debug, NULL);
 300         }
 301
 302         return ev;
 303 }
 304