Skip to content

pttc: Add support for nasm assembler #120

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

Open
yktyagi wants to merge 1 commit into
base: stable/v2.2
Choose a base branch
from
Open

pttc: Add support for nasm assembler #120

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
6 changes: 3 additions & 3 deletions doc/howto_pttc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Testing the Intel(R) Processor Trace (Intel PT) Decoder Library and Samples {#pt
!-->

This chapter documents how to use the pttc tool to generate and run tests.
Pttc takes a yasm assembly file and creates a Processor Trace stream from
Pttc takes a nasm assembly file and creates a Processor Trace stream from
special directives in its input.


Expand All @@ -49,7 +49,7 @@ directory:
file-<tool>.exp
file-<src>.sb

The `.lst` and `.bin` files are generated by a call to yasm. The `.pt` file
The `.lst` and `.bin` files are generated by a call to nasm. The `.pt` file
contains the Processor Trace and the `.exp` files contain the content of the
comments after the `.exp` directive for tool `<tool>` (see below). The `.sb`
files contain sideband infomrmation from source `<src>` (see below).
Expand All @@ -60,7 +60,7 @@ Pttc prints the filenames of the generated `.exp` and `.sb` files to stdout.
Syntax
------

Pttc allows annotations in the comments of yasm assembler source files. The
Pttc allows annotations in the comments of nasm assembler source files. The
parser recognizes all comments that contain the `@pt` directive marker.

Every pt directive can be preceded by a label name followed by a colon (`:`).
Expand Down
63 changes: 53 additions & 10 deletions pttc/src/yasm.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ static int lookup_section_vstart(struct label *l, char *line,
}

static const char key_section[] = "[section";
static const char key_org[] = "[org";
static const char *key_org[] = {"[org", "org", NULL};

int parse_yasm_labels(struct label *l, const struct text *t)
{
Expand Down Expand Up @@ -192,12 +192,33 @@ int parse_yasm_labels(struct label *l, const struct text *t)
continue;
}

tmp = strstr(line, key_org);
if (tmp) {
/* Try both yasm format "[org" and nasm format "org" */
tmp = NULL;
int org_style = -1;
for (int j = 0; key_org[j] != NULL; j++) {
tmp = strstr(line, key_org[j]);
if (tmp) {
org_style = j;
break;
}
}

if (tmp && org_style >= 0) {
char *org;

org = tmp + sizeof(key_org) - 1;
tmp = strstr(org, "]");
org = tmp + strlen(key_org[org_style]);
/* For yasm format "[org", look for ] */
if (org_style == 0) {
tmp = strstr(org, "]");
} else {
/* For nasm, skip whitespace to find hex value */
while (isspace(*org))
org++;
tmp = org;
/* Find end of hex number */
while (*tmp && !isspace(*tmp))
tmp++;
}
if (!tmp)
return -err_no_org_directive;

Expand Down Expand Up @@ -720,18 +741,17 @@ struct yasm *yasm_alloc(const char *pttfile)
static int yasm_run(struct yasm *y)
{
char *argv[] = {
"yasm",
"nasm",
"<pttfile>",
"-f", "bin",
"-o", "<binfile>",
"-L", "nasm",
"-l", "<lstfile>",
NULL,
};

argv[1] = y->pttfile;
argv[5] = y->binfile;
argv[9] = y->lstfile;
argv[7] = y->lstfile;

return run(argv[0], argv);
}
Expand Down Expand Up @@ -825,9 +845,32 @@ static int yasm_advance_next_line(struct yasm *y)
/* if line number or increment in the previous line
* directive is <= 0, the current lst line has no
* corresponding line in the source file.
*
* For nasm compatibility: if no %line directives have been
* seen yet, assume 1:1 mapping with source file.
*/
if (y->st_asm->n <= 0 || y->st_asm->inc <= 0)
continue;
if (y->st_asm->n <= 0 || y->st_asm->inc <= 0) {
/* If we haven't seen any %line directive, try to use
* the source file directly with 1:1 line mapping.
*/
if (!y->st_asm->filename || y->st_asm->filename[0] == '\0') {
/* Set to source .ptt file for first time */
st_set_file(y->st_asm, y->pttfile, 1, 1);
}

/* Calculate source line from listing line for nasm */
asm_line = (int)y->lst_curr_line;

/* Read from source file at same line number */
errcode = fl_getline(y->fl, s, (size_t) sizeof(s),
y->st_asm->filename,
(size_t) asm_line - 1u);
if (errcode < 0)
continue; /* Skip if can't read source line */

errcode = st_update(y->st_asm, s);
break;
}

/* finally the current line in the lst file can be
* correlated to the source file, so we retrieve the
Expand Down