Styjun

I am trying to build an x86 program that reads a file into memory. It uses a few different syscalls, and messes with memory and such. There's a lot in there to figure out.

To simplify debugging and figuring this out, I wanted to add assert statements which, if there's a mismatch, it prints out a nice error message. This is the first step in learning assembly so I can print the numbers and strings that get placed on different registers and such after operations. Then I can print them out and debug them without any fancy tools.

Wondering if one could help me write an ASSERT AND PRINT in NASM for Mac x86-64. I have this so far:

%define a rdi
%define b rsi
%define c rdx
%define d r10
%define e r8
%define f r9
%define i rax

%define EXIT 0x2000001
%define EXIT_STATUS 0

%define READ 0x2000003 ; read
%define WRITE 0x2000004 ; write
%define OPEN 0x2000005 ; open(path, oflag)
%define CLOSE 0x2000006 ; CLOSE
%define MMAP 0x2000197 ; mmap(void *addr, size_t len, int prot, int flags, int fildes, off_t offset)

%define PROT_NONE 0x00 ; no permissions
%define PROT_READ 0x01 ; pages can be read
%define PROT_WRITE 0x02 ; pages can be written
%define PROT_EXEC 0x04 ; pages can be executed

%define MAP_SHARED 0x0001 ; share changes
%define MAP_PRIVATE 0x0002 ; changes are private
%define MAP_FIXED 0x0010 ; map addr must be exactly as requested
%define MAP_RENAME 0x0020 ; Sun: rename private pages to file
%define MAP_NORESERVE 0x0040 ; Sun: don't reserve needed swap area
%define MAP_INHERIT 0x0080 ; region is retained after exec
%define MAP_NOEXTEND 0x0100 ; for MAP_FILE, don't change file size
%define MAP_HASSEMAPHORE 0x0200 ; region may contain semaphores

;
; Assert equals.
;

%macro ASSERT 3
 cmp %1, %2
 jne prepare_error
prepare_error:
 push %3
 jmp throw_error
%endmacro

;
; Print to stdout.
;

%macro PRINT 1
 mov c, getLengthOf(%1) ; "rdx" stores the string length
 mov b, %1 ; "rsi" stores the byte string to be used
 mov a, 1 ; "rdi" tells where to write (stdout file descriptor: 1)
 mov i, WRITE ; syscall: write
 syscall
%endmacro

;
; Read file into memory.
;

start:
 ASSERT PROT_READ, 0x01, "Something wrong with PROT_READ"

 mov b, PROT_READ
 mov a, PROT_WRITE
 xor a, b

 mov f, 0
 mov e, -1
 mov d, MAP_PRIVATE
 mov c, a
 mov b, 500000
 mov a, 0
 mov i, MMAP
 syscall
 PRINT "mmap output "
 PRINT i ; check what's returned
 PRINT "n"
 mov e, i

 mov b, O_RDONLY
 mov a, "Makefile"
 mov i, OPEN
 syscall
 mov a, i

 mov b, e
 mov i, READ
 syscall

;
; Exit status
;

exit:
 mov a, EXIT_STATUS ; exit status
 mov i, EXIT ; syscall: exit
 syscall

throw_error:
 PRINT pop() ; print error or something
 jmp exit

mov rsi, "abcdefgh" is a mov-immediate of the string contents, not a pointer to it. It only exists as an immediate if you do that.

Your macro will need to switch to .rodata and back to put the string in memory; possibly you could turn it into a sequence of push-immediate onto the stack with NASM macros, but that sounds hard.

So you can use the usual msglen equ $ - msg to get the length. (Actually using NASM local labels so the macro doesn't create conflicts).

See NASM - Macro local label as parameter to another macro where I wrote basically this answer a couple weeks ago. But not exactly a duplicate because it didn't have the bug of using the string as an immediate.

Anyway, NASM has no support AFAIK for switching sections and then coming back to the current section, like GAS .pushsection. So we're stuck hard-coding section .text unless you want to add an optional parameter for section name.

 ; write(1, string, sizeof(stringarray))
 ; switches to SECTION .text regardless of previous section
 ; clobbers: RDI, RSI, RDX, RCX,R11 (by syscall itself)
 : output: RAX = bytes written, or -errno
%macro PRINT 1
section .rodata 
;; NASM macro-local labels
 %%str db %1 ; put the string in read-only memory
 %%strln equ $ - %%str ; current position - string start
section .text
 mov edx, %%strlen ; len
 lea rsi, [rel %%str] ; buf = the string. (RIP-relative for position-independent)
 mov edi, 1 ; fd = stdout
 mov eax, WRITE
 syscall
%endmacro

This doesn't attempt to combine duplicates of the same string. Using it many times with the same message will be inefficient. This doesn't matter for debugging.

I could have left your %defines for RDI, and let NASM optimize mov rdi, 1 (7 bytes) into mov edi, 1 (5 bytes). But YASM won't do that so it's better to make it explicit if you care about anyone building your code with YASM.

I used a RIP-relative LEA because that's the most efficient way to put a static address into a register in position-independent code. In Linux non-PIE executables, use mov esi, %%str (5 bytes and can run on any port, more than LEA). But on OS X, the base virtual address where an executable is mapped/loaded is always above 2^32, and you never want mov r64, imm64 with a 64-bit absolute address.

On Linux, where system-call numbers are small integers, you could use lea eax, [rdi-1 + WRITE] to do eax = SYS_write with a 3 byte instruction vs. 5 for mov.