libgdbr.h File Reference

#include <stdint.h>
#include "arch.h"
#include "rz_types_base.h"
#include "rz_socket.h"
#include "rz_th.h"

Go to the source code of this file.

Classes
struct	libgdbr_message_t
struct	libgdbr_stub_features_t
struct	libgdbr_stop_reason
struct	libgdbr_t

Macros
#define	MSG_OK   0
#define	MSG_NOT_SUPPORTED   -1
#define	MSG_ERROR_1   -2
#define	GDB_REMOTE_TYPE_GDB   0
#define	GDB_REMOTE_TYPE_LLDB   1
#define	GDB_MAX_PKTSZ   4

Typedefs
typedef struct libgdbr_message_t	libgdbr_message_t
typedef struct libgdbr_stub_features_t	libgdbr_stub_features_t
typedef struct libgdbr_stop_reason	libgdbr_stop_reason_t
typedef struct libgdbr_t	libgdbr_t

Functions
	RZ_PACKED (typedef struct libgdbr_fstat_t { unsigned dev;unsigned ino;unsigned mode;unsigned numlinks;unsigned uid;unsigned gid;unsigned rdev;uint64_t size;uint64_t blksize;uint64_t blocks;unsigned atime;unsigned mtime;unsigned ctime;}) libgdbr_fstat_t
int	gdbr_init (libgdbr_t *g, bool is_server)
	Function initializes the libgdbr lib. More...
bool	gdbr_set_architecture (libgdbr_t *g, int arch, int bits)
	Function initializes the architecture of the gdbsession. More...
char *	gdbr_get_reg_profile (int arch, int bits)
	Function get gdb registers profile based on arch and bits. More...
int	gdbr_set_reg_profile (libgdbr_t *g, const char *str)
	Function set the gdbr internal registers profile. More...
int	gdbr_cleanup (libgdbr_t *g)
	frees all buffers and cleans the libgdbr instance stuff More...

Macro Definition Documentation

GDB_MAX_PKTSZ

#define GDB_MAX_PKTSZ   4

Definition at line 21 of file libgdbr.h.

GDB_REMOTE_TYPE_GDB

#define GDB_REMOTE_TYPE_GDB   0

Definition at line 19 of file libgdbr.h.

GDB_REMOTE_TYPE_LLDB

#define GDB_REMOTE_TYPE_LLDB   1

Definition at line 20 of file libgdbr.h.

MSG_ERROR_1

#define MSG_ERROR_1   -2

Definition at line 17 of file libgdbr.h.

MSG_NOT_SUPPORTED

#define MSG_NOT_SUPPORTED   -1

Definition at line 16 of file libgdbr.h.

MSG_OK

#define MSG_OK   0

Definition at line 15 of file libgdbr.h.

Typedef Documentation

libgdbr_message_t

typedef struct libgdbr_message_t libgdbr_message_t

Structure that saves a gdb message

libgdbr_stop_reason_t

typedef struct libgdbr_stop_reason libgdbr_stop_reason_t

Stores information from the stop-reply packet (why target stopped)

libgdbr_stub_features_t

typedef struct libgdbr_stub_features_t libgdbr_stub_features_t

Structure that stores features supported

libgdbr_t

typedef struct libgdbr_t libgdbr_t

Core "object" that saves the instance of the lib

Function Documentation

gdbr_cleanup()

int gdbr_cleanup

(

libgdbr_t *

g

)

frees all buffers and cleans the libgdbr instance stuff

Returns

a failure code (currently -1) or 0 if call successfully

Definition at line 146 of file libgdbr.c.

                               {
    if (!g) {
        return -1;
    }
    RZ_FREE(g->data);
    g->send_len = 0;
    RZ_FREE(g->send_buff);
    RZ_FREE(g->read_buff);
    rz_socket_free(g->sock);
    rz_th_lock_free(g->gdbr_lock);
    return 0;
}

References g, RZ_FREE, rz_socket_free(), and rz_th_lock_free().

Referenced by __close(), and rz_core_rtr_gdb_run().

gdbr_get_reg_profile()

char* gdbr_get_reg_profile	(	int	arch,
		int	bits
	)

Function get gdb registers profile based on arch and bits.

Parameters

architecture

and bit size.

Returns

a failure code

Definition at line 76 of file libgdbr.c.

                                               {
    switch (arch) {
    case RZ_SYS_ARCH_X86:
        if (bits == 32) {
#include "reg/x86_32.h"
        } else if (bits == 64) {
#include "reg/x86_64.h"
        } else {
            eprintf("%s: unsupported x86 bits: %d\n", __func__, bits);
            return NULL;
        }
        break;
    case RZ_SYS_ARCH_ARM:
        if (bits == 32) {
#include "reg/arm32.h"
        } else if (bits == 64) {
#include "reg/arm64.h"
        } else {
            eprintf("%s: unsupported arm bits: %d\n", __func__, bits);
            return NULL;
        }
        break;
    case RZ_SYS_ARCH_SH:
#include "reg/sh.h"
        break;
    case RZ_SYS_ARCH_LM32:
#include "reg/lm32.h"
        break;
    case RZ_SYS_ARCH_RISCV:
        if (bits == 64) {
#include "reg/riscv64.h"
        } else {
            eprintf("%s: unsupported riscv bits: %d\n", __func__, bits);
            return NULL;
        }
        break;
    case RZ_SYS_ARCH_MIPS:
#include "reg/mips.h"
        break;
    case RZ_SYS_ARCH_AVR:
#include "reg/avr.h"
        break;
    case RZ_SYS_ARCH_V850:
#include "reg/v850.h"
        break;
    }
    return NULL;
}

References arch, bits(), eprintf, NULL, RZ_SYS_ARCH_ARM, RZ_SYS_ARCH_AVR, RZ_SYS_ARCH_LM32, RZ_SYS_ARCH_MIPS, RZ_SYS_ARCH_RISCV, RZ_SYS_ARCH_SH, RZ_SYS_ARCH_V850, and RZ_SYS_ARCH_X86.

Referenced by gdbr_set_architecture(), and rz_debug_gdb_reg_profile().

gdbr_init()

int gdbr_init	(	libgdbr_t *	g,
		bool	is_server
	)

Function initializes the libgdbr lib.

Returns

a failure code (currently -1) or 0 if call successfully

Definition at line 9 of file libgdbr.c.

                                            {
    if (!g) {
        return -1;
    }
    memset(g, 0, sizeof(libgdbr_t));
    g->no_ack = false;
    g->stub_features.extended_mode = -1;
    g->stub_features.pkt_sz = 64;
    g->stub_features.P = true;
    g->remote_file_fd = -1;
    g->is_server = is_server;
    g->send_max = 2500;
    g->send_buff = (char *)calloc(g->send_max, 1);
    g->page_size = 4096;
    g->num_retries = 40; // safe number, should be ~10 seconds
    if (!g->send_buff) {
        return -1;
    }
    g->send_len = 0;
    g->read_max = 4096;
    g->read_buff = (char *)calloc(g->read_max, 1);
    if (!g->read_buff) {
        RZ_FREE(g->send_buff);
        return -1;
    }
    g->sock = rz_socket_new(0);
    g->gdbr_lock = rz_th_lock_new(true);
    g->gdbr_lock_depth = 0;
    g->last_code = MSG_OK;
    g->connected = 0;
    g->data_len = 0;
    g->data_max = 4096;
    g->data = calloc(g->data_max, 1);
    if (!g->data) {
        RZ_FREE(g->send_buff);
        RZ_FREE(g->read_buff);
        return -1;
    }
    g->remote_type = GDB_REMOTE_TYPE_GDB;
    g->isbreaked = false;
    return 0;
}

References calloc(), g, GDB_REMOTE_TYPE_GDB, memset(), MSG_OK, RZ_FREE, rz_socket_new(), and rz_th_lock_new().

Referenced by __open(), and rz_core_rtr_gdb_run().

gdbr_set_architecture()

bool gdbr_set_architecture	(	libgdbr_t *	g,
		int	arch,
		int	bits
	)

Function initializes the architecture of the gdbsession.

Parameters

architecture

defines the architecure used (registersize, and such)

Returns

false on failure

Definition at line 52 of file libgdbr.c.

                                                             {
    if (!g) {
        return false;
    }
    if (g->target.valid && g->registers) {
        return true;
    }
 
    char *regprofile = gdbr_get_reg_profile(arch, bits);
    if (!regprofile) {
        eprintf("cannot find gdb reg_profile\n");
        return false;
    }
    if (!gdbr_set_reg_profile(g, regprofile)) {
        free(regprofile);
        return false;
    }
    g->target.arch = arch;
    g->target.bits = bits;
    g->target.valid = true;
 
    return true;
}

References arch, bits(), eprintf, free(), g, gdbr_get_reg_profile(), and gdbr_set_reg_profile().

Referenced by rz_core_rtr_gdb_run(), rz_debug_gdb_attach(), and rz_debug_gdb_reg_profile().

gdbr_set_reg_profile()

int gdbr_set_reg_profile	(	libgdbr_t *	g,
		const char *	str
	)

Function set the gdbr internal registers profile.

Parameters

registers

profile string which shares the same format as RzReg API

Returns

a failure code

Definition at line 125 of file libgdbr.c.

                                                        {
    if (!g || !str) {
        return -1;
    }
    gdb_reg_t *registers = arch_parse_reg_profile(str);
    if (!registers) {
        eprintf("cannot parse reg profile\n");
        return -1;
    }
    if (g->target.regprofile) {
        free(g->target.regprofile);
    }
    g->target.regprofile = strdup(str);
    if (g->registers) {
        free(g->registers);
    }
    g->registers = arch_parse_reg_profile(str);
 
    return 0;
}

References arch_parse_reg_profile(), eprintf, free(), g, cmd_descs_generate::str, and strdup().

Referenced by gdbr_set_architecture(), and rz_debug_gdb_set_reg_profile().

RZ_PACKED()

RZ_PACKED

(

typedef struct libgdbr_fstat_t { unsigned dev;unsigned ino;unsigned mode;unsigned numlinks;unsigned uid;unsigned gid;unsigned rdev;uint64_t size;uint64_t blksize;uint64_t blocks;unsigned atime;unsigned mtime;unsigned ctime;}

)

Structure for fstat data sent by gdb remote server

References blocks, and dev.