lib/tevent/tevent_internal.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    generalised event loop handling
   5
   6    INTERNAL STRUCTS. THERE ARE NO API GUARANTEES.
   7    External users should only ever have to include this header when
   8    implementing new tevent backends.
   9
  10    Copyright (C) Stefan Metzmacher 2005-2009
  11
  12      ** NOTE! The following LGPL license applies to the tevent
  13      ** library. This does NOT imply that all of Samba is released
  14      ** under the LGPL
  15
  16    This library is free software; you can redistribute it and/or
  17    modify it under the terms of the GNU Lesser General Public
  18    License as published by the Free Software Foundation; either
  19    version 3 of the License, or (at your option) any later version.
  20
  21    This library is distributed in the hope that it will be useful,
  22    but WITHOUT ANY WARRANTY; without even the implied warranty of
  23    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24    Lesser General Public License for more details.
  25
  26    You should have received a copy of the GNU Lesser General Public
  27    License along with this library; if not, see <http://www.gnu.org/licenses/>.
  28 */
  29
  30 struct tevent_req {
  31         /**
  32          * @brief What to do on completion
  33          *
  34          * This is used for the user of an async request, fn is called when
  35          * the request completes, either successfully or with an error.
  36          */
  37         struct {
  38                 /**
  39                  * @brief Completion function
  40                  * Completion function, to be filled by the API user
  41                  */
  42                 tevent_req_fn fn;
  43                 /**
  44                  * @brief Private data for the completion function
  45                  */
  46                 void *private_data;
  47         } async;
  48
  49         /**
  50          * @brief Private state pointer for the actual implementation
  51          *
  52          * The implementation doing the work for the async request needs to
  53          * keep around current data like for example a fd event. The user of
  54          * an async request should not touch this.
  55          */
  56         void *data;
  57
  58         /**
  59          * @brief A function to overwrite the default print function
  60          *
  61          * The implementation doing the work may want to implement a
  62          * custom function to print the text representation of the async
  63          * request.
  64          */
  65         tevent_req_print_fn private_print;
  66
  67         /**
  68          * @brief A function to cancel the request
  69          *
  70          * The implementation might want to set a function
  71          * that is called when the tevent_req_cancel() function
  72          * was called.
  73          */
  74         tevent_req_cancel_fn private_cancel;
  75
  76         /**
  77          * @brief A function to cleanup the request
  78          *
  79          * The implementation might want to set a function
  80          * that is called before the tevent_req_done() and tevent_req_error()
  81          * trigger the callers callback function.
  82          */
  83         struct {
  84                 tevent_req_cleanup_fn fn;
  85                 enum tevent_req_state state;
  86         } private_cleanup;
  87
  88         /**
  89          * @brief Internal state of the request
  90          *
  91          * Callers should only access this via functions and never directly.
  92          */
  93         struct {
  94                 /**
  95                  * @brief The talloc type of the data pointer
  96                  *
  97                  * This is filled by the tevent_req_create() macro.
  98                  *
  99                  * This for debugging only.
 100                  */
 101                 const char *private_type;
 102
 103                 /**
 104                  * @brief The location where the request was created
 105                  *
 106                  * This uses the __location__ macro via the tevent_req_create()
 107                  * macro.
 108                  *
 109                  * This for debugging only.
 110                  */
 111                 const char *create_location;
 112
 113                 /**
 114                  * @brief The location where the request was finished
 115                  *
 116                  * This uses the __location__ macro via the tevent_req_done(),
 117                  * tevent_req_error() or tevent_req_nomem() macro.
 118                  *
 119                  * This for debugging only.
 120                  */
 121                 const char *finish_location;
 122
 123                 /**
 124                  * @brief The location where the request was canceled
 125                  *
 126                  * This uses the __location__ macro via the
 127                  * tevent_req_cancel() macro.
 128                  *
 129                  * This for debugging only.
 130                  */
 131                 const char *cancel_location;
 132
 133                 /**
 134                  * @brief The external state - will be queried by the caller
 135                  *
 136                  * While the async request is being processed, state will remain in
 137                  * TEVENT_REQ_IN_PROGRESS. A request is finished if
 138                  * req->state>=TEVENT_REQ_DONE.
 139                  */
 140                 enum tevent_req_state state;
 141
 142                 /**
 143                  * @brief status code when finished
 144                  *
 145                  * This status can be queried in the async completion function. It
 146                  * will be set to 0 when everything went fine.
 147                  */
 148                 uint64_t error;
 149
 150                 /**
 151                  * @brief the immediate event used by tevent_req_post
 152                  *
 153                  */
 154                 struct tevent_immediate *trigger;
 155
 156                 /**
 157                  * @brief An event context which will be used to
 158                  *        defer the _tevent_req_notify_callback().
 159                  */
 160                 struct tevent_context *defer_callback_ev;
 161
 162                 /**
 163                  * @brief the timer event if tevent_req_set_endtime was used
 164                  *
 165                  */
 166                 struct tevent_timer *timer;
 167         } internal;
 168 };
 169
 170 struct tevent_fd {
 171         struct tevent_fd *prev, *next;
 172         struct tevent_context *event_ctx;
 173         bool busy;
 174         bool destroyed;
 175         int fd;
 176         uint16_t flags; /* see TEVENT_FD_* flags */
 177         tevent_fd_handler_t handler;
 178         tevent_fd_close_fn_t close_fn;
 179         /* this is private for the specific handler */
 180         void *private_data;
 181         /* this is for debugging only! */
 182         const char *handler_name;
 183         const char *location;
 184         /* this is private for the events_ops implementation */
 185         uint64_t additional_flags;
 186         void *additional_data;
 187 };
 188
 189 struct tevent_timer {
 190         struct tevent_timer *prev, *next;
 191         struct tevent_context *event_ctx;
 192         bool busy;
 193         bool destroyed;
 194         struct timeval next_event;
 195         tevent_timer_handler_t handler;
 196         /* this is private for the specific handler */
 197         void *private_data;
 198         /* this is for debugging only! */
 199         const char *handler_name;
 200         const char *location;
 201         /* this is private for the events_ops implementation */
 202         void *additional_data;
 203 };
 204
 205 struct tevent_immediate {
 206         struct tevent_immediate *prev, *next;
 207         struct tevent_context *event_ctx;
 208         bool busy;
 209         bool destroyed;
 210         tevent_immediate_handler_t handler;
 211         /* this is private for the specific handler */
 212         void *private_data;
 213         /* this is for debugging only! */
 214         const char *handler_name;
 215         const char *create_location;
 216         const char *schedule_location;
 217         /* this is private for the events_ops implementation */
 218         void (*cancel_fn)(struct tevent_immediate *im);
 219         void *additional_data;
 220 };
 221
 222 struct tevent_signal {
 223         struct tevent_signal *prev, *next;
 224         struct tevent_context *event_ctx;
 225         bool busy;
 226         bool destroyed;
 227         int signum;
 228         int sa_flags;
 229         tevent_signal_handler_t handler;
 230         /* this is private for the specific handler */
 231         void *private_data;
 232         /* this is for debugging only! */
 233         const char *handler_name;
 234         const char *location;
 235         /* this is private for the events_ops implementation */
 236         void *additional_data;
 237 };
 238
 239 struct tevent_threaded_context {
 240         struct tevent_threaded_context *next, *prev;
 241
 242 #ifdef HAVE_PTHREAD
 243         pthread_mutex_t event_ctx_mutex;
 244 #endif
 245         struct tevent_context *event_ctx;
 246 };
 247
 248 struct tevent_debug_ops {
 249         void (*debug)(void *context, enum tevent_debug_level level,
 250                       const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
 251         void *context;
 252 };
 253
 254 void tevent_debug(struct tevent_context *ev, enum tevent_debug_level level,
 255                   const char *fmt, ...) PRINTF_ATTRIBUTE(3,4);
 256
 257 void tevent_abort(struct tevent_context *ev, const char *reason);
 258
 259 void tevent_common_check_double_free(TALLOC_CTX *ptr, const char *reason);
 260
 261 struct tevent_context {
 262         /* the specific events implementation */
 263         const struct tevent_ops *ops;
 264
 265         /*
 266          * The following three pointers are queried on every loop_once
 267          * in the order in which they appear here. Not measured, but
 268          * hopefully putting them at the top together with "ops"
 269          * should make tevent a *bit* more cache-friendly than before.
 270          */
 271
 272         /* list of signal events - used by common code */
 273         struct tevent_signal *signal_events;
 274
 275         /* List of threaded job indicators */
 276         struct tevent_threaded_context *threaded_contexts;
 277
 278         /* list of immediate events - used by common code */
 279         struct tevent_immediate *immediate_events;
 280
 281         /* list of fd events - used by common code */
 282         struct tevent_fd *fd_events;
 283
 284         /* list of timed events - used by common code */
 285         struct tevent_timer *timer_events;
 286
 287         /* List of scheduled immediates */
 288         pthread_mutex_t scheduled_mutex;
 289         struct tevent_immediate *scheduled_immediates;
 290
 291         /* this is private for the events_ops implementation */
 292         void *additional_data;
 293
 294         /* pipe hack used with signal handlers */
 295         struct tevent_fd *wakeup_fde;
 296         int wakeup_fd;          /* fd to write into */
 297 #ifndef HAVE_EVENT_FD
 298         int wakeup_read_fd;
 299 #endif
 300
 301         /* debugging operations */
 302         struct tevent_debug_ops debug_ops;
 303
 304         /* info about the nesting status */
 305         struct {
 306                 bool allowed;
 307                 uint32_t level;
 308                 tevent_nesting_hook hook_fn;
 309                 void *hook_private;
 310         } nesting;
 311
 312         struct {
 313                 tevent_trace_callback_t callback;
 314                 void *private_data;
 315         } tracing;
 316
 317         /*
 318          * an optimization pointer into timer_events
 319          * used by used by common code via
 320          * tevent_common_add_timer_v2()
 321          */
 322         struct tevent_timer *last_zero_timer;
 323
 324 #ifdef HAVE_PTHREAD
 325         struct tevent_context *prev, *next;
 326 #endif
 327 };
 328
 329 const struct tevent_ops *tevent_find_ops_byname(const char *name);
 330
 331 int tevent_common_context_destructor(struct tevent_context *ev);
 332 int tevent_common_loop_wait(struct tevent_context *ev,
 333                             const char *location);
 334
 335 int tevent_common_fd_destructor(struct tevent_fd *fde);
 336 struct tevent_fd *tevent_common_add_fd(struct tevent_context *ev,
 337                                        TALLOC_CTX *mem_ctx,
 338                                        int fd,
 339                                        uint16_t flags,
 340                                        tevent_fd_handler_t handler,
 341                                        void *private_data,
 342                                        const char *handler_name,
 343                                        const char *location);
 344 void tevent_common_fd_set_close_fn(struct tevent_fd *fde,
 345                                    tevent_fd_close_fn_t close_fn);
 346 uint16_t tevent_common_fd_get_flags(struct tevent_fd *fde);
 347 void tevent_common_fd_set_flags(struct tevent_fd *fde, uint16_t flags);
 348 int tevent_common_invoke_fd_handler(struct tevent_fd *fde, uint16_t flags,
 349                                     bool *removed);
 350
 351 struct tevent_timer *tevent_common_add_timer(struct tevent_context *ev,
 352                                              TALLOC_CTX *mem_ctx,
 353                                              struct timeval next_event,
 354                                              tevent_timer_handler_t handler,
 355                                              void *private_data,
 356                                              const char *handler_name,
 357                                              const char *location);
 358 struct tevent_timer *tevent_common_add_timer_v2(struct tevent_context *ev,
 359                                                 TALLOC_CTX *mem_ctx,
 360                                                 struct timeval next_event,
 361                                                 tevent_timer_handler_t handler,
 362                                                 void *private_data,
 363                                                 const char *handler_name,
 364                                                 const char *location);
 365 struct timeval tevent_common_loop_timer_delay(struct tevent_context *);
 366 int tevent_common_invoke_timer_handler(struct tevent_timer *te,
 367                                        struct timeval current_time,
 368                                        bool *removed);
 369
 370 void tevent_common_schedule_immediate(struct tevent_immediate *im,
 371                                       struct tevent_context *ev,
 372                                       tevent_immediate_handler_t handler,
 373                                       void *private_data,
 374                                       const char *handler_name,
 375                                       const char *location);
 376 int tevent_common_invoke_immediate_handler(struct tevent_immediate *im,
 377                                            bool *removed);
 378 bool tevent_common_loop_immediate(struct tevent_context *ev);
 379 void tevent_common_threaded_activate_immediate(struct tevent_context *ev);
 380
 381 bool tevent_common_have_events(struct tevent_context *ev);
 382 int tevent_common_wakeup_init(struct tevent_context *ev);
 383 int tevent_common_wakeup_fd(int fd);
 384 int tevent_common_wakeup(struct tevent_context *ev);
 385
 386 struct tevent_signal *tevent_common_add_signal(struct tevent_context *ev,
 387                                                TALLOC_CTX *mem_ctx,
 388                                                int signum,
 389                                                int sa_flags,
 390                                                tevent_signal_handler_t handler,
 391                                                void *private_data,
 392                                                const char *handler_name,
 393                                                const char *location);
 394 int tevent_common_check_signal(struct tevent_context *ev);
 395 void tevent_cleanup_pending_signal_handlers(struct tevent_signal *se);
 396 int tevent_common_invoke_signal_handler(struct tevent_signal *se,
 397                                         int signum, int count, void *siginfo,
 398                                         bool *removed);
 399
 400 bool tevent_standard_init(void);
 401 bool tevent_poll_init(void);
 402 void tevent_poll_event_add_fd_internal(struct tevent_context *ev,
 403                                        struct tevent_fd *fde);
 404 bool tevent_poll_mt_init(void);
 405 #ifdef HAVE_EPOLL
 406 bool tevent_epoll_init(void);
 407 void tevent_epoll_set_panic_fallback(struct tevent_context *ev,
 408                         bool (*panic_fallback)(struct tevent_context *ev,
 409                                                bool replay));
 410 #endif
 411 #ifdef HAVE_SOLARIS_PORTS
 412 bool tevent_port_init(void);
 413 #endif
 414
 415
 416 void tevent_trace_point_callback(struct tevent_context *ev,
 417                                  enum tevent_trace_point);