Commit 30b80fd5 authored by Daniel P. Berrangé's avatar Daniel P. Berrangé Committed by Gerd Hoffmann
Browse files

ui: mix misleading comments & return types of VNC I/O helper methods 



While the QIOChannel APIs for reading/writing data return ssize_t, with negative
value indicating an error, the VNC code passes this return value through the
vnc_client_io_error() method. This detects the error condition, disconnects the
client and returns 0 to indicate error. Thus all the VNC helper methods should
return size_t (unsigned), and misleading comments which refer to the possibility
of negative return values need fixing.

Signed-off-by: default avatarDaniel P. Berrange <berrange@redhat.com>
Reviewed-by: default avatarDarren Kenny <darren.kenny@oracle.com>
Reviewed-by: default avatarMarc-André Lureau <marcandre.lureau@redhat.com>
Message-id: 20171218191228.31018-14-berrange@redhat.com
Signed-off-by: default avatarGerd Hoffmann <kraxel@redhat.com>
parent 6aa22a29

ui/vnc-auth-sasl.c

+4 −4
Original line number Diff line number Diff line
@@ -48,9 +48,9 @@ void vnc_sasl_client_cleanup(VncState *vs) 
}





long vnc_client_write_sasl(VncState *vs)

size_t vnc_client_write_sasl(VncState *vs)

{

    long ret;

    size_t ret;



    VNC_DEBUG("Write SASL: Pending output %p size %zd offset %zd "

              "Encoded: %p size %d offset %d\n",
@@ -106,9 +106,9 @@ long vnc_client_write_sasl(VncState *vs) 
}





long vnc_client_read_sasl(VncState *vs)

size_t vnc_client_read_sasl(VncState *vs)

{

    long ret;

    size_t ret;

    uint8_t encoded[4096];

    const char *decoded;

    unsigned int decodedLen;

ui/vnc-auth-sasl.h

+2 −2
Original line number Diff line number Diff line
@@ -65,8 +65,8 @@ struct VncDisplaySASL { 


void vnc_sasl_client_cleanup(VncState *vs);



long vnc_client_read_sasl(VncState *vs);

long vnc_client_write_sasl(VncState *vs);

size_t vnc_client_read_sasl(VncState *vs);

size_t vnc_client_write_sasl(VncState *vs);



void start_auth_sasl(VncState *vs);

ui/vnc.c

+15 −14
Original line number Diff line number Diff line
@@ -1272,7 +1272,7 @@ void vnc_disconnect_finish(VncState *vs) 
    g_free(vs);

}



ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp)

size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp)

{

    if (ret <= 0) {

        if (ret == 0) {
@@ -1315,9 +1315,9 @@ void vnc_client_error(VncState *vs) 
 *

 * Returns the number of bytes written, which may be less than

 * the requested 'datalen' if the socket would block. Returns

 * -1 on error, and disconnects the client socket.

 * 0 on I/O error, and disconnects the client socket.

 */

ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen)

size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen)

{

    Error *err = NULL;

    ssize_t ret;
@@ -1336,12 +1336,12 @@ ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen) 
 *

 * Returns the number of bytes written, which may be less than

 * the buffered output data if the socket would block.  Returns

 * -1 on error, and disconnects the client socket.

 * 0 on I/O error, and disconnects the client socket.

 */

static ssize_t vnc_client_write_plain(VncState *vs)

static size_t vnc_client_write_plain(VncState *vs)

{

    size_t offset;

    ssize_t ret;

    size_t ret;



#ifdef CONFIG_VNC_SASL

    VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
@@ -1442,9 +1442,9 @@ void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting) 
 *

 * Returns the number of bytes read, which may be less than

 * the requested 'datalen' if the socket would block. Returns

 * -1 on error, and disconnects the client socket.

 * 0 on I/O error or EOF, and disconnects the client socket.

 */

ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen)

size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen)

{

    ssize_t ret;

    Error *err = NULL;
@@ -1460,12 +1460,13 @@ ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen) 
 * when not using any SASL SSF encryption layers. Will read as much

 * data as possible without blocking.

 *

 * Returns the number of bytes read. Returns -1 on error, and

 * disconnects the client socket.

 * Returns the number of bytes read, which may be less than

 * the requested 'datalen' if the socket would block. Returns

 * 0 on I/O error or EOF, and disconnects the client socket.

 */

static ssize_t vnc_client_read_plain(VncState *vs)

static size_t vnc_client_read_plain(VncState *vs)

{

    ssize_t ret;

    size_t ret;

    VNC_DEBUG("Read plain %p size %zd offset %zd\n",

              vs->input.buffer, vs->input.capacity, vs->input.offset);

    buffer_reserve(&vs->input, 4096);
@@ -1491,7 +1492,7 @@ static void vnc_jobs_bh(void *opaque) 
 */

static int vnc_client_read(VncState *vs)

{

    ssize_t ret;

    size_t ret;



#ifdef CONFIG_VNC_SASL

    if (vs->sasl.conn && vs->sasl.runSSF)

ui/vnc.h

+3 −3
Original line number Diff line number Diff line
@@ -524,8 +524,8 @@ gboolean vnc_client_io(QIOChannel *ioc, 
                       GIOCondition condition,

                       void *opaque);



ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);

ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);

size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);

size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);



/* Protocol I/O functions */

void vnc_write(VncState *vs, const void *data, size_t len);
@@ -544,7 +544,7 @@ uint32_t read_u32(uint8_t *data, size_t offset); 


/* Protocol stage functions */

void vnc_client_error(VncState *vs);

ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);

size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);



void start_client_init(VncState *vs);

void start_auth_vnc(VncState *vs);