pdb_downloader.c File Reference

#include <string.h>
#include <rz_util.h>
#include <rz_core.h>
#include <rz_windows.h>
#include <rz_socket.h>
#include "pdb_downloader.h"

Go to the source code of this file.

Functions
static bool	download_and_write (SPDBDownloaderOpt *opt, const char *file)
static char *	download (struct SPDBDownloader *pd)
void	init_pdb_downloader (SPDBDownloaderOpt *opt, SPDBDownloader *pd)
	initialization of pdb downloader by SPDBDownloaderOpt More...
void	deinit_pdb_downloader (SPDBDownloader *pd)
	deinitialization of PDB downloader More...
static bool	is_valid_guid (const char *guid)
RZ_API int	rz_bin_pdb_download (RZ_NONNULL RzBin *bin, RZ_NULLABLE PJ *pj, int isradjson, RZ_NONNULL SPDBOptions *options)
	Download PDB file for currently opened RzBin file. More...
RZ_API RZ_OWN char *	rz_bin_symserver_download (RZ_NONNULL const SPDBDownloaderOpt *options)
	downloads file from symbol server More...

Function Documentation

deinit_pdb_downloader()

void deinit_pdb_downloader

(

SPDBDownloader *

pd

)

deinitialization of PDB downloader

Parameters

pdb_downloader

PDB downloader that will be deinitialized

Definition at line 142 of file pdb_downloader.c.

                                               {
    RZ_FREE(pd->opt->dbg_file);
    RZ_FREE(pd->opt->guid);
    RZ_FREE(pd->opt->symbol_server);
    RZ_FREE(pd->opt->symbol_store_path);
    RZ_FREE(pd->opt);
    pd->download = 0;
}

References SPDBDownloaderOpt::dbg_file, SPDBDownloader::download, SPDBDownloaderOpt::guid, SPDBDownloader::opt, RZ_FREE, SPDBDownloaderOpt::symbol_server, and SPDBDownloaderOpt::symbol_store_path.

Referenced by rz_bin_symserver_download().

download()

static char* download ( struct SPDBDownloader *  pd )

static

Definition at line 59 of file pdb_downloader.c.

                                                 {
    SPDBDownloaderOpt *opt = pd->opt;
    bool downloaded = false;
 
    if (!opt->dbg_file || !*opt->dbg_file) {
        // no pdb debug file
        return NULL;
    }
 
    char *abspath_to_file = rz_str_newf("%s%s%s%s%s%s%s",
        opt->symbol_store_path, RZ_SYS_DIR,
        opt->dbg_file, RZ_SYS_DIR,
        opt->guid, RZ_SYS_DIR,
        opt->dbg_file);
 
    if (rz_file_exists(abspath_to_file)) {
        eprintf("File already downloaded.\n");
        return abspath_to_file;
    }
 
    if (opt->extract == 0) {
        char *extractor_cmd = NULL;
        char *archive_name = strdup(opt->dbg_file);
        archive_name[strlen(archive_name) - 1] = '_';
        char *abspath_to_archive = rz_str_newf("%s%s%s%s%s%s%s",
            opt->symbol_store_path, RZ_SYS_DIR,
            opt->dbg_file, RZ_SYS_DIR,
            opt->guid, RZ_SYS_DIR,
            archive_name);
        char *abspath_to_dir = rz_file_dirname(abspath_to_archive);
 
        eprintf("Attempting to download compressed pdb in %s\n", abspath_to_archive);
        downloaded = download_and_write(opt, archive_name);
 
        if (opt->extract > 0 && downloaded) {
            eprintf("Attempting to decompress pdb\n");
            if (!rz_bin_pdb_extract_in_folder(abspath_to_archive, abspath_to_dir)) {
                downloaded = false;
            }
            rz_file_rm(abspath_to_archive);
        }
        free(archive_name);
        free(abspath_to_dir);
        free(abspath_to_archive);
        free(extractor_cmd);
    }
    if (!downloaded) {
        eprintf("Falling back to uncompressed pdb\n");
        eprintf("Attempting to download uncompressed pdb in %s\n", abspath_to_file);
        downloaded = download_and_write(opt, opt->dbg_file);
        if (!downloaded) {
            RZ_FREE(abspath_to_file);
        }
    }
    return downloaded ? abspath_to_file : NULL;
}

References SPDBDownloaderOpt::dbg_file, download_and_write(), eprintf, SPDBDownloaderOpt::extract, free(), SPDBDownloaderOpt::guid, NULL, SPDBDownloader::opt, rz_bin_pdb_extract_in_folder(), rz_file_dirname(), rz_file_exists(), rz_file_rm(), RZ_FREE, rz_str_newf(), RZ_SYS_DIR, strdup(), and SPDBDownloaderOpt::symbol_store_path.

Referenced by init_pdb_downloader().

download_and_write()

static bool download_and_write ( SPDBDownloaderOpt *  opt, const char *  file  )

static

Definition at line 11 of file pdb_downloader.c.

                                                                         {
    char *dir = rz_str_newf("%s%s%s%s%s",
        opt->symbol_store_path, RZ_SYS_DIR,
        opt->dbg_file, RZ_SYS_DIR,
        opt->guid);
    if (!rz_sys_mkdirp(dir)) {
        free(dir);
        return false;
    }
    char *path = rz_str_newf("%s%s%s", dir, RZ_SYS_DIR, opt->dbg_file);
    if (rz_file_exists(path)) {
        free(dir);
        free(path);
        return true;
    }
    char *url = rz_str_newf("%s/%s/%s/%s", opt->symbol_server, opt->dbg_file, opt->guid, file);
#if __WINDOWS__
    if (rz_str_startswith(url, "\\\\")) { // Network path
        wchar_t *origin = rz_utf8_to_utf16(url);
        wchar_t *dest = rz_utf8_to_utf16(path);
        BOOL ret = CopyFileW(origin, dest, FALSE);
        free(dir);
        free(path);
        free(origin);
        free(dest);
        return ret;
    }
#endif
    int len;
    char *file_buf = rz_socket_http_get(url, NULL, &len);
    free(url);
    if (!len || RZ_STR_ISEMPTY(file_buf)) {
        free(dir);
        free(file_buf);
        free(path);
        return false;
    }
    FILE *f = fopen(path, "wb");
    if (f) {
        fwrite(file_buf, sizeof(char), (size_t)len, f);
        fclose(f);
    }
    free(dir);
    free(path);
    free(file_buf);
    return true;
}

References SPDBDownloaderOpt::dbg_file, dest, f, FALSE, benchmark::FILE, free(), SPDBDownloaderOpt::guid, len, NULL, path, rz_file_exists(), rz_socket_http_get(), RZ_STR_ISEMPTY, rz_str_newf(), rz_str_startswith(), RZ_SYS_DIR, rz_sys_mkdirp(), SPDBDownloaderOpt::symbol_server, SPDBDownloaderOpt::symbol_store_path, and setup::url.

Referenced by download().

init_pdb_downloader()

void init_pdb_downloader	(	SPDBDownloaderOpt *	opt,
		SPDBDownloader *	pd
	)

initialization of pdb downloader by SPDBDownloaderOpt

Parameters

opt	PDB options
pdb_downloader	PDB downloader that will be initialized

Definition at line 122 of file pdb_downloader.c.

                                                                     {
    pd->opt = RZ_NEW0(SPDBDownloaderOpt);
    if (!pd->opt) {
        pd->download = 0;
        eprintf("Cannot allocate memory for SPDBDownloaderOpt.\n");
        return;
    }
    pd->opt->dbg_file = strdup(opt->dbg_file);
    pd->opt->guid = strdup(opt->guid);
    pd->opt->symbol_server = strdup(opt->symbol_server);
    pd->opt->symbol_store_path = strdup(opt->symbol_store_path);
    pd->opt->extract = opt->extract;
    pd->download = download;
}

References SPDBDownloaderOpt::dbg_file, download(), SPDBDownloader::download, eprintf, SPDBDownloaderOpt::extract, SPDBDownloaderOpt::guid, SPDBDownloader::opt, RZ_NEW0, strdup(), SPDBDownloaderOpt::symbol_server, and SPDBDownloaderOpt::symbol_store_path.

Referenced by rz_bin_symserver_download().

is_valid_guid()

static bool is_valid_guid ( const char *  guid )

static

Definition at line 151 of file pdb_downloader.c.

                                            {
    if (!guid) {
        return false;
    }
    size_t i;
    for (i = 0; guid[i]; i++) {
        if (!isxdigit(guid[i])) {
            return false;
        }
    }
    return i >= 33; // len of GUID and age
}

References i, and isxdigit.

Referenced by rz_bin_pdb_download().

rz_bin_pdb_download()

RZ_API int rz_bin_pdb_download	(	RZ_NONNULL RzBin *	bin,
		RZ_NULLABLE PJ *	pj,
		int	isradjson,
		RZ_NONNULL SPDBOptions *	options
	)

Download PDB file for currently opened RzBin file.

Parameters

bin	RzBin instance
pj	Optional PJ instance for json output
isradjson	Use pj for json output
options	symbol server options for downloading the PDB file

Definition at line 171 of file pdb_downloader.c.

                                                                                                                          {
    rz_return_val_if_fail(bin && options, 1);
    SPDBDownloaderOpt opt;
    RzBinInfo *info = rz_bin_get_info(bin);
 
    if (!info || !info->debug_file_name) {
        RZ_LOG_ERROR("Can't find debug filename\n");
        return 1;
    }
 
    if (!is_valid_guid(info->guid)) {
        RZ_LOG_ERROR("Invalid GUID for file\n");
        return 1;
    }
 
    if (!options->symbol_server || !options->symbol_store_path) {
        RZ_LOG_ERROR("Can't retrieve pdb configurations\n");
        return 1;
    }
 
    opt.dbg_file = rz_file_dos_basename(info->debug_file_name);
    opt.guid = info->guid;
    opt.symbol_server = options->symbol_server;
    opt.symbol_store_path = options->symbol_store_path;
    opt.extract = options->extract;
 
    char *path = rz_bin_symserver_download(&opt);
 
    if (isradjson) {
        pj_ko(pj, "pdb");
        pj_ks(pj, "file", opt.dbg_file);
        pj_ks(pj, "guid", opt.guid);
        pj_ks(pj, "path", path);
        pj_kb(pj, "download", (bool)path);
        pj_end(pj);
    } else {
        rz_cons_printf("PDB \"%s\" download %s\n",
            opt.dbg_file, path ? "success" : "failed");
    }
    free(path);
    return !path;
}

References SPDBDownloaderOpt::dbg_file, rz_bin_info_t::debug_file_name, SPDBDownloaderOpt::extract, free(), SPDBDownloaderOpt::guid, rz_bin_info_t::guid, info(), is_valid_guid(), options, path, pj_end(), pj_kb(), pj_ko(), pj_ks(), rz_bin_get_info(), rz_bin_symserver_download(), rz_cons_printf(), rz_file_dos_basename(), RZ_LOG_ERROR, rz_return_val_if_fail, SPDBDownloaderOpt::symbol_server, and SPDBDownloaderOpt::symbol_store_path.

Referenced by download_pdb(), GetHeapGlobalsOffset(), rz_cmd_info_pdb_download_handler(), and rz_main_rz_bin().

rz_bin_symserver_download()

RZ_API RZ_OWN char* rz_bin_symserver_download

(

RZ_NONNULL const SPDBDownloaderOpt *

options

)

downloads file from symbol server

Parameters

options

options for downloading file

Returns

char* is the path that file was downloaded to or NULL in case of failure

Definition at line 219 of file pdb_downloader.c.

                                                                                           {
    rz_return_val_if_fail(options, NULL);
    SPDBDownloader downloader;
    SPDBDownloaderOpt opt = *options;
    char *path = NULL;
    char *symbol_server = strdup(options->symbol_server);
    char *server = strtok(symbol_server, ";");
    while (server && !path) {
        opt.symbol_server = server;
        init_pdb_downloader(&opt, &downloader);
        if (!downloader.download) {
            break;
        }
        path = downloader.download(&downloader);
        deinit_pdb_downloader(&downloader);
        server = strtok(NULL, ";");
    }
    free(symbol_server);
    return path;
}

References deinit_pdb_downloader(), SPDBDownloader::download, free(), init_pdb_downloader(), NULL, options, path, rz_return_val_if_fail, strdup(), and SPDBDownloaderOpt::symbol_server.

Referenced by rz_bin_pdb_download(), and winkd_download_module_and_pdb().