1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
/*
Unix SMB/CIFS implementation.
Infrastructure for async requests
Copyright (C) Volker Lendecke 2008
Copyright (C) Stefan Metzmacher 2009
** NOTE! The following LGPL license applies to the tevent
** library. This does NOT imply that all of Samba is released
** under the LGPL
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
Lesser General Public License for more details.
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 "replace.h"
#include "tevent.h"
#include "tevent_internal.h"
#include "tevent_util.h"
char *tevent_req_default_print(struct tevent_req *req, TALLOC_CTX *mem_ctx)
{
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
);
}
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);
}
static int tevent_req_destructor(struct tevent_req *req);
struct tevent_req *_tevent_req_create(TALLOC_CTX *mem_ctx,
void *pdata,
size_t data_size,
const char *type,
const char *location)
{
struct tevent_req *req;
void **ppdata = (void **)pdata;
void *data;
size_t payload;
payload = sizeof(struct tevent_immediate) + data_size;
if (payload < sizeof(struct tevent_immediate)) {
/* overflow */
return NULL;
}
req = talloc_pooled_object(
mem_ctx, struct tevent_req, 2,
sizeof(struct tevent_immediate) + data_size);
if (req == NULL) {
return NULL;
}
*req = (struct tevent_req) {
.internal.private_type = type,
.internal.create_location = location,
.internal.state = TEVENT_REQ_IN_PROGRESS,
.internal.trigger = tevent_create_immediate(req)
};
data = talloc_zero_size(req, data_size);
/*
* No need to check for req->internal.trigger!=NULL or
* data!=NULL, this can't fail: talloc_pooled_object has
* already allocated sufficient memory.
*/
talloc_set_name_const(data, type);
req->data = data;
talloc_set_destructor(req, tevent_req_destructor);
*ppdata = data;
return req;
}
static int tevent_req_destructor(struct tevent_req *req)
{
tevent_req_received(req);
return 0;
}
void _tevent_req_notify_callback(struct tevent_req *req, const char *location)
{
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);
}
}
static void tevent_req_cleanup(struct tevent_req *req)
{
if (req->private_cleanup.fn == NULL) {
return;
}
if (req->private_cleanup.state >= req->internal.state) {
/*
* Don't call the cleanup_function multiple times for the same
* state recursively
*/
return;
}
req->private_cleanup.state = req->internal.state;
req->private_cleanup.fn(req, req->internal.state);
}
static void tevent_req_finish(struct tevent_req *req,
enum tevent_req_state state,
const char *location)
{
/*
* make sure we do not timeout after
* the request was already finished
*/
TALLOC_FREE(req->internal.timer);
req->internal.state = state;
req->internal.finish_location = location;
tevent_req_cleanup(req);
_tevent_req_notify_callback(req, location);
}
void _tevent_req_done(struct tevent_req *req,
const char *location)
{
tevent_req_finish(req, TEVENT_REQ_DONE, location);
}
bool _tevent_req_error(struct tevent_req *req,
uint64_t error,
const char *location)
{
if (error == 0) {
return false;
}
req->internal.error = error;
tevent_req_finish(req, TEVENT_REQ_USER_ERROR, location);
return true;
}
void _tevent_req_oom(struct tevent_req *req, const char *location)
{
tevent_req_finish(req, TEVENT_REQ_NO_MEMORY, location);
}
bool _tevent_req_nomem(const void *p,
struct tevent_req *req,
const char *location)
{
if (p != NULL) {
return false;
}
_tevent_req_oom(req, location);
return true;
}
/**
* @internal
*
* @brief Immediate event callback.
*
* @param[in] ev The event context to use.
*
* @param[in] im The immediate event.
*
* @param[in] priv The async request to be finished.
*/
static void tevent_req_trigger(struct tevent_context *ev,
struct tevent_immediate *im,
void *private_data)
{
struct tevent_req *req =
talloc_get_type_abort(private_data,
struct tevent_req);
tevent_req_finish(req, req->internal.state,
req->internal.finish_location);
}
struct tevent_req *tevent_req_post(struct tevent_req *req,
struct tevent_context *ev)
{
tevent_schedule_immediate(req->internal.trigger,
ev, tevent_req_trigger, req);
return req;
}
void tevent_req_defer_callback(struct tevent_req *req,
struct tevent_context *ev)
{
req->internal.defer_callback_ev = ev;
}
bool tevent_req_is_in_progress(struct tevent_req *req)
{
if (req->internal.state == TEVENT_REQ_IN_PROGRESS) {
return true;
}
return false;
}
void tevent_req_received(struct tevent_req *req)
{
talloc_set_destructor(req, NULL);
req->private_print = NULL;
req->private_cancel = NULL;
TALLOC_FREE(req->internal.trigger);
TALLOC_FREE(req->internal.timer);
req->internal.state = TEVENT_REQ_RECEIVED;
tevent_req_cleanup(req);
TALLOC_FREE(req->data);
}
bool tevent_req_poll(struct tevent_req *req,
struct tevent_context *ev)
{
while (tevent_req_is_in_progress(req)) {
int ret;
ret = tevent_loop_once(ev);
if (ret != 0) {
return false;
}
}
return true;
}
bool tevent_req_is_error(struct tevent_req *req, enum tevent_req_state *state,
uint64_t *error)
{
if (req->internal.state == TEVENT_REQ_DONE) {
return false;
}
if (req->internal.state == TEVENT_REQ_USER_ERROR) {
*error = req->internal.error;
}
*state = req->internal.state;
return true;
}
static void tevent_req_timedout(struct tevent_context *ev,
struct tevent_timer *te,
struct timeval now,
void *private_data)
{
struct tevent_req *req =
talloc_get_type_abort(private_data,
struct tevent_req);
TALLOC_FREE(req->internal.timer);
tevent_req_finish(req, TEVENT_REQ_TIMED_OUT, __FUNCTION__);
}
bool tevent_req_set_endtime(struct tevent_req *req,
struct tevent_context *ev,
struct timeval endtime)
{
TALLOC_FREE(req->internal.timer);
req->internal.timer = tevent_add_timer(ev, req, endtime,
tevent_req_timedout,
req);
if (tevent_req_nomem(req->internal.timer, req)) {
return false;
}
return true;
}
void tevent_req_set_callback(struct tevent_req *req, tevent_req_fn fn, void *pvt)
{
req->async.fn = fn;
req->async.private_data = pvt;
}
void *_tevent_req_callback_data(struct tevent_req *req)
{
return req->async.private_data;
}
void *_tevent_req_data(struct tevent_req *req)
{
return req->data;
}
void tevent_req_set_print_fn(struct tevent_req *req, tevent_req_print_fn fn)
{
req->private_print = fn;
}
void tevent_req_set_cancel_fn(struct tevent_req *req, tevent_req_cancel_fn fn)
{
req->private_cancel = fn;
}
bool _tevent_req_cancel(struct tevent_req *req, const char *location)
{
if (req->private_cancel == NULL) {
return false;
}
return req->private_cancel(req);
}
void tevent_req_set_cleanup_fn(struct tevent_req *req, tevent_req_cleanup_fn fn)
{
req->private_cleanup.state = req->internal.state;
req->private_cleanup.fn = fn;
}
|