Skip to content

Commit

Permalink
Improves formatting and naming convention.
Browse files Browse the repository at this point in the history 
Adds more test cases to check validate/encode functions.
  • Loading branch information
@shivmgg
shivmgg committed Jul 9, 2018
1 parent acc9d98 commit b67a8c0
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 66 deletions.
31 changes: 19 additions & 12 deletions src/libosd/gdbserver-private.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,31 @@

/**
* Return packet-data from the received data buffer by validating the checksum
*
* It calculates the checksum of the obtained packet-data and compares it with
* the obtained checksum. This function ensures that the received packet-data
* is valid and uncorrupted.
* Refer https://sourceware.org/gdb/onlinedocs/gdb/Overview.html#Overview
*
* @param buf_p the pointer to the received packet buffer data
* @param ver_checksum '1' indicates valid checksum
* @param len the length of the packet-data
* @param buffer the packet-data received
* @param packet_buffer the pointer to the received packet buffer data
* @param packet_len the length of th packet buffer
* @param packet_data_len the length of the packet-data
* @param packet_data the packet-data received
*
*/
osd_result validate_rsp_packet(char *buf_p, bool *ver_checksum, int *len,
char *buffer);

bool validate_rsp_packet(char *packet_buffer, int packet_len,
int *packet_data_len, char *packet_data);

/**
* Set packet-data into the RSP format: $packet-data#checksum
*
* Refer https://sourceware.org/gdb/onlinedocs/gdb/Overview.html#Overview
*
* @param buffer the packet-data buffer
* @param len the length of the packet-data
* @param packet_buffer the packet buffer in RSP format
* @param packet_data the packet-data buffer
* @param packet_data_len the length of the packet-data
* @param packet_buffer the packet buffer in RSP format
*/
osd_result configure_rsp_packet(char *buffer, int len, char *packet_buffer);

osd_result encode_rsp_packet(char *packet_data, int packet_data_len,
char *packet_buffer);

#endif // OSD_GDBSERVER_PRIVATE_H
79 changes: 42 additions & 37 deletions src/libosd/gdbserver.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@
*/

#include <osd/gdbserver.h>
#include "gdbserver-private.h"
#include <osd/module.h>
#include <osd/osd.h>
#include <osd/reg.h>
#include "gdbserver-private.h"
#include "osd-private.h"

#include <arpa/inet.h>
Expand Down Expand Up @@ -250,19 +250,19 @@ static osd_result get_char(struct osd_gdbserver_ctx *ctx, int *ch)
return OSD_OK;
}

//API_EXPORT
osd_result validate_rsp_packet(char *buf_p, bool *ver_checksum, int *len,
char *buffer)
API_EXPORT
bool validate_rsp_packet(char *packet_buffer, int packet_len,
int *packet_data_len, char *packet_data)
{
unsigned char val_checksum = 0;
char packet_checksum[3];
int packet_char;
int cnt = 0;
char *buf = buf_p;
char *buf = packet_buffer;

// packet-format: $packet-data#checksum
// traversing through the obtained packet till we obtained '#'
while (1) {
while (packet_len >= 2) {
packet_char = *buf++;

if (packet_char == '#') {
Expand All @@ -272,30 +272,33 @@ osd_result validate_rsp_packet(char *buf_p, bool *ver_checksum, int *len,
* character followed by the original character XORed with 0x20.
*/
if (packet_char == '}') {
val_checksum += packet_char & 0xff;
val_checksum += packet_char;
packet_char = *buf++;
val_checksum += packet_char & 0xff;
buffer[cnt++] = (packet_char ^ 0x20) & 0xff;
packet_len--;
val_checksum += packet_char;
packet_data[cnt++] = (packet_char ^ 0x20);
} else {
val_checksum += packet_char & 0xff;
buffer[cnt++] = packet_char & 0xff;
val_checksum += packet_char;
packet_data[cnt++] = packet_char;
}
packet_len--;
}

buffer[cnt] = '\0';
*len = cnt;
packet_char = *buf++;
packet_checksum[0] = packet_char;
packet_char = *buf;
packet_checksum[1] = packet_char;
packet_checksum[2] = 0;
*ver_checksum = (val_checksum == strtoul(packet_checksum, NULL, 16));

return OSD_OK;
packet_data[cnt] = '\0';
*packet_data_len = cnt;
bool ver_checksum = (val_checksum == strtoul(packet_checksum, NULL, 16));

return ver_checksum;
}

static osd_result receive_rsp_packet(struct osd_gdbserver_ctx *ctx,
char *buffer, int *len)
int *packet_data_len, char *packet_data)
{
int packet_char;
osd_result rv;
Expand All @@ -307,34 +310,36 @@ static osd_result receive_rsp_packet(struct osd_gdbserver_ctx *ctx,
}
} while (packet_char != '$');

bool ver_checksum = 0;
rv = validate_rsp_packet(ctx->buf_p, &ver_checksum, len, buffer);
char *packet_buffer = ctx->buf_p;
int packet_len = ctx->buf_cnt;
bool ver_checksum = validate_rsp_packet(packet_buffer, packet_len,
packet_data_len, packet_data);

if (ver_checksum == 1) {
rv = osd_gdbserver_write_data(ctx, "+", 1);
} else {
rv = osd_gdbserver_write_data(ctx, "-", 1);
}
if (OSD_FAILED(rv)) {
return rv;
} else {
if (ver_checksum == 1) {
rv = osd_gdbserver_write_data(ctx, "+", 1);
} else {
rv = osd_gdbserver_write_data(ctx, "-", 1);
}
if (OSD_FAILED(rv)) {
return rv;
}
}

return OSD_OK;
}

API_EXPORT
osd_result configure_rsp_packet(char *buffer, int len, char *packet_buffer)
osd_result encode_rsp_packet(char *packet_data, int packet_data_len,
char *packet_buffer)
{
int packet_checksum = 0;
packet_buffer[0] = '$';
memcpy(packet_buffer + 1, buffer, len);
int j = len + 1;

memcpy(packet_buffer + 1, packet_data, packet_data_len);
int j = packet_data_len + 1;

packet_buffer[j++] = '#';
for (int i = 0; i < len; i++) {
packet_checksum += buffer[i];
for (int i = 0; i < packet_data_len; i++) {
packet_checksum += packet_data[i];
}
packet_buffer[j++] = dectohex((packet_checksum >> 4) & 0xf);
packet_buffer[j++] = dectohex(packet_checksum & 0xf);
Expand All @@ -343,16 +348,16 @@ osd_result configure_rsp_packet(char *buffer, int len, char *packet_buffer)
return OSD_OK;
}

static osd_result send_rsp_packet(struct osd_gdbserver_ctx *ctx, char *buffer,
int len)
static osd_result send_rsp_packet(struct osd_gdbserver_ctx *ctx,
char *packet_data, int packet_data_len)
{
char packet_buffer[len + 5];
char packet_buffer[packet_data_len + 5];
osd_result rv;

while (1) {
configure_rsp_packet(buffer, len, packet_buffer);
encode_rsp_packet(packet_data, packet_data_len, packet_buffer);

rv = osd_gdbserver_write_data(ctx, packet_buffer, len + 4);
rv = osd_gdbserver_write_data(ctx, packet_buffer, packet_data_len + 4);
if (OSD_FAILED(rv)) {
return OSD_ERROR_FAILURE;
}
Expand Down
62 changes: 45 additions & 17 deletions tests/unit/check_gdbserver.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,60 @@ const unsigned int target_subnet_addr = 0;
unsigned int mock_hostmod_diaddr;
unsigned int mock_scm_diaddr;

START_TEST(test_validate_rsp_packet)
START_TEST(test1_validate_rsp_packet)
{
osd_result rv;
char packet_buffer[12] = "swbreak#ef";
char *buf_p = "swbreak#ef";
bool ver_checksum;
int len;
char buffer[1024];
char *packet_buffer = "swbreak#ef";
int packet_len = 10;
char packet_data[1024];
int packet_data_len;
ver_checksum = validate_rsp_packet(packet_buffer, packet_len,
&packet_data_len, packet_data);
ck_assert_uint_eq(ver_checksum, 1);
ck_assert_uint_eq(packet_data_len, 7);
ck_assert_str_eq(packet_data, "swbreak");
}
END_TEST

rv = validate_rsp_packet(buf_p, &ver_checksum, &len, buffer);
ck_assert(OSD_SUCCEEDED(rv));
ck_assert_uint_eq(len, 7);
ck_assert_str_eq(buffer, "swbreak");
START_TEST(test2_validate_rsp_packet)
{
bool ver_checksum;
char *packet_buffer = "swbre}]ak#c9";
int packet_len = 11;
char packet_data[1024];
int packet_data_len;
ver_checksum = validate_rsp_packet(packet_buffer, packet_len,
&packet_data_len, packet_data);
ck_assert_uint_eq(ver_checksum, 1);
ck_assert_uint_eq(packet_data_len, 8);
ck_assert_str_eq(packet_data, "swbre}ak");
}
END_TEST

START_TEST(test_configure_rsp_packet)
START_TEST(test1_encode_rsp_packet)
{
char buffer[8] = "swbreak";
char packet_data[8] = "swbreak";
int packet_checksum;
int len = 7;
char packet_buffer[len + 5];
int packet_data_len = 7;
char packet_buffer[packet_data_len + 5];

configure_rsp_packet(buffer, len, packet_buffer);
encode_rsp_packet(packet_data, packet_data_len, packet_buffer);
ck_assert_str_eq(packet_buffer, "$swbreak#ef");
}
END_TEST

START_TEST(test2_encode_rsp_packet)
{
char packet_data[9] = "swbre:ak";
int packet_checksum;
int packet_data_len = 8;
char packet_buffer[packet_data_len + 5];

encode_rsp_packet(packet_data, packet_data_len, packet_buffer);
ck_assert_str_eq(packet_buffer, "$swbre:ak#29");
}
END_TEST

Suite *suite(void)
{
Suite *s;
Expand All @@ -67,8 +93,10 @@ Suite *suite(void)

tc_testing = tcase_create("Testing");

tcase_add_test(tc_testing, test_validate_rsp_packet);
tcase_add_test(tc_testing, test_configure_rsp_packet);
tcase_add_test(tc_testing, test1_validate_rsp_packet);
tcase_add_test(tc_testing, test2_validate_rsp_packet);
tcase_add_test(tc_testing, test1_encode_rsp_packet);
tcase_add_test(tc_testing, test2_encode_rsp_packet);
suite_add_tcase(s, tc_testing);

return s;
Expand Down

0 comments on commit b67a8c0

Please sign in to comment.