1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 17:38:00 +00:00

New Seat callback, seat_sent().

This is used to notify the Seat that some data has been cleared from
the backend's outgoing data buffer. In other words, it notifies the
Seat that it might be worth calling backend_sendbuffer() again.

We've never needed this before, because until now, Seats have always
been the 'main program' part of the application, meaning they were
also in control of the event loop. So they've been able to call
backend_sendbuffer() proactively, every time they go round the event
loop, instead of having to wait for a callback.

But now, the SSH proxy is the first example of a Seat without
privileged access to the event loop, so it has no way to find out that
the backend's sendbuffer has got smaller. And without that, it can't
pass that notification on to plug_sent, to unblock in turn whatever
the proxied connection might have been waiting to send.

In fact, before this commit, sshproxy.c never called plug_sent at all.
As a result, large data uploads over an SSH jump host would hang
forever as soon as the outgoing buffer filled up for the first time:
the main backend (to which sshproxy.c was acting as a Socket) would
carefully stop filling up the buffer, and then never receive the call
to plug_sent that would cause it to start again.

The new callback is ignored everywhere except in sshproxy.c. It might
be a good idea to remove backend_sendbuffer() entirely and convert all
previous uses of it into non-empty implementations of this callback,
so that we've only got one system; but for the moment, I haven't done
that.
This commit is contained in:
Simon Tatham 2021-06-27 13:52:48 +01:00
parent ff941299cf
commit 6246ff3f0a
24 changed files with 56 additions and 0 deletions

View File

@ -104,6 +104,7 @@ static void raw_sent(Plug *plug, size_t bufsize)
{ {
Raw *raw = container_of(plug, Raw, plug); Raw *raw = container_of(plug, Raw, plug);
raw->bufsize = bufsize; raw->bufsize = bufsize;
seat_sent(raw->seat, raw->bufsize);
} }
static const PlugVtable Raw_plugvt = { static const PlugVtable Raw_plugvt = {

View File

@ -116,6 +116,7 @@ static void rlogin_sent(Plug *plug, size_t bufsize)
{ {
Rlogin *rlogin = container_of(plug, Rlogin, plug); Rlogin *rlogin = container_of(plug, Rlogin, plug);
rlogin->bufsize = bufsize; rlogin->bufsize = bufsize;
seat_sent(rlogin->seat, rlogin->bufsize);
} }
static void rlogin_startup(Rlogin *rlogin, const char *ruser) static void rlogin_startup(Rlogin *rlogin, const char *ruser)

View File

@ -600,6 +600,7 @@ static void supdup_sent(Plug *plug, size_t bufsize)
{ {
Supdup *supdup = container_of(plug, Supdup, plug); Supdup *supdup = container_of(plug, Supdup, plug);
supdup->bufsize = bufsize; supdup->bufsize = bufsize;
seat_sent(supdup->seat, supdup->bufsize);
} }
static void supdup_send_36bits(Supdup *supdup, unsigned long long thirtysix) static void supdup_send_36bits(Supdup *supdup, unsigned long long thirtysix)

View File

@ -662,6 +662,7 @@ static void telnet_sent(Plug *plug, size_t bufsize)
{ {
Telnet *telnet = container_of(plug, Telnet, plug); Telnet *telnet = container_of(plug, Telnet, plug);
telnet->bufsize = bufsize; telnet->bufsize = bufsize;
seat_sent(telnet->seat, telnet->bufsize);
} }
static const PlugVtable Telnet_plugvt = { static const PlugVtable Telnet_plugvt = {

1
pscp.c
View File

@ -65,6 +65,7 @@ static bool pscp_eof(Seat *);
static const SeatVtable pscp_seat_vt = { static const SeatVtable pscp_seat_vt = {
.output = pscp_output, .output = pscp_output,
.eof = pscp_eof, .eof = pscp_eof,
.sent = nullseat_sent,
.get_userpass_input = filexfer_get_userpass_input, .get_userpass_input = filexfer_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

View File

@ -47,6 +47,7 @@ static bool psftp_eof(Seat *);
static const SeatVtable psftp_seat_vt = { static const SeatVtable psftp_seat_vt = {
.output = psftp_output, .output = psftp_output,
.eof = psftp_eof, .eof = psftp_eof,
.sent = nullseat_sent,
.get_userpass_input = filexfer_get_userpass_input, .get_userpass_input = filexfer_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

14
putty.h
View File

@ -886,6 +886,17 @@ struct SeatVtable {
*/ */
bool (*eof)(Seat *seat); bool (*eof)(Seat *seat);
/*
* Called by the back end to notify that the output backlog has
* changed size. A front end in control of the event loop won't
* necessarily need this (they can just keep checking it via
* backend_sendbuffer at every opportunity), but one buried in the
* depths of something else (like an SSH proxy) will need to be
* proactively notified that the amount of buffered data has
* become smaller.
*/
void (*sent)(Seat *seat, size_t new_sendbuffer);
/* /*
* Try to get answers from a set of interactive login prompts. The * Try to get answers from a set of interactive login prompts. The
* prompts are provided in 'p'; the bufchain 'input' holds the * prompts are provided in 'p'; the bufchain 'input' holds the
@ -1117,6 +1128,8 @@ static inline size_t seat_output(
{ return seat->vt->output(seat, err, data, len); } { return seat->vt->output(seat, err, data, len); }
static inline bool seat_eof(Seat *seat) static inline bool seat_eof(Seat *seat)
{ return seat->vt->eof(seat); } { return seat->vt->eof(seat); }
static inline void seat_sent(Seat *seat, size_t bufsize)
{ seat->vt->sent(seat, bufsize); }
static inline int seat_get_userpass_input( static inline int seat_get_userpass_input(
Seat *seat, prompts_t *p, bufchain *input) Seat *seat, prompts_t *p, bufchain *input)
{ return seat->vt->get_userpass_input(seat, p, input); } { return seat->vt->get_userpass_input(seat, p, input); }
@ -1190,6 +1203,7 @@ static inline size_t seat_stderr_pl(Seat *seat, ptrlen data)
size_t nullseat_output( size_t nullseat_output(
Seat *seat, bool is_stderr, const void *data, size_t len); Seat *seat, bool is_stderr, const void *data, size_t len);
bool nullseat_eof(Seat *seat); bool nullseat_eof(Seat *seat);
void nullseat_sent(Seat *seat, size_t bufsize);
int nullseat_get_userpass_input(Seat *seat, prompts_t *p, bufchain *input); int nullseat_get_userpass_input(Seat *seat, prompts_t *p, bufchain *input);
void nullseat_notify_remote_exit(Seat *seat); void nullseat_notify_remote_exit(Seat *seat);
void nullseat_notify_remote_disconnect(Seat *seat); void nullseat_notify_remote_disconnect(Seat *seat);

1
ssh.h
View File

@ -402,6 +402,7 @@ bool ssh_is_bare(Ssh *ssh);
/* Communications back to ssh.c from the BPP */ /* Communications back to ssh.c from the BPP */
void ssh_conn_processed_data(Ssh *ssh); void ssh_conn_processed_data(Ssh *ssh);
void ssh_sendbuffer_changed(Ssh *ssh);
void ssh_check_frozen(Ssh *ssh); void ssh_check_frozen(Ssh *ssh);
/* Functions to abort the connection, for various reasons. */ /* Functions to abort the connection, for various reasons. */

View File

@ -201,4 +201,6 @@ static void ssh2_bare_bpp_handle_output(BinaryPacketProtocol *bpp)
ssh2_bare_bpp_format_packet(s, pkt); ssh2_bare_bpp_format_packet(s, pkt);
ssh_free_pktout(pkt); ssh_free_pktout(pkt);
} }
ssh_sendbuffer_changed(bpp->ssh);
} }

View File

@ -376,6 +376,8 @@ static void ssh1_bpp_handle_output(BinaryPacketProtocol *bpp)
break; break;
} }
} }
ssh_sendbuffer_changed(bpp->ssh);
} }
static void ssh1_bpp_queue_disconnect(BinaryPacketProtocol *bpp, static void ssh1_bpp_queue_disconnect(BinaryPacketProtocol *bpp,

View File

@ -979,4 +979,6 @@ static void ssh2_bpp_handle_output(BinaryPacketProtocol *bpp)
ssh2_bpp_enable_pending_compression(s); ssh2_bpp_enable_pending_compression(s);
} }
} }
ssh_sendbuffer_changed(bpp->ssh);
} }

View File

@ -1157,6 +1157,7 @@ static size_t ssh2_try_send(struct ssh2_channel *c)
if (!bufsize && c->pending_eof) if (!bufsize && c->pending_eof)
ssh2_channel_try_eof(c); ssh2_channel_try_eof(c);
ssh_sendbuffer_changed(s->ppl.ssh);
return bufsize; return bufsize;
} }

View File

@ -107,6 +107,7 @@ static int server_confirm_weak_cached_hostkey(
static const SeatVtable server_seat_vt = { static const SeatVtable server_seat_vt = {
.output = nullseat_output, .output = nullseat_output,
.eof = nullseat_eof, .eof = nullseat_eof,
.sent = nullseat_sent,
.get_userpass_input = nullseat_get_userpass_input, .get_userpass_input = nullseat_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,
@ -187,6 +188,10 @@ LogContext *ssh_get_logctx(Ssh *ssh)
return srv->logctx; return srv->logctx;
} }
void ssh_sendbuffer_changed(Ssh *ssh)
{
}
void ssh_throttle_conn(Ssh *ssh, int adjust) void ssh_throttle_conn(Ssh *ssh, int adjust)
{ {
server *srv = container_of(ssh, server, ssh); server *srv = container_of(ssh, server, ssh);

View File

@ -186,6 +186,7 @@ static bool sesschan_get_window_pixel_size(Seat *seat, int *w, int *h);
static const SeatVtable sesschan_seat_vt = { static const SeatVtable sesschan_seat_vt = {
.output = sesschan_seat_output, .output = sesschan_seat_output,
.eof = sesschan_seat_eof, .eof = sesschan_seat_eof,
.sent = nullseat_sent,
.get_userpass_input = nullseat_get_userpass_input, .get_userpass_input = nullseat_get_userpass_input,
.notify_remote_exit = sesschan_notify_remote_exit, .notify_remote_exit = sesschan_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

View File

@ -640,6 +640,7 @@ static void ssh_sent(Plug *plug, size_t bufsize)
if (bufsize < SSH_MAX_BACKLOG) { if (bufsize < SSH_MAX_BACKLOG) {
ssh_throttle_all(ssh, false, bufsize); ssh_throttle_all(ssh, false, bufsize);
queue_idempotent_callback(&ssh->ic_out_raw); queue_idempotent_callback(&ssh->ic_out_raw);
ssh_sendbuffer_changed(ssh);
} }
} }
@ -1042,6 +1043,11 @@ static size_t ssh_sendbuffer(Backend *be)
return backlog; return backlog;
} }
void ssh_sendbuffer_changed(Ssh *ssh)
{
seat_sent(ssh->seat, ssh_sendbuffer(&ssh->backend));
}
/* /*
* Called to set the size of the window from SSH's POV. * Called to set the size of the window from SSH's POV.
*/ */

View File

@ -1484,6 +1484,7 @@ static void ssh2_transport_process_queue(PacketProtocolLayer *ppl)
* layer's outgoing queue on to our own. * layer's outgoing queue on to our own.
*/ */
pq_concatenate(s->ppl.out_pq, s->ppl.out_pq, &s->pq_out_higher); pq_concatenate(s->ppl.out_pq, s->ppl.out_pq, &s->pq_out_higher);
ssh_sendbuffer_changed(s->ppl.ssh);
/* /*
* Expect SSH2_MSG_NEWKEYS from server. * Expect SSH2_MSG_NEWKEYS from server.
@ -1620,6 +1621,7 @@ static void ssh2_transport_process_queue(PacketProtocolLayer *ppl)
/* Pass through outgoing packets from the higher layer. */ /* Pass through outgoing packets from the higher layer. */
pq_concatenate(s->ppl.out_pq, s->ppl.out_pq, &s->pq_out_higher); pq_concatenate(s->ppl.out_pq, s->ppl.out_pq, &s->pq_out_higher);
ssh_sendbuffer_changed(s->ppl.ssh);
/* Wait for either a KEXINIT, or something setting /* Wait for either a KEXINIT, or something setting
* s->rekey_class. This call to ssh2_transport_pop also has * s->rekey_class. This call to ssh2_transport_pop also has

View File

@ -258,6 +258,12 @@ static bool sshproxy_eof(Seat *seat)
return false; return false;
} }
static void sshproxy_sent(Seat *seat, size_t new_bufsize)
{
SshProxy *sp = container_of(seat, SshProxy, seat);
plug_sent(sp->plug, new_bufsize);
}
static void sshproxy_notify_remote_disconnect(Seat *seat) static void sshproxy_notify_remote_disconnect(Seat *seat)
{ {
SshProxy *sp = container_of(seat, SshProxy, seat); SshProxy *sp = container_of(seat, SshProxy, seat);
@ -415,6 +421,7 @@ static bool sshproxy_set_trust_status(Seat *seat, bool trusted)
static const SeatVtable SshProxy_seat_vt = { static const SeatVtable SshProxy_seat_vt = {
.output = sshproxy_output, .output = sshproxy_output,
.eof = sshproxy_eof, .eof = sshproxy_eof,
.sent = sshproxy_sent,
.get_userpass_input = sshproxy_get_userpass_input, .get_userpass_input = sshproxy_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = sshproxy_notify_remote_disconnect, .notify_remote_disconnect = sshproxy_notify_remote_disconnect,

View File

@ -389,6 +389,7 @@ static bool plink_seat_interactive(Seat *seat)
static const SeatVtable plink_seat_vt = { static const SeatVtable plink_seat_vt = {
.output = plink_output, .output = plink_output,
.eof = plink_eof, .eof = plink_eof,
.sent = nullseat_sent,
.get_userpass_input = plink_get_userpass_input, .get_userpass_input = plink_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

View File

@ -454,6 +454,7 @@ static void serial_try_write(Serial *serial)
bufchain_consume(&serial->output_data, ret); bufchain_consume(&serial->output_data, ret);
} }
seat_sent(serial->seat, bufchain_size(&serial->output_data));
serial_uxsel_setup(serial); serial_uxsel_setup(serial);
} }

View File

@ -389,6 +389,7 @@ static bool gtk_seat_get_cursor_position(Seat *seat, int *x, int *y);
static const SeatVtable gtk_seat_vt = { static const SeatVtable gtk_seat_vt = {
.output = gtk_seat_output, .output = gtk_seat_output,
.eof = gtk_seat_eof, .eof = gtk_seat_eof,
.sent = nullseat_sent,
.get_userpass_input = gtk_seat_get_userpass_input, .get_userpass_input = gtk_seat_get_userpass_input,
.notify_remote_exit = gtk_seat_notify_remote_exit, .notify_remote_exit = gtk_seat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

View File

@ -7,6 +7,7 @@
size_t nullseat_output( size_t nullseat_output(
Seat *seat, bool is_stderr, const void *data, size_t len) { return 0; } Seat *seat, bool is_stderr, const void *data, size_t len) { return 0; }
bool nullseat_eof(Seat *seat) { return true; } bool nullseat_eof(Seat *seat) { return true; }
void nullseat_sent(Seat *seat, size_t bufsize) {}
int nullseat_get_userpass_input( int nullseat_get_userpass_input(
Seat *seat, prompts_t *p, bufchain *input) { return 0; } Seat *seat, prompts_t *p, bufchain *input) { return 0; }
void nullseat_notify_remote_exit(Seat *seat) {} void nullseat_notify_remote_exit(Seat *seat) {}

View File

@ -83,6 +83,7 @@ static bool plink_seat_interactive(Seat *seat)
static const SeatVtable plink_seat_vt = { static const SeatVtable plink_seat_vt = {
.output = plink_output, .output = plink_output,
.eof = plink_eof, .eof = plink_eof,
.sent = nullseat_sent,
.get_userpass_input = plink_get_userpass_input, .get_userpass_input = plink_get_userpass_input,
.notify_remote_exit = nullseat_notify_remote_exit, .notify_remote_exit = nullseat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,

View File

@ -88,6 +88,7 @@ static void serial_sentdata(struct handle *h, size_t new_backlog, int err)
seat_connection_fatal(serial->seat, "%s", error_msg); seat_connection_fatal(serial->seat, "%s", error_msg);
} else { } else {
serial->bufsize = new_backlog; serial->bufsize = new_backlog;
seat_sent(serial->seat, serial->bufsize);
} }
} }

View File

@ -330,6 +330,7 @@ static bool win_seat_get_window_pixel_size(Seat *seat, int *x, int *y);
static const SeatVtable win_seat_vt = { static const SeatVtable win_seat_vt = {
.output = win_seat_output, .output = win_seat_output,
.eof = win_seat_eof, .eof = win_seat_eof,
.sent = nullseat_sent,
.get_userpass_input = win_seat_get_userpass_input, .get_userpass_input = win_seat_get_userpass_input,
.notify_remote_exit = win_seat_notify_remote_exit, .notify_remote_exit = win_seat_notify_remote_exit,
.notify_remote_disconnect = nullseat_notify_remote_disconnect, .notify_remote_disconnect = nullseat_notify_remote_disconnect,