Skip to content

Log parse support for FTDC binary logs #341

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kelvin-cao merged 1 commit into from
Mar 20, 2025
Merged

Log parse support for FTDC binary logs #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion cli/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1130,6 +1130,7 @@ static int log_parse(int argc, char **argv)
const struct argconfig_choice log_types[] = {
{"APP", SWITCHTEC_LOG_PARSE_TYPE_APP, "app log"},
{"MAILBOX", SWITCHTEC_LOG_PARSE_TYPE_MAILBOX, "mailbox log"},
{"FTDC", SWITCHTEC_LOG_PARSE_TYPE_FTDC, "ftdc"},
{}
};
const struct argconfig_choice device_gen[] = {
Expand Down Expand Up @@ -1208,7 +1209,7 @@ static int log_parse(int argc, char **argv)
fprintf(stderr, "\nParsed log saved to %s.\n",
cfg.parsed_log_filename);

if (info.version_mismatch) {
if (info.version_mismatch && cfg.log_type != SWITCHTEC_LOG_PARSE_TYPE_FTDC) {
fprintf(stderr, "\nWARNING: The two input files have different version numbers.\n");
fprintf(stderr, "\t\tFW Version\tSDK Version\n");
fprintf(stderr, "Log file:\t0x%08x\t0x%08x\n",
Expand Down
3 changes: 2 additions & 1 deletion inc/switchtec/switchtec.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,8 @@ enum switchtec_log_type {
*/
enum switchtec_log_parse_type {
SWITCHTEC_LOG_PARSE_TYPE_APP,
SWITCHTEC_LOG_PARSE_TYPE_MAILBOX
SWITCHTEC_LOG_PARSE_TYPE_MAILBOX,
SWITCHTEC_LOG_PARSE_TYPE_FTDC
};

/**
Expand Down
52 changes: 41 additions & 11 deletions lib/switchtec.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ static int write_parsed_log(struct log_a_data log_data[],
struct module_log_defs *mod_defs;

if (entry_idx == 0) {
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP)
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP || log_type == SWITCHTEC_LOG_PARSE_TYPE_FTDC)
fputs(" #|Timestamp |Module |Severity |Event ID |Event\n",
log_file);
else
Expand All @@ -1094,7 +1094,7 @@ static int write_parsed_log(struct log_a_data log_data[],
hours = time % 24;
days = time / 24;

if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP) {
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP || log_type == SWITCHTEC_LOG_PARSE_TYPE_FTDC) {
/*
* app log: module ID and log severity are in the 3rd
* DWord
Expand Down Expand Up @@ -1155,7 +1155,7 @@ static int write_parsed_log(struct log_a_data log_data[],
if (ret < 0)
goto ret_print_error;

if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP) {
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP || log_type == SWITCHTEC_LOG_PARSE_TYPE_FTDC) {
/* print the module name and log severity */
if (fprintf(log_file, "%-12s |%-8s |0x%04x |",
mod_defs->mod_name, log_sev_strs[log_sev],
Expand Down Expand Up @@ -1219,6 +1219,23 @@ static int parse_def_header(FILE *log_def_file, uint32_t *fw_version,
return 0;
}

static int append_ftdc_log_header(int fd, uint32_t sdk_def_version,
uint32_t fw_def_version)
{
int ret;
char hdr_str_fmt[] = "##########################################\n"
"## Parsed with FTDC log file from definition:\n"
"## FW def version %08x\n"
"## SDK def version %08x\n"
"##########################################\n\n";
char hdr_str[512];

snprintf(hdr_str, 512, hdr_str_fmt, fw_def_version, sdk_def_version);
ret = write(fd, hdr_str, strlen(hdr_str));

return ret;
}

static int append_log_header(int fd, uint32_t sdk_version,
uint32_t fw_version, int binary)
{
Expand Down Expand Up @@ -1562,20 +1579,28 @@ int switchtec_parse_log(FILE *bin_log_file, FILE *log_def_file,
memset(info, 0, sizeof(*info));

if ((log_type != SWITCHTEC_LOG_PARSE_TYPE_APP) &&
(log_type != SWITCHTEC_LOG_PARSE_TYPE_MAILBOX)) {
(log_type != SWITCHTEC_LOG_PARSE_TYPE_MAILBOX) &&
(log_type != SWITCHTEC_LOG_PARSE_TYPE_FTDC)) {
errno = EINVAL;
return -errno;
}

ret = parse_log_header(bin_log_file, &fw_version_log,
&sdk_version_log);
if (ret)
return ret;
if (log_type != SWITCHTEC_LOG_PARSE_TYPE_FTDC)
{
ret = parse_log_header(bin_log_file, &fw_version_log,
&sdk_version_log);
if (ret)
return ret;
}

ret = parse_def_header(log_def_file, &fw_version_def,
&sdk_version_def);
if (ret)
return ret;

if (log_type == SWITCHTEC_LOG_PARSE_TYPE_FTDC)
fw_version_log = 0;

if (log_type == SWITCHTEC_LOG_PARSE_TYPE_MAILBOX) {
fw_version_log = fw_version_def;
sdk_version_log = sdk_version_def;
Expand All @@ -1589,16 +1614,21 @@ int switchtec_parse_log(FILE *bin_log_file, FILE *log_def_file,
info->log_sdk_version = sdk_version_log;
}
/* read the log definition file into defs */
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP)
if (log_type == SWITCHTEC_LOG_PARSE_TYPE_APP || log_type == SWITCHTEC_LOG_PARSE_TYPE_FTDC)
ret = read_app_log_defs(log_def_file, &defs);
else
ret = read_mailbox_log_defs(log_def_file, &defs);

if (ret < 0)
return ret;

ret = append_log_header(fileno(parsed_log_file), sdk_version_log,
fw_version_log, 0);
if (log_type != SWITCHTEC_LOG_PARSE_TYPE_FTDC)
ret = append_log_header(fileno(parsed_log_file), sdk_version_log,
fw_version_log, 0);
else
ret = append_ftdc_log_header(fileno(parsed_log_file), sdk_version_def,
fw_version_def);

if (ret < 0)
return ret;

Expand Down