lobo/isync
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fake async drivers more convincingly

Browse Source 
instead of delaying the callback, delay the actual driver call. this is
in line with how the IMAP driver would behave, as since commit 6c08f568
it queues the socket writes (the network upstream latency goes on top,
but that doesn't alter the result).

amends 4423a932.
This commit is contained in:
Oswald Buddenhagen 2022-02-07 12:53:58 +01:00
parent 16238909d3
commit 3a8f8a8391
3 changed files with 94 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/driver.h
View File

@ -128,9 +128,8 @@ static_assert_bits(F, msg_data_t, flags);
#define DRV_CANCELED 4 #define DRV_CANCELED 4
/* All memory belongs to the driver's user, unless stated otherwise. */ /* All memory belongs to the driver's user, unless stated otherwise. */
// If the driver is NOT DRV_ASYNC, memory owned by the driver returned // All memory passed to driver functions must remain valid until the
// through callbacks MUST remain valid until a related subsequent command // respective result callback is invoked.
// is invoked, as the proxy driver may deliver these pointers with delay.
/* /*
This flag says that the driver CAN store messages with CRLFs, This flag says that the driver CAN store messages with CRLFs,

153
src/drv_proxy.c
View File

@ -20,7 +20,7 @@ typedef union proxy_store {
uint ref_count; uint ref_count;
driver_t *real_driver; driver_t *real_driver;
store_t *real_store; store_t *real_store;
gen_cmd_t *done_cmds, **done_cmds_append; gen_cmd_t *pending_cmds, **pending_cmds_append;
gen_cmd_t *check_cmds, **check_cmds_append; gen_cmd_t *check_cmds, **check_cmds_append;
wakeup_t wakeup; wakeup_t wakeup;
@ -51,17 +51,6 @@ struct gen_cmd {
GEN_CMD GEN_CMD
}; };
#define GEN_STS_CMD \
GEN_CMD \
int sts;
typedef union {
gen_cmd_t gen;
struct {
GEN_STS_CMD
};
} gen_sts_cmd_t;
static gen_cmd_t * static gen_cmd_t *
proxy_cmd_new( proxy_store_t *ctx, uint sz ) proxy_cmd_new( proxy_store_t *ctx, uint sz )
{ {
@ -87,10 +76,10 @@ proxy_wakeup( void *aux )
{ {
proxy_store_t *ctx = (proxy_store_t *)aux; proxy_store_t *ctx = (proxy_store_t *)aux;
gen_cmd_t *cmd = ctx->done_cmds; gen_cmd_t *cmd = ctx->pending_cmds;
assert( cmd ); assert( cmd );
if (!(ctx->done_cmds = cmd->next)) if (!(ctx->pending_cmds = cmd->next))
ctx->done_cmds_append = &ctx->done_cmds; ctx->pending_cmds_append = &ctx->pending_cmds;
else else
conf_wakeup( &ctx->wakeup, 0 ); conf_wakeup( &ctx->wakeup, 0 );
cmd->queued_cb( cmd ); cmd->queued_cb( cmd );
@ -98,22 +87,22 @@ proxy_wakeup( void *aux )
} }
static void static void
proxy_invoke_cb( gen_cmd_t *cmd, void (*cb)( gen_cmd_t * ), int checked, const char *name ) proxy_invoke( gen_cmd_t *cmd, int checked, const char *name )
{ {
if (DFlags & FORCEASYNC) { if (DFlags & FORCEASYNC) {
debug( "%s[% 2d] Callback queue %s%s\n", cmd->ctx->label, cmd->tag, name, checked ? " (checked)" : "" ); proxy_store_t *ctx = cmd->ctx;
cmd->queued_cb = cb; debug( "%s[% 2d] Queue %s%s\n", ctx->label, cmd->tag, name, checked ? " (checked)" : "" );
cmd->next = NULL; cmd->next = NULL;
if (checked) { if (checked) {
*cmd->ctx->check_cmds_append = cmd; *ctx->check_cmds_append = cmd;
cmd->ctx->check_cmds_append = &cmd->next; ctx->check_cmds_append = &cmd->next;
} else { } else {
*cmd->ctx->done_cmds_append = cmd; *ctx->pending_cmds_append = cmd;
cmd->ctx->done_cmds_append = &cmd->next; ctx->pending_cmds_append = &cmd->next;
conf_wakeup( &cmd->ctx->wakeup, 0 ); conf_wakeup( &ctx->wakeup, 0 );
} }
} else { } else {
cb( cmd ); cmd->queued_cb( cmd );
proxy_cmd_done( cmd ); proxy_cmd_done( cmd );
} }
} }
@ -122,8 +111,8 @@ static void
proxy_flush_checked_cmds( proxy_store_t *ctx ) proxy_flush_checked_cmds( proxy_store_t *ctx )
{ {
if (ctx->check_cmds) { if (ctx->check_cmds) {
*ctx->done_cmds_append = ctx->check_cmds; *ctx->pending_cmds_append = ctx->check_cmds;
ctx->done_cmds_append = ctx->check_cmds_append; ctx->pending_cmds_append = ctx->check_cmds_append;
ctx->check_cmds_append = &ctx->check_cmds; ctx->check_cmds_append = &ctx->check_cmds;
ctx->check_cmds = NULL; ctx->check_cmds = NULL;
conf_wakeup( &ctx->wakeup, 0 ); conf_wakeup( &ctx->wakeup, 0 );
@ -131,15 +120,14 @@ proxy_flush_checked_cmds( proxy_store_t *ctx )
} }
static void static void
proxy_cancel_checked_cmds( proxy_store_t *ctx ) proxy_cancel_queued_cmds( proxy_store_t *ctx )
{ {
gen_cmd_t *cmd; if (ctx->pending_cmds || ctx->check_cmds) {
// This would involve directly invoking the result callbacks with
while ((cmd = ctx->check_cmds)) { // DRV_CANCEL, for which we'd need another set of dispatch functions.
if (!(ctx->check_cmds = cmd->next)) // The autotest doesn't need that, so save the effort.
ctx->check_cmds_append = &ctx->check_cmds; error( "Fatal: Faking asynchronous cancelation is not supported.\n" );
((gen_sts_cmd_t *)cmd)->sts = DRV_CANCELED; abort();
cmd->queued_cb( cmd );
} }
} }
@ -185,34 +173,39 @@ static @type@proxy_@name@( store_t *gctx@decl_args@ )
//# TEMPLATE CALLBACK //# TEMPLATE CALLBACK
typedef union { typedef union {
@gen_cmd_t@ gen; gen_cmd_t gen;
struct { struct {
@GEN_CMD@ GEN_CMD
@decl_cb_state@
void (*callback)( @decl_cb_args@void *aux ); void (*callback)( @decl_cb_args@void *aux );
void *callback_aux; void *callback_aux;
@decl_state@ @decl_state@
}; };
} @name@_cmd_t; } @name@_cmd_t;
static void
proxy_do_@name@_cb( gen_cmd_t *gcmd )
{
@name@_cmd_t *cmd = (@name@_cmd_t *)gcmd;
debug( "%s[% 2d] Callback enter @name@@print_fmt_cb_args@\n", cmd->ctx->label, cmd->tag@print_pass_cb_args@ );
@print_cb_args@
cmd->callback( @pass_cb_args@cmd->callback_aux );
debug( "%s[% 2d] Callback leave @name@\n", cmd->ctx->label, cmd->tag );
}
static void static void
proxy_@name@_cb( @decl_cb_args@void *aux ) proxy_@name@_cb( @decl_cb_args@void *aux )
{ {
@name@_cmd_t *cmd = (@name@_cmd_t *)aux; @name@_cmd_t *cmd = (@name@_cmd_t *)aux;
proxy_store_t *ctx = cmd->ctx;
@save_cb_args@ debug( "%s[% 2d] Callback enter @name@@print_fmt_cb_args@\n", ctx->label, cmd->tag@print_pass_cb_args@ );
proxy_invoke_cb( @gen_cmd@, proxy_do_@name@_cb, @checked@, "@name@" ); @print_cb_args@
cmd->callback( @pass_cb_args@cmd->callback_aux );
debug( "%s[% 2d] Callback leave @name@\n", ctx->label, cmd->tag );
proxy_cmd_done( &cmd->gen );
}
static void
proxy_do_@name@( gen_cmd_t *gcmd )
{
@name@_cmd_t *cmd = (@name@_cmd_t *)gcmd;
proxy_store_t *ctx = cmd->ctx;
@pre_print_args@
debug( "%s[% 2d] Enter @name@@print_fmt_args@\n", ctx->label, cmd->tag@print_pass_args@ );
@print_args@
ctx->real_driver->@name@( ctx->real_store@pass_args@, proxy_@name@_cb, cmd );
debug( "%s[% 2d] Leave @name@\n", ctx->label, cmd->tag );
} }
static @type@proxy_@name@( store_t *gctx@decl_args@, void (*cb)( @decl_cb_args@void *aux ), void *aux ) static @type@proxy_@name@( store_t *gctx@decl_args@, void (*cb)( @decl_cb_args@void *aux ), void *aux )
@ -220,23 +213,19 @@ static @type@proxy_@name@( store_t *gctx@decl_args@, void (*cb)( @decl_cb_args@v
proxy_store_t *ctx = (proxy_store_t *)gctx; proxy_store_t *ctx = (proxy_store_t *)gctx;
@name@_cmd_t *cmd = (@name@_cmd_t *)proxy_cmd_new( ctx, sizeof(@name@_cmd_t) ); @name@_cmd_t *cmd = (@name@_cmd_t *)proxy_cmd_new( ctx, sizeof(@name@_cmd_t) );
cmd->queued_cb = proxy_do_@name@;
cmd->callback = cb; cmd->callback = cb;
cmd->callback_aux = aux; cmd->callback_aux = aux;
@assign_state@ @assign_state@
@pre_print_args@ proxy_invoke( &cmd->gen, @checked@, "@name@" );
debug( "%s[% 2d] Enter @name@@print_fmt_args@\n", ctx->label, cmd->tag@print_pass_args@ );
@print_args@
ctx->real_driver->@name@( ctx->real_store@pass_args@, proxy_@name@_cb, cmd );
debug( "%s[% 2d] Leave @name@\n", ctx->label, cmd->tag );
proxy_cmd_done( @gen_cmd@ );
} }
//# END //# END
//# UNDEFINE list_store_print_fmt_cb_args //# UNDEFINE list_store_print_fmt_cb_args
//# UNDEFINE list_store_print_pass_cb_args //# UNDEFINE list_store_print_pass_cb_args
//# DEFINE list_store_print_cb_args //# DEFINE list_store_print_cb_args
if (cmd->sts == DRV_OK) { if (sts == DRV_OK) {
for (string_list_t *box = cmd->boxes; box; box = box->next) for (string_list_t *box = boxes; box; box = box->next)
debug( " %s\n", box->string ); debug( " %s\n", box->string );
} }
//# END //# END
@ -250,46 +239,40 @@ static @type@proxy_@name@( store_t *gctx@decl_args@, void (*cb)( @decl_cb_args@v
char ubuf[12]; char ubuf[12];
//# END //# END
//# DEFINE load_box_print_fmt_args , [%u,%s] (find >= %u, paired <= %u, new > %u) //# DEFINE load_box_print_fmt_args , [%u,%s] (find >= %u, paired <= %u, new > %u)
//# DEFINE load_box_print_pass_args , minuid, (maxuid == UINT_MAX) ? "inf" : (nfsnprintf( ubuf, sizeof(ubuf), "%u", maxuid ), ubuf), finduid, pairuid, newuid //# DEFINE load_box_print_pass_args , cmd->minuid, (cmd->maxuid == UINT_MAX) ? "inf" : (nfsnprintf( ubuf, sizeof(ubuf), "%u", cmd->maxuid ), ubuf), cmd->finduid, cmd->pairuid, cmd->newuid
//# DEFINE load_box_print_args //# DEFINE load_box_print_args
if (excs.size) { if (cmd->excs.size) {
debugn( " excs:" ); debugn( " excs:" );
for (uint t = 0; t < excs.size; t++) for (uint t = 0; t < cmd->excs.size; t++)
debugn( " %u", excs.data[t] ); debugn( " %u", cmd->excs.data[t] );
debug( "\n" ); debug( "\n" );
} }
//# END //# END
//# DEFINE load_box_print_fmt_cb_args , sts=%d, total=%d, recent=%d //# DEFINE load_box_print_fmt_cb_args , sts=%d, total=%d, recent=%d
//# DEFINE load_box_print_pass_cb_args , cmd->sts, cmd->total_msgs, cmd->recent_msgs //# DEFINE load_box_print_pass_cb_args , sts, total_msgs, recent_msgs
//# DEFINE load_box_print_cb_args //# DEFINE load_box_print_cb_args
if (cmd->sts == DRV_OK) { if (sts == DRV_OK) {
for (message_t *msg = cmd->msgs; msg; msg = msg->next) for (message_t *msg = msgs; msg; msg = msg->next)
debug( " uid=%-5u flags=%-4s size=%-6u tuid=%." stringify(TUIDL) "s\n", debug( " uid=%-5u flags=%-4s size=%-6u tuid=%." stringify(TUIDL) "s\n",
msg->uid, (msg->status & M_FLAGS) ? fmt_flags( msg->flags ).str : "?", msg->size, *msg->tuid ? msg->tuid : "?" ); msg->uid, (msg->status & M_FLAGS) ? fmt_flags( msg->flags ).str : "?", msg->size, *msg->tuid ? msg->tuid : "?" );
} }
//# END //# END
//# DEFINE find_new_msgs_print_fmt_cb_args , sts=%d //# DEFINE find_new_msgs_print_fmt_cb_args , sts=%d
//# DEFINE find_new_msgs_print_pass_cb_args , cmd->sts //# DEFINE find_new_msgs_print_pass_cb_args , sts
//# DEFINE find_new_msgs_print_cb_args //# DEFINE find_new_msgs_print_cb_args
if (cmd->sts == DRV_OK) { if (sts == DRV_OK) {
for (message_t *msg = cmd->msgs; msg; msg = msg->next) for (message_t *msg = msgs; msg; msg = msg->next)
debug( " uid=%-5u tuid=%." stringify(TUIDL) "s\n", msg->uid, msg->tuid ); debug( " uid=%-5u tuid=%." stringify(TUIDL) "s\n", msg->uid, msg->tuid );
} }
//# END //# END
//# DEFINE fetch_msg_decl_state
msg_data_t *data;
//# END
//# DEFINE fetch_msg_assign_state
cmd->data = data;
//# END
//# DEFINE fetch_msg_print_fmt_args , uid=%u, want_flags=%s, want_date=%s //# DEFINE fetch_msg_print_fmt_args , uid=%u, want_flags=%s, want_date=%s
//# DEFINE fetch_msg_print_pass_args , msg->uid, !(msg->status & M_FLAGS) ? "yes" : "no", data->date ? "yes" : "no" //# DEFINE fetch_msg_print_pass_args , cmd->msg->uid, !(cmd->msg->status & M_FLAGS) ? "yes" : "no", cmd->data->date ? "yes" : "no"
//# DEFINE fetch_msg_print_fmt_cb_args , flags=%s, date=%lld, size=%u //# DEFINE fetch_msg_print_fmt_cb_args , flags=%s, date=%lld, size=%u
//# DEFINE fetch_msg_print_pass_cb_args , fmt_flags( cmd->data->flags ).str, (long long)cmd->data->date, cmd->data->len //# DEFINE fetch_msg_print_pass_cb_args , fmt_flags( cmd->data->flags ).str, (long long)cmd->data->date, cmd->data->len
//# DEFINE fetch_msg_print_cb_args //# DEFINE fetch_msg_print_cb_args
if (cmd->sts == DRV_OK && (DFlags & DEBUG_DRV_ALL)) { if (sts == DRV_OK && (DFlags & DEBUG_DRV_ALL)) {
printf( "%s=========\n", cmd->ctx->label ); printf( "%s=========\n", cmd->ctx->label );
fwrite( cmd->data->data, cmd->data->len, 1, stdout ); fwrite( cmd->data->data, cmd->data->len, 1, stdout );
printf( "%s=========\n", cmd->ctx->label ); printf( "%s=========\n", cmd->ctx->label );
@ -298,40 +281,40 @@ static @type@proxy_@name@( store_t *gctx@decl_args@, void (*cb)( @decl_cb_args@v
//# END //# END
//# DEFINE store_msg_print_fmt_args , flags=%s, date=%lld, size=%u, to_trash=%s //# DEFINE store_msg_print_fmt_args , flags=%s, date=%lld, size=%u, to_trash=%s
//# DEFINE store_msg_print_pass_args , fmt_flags( data->flags ).str, (long long)data->date, data->len, to_trash ? "yes" : "no" //# DEFINE store_msg_print_pass_args , fmt_flags( cmd->data->flags ).str, (long long)cmd->data->date, cmd->data->len, cmd->to_trash ? "yes" : "no"
//# DEFINE store_msg_print_args //# DEFINE store_msg_print_args
if (DFlags & DEBUG_DRV_ALL) { if (DFlags & DEBUG_DRV_ALL) {
printf( "%s>>>>>>>>>\n", ctx->label ); printf( "%s>>>>>>>>>\n", ctx->label );
fwrite( data->data, data->len, 1, stdout ); fwrite( cmd->data->data, cmd->data->len, 1, stdout );
printf( "%s>>>>>>>>>\n", ctx->label ); printf( "%s>>>>>>>>>\n", ctx->label );
fflush( stdout ); fflush( stdout );
} }
//# END //# END
//# DEFINE set_msg_flags_checked 1
//# DEFINE set_msg_flags_print_fmt_args , uid=%u, add=%s, del=%s //# DEFINE set_msg_flags_print_fmt_args , uid=%u, add=%s, del=%s
//# DEFINE set_msg_flags_print_pass_args , uid, fmt_flags( add ).str, fmt_flags( del ).str //# DEFINE set_msg_flags_print_pass_args , cmd->uid, fmt_flags( cmd->add ).str, fmt_flags( cmd->del ).str
//# DEFINE set_msg_flags_checked sts == DRV_OK
//# DEFINE trash_msg_print_fmt_args , uid=%u //# DEFINE trash_msg_print_fmt_args , uid=%u
//# DEFINE trash_msg_print_pass_args , msg->uid //# DEFINE trash_msg_print_pass_args , cmd->msg->uid
//# DEFINE commit_cmds_print_args //# DEFINE commit_cmds_print_args
proxy_flush_checked_cmds( ctx ); proxy_flush_checked_cmds( ctx );
//# END //# END
//# DEFINE cancel_cmds_print_cb_args //# DEFINE cancel_cmds_print_cb_args
proxy_cancel_checked_cmds( cmd->ctx ); proxy_cancel_queued_cmds( ctx );
//# END //# END
//# DEFINE free_store_print_args //# DEFINE free_store_print_args
proxy_cancel_checked_cmds( ctx ); proxy_cancel_queued_cmds( ctx );
//# END //# END
//# DEFINE free_store_action //# DEFINE free_store_action
proxy_store_deref( ctx ); proxy_store_deref( ctx );
//# END //# END
//# DEFINE cancel_store_print_args //# DEFINE cancel_store_print_args
proxy_cancel_checked_cmds( ctx ); proxy_cancel_queued_cmds( ctx );
//# END //# END
//# DEFINE cancel_store_action //# DEFINE cancel_store_action
proxy_store_deref( ctx ); proxy_store_deref( ctx );
@ -369,7 +352,7 @@ proxy_alloc_store( store_t *real_ctx, const char *label )
ctx->gen.conf = real_ctx->conf; ctx->gen.conf = real_ctx->conf;
ctx->ref_count = 1; ctx->ref_count = 1;
ctx->label = label; ctx->label = label;
ctx->done_cmds_append = &ctx->done_cmds; ctx->pending_cmds_append = &ctx->pending_cmds;
ctx->check_cmds_append = &ctx->check_cmds; ctx->check_cmds_append = &ctx->check_cmds;
ctx->real_driver = real_ctx->driver; ctx->real_driver = real_ctx->driver;
ctx->real_store = real_ctx; ctx->real_store = real_ctx;

39
src/drv_proxy_gen.pl
View File

@ -134,38 +134,37 @@ for (@ptypes) {
$template = "GETTER"; $template = "GETTER";
$replace{'fmt'} = type_to_format($cmd_type); $replace{'fmt'} = type_to_format($cmd_type);
} else { } else {
my $pass_args;
if ($cmd_type eq "void " && $cmd_args =~ s/, void \(\*cb\)\( (.*)void \*aux \), void \*aux$//) { if ($cmd_type eq "void " && $cmd_args =~ s/, void \(\*cb\)\( (.*)void \*aux \), void \*aux$//) {
my $cmd_cb_args = $1; my $cmd_cb_args = $1;
if (length($cmd_cb_args)) {
$replace{'decl_cb_args'} = $cmd_cb_args; $replace{'decl_cb_args'} = $cmd_cb_args;
my $r_cmd_cb_args = $cmd_cb_args; $replace{'pass_cb_args'} = make_args($cmd_cb_args);
$r_cmd_cb_args =~ s/^int sts, // or die("Callback arguments of $cmd_name don't start with sts.\n"); my $cmd_print_cb_args = $cmd_cb_args =~ s/(.*), $/, $1/r;
$replace{'decl_cb_state'} = $r_cmd_cb_args =~ s/, /\;\n/gr; $replace{'print_pass_cb_args'} = make_args($cmd_print_cb_args);
my $pass_cb_args = make_args($cmd_cb_args); $replace{'print_fmt_cb_args'} = make_format($cmd_print_cb_args);
$replace{'save_cb_args'} = $pass_cb_args =~ s/([^,]+), /cmd->$1 = $1\;\n/gr;
$pass_cb_args =~ s/([^, ]+)/cmd->$1/g; $pass_args = make_args($cmd_args);
$replace{'pass_cb_args'} = $pass_cb_args; $pass_args =~ s/([^, ]+)/cmd->$1/g;
$replace{'print_pass_cb_args'} = $pass_cb_args =~ s/(.*), $/, $1/r; my $r_cmd_args = $cmd_args =~ s/, (.*)$/$1, /r;
$replace{'print_fmt_cb_args'} = make_format($cmd_cb_args =~ s/(.*), $/, $1/r); $replace{'decl_state'} = $r_cmd_args =~ s/, /\;\n/gr;
$replace{'gen_cmd_t'} = "gen_sts_cmd_t"; my $r_pass_args = make_args($r_cmd_args);
$replace{'GEN_CMD'} = "GEN_STS_CMD\n"; $replace{'assign_state'} = $r_pass_args =~ s/([^,]+), /cmd->$1 = $1\;\n/gr;
$replace{'gen_cmd'} = "&cmd->gen.gen";
} else {
$replace{'gen_cmd_t'} = "gen_cmd_t";
$replace{'GEN_CMD'} = "GEN_CMD\n";
$replace{'gen_cmd'} = "&cmd->gen";
}
$replace{'checked'} = '0'; $replace{'checked'} = '0';
$template = "CALLBACK"; $template = "CALLBACK";
} elsif ($cmd_type eq "void ") { } else {
$pass_args = make_args($cmd_args);
if ($cmd_type eq "void ") {
$template = "REGULAR_VOID"; $template = "REGULAR_VOID";
} else { } else {
$template = "REGULAR"; $template = "REGULAR";
$replace{'print_fmt_ret'} = type_to_format($cmd_type); $replace{'print_fmt_ret'} = type_to_format($cmd_type);
$replace{'print_pass_ret'} = "rv"; $replace{'print_pass_ret'} = "rv";
} }
}
$replace{'decl_args'} = $cmd_args; $replace{'decl_args'} = $cmd_args;
$replace{'print_pass_args'} = $replace{'pass_args'} = make_args($cmd_args); $replace{'print_pass_args'} = $replace{'pass_args'} = $pass_args;
$replace{'print_fmt_args'} = make_format($cmd_args); $replace{'print_fmt_args'} = make_format($cmd_args);
} }
for (keys %defines) { for (keys %defines) {