talloc: use the system pytalloc-util for python3 as well
[sfrench/samba-autobuild/.git] / lib / tevent / tevent_internal.h
index cf54242da1a2b5283e8711447f863d72db2eb24c..a5f1ebdefd53db76c3ba730b7c6b82b7bee0acf4 100644 (file)
@@ -3,7 +3,9 @@
 
    generalised event loop handling
 
-   Internal structs
+   INTERNAL STRUCTS. THERE ARE NO API GUARANTEES.
+   External users should only ever have to include this header when 
+   implementing new tevent backends.
 
    Copyright (C) Stefan Metzmacher 2005-2009
 
@@ -62,6 +64,27 @@ struct tevent_req {
         */
        tevent_req_print_fn private_print;
 
+       /**
+        * @brief A function to cancel the request
+        *
+        * The implementation might want to set a function
+        * that is called when the tevent_req_cancel() function
+        * was called.
+        */
+       tevent_req_cancel_fn private_cancel;
+
+       /**
+        * @brief A function to cleanup the request
+        *
+        * The implementation might want to set a function
+        * that is called before the tevent_req_done() and tevent_req_error()
+        * trigger the callers callback function.
+        */
+       struct {
+               tevent_req_cleanup_fn fn;
+               enum tevent_req_state state;
+       } private_cleanup;
+
        /**
         * @brief Internal state of the request
         *
@@ -85,7 +108,27 @@ struct tevent_req {
                 *
                 * This for debugging only.
                 */
-               const char *location;
+               const char *create_location;
+
+               /**
+                * @brief The location where the request was finished
+                *
+                * This uses the __location__ macro via the tevent_req_done(),
+                * tevent_req_error() or tevent_req_nomem() macro.
+                *
+                * This for debugging only.
+                */
+               const char *finish_location;
+
+               /**
+                * @brief The location where the request was canceled
+                *
+                * This uses the __location__ macro via the
+                * tevent_req_cancel() macro.
+                *
+                * This for debugging only.
+                */
+               const char *cancel_location;
 
                /**
                 * @brief The external state - will be queried by the caller
@@ -105,67 +148,25 @@ struct tevent_req {
                uint64_t error;
 
                /**
-                * @brief the timer event if tevent_req_post was used
+                * @brief the immediate event used by tevent_req_post
                 *
                 */
-               struct tevent_timer *trigger;
+               struct tevent_immediate *trigger;
 
                /**
-                * @brief the timer event if tevent_req_set_timeout was used
+                * @brief An event context which will be used to
+                *        defer the _tevent_req_notify_callback().
+                */
+               struct tevent_context *defer_callback_ev;
+
+               /**
+                * @brief the timer event if tevent_req_set_endtime was used
                 *
                 */
                struct tevent_timer *timer;
        } internal;
 };
 
-struct tevent_ops {
-       /* conntext init */
-       int (*context_init)(struct tevent_context *ev);
-
-       /* fd_event functions */
-       struct tevent_fd *(*add_fd)(struct tevent_context *ev,
-                                   TALLOC_CTX *mem_ctx,
-                                   int fd, uint16_t flags,
-                                   tevent_fd_handler_t handler,
-                                   void *private_data,
-                                   const char *handler_name,
-                                   const char *location);
-       void (*set_fd_close_fn)(struct tevent_fd *fde,
-                               tevent_fd_close_fn_t close_fn);
-       uint16_t (*get_fd_flags)(struct tevent_fd *fde);
-       void (*set_fd_flags)(struct tevent_fd *fde, uint16_t flags);
-
-       /* timed_event functions */
-       struct tevent_timer *(*add_timer)(struct tevent_context *ev,
-                                         TALLOC_CTX *mem_ctx,
-                                         struct timeval next_event,
-                                         tevent_timer_handler_t handler,
-                                         void *private_data,
-                                         const char *handler_name,
-                                         const char *location);
-
-       /* immediate event functions */
-       void (*schedule_immediate)(struct tevent_immediate *im,
-                                  struct tevent_context *ev,
-                                  tevent_immediate_handler_t handler,
-                                  void *private_data,
-                                  const char *handler_name,
-                                  const char *location);
-
-       /* signal functions */
-       struct tevent_signal *(*add_signal)(struct tevent_context *ev,
-                                           TALLOC_CTX *mem_ctx,
-                                           int signum, int sa_flags,
-                                           tevent_signal_handler_t handler,
-                                           void *private_data,
-                                           const char *handler_name,
-                                           const char *location);
-
-       /* loop functions */
-       int (*loop_once)(struct tevent_context *ev, const char *location);
-       int (*loop_wait)(struct tevent_context *ev, const char *location);
-};
-
 struct tevent_fd {
        struct tevent_fd *prev, *next;
        struct tevent_context *event_ctx;
@@ -179,7 +180,7 @@ struct tevent_fd {
        const char *handler_name;
        const char *location;
        /* this is private for the events_ops implementation */
-       uint16_t additional_flags;
+       uint64_t additional_flags;
        void *additional_data;
 };
 
@@ -227,6 +228,16 @@ struct tevent_signal {
        void *additional_data;
 };
 
+struct tevent_threaded_context {
+       struct tevent_threaded_context *next, *prev;
+
+#ifdef HAVE_PTHREAD
+       pthread_mutex_t event_ctx_mutex;
+#endif
+       struct tevent_context *event_ctx;
+       int wakeup_fd;
+};
+
 struct tevent_debug_ops {
        void (*debug)(void *context, enum tevent_debug_level level,
                      const char *fmt, va_list ap) PRINTF_ATTRIBUTE(3,0);
@@ -240,23 +251,41 @@ struct tevent_context {
        /* the specific events implementation */
        const struct tevent_ops *ops;
 
+       /*
+        * The following three pointers are queried on every loop_once
+        * in the order in which they appear here. Not measured, but
+        * hopefully putting them at the top together with "ops"
+        * should make tevent a *bit* more cache-friendly than before.
+        */
+
+       /* list of signal events - used by common code */
+       struct tevent_signal *signal_events;
+
+       /* List of threaded job indicators */
+       struct tevent_threaded_context *threaded_contexts;
+
+       /* list of immediate events - used by common code */
+       struct tevent_immediate *immediate_events;
+
        /* list of fd events - used by common code */
        struct tevent_fd *fd_events;
 
        /* list of timed events - used by common code */
        struct tevent_timer *timer_events;
 
-       /* list of immediate events - used by common code */
-       struct tevent_immediate *immediate_events;
-
-       /* list of signal events - used by common code */
-       struct tevent_signal *signal_events;
+       /* List of scheduled immediates */
+       pthread_mutex_t scheduled_mutex;
+       struct tevent_immediate *scheduled_immediates;
 
        /* this is private for the events_ops implementation */
        void *additional_data;
 
        /* pipe hack used with signal handlers */
-       struct tevent_fd *pipe_fde;
+       struct tevent_fd *wakeup_fde;
+       int wakeup_fd;          /* fd to write into */
+#ifndef HAVE_EVENT_FD
+       int wakeup_read_fd;
+#endif
 
        /* debugging operations */
        struct tevent_debug_ops debug_ops;
@@ -268,10 +297,25 @@ struct tevent_context {
                tevent_nesting_hook hook_fn;
                void *hook_private;
        } nesting;
-};
 
+       struct {
+               tevent_trace_callback_t callback;
+               void *private_data;
+       } tracing;
+
+       /*
+        * an optimization pointer into timer_events
+        * used by used by common code via
+        * tevent_common_add_timer_v2()
+        */
+       struct tevent_timer *last_zero_timer;
+
+#ifdef HAVE_PTHREAD
+       struct tevent_context *prev, *next;
+#endif
+};
 
-bool tevent_register_backend(const char *name, const struct tevent_ops *ops);
+const struct tevent_ops *tevent_find_ops_byname(const char *name);
 
 int tevent_common_context_destructor(struct tevent_context *ev);
 int tevent_common_loop_wait(struct tevent_context *ev,
@@ -298,6 +342,13 @@ struct tevent_timer *tevent_common_add_timer(struct tevent_context *ev,
                                             void *private_data,
                                             const char *handler_name,
                                             const char *location);
+struct tevent_timer *tevent_common_add_timer_v2(struct tevent_context *ev,
+                                               TALLOC_CTX *mem_ctx,
+                                               struct timeval next_event,
+                                               tevent_timer_handler_t handler,
+                                               void *private_data,
+                                               const char *handler_name,
+                                               const char *location);
 struct timeval tevent_common_loop_timer_delay(struct tevent_context *);
 
 void tevent_common_schedule_immediate(struct tevent_immediate *im,
@@ -307,6 +358,12 @@ void tevent_common_schedule_immediate(struct tevent_immediate *im,
                                      const char *handler_name,
                                      const char *location);
 bool tevent_common_loop_immediate(struct tevent_context *ev);
+void tevent_common_threaded_activate_immediate(struct tevent_context *ev);
+
+bool tevent_common_have_events(struct tevent_context *ev);
+int tevent_common_wakeup_init(struct tevent_context *ev);
+int tevent_common_wakeup_fd(int fd);
+int tevent_common_wakeup(struct tevent_context *ev);
 
 struct tevent_signal *tevent_common_add_signal(struct tevent_context *ev,
                                               TALLOC_CTX *mem_ctx,
@@ -317,9 +374,24 @@ struct tevent_signal *tevent_common_add_signal(struct tevent_context *ev,
                                               const char *handler_name,
                                               const char *location);
 int tevent_common_check_signal(struct tevent_context *ev);
+void tevent_cleanup_pending_signal_handlers(struct tevent_signal *se);
 
 bool tevent_standard_init(void);
 bool tevent_select_init(void);
+bool tevent_poll_init(void);
+void tevent_poll_event_add_fd_internal(struct tevent_context *ev,
+                                      struct tevent_fd *fde);
+bool tevent_poll_mt_init(void);
 #ifdef HAVE_EPOLL
 bool tevent_epoll_init(void);
+void tevent_epoll_set_panic_fallback(struct tevent_context *ev,
+                       bool (*panic_fallback)(struct tevent_context *ev,
+                                              bool replay));
 #endif
+#ifdef HAVE_SOLARIS_PORTS
+bool tevent_port_init(void);
+#endif
+
+
+void tevent_trace_point_callback(struct tevent_context *ev,
+                                enum tevent_trace_point);