dbginfo.c File Reference

#include <rz_types.h>
#include <rz_bin.h>

Go to the source code of this file.

Macros
#define	CMP(x, y)   (x > y.address ? 1 : (x < y.address ? -1 : 0))

Functions
RZ_API void	rz_bin_source_line_info_builder_init (RzBinSourceLineInfoBuilder *builder)
RZ_API void	rz_bin_source_line_info_builder_fini (RzBinSourceLineInfoBuilder *builder)
RZ_API void	rz_bin_source_line_info_builder_push_sample (RzBinSourceLineInfoBuilder *builder, ut64 address, ut32 line, ut32 column, const char *file)
	Push a new sample into the builder. More...
static int	line_sample_cmp (const void *a, const void *b)
RZ_API RzBinSourceLineInfo *	rz_bin_source_line_info_builder_build_and_fini (RzBinSourceLineInfoBuilder *builder)
RZ_API void	rz_bin_source_line_info_free (RzBinSourceLineInfo *sli)
RZ_API const RzBinSourceLineSample *	rz_bin_source_line_info_get_first_at (const RzBinSourceLineInfo *sli, ut64 addr)
	Find the first sample that affects the given address. i.e. find the first sample with the highest address less or equal to addr. There may be more which can be retrieved by repeatedly calling rz_bin_source_line_info_get_next() until it returns NULL. More...
RZ_API const RzBinSourceLineSample *	rz_bin_source_line_info_get_next (const RzBinSourceLineInfo *sli, RZ_NONNULL const RzBinSourceLineSample *cur)
RZ_DEPRECATE RZ_API bool	rz_bin_addr2line (RzBin *bin, ut64 addr, char *file, int len, int *line)
RZ_DEPRECATE RZ_API char *	rz_bin_addr2text (RzBin *bin, ut64 addr, int origin)

Macro Definition Documentation

CMP

#define CMP	(		x,
			y
	)		(x > y.address ? 1 : (x < y.address ? -1 : 0))

Function Documentation

line_sample_cmp()

static int line_sample_cmp ( const void *  a, const void *  b  )

static

Definition at line 39 of file dbginfo.c.

                                                         {
    const RzBinSourceLineSample *sa = a;
    const RzBinSourceLineSample *sb = b;
    // first, sort by addr
    if (sa->address < sb->address) {
        return -1;
    }
    if (sa->address > sb->address) {
        return 1;
    }
    // closing samples are always equal (rest of their fields are ignored anyway)
    if (rz_bin_source_line_sample_is_closing(sa) && rz_bin_source_line_sample_is_closing(sb)) {
        return 0;
    }
    // push closing samples to the back, which is necessary to skip them during packing
    if (rz_bin_source_line_sample_is_closing(sa)) {
        return 1;
    }
    if (rz_bin_source_line_sample_is_closing(sb)) {
        return -1;
    }
    // then sort by line
    if (sa->line < sb->line) {
        return -1;
    }
    if (sa->line > sb->line) {
        return 1;
    }
    // then by column
    if (sa->column < sb->column) {
        return -1;
    }
    if (sa->column > sb->column) {
        return 1;
    }
    // and eventually by file because this is the most exponsive operation
    if (!sa->file && !sb->file) {
        return 0;
    }
    if (!sa->file) {
        return -1;
    }
    if (!sb->file) {
        return 1;
    }
    return strcmp(sa->file, sb->file);
}

References a, rz_bin_source_line_sample_t::address, b, rz_bin_source_line_sample_t::column, rz_bin_source_line_sample_t::file, rz_bin_source_line_sample_t::line, rz_bin_source_line_sample_is_closing(), and sb.

Referenced by rz_bin_source_line_info_builder_build_and_fini().

rz_bin_addr2line()

RZ_DEPRECATE RZ_API bool rz_bin_addr2line	(	RzBin *	bin,
		ut64	addr,
		char *	file,
		int	len,
		int *	line
	)

Definition at line 194 of file dbginfo.c.

                                                                                                 {
    rz_return_val_if_fail(bin, false);
    if (!bin->cur || !bin->cur->o || !bin->cur->o->lines) {
        return false;
    }
    const RzBinSourceLineSample *s = rz_bin_source_line_info_get_first_at(bin->cur->o->lines, addr);
    if (!s || s->address != addr) {
        // consider only exact matches, not inside of samples
        return false;
    }
    if (line) {
        *line = s->line;
    }
    if (file && len) {
        if (s->file) {
            rz_str_ncpy(file, s->file, len);
        } else {
            *file = 0;
        }
    }
    return false;
}

References addr, len, setup::line, rz_bin_source_line_info_get_first_at(), rz_return_val_if_fail, rz_str_ncpy(), and s.

Referenced by core_analysis_graph_label(), and step_line().

rz_bin_addr2text()

RZ_DEPRECATE RZ_API char* rz_bin_addr2text	(	RzBin *	bin,
		ut64	addr,
		int	origin
	)

Definition at line 217 of file dbginfo.c.

                                                                              {
    rz_return_val_if_fail(bin, NULL);
    if (!bin->cur || !bin->cur->o || !bin->cur->o->lines) {
        return NULL;
    }
    const RzBinSourceLineSample *s = rz_bin_source_line_info_get_first_at(bin->cur->o->lines, addr);
    if (s && s->address != addr) {
        // consider only exact matches, not inside of samples
        return NULL;
    }
    while (s && !s->file) {
        s = rz_bin_source_line_info_get_next(bin->cur->o->lines, s);
    }
    if (!s) {
        return NULL;
    }
    const char *file_nopath;
    if (origin > 1) {
        file_nopath = s->file;
    } else {
        file_nopath = strrchr(s->file, '/');
        if (file_nopath) {
            file_nopath++;
        } else {
            file_nopath = s->file;
        }
    }
    if (!s->line) {
        return strdup(file_nopath);
    }
    char *out = rz_file_slurp_line(s->file, s->line, 0);
    if (out) {
        rz_str_trim(out);
        if (origin) {
            char *res = rz_str_newf("%s:%d %s",
                file_nopath, s->line,
                out ? out : "");
            free(out);
            out = res;
        }
        return out;
    }
    return rz_str_newf("%s:%" PFMT32u, file_nopath, s->line);
}

References addr, free(), NULL, out, PFMT32u, rz_bin_source_line_info_get_first_at(), rz_bin_source_line_info_get_next(), rz_file_slurp_line(), rz_return_val_if_fail, rz_str_newf(), rz_str_trim(), s, and strdup().

Referenced by ds_print_dwarf(), and rabin_show_srcline().

rz_bin_source_line_info_builder_build_and_fini()

RZ_API RzBinSourceLineInfo* rz_bin_source_line_info_builder_build_and_fini

(

RzBinSourceLineInfoBuilder *

builder

)

Definition at line 87 of file dbginfo.c.

                                                                                                                {
    RzBinSourceLineInfo *r = RZ_NEW0(RzBinSourceLineInfo);
    if (!r) {
        goto err;
    }
    size_t initial_samples_count = rz_vector_len(&builder->samples); // final count may be less after removing unnecessary closing samples
    if (initial_samples_count) {
        r->samples = RZ_NEWS0(RzBinSourceLineSample, initial_samples_count);
        if (!r->samples) {
            goto err_r;
        }
 
        // samples should be built in flat RzVector to avoid excessive small mallocs,
        // for sorting we use a pvector with references into our flat vectors (after flushing them).
 
        RzPVector sorter;
        rz_pvector_init(&sorter, NULL);
        RzBinSourceLineSample *initial_samples = rz_vector_flush(&builder->samples);
        rz_pvector_reserve(&sorter, initial_samples_count);
        for (size_t i = 0; i < initial_samples_count; i++) {
            rz_pvector_push(&sorter, &initial_samples[i]);
        }
        rz_pvector_sort(&sorter, line_sample_cmp);
 
        r->samples_count = 0;
        for (size_t i = 0; i < initial_samples_count; i++) {
            RzBinSourceLineSample *new_sample = rz_pvector_at(&sorter, i);
            if (r->samples_count) {
                RzBinSourceLineSample *prev = &r->samples[r->samples_count - 1];
                if (prev->address == new_sample->address && rz_bin_source_line_sample_is_closing(new_sample)) {
                    // closing sample but there are others that are not closing so this is dropped
                    continue;
                }
            }
            r->samples[r->samples_count++] = *new_sample;
        }
        free(initial_samples); // all inner strings are moved already
        rz_pvector_fini(&sorter);
    }
    r->filename_pool = builder->filename_pool;
    // don't call regular fini on the builder because we moved its string pool!
    rz_vector_fini(&builder->samples);
    return r;
err_r:
    free(r);
err:
    rz_bin_source_line_info_builder_fini(builder);
    return NULL;
}

References rz_bin_source_line_sample_t::address, err, rz_bin_source_line_info_builder_t::filename_pool, free(), i, line_sample_cmp(), NULL, r, rz_bin_source_line_info_builder_fini(), rz_bin_source_line_sample_is_closing(), RZ_NEW0, RZ_NEWS0, rz_pvector_at(), rz_pvector_fini(), rz_pvector_init(), rz_pvector_push(), rz_pvector_reserve(), rz_pvector_sort(), rz_vector_fini(), rz_vector_flush(), rz_vector_len(), and rz_bin_source_line_info_builder_t::samples.

Referenced by lines(), and parse_line_raw().

rz_bin_source_line_info_builder_fini()

RZ_API void rz_bin_source_line_info_builder_fini

(

RzBinSourceLineInfoBuilder *

builder

)

Definition at line 14 of file dbginfo.c.

                                                                                      {
    rz_vector_fini(&builder->samples);
    rz_str_constpool_fini(&builder->filename_pool);
}

References rz_bin_source_line_info_builder_t::filename_pool, rz_str_constpool_fini(), rz_vector_fini(), and rz_bin_source_line_info_builder_t::samples.

Referenced by rz_bin_source_line_info_builder_build_and_fini().

rz_bin_source_line_info_builder_init()

RZ_API void rz_bin_source_line_info_builder_init

(

RzBinSourceLineInfoBuilder *

builder

)

Definition at line 9 of file dbginfo.c.

                                                                                      {
    rz_vector_init(&builder->samples, sizeof(RzBinSourceLineSample), NULL, NULL);
    rz_str_constpool_init(&builder->filename_pool);
}

References rz_bin_source_line_info_builder_t::filename_pool, NULL, rz_str_constpool_init(), rz_vector_init(), and rz_bin_source_line_info_builder_t::samples.

Referenced by lines(), and parse_line_raw().

rz_bin_source_line_info_builder_push_sample()

RZ_API void rz_bin_source_line_info_builder_push_sample	(	RzBinSourceLineInfoBuilder *	builder,
		ut64	address,
		ut32	line,
		ut32	column,
		const char *	file
	)

Push a new sample into the builder.

This function is used to continuously fill the builder with concrete samples of line info for a specific address, usually during parsing of debug info from a file. The samples may be pushed in any order and the builder will later take care of generating a valid RzBinSourceLineInfo from it.

Parameters

line	may be 0 or a positive line number, where 0 means that this entry closes the one before it. see also RzBinSourceLine.

Definition at line 28 of file dbginfo.c.

                                                                                                                                                     {
    RzBinSourceLineSample *sample = rz_vector_push(&builder->samples, NULL);
    if (!sample) {
        return;
    }
    sample->address = address;
    sample->line = line;
    sample->column = column;
    sample->file = file ? rz_str_constpool_get(&builder->filename_pool, file) : NULL;
}

References rz_bin_source_line_sample_t::address, rz_bin_source_line_sample_t::column, rz_bin_source_line_sample_t::file, rz_bin_source_line_info_builder_t::filename_pool, rz_bin_source_line_sample_t::line, setup::line, NULL, rz_str_constpool_get(), rz_vector_push(), and rz_bin_source_line_info_builder_t::samples.

Referenced by lines(), rz_bin_dwarf_line_op_run(), and store_line_sample().

rz_bin_source_line_info_free()

RZ_API void rz_bin_source_line_info_free

(

RzBinSourceLineInfo *

sli

)

Definition at line 137 of file dbginfo.c.

                                                                   {
    if (!sli) {
        return;
    }
    free(sli->samples);
    rz_str_constpool_fini(&sli->filename_pool);
    free(sli);
}

References rz_bin_source_line_info_t::filename_pool, free(), rz_str_constpool_fini(), and rz_bin_source_line_info_t::samples.

Referenced by rz_bin_dwarf_line_info_free(), and rz_bin_object_free().

rz_bin_source_line_info_get_first_at()

RZ_API const RzBinSourceLineSample* rz_bin_source_line_info_get_first_at	(	const RzBinSourceLineInfo *	sli,
		ut64	addr
	)

Find the first sample that affects the given address. i.e. find the first sample with the highest address less or equal to addr. There may be more which can be retrieved by repeatedly calling rz_bin_source_line_info_get_next() until it returns NULL.

Definition at line 151 of file dbginfo.c.

                                                                                                                    {
    if (!sli->samples_count) {
        return NULL;
    }
    size_t l;
#define CMP(x, y) (x > y.address ? 1 : (x < y.address ? -1 : 0))
    rz_array_upper_bound(sli->samples, sli->samples_count, addr, l, CMP);
#undef CMP
    if (!l) {
        return NULL;
    }
    l--;
    RzBinSourceLineSample *r = &sli->samples[l];
    if (r->address > addr || rz_bin_source_line_sample_is_closing(r)) {
        return NULL;
    }
    // walk back to the very first entry with this addr
    while (r > sli->samples) {
        if ((r - 1)->address == r->address) {
            r--;
        } else {
            break;
        }
    }
    return r;
}

References addr, CMP, NULL, r, rz_array_upper_bound, rz_bin_source_line_sample_is_closing(), rz_bin_source_line_info_t::samples, and rz_bin_source_line_info_t::samples_count.

Referenced by print_source_info(), rz_bin_addr2line(), and rz_bin_addr2text().

rz_bin_source_line_info_get_next()

RZ_API const RzBinSourceLineSample* rz_bin_source_line_info_get_next	(	const RzBinSourceLineInfo *	sli,
		RZ_NONNULL const RzBinSourceLineSample *	cur
	)

Parameters

cur	MUST be a pointer returned by either rz_bin_source_line_info_get_first_at() or rz_bin_source_line_info_get_next().

Returns

The next sample at the same address as cur or NULL if there is none.

Definition at line 182 of file dbginfo.c.

                                                                                                                                                  {
    rz_return_val_if_fail(sli && cur && cur >= sli->samples && cur < sli->samples + sli->samples_count, NULL);
    if (cur == sli->samples + sli->samples_count - 1) {
        return NULL;
    }
    const RzBinSourceLineSample *next = cur + 1;
    if (next->address != cur->address) {
        return NULL;
    }
    return next;
}

References rz_bin_source_line_sample_t::address, NULL, rz_return_val_if_fail, rz_bin_source_line_info_t::samples, and rz_bin_source_line_info_t::samples_count.

Referenced by print_source_info(), and rz_bin_addr2text().