Unix SMB/CIFS implementation.
Infrastructure for async requests
Copyright (C) Volker Lendecke 2008
+ Copyright (C) Stefan Metzmacher 2009
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License, or
- (at your option) any later version.
+ ** NOTE! The following LGPL license applies to the tevent
+ ** library. This does NOT imply that all of Samba is released
+ ** under the LGPL
- This program is distributed in the hope that it will be useful,
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 3 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
+ You should have received a copy of the GNU Lesser General Public
+ License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
-#include "includes.h"
-#include "lib/tevent/tevent.h"
-#include "lib/talloc/talloc.h"
-#include "lib/util/dlinklist.h"
-#include "lib/async_req/async_req.h"
-
-#ifndef TALLOC_FREE
-#define TALLOC_FREE(ctx) do { talloc_free(ctx); ctx=NULL; } while(0)
-#endif
-
-/**
- * @brief Print an async_req structure
- * @param[in] mem_ctx The memory context for the result
- * @param[in] req The request to be printed
- * @retval Text representation of req
- *
- * This is a default print function for async requests. Implementations should
- * override this with more specific information.
- *
- * This function should not be used by async API users, this is non-static
- * only to allow implementations to easily provide default information in
- * their specific functions.
- */
+#include "replace.h"
+#include "tevent.h"
+#include "tevent_internal.h"
+#include "tevent_util.h"
-char *async_req_print(TALLOC_CTX *mem_ctx, struct async_req *req)
+char *tevent_req_default_print(struct tevent_req *req, TALLOC_CTX *mem_ctx)
{
- return talloc_asprintf(mem_ctx, "async_req: state=%d, error=%d, "
- "priv=%s", req->state, (int)req->error,
- talloc_get_name(req->private_data));
+ return talloc_asprintf(mem_ctx,
+ "tevent_req[%p/%s]: state[%d] error[%lld (0x%llX)] "
+ " state[%s (%p)] timer[%p]",
+ req, req->internal.create_location,
+ req->internal.state,
+ (unsigned long long)req->internal.error,
+ (unsigned long long)req->internal.error,
+ talloc_get_name(req->data),
+ req->data,
+ req->internal.timer
+ );
}
-/**
- * @brief Create an async request
- * @param[in] mem_ctx The memory context for the result
- * @param[in] ev The event context this async request will be driven by
- * @retval A new async request
- *
- * The new async request will be initialized in state ASYNC_REQ_IN_PROGRESS
- */
+char *tevent_req_print(TALLOC_CTX *mem_ctx, struct tevent_req *req)
+{
+ if (!req->private_print) {
+ return tevent_req_default_print(req, mem_ctx);
+ }
+
+ return req->private_print(req, mem_ctx);
+}
-struct async_req *async_req_new(TALLOC_CTX *mem_ctx)
+struct tevent_req *_tevent_req_create(TALLOC_CTX *mem_ctx,
+ void *pdata,
+ size_t data_size,
+ const char *type,
+ const char *location)
{
- struct async_req *result;
+ struct tevent_req *req;
+ void **ppdata = (void **)pdata;
+ void *data;
+
+ req = talloc_zero(mem_ctx, struct tevent_req);
+ if (req == NULL) {
+ return NULL;
+ }
+ req->internal.private_type = type;
+ req->internal.create_location = location;
+ req->internal.finish_location = NULL;
+ req->internal.state = TEVENT_REQ_IN_PROGRESS;
+ req->internal.trigger = tevent_create_immediate(req);
+ if (!req->internal.trigger) {
+ talloc_free(req);
+ return NULL;
+ }
+ req->internal.defer_callback_ev = NULL;
- result = talloc_zero(mem_ctx, struct async_req);
- if (result == NULL) {
+ data = talloc_zero_size(req, data_size);
+ if (data == NULL) {
+ talloc_free(req);
return NULL;
}
- result->state = ASYNC_REQ_IN_PROGRESS;
- result->print = async_req_print;
- return result;
+ talloc_set_name_const(data, type);
+
+ req->data = data;
+
+ *ppdata = data;
+ return req;
}
-static void async_req_finish(struct async_req *req, enum async_req_state state)
+void _tevent_req_notify_callback(struct tevent_req *req, const char *location)
{
- req->state = state;
+ req->internal.finish_location = location;
+ if (req->internal.defer_callback_ev) {
+ (void)tevent_req_post(req, req->internal.defer_callback_ev);
+ req->internal.defer_callback_ev = NULL;
+ return;
+ }
if (req->async.fn != NULL) {
req->async.fn(req);
}
}
-/**
- * @brief An async request has successfully finished
- * @param[in] req The finished request
- *
- * async_req_done is to be used by implementors of async requests. When a
- * request is successfully finished, this function calls the user's completion
- * function.
- */
-
-void async_req_done(struct async_req *req)
+static void tevent_req_finish(struct tevent_req *req,
+ enum tevent_req_state state,
+ const char *location)
{
- async_req_finish(req, ASYNC_REQ_DONE);
+ req->internal.state = state;
+ _tevent_req_notify_callback(req, location);
}
-/**
- * @brief An async request has seen an error
- * @param[in] req The request with an error
- * @param[in] error The error code
- *
- * async_req_done is to be used by implementors of async requests. When a
- * request can not successfully completed, the implementation should call this
- * function with the appropriate status code.
- */
-
-void async_req_error(struct async_req *req, uint64_t error)
+void _tevent_req_done(struct tevent_req *req,
+ const char *location)
{
- req->error = error;
- async_req_finish(req, ASYNC_REQ_USER_ERROR);
+ tevent_req_finish(req, TEVENT_REQ_DONE, location);
}
-/**
- * @brief Timed event callback
- * @param[in] ev Event context
- * @param[in] te The timed event
- * @param[in] now zero time
- * @param[in] priv The async request to be finished
- */
-
-static void async_trigger(struct tevent_context *ev, struct tevent_timer *te,
- struct timeval now, void *priv)
+bool _tevent_req_error(struct tevent_req *req,
+ uint64_t error,
+ const char *location)
{
- struct async_req *req = talloc_get_type_abort(priv, struct async_req);
-
- TALLOC_FREE(te);
- if (req->error == 0) {
- async_req_done(req);
- }
- else {
- async_req_error(req, req->error);
+ if (error == 0) {
+ return false;
}
+
+ req->internal.error = error;
+ tevent_req_finish(req, TEVENT_REQ_USER_ERROR, location);
+ return true;
}
-/**
- * @brief Helper function for nomem check
- * @param[in] p The pointer to be checked
- * @param[in] req The request being processed
- *
- * Convenience helper to easily check alloc failure within a callback
- * implementing the next step of an async request.
- *
- * Call pattern would be
- * \code
- * p = talloc(mem_ctx, bla);
- * if (async_req_ntnomem(p, req)) {
- * return;
- * }
- * \endcode
- */
+void _tevent_req_oom(struct tevent_req *req, const char *location)
+{
+ tevent_req_finish(req, TEVENT_REQ_NO_MEMORY, location);
+}
-bool async_req_nomem(const void *p, struct async_req *req)
+bool _tevent_req_nomem(const void *p,
+ struct tevent_req *req,
+ const char *location)
{
if (p != NULL) {
return false;
}
- async_req_finish(req, ASYNC_REQ_NO_MEMORY);
+ _tevent_req_oom(req, location);
return true;
}
/**
- * @brief Finish a request before it started processing
- * @param[in] req The finished request
- * @param[in] status The success code
+ * @internal
+ *
+ * @brief Immediate event callback.
*
- * An implementation of an async request might find that it can either finish
- * the request without waiting for an external event, or it can't even start
- * the engine. To present the illusion of a callback to the user of the API,
- * the implementation can call this helper function which triggers an
- * immediate timed event. This way the caller can use the same calling
- * conventions, independent of whether the request was actually deferred.
+ * @param[in] ev The event context to use.
+ *
+ * @param[in] im The immediate event.
+ *
+ * @param[in] priv The async request to be finished.
*/
-
-bool async_post_error(struct async_req *req, struct tevent_context *ev,
- uint64_t error)
+static void tevent_req_trigger(struct tevent_context *ev,
+ struct tevent_immediate *im,
+ void *private_data)
{
- req->error = error;
+ struct tevent_req *req = talloc_get_type(private_data,
+ struct tevent_req);
- if (tevent_add_timer(ev, req, timeval_zero(),
- async_trigger, req) == NULL) {
- return false;
- }
- return true;
+ tevent_req_finish(req, req->internal.state,
+ req->internal.finish_location);
}
-bool async_req_is_error(struct async_req *req, enum async_req_state *state,
- uint64_t *error)
+struct tevent_req *tevent_req_post(struct tevent_req *req,
+ struct tevent_context *ev)
{
- if (req->state == ASYNC_REQ_DONE) {
- return false;
- }
- if (req->state == ASYNC_REQ_USER_ERROR) {
- *error = req->error;
- }
- *state = req->state;
- return true;
+ tevent_schedule_immediate(req->internal.trigger,
+ ev, tevent_req_trigger, req);
+ return req;
}
-static void async_req_timedout(struct tevent_context *ev,
- struct tevent_timer *te,
- struct timeval now,
- void *priv)
+void tevent_req_defer_callback(struct tevent_req *req,
+ struct tevent_context *ev)
{
- struct async_req *req = talloc_get_type_abort(priv, struct async_req);
- TALLOC_FREE(te);
- async_req_finish(req, ASYNC_REQ_TIMED_OUT);
+ req->internal.defer_callback_ev = ev;
}
-bool async_req_set_timeout(struct async_req *req, struct tevent_context *ev,
- struct timeval to)
+bool tevent_req_is_in_progress(struct tevent_req *req)
{
- return (tevent_add_timer(
- ev, req, timeval_current_ofs(to.tv_sec, to.tv_usec),
- async_req_timedout, req)
- != NULL);
+ if (req->internal.state == TEVENT_REQ_IN_PROGRESS) {
+ return true;
+ }
+
+ return false;
}
-struct async_req *async_wait_send(TALLOC_CTX *mem_ctx,
- struct tevent_context *ev,
- struct timeval to)
+void tevent_req_received(struct tevent_req *req)
{
- struct async_req *result;
+ TALLOC_FREE(req->data);
+ req->private_print = NULL;
- result = async_req_new(mem_ctx);
- if (result == NULL) {
- return result;
- }
- if (!async_req_set_timeout(result, ev, to)) {
- TALLOC_FREE(result);
- return NULL;
- }
- return result;
-}
+ TALLOC_FREE(req->internal.trigger);
+ TALLOC_FREE(req->internal.timer);
-bool async_wait_recv(struct async_req *req)
-{
- return true;
+ req->internal.state = TEVENT_REQ_RECEIVED;
}
-struct async_queue_entry {
- struct async_queue_entry *prev, *next;
- struct async_req_queue *queue;
- struct async_req *req;
- void (*trigger)(struct async_req *req);
-};
+bool tevent_req_poll(struct tevent_req *req,
+ struct tevent_context *ev)
+{
+ while (tevent_req_is_in_progress(req)) {
+ int ret;
-struct async_req_queue {
- struct async_queue_entry *queue;
-};
+ ret = tevent_loop_once(ev);
+ if (ret != 0) {
+ return false;
+ }
+ }
-struct async_req_queue *async_req_queue_init(TALLOC_CTX *mem_ctx)
-{
- return talloc_zero(mem_ctx, struct async_req_queue);
+ return true;
}
-static int async_queue_entry_destructor(struct async_queue_entry *e)
+bool tevent_req_is_error(struct tevent_req *req, enum tevent_req_state *state,
+ uint64_t *error)
{
- struct async_req_queue *queue = e->queue;
-
- DLIST_REMOVE(queue->queue, e);
-
- if (queue->queue != NULL) {
- queue->queue->trigger(queue->queue->req);
+ if (req->internal.state == TEVENT_REQ_DONE) {
+ return false;
}
-
- return 0;
+ if (req->internal.state == TEVENT_REQ_USER_ERROR) {
+ *error = req->internal.error;
+ }
+ *state = req->internal.state;
+ return true;
}
-static void async_req_immediate_trigger(struct tevent_context *ev,
- struct tevent_timer *te,
- struct timeval now,
- void *priv)
+static void tevent_req_timedout(struct tevent_context *ev,
+ struct tevent_timer *te,
+ struct timeval now,
+ void *private_data)
{
- struct async_queue_entry *e = talloc_get_type_abort(
- priv, struct async_queue_entry);
+ struct tevent_req *req = talloc_get_type(private_data,
+ struct tevent_req);
- TALLOC_FREE(te);
- e->trigger(e->req);
+ TALLOC_FREE(req->internal.timer);
+
+ tevent_req_finish(req, TEVENT_REQ_TIMED_OUT, __FUNCTION__);
}
-bool async_req_enqueue(struct async_req_queue *queue, struct tevent_context *ev,
- struct async_req *req,
- void (*trigger)(struct async_req *req))
+bool tevent_req_set_endtime(struct tevent_req *req,
+ struct tevent_context *ev,
+ struct timeval endtime)
{
- struct async_queue_entry *e;
- bool busy;
-
- busy = (queue->queue != NULL);
+ TALLOC_FREE(req->internal.timer);
- e = talloc(req, struct async_queue_entry);
- if (e == NULL) {
+ req->internal.timer = tevent_add_timer(ev, req, endtime,
+ tevent_req_timedout,
+ req);
+ if (tevent_req_nomem(req->internal.timer, req)) {
return false;
}
- e->req = req;
- e->trigger = trigger;
- e->queue = queue;
+ return true;
+}
- DLIST_ADD_END(queue->queue, e, struct async_queue_entry *);
- talloc_set_destructor(e, async_queue_entry_destructor);
+void tevent_req_set_callback(struct tevent_req *req, tevent_req_fn fn, void *pvt)
+{
+ req->async.fn = fn;
+ req->async.private_data = pvt;
+}
- if (!busy) {
- struct tevent_timer *te;
+void *_tevent_req_callback_data(struct tevent_req *req)
+{
+ return req->async.private_data;
+}
- te = tevent_add_timer(ev, e, timeval_zero(),
- async_req_immediate_trigger,
- e);
- if (te == NULL) {
- TALLOC_FREE(e);
- return false;
- }
- }
+void *_tevent_req_data(struct tevent_req *req)
+{
+ return req->data;
+}
- return true;
+void tevent_req_set_print_fn(struct tevent_req *req, tevent_req_print_fn fn)
+{
+ req->private_print = fn;
}
-bool _async_req_setup(TALLOC_CTX *mem_ctx, struct async_req **preq,
- void *pstate, size_t state_size, const char *typename)
+void tevent_req_set_cancel_fn(struct tevent_req *req, tevent_req_cancel_fn fn)
{
- struct async_req *req;
- void **ppstate = (void **)pstate;
- void *state;
+ req->private_cancel = fn;
+}
- req = async_req_new(mem_ctx);
- if (req == NULL) {
- return false;
- }
- state = talloc_size(req, state_size);
- if (state == NULL) {
- TALLOC_FREE(req);
+bool _tevent_req_cancel(struct tevent_req *req, const char *location)
+{
+ if (req->private_cancel == NULL) {
return false;
}
- talloc_set_name_const(state, typename);
- req->private_data = state;
-
- *preq = req;
- *ppstate = state;
- return true;
+ return req->private_cancel(req);
}
git.samba.org / metze / samba / wip.git / blobdiff