View source for Assembler Basics

[[Category:Assembly Language]]
When you program in [[Assembly Language|assembly language]], you're directly programming the "bare metal" hardware. This means that many of the compile-time and run-time checks, error messages, and diagnostics that are present in other languages are not available. The computer will follow your instructions exactly, even if they are completely wrong (like executing data), and when something goes wrong, your program won't terminate until it tries to do something that's not permitted, such as execute an invalid opcode or attempt to access a protected or unmapped region of memory. When that happens, the CPU will signal an exception, and in most cases the operating system will shut down the offending process.

== Format of an Assembly Language program ==

The traditional extension for assembly-language source files is <code>.s</code> (e.g., <code>example.s</code>), or <code>.S</code> for files that need to go through the C preprocessor (<code>cpp</code>).

An assembly-language program consists of:
# [[Symbol|Symbols]] that are constants which correspond to memory addresses, registers, or other values.
# Instructions - Mnemonics for an operations, each followed by zero or more arguments.
# Data - Values used by the program for things such as initial variable values and string or numeric constants.

Assembler '''directives''' are used to control the assembly of the code, by specifying output file sections (such as .text (machine code), .data (read/write data), or .rodata (read-only data/constants) in an ELF file) and data formats (such as word size for numeric values), and by defining macros.

Consider this x86_64 assembly language "Hello World" program:

 <font color="red">.text</font>
 <font color="red">.global</font>  <font color="blue">_start</font>
 
 <font color="blue">stdout</font> = <font color="orange">1</font>
 
 <font color="blue">_start:</font>
         <font color="green">mov</font>    $<font color="blue">len</font>,%<font color="blue">rdx</font>                       /* message length */
         <font color="green">mov</font>    $<font color="blue">msg</font>,%<font color="blue">rsi</font>                       /* message location */
         <font color="green">mov</font>    $<font color="blue">stdout</font>,%<font color="blue">rdi</font>                    /* file descriptor stdout */
         <font color="green">mov</font>    $<font color="orange">1</font>,%<font color="blue">rax</font>                         /* [[Syscalls|syscall]] sys_write */
         <font color="green">syscall</font>
 
         <font color="green">mov</font>    $<font color="orange">0</font>,%<font color="blue">rdi</font>                         /* exit status */
         <font color="green">mov</font>    $<font color="orange">60</font>,%<font color="blue">rax</font>                        /* syscall sys_exit */
         <font color="green">syscall</font>
 
 <font color="red">.rodata</font>
 
 <font color="blue">msg:</font>    <font color="red">.ascii</font>      <font color="orange">"Hello, world!\n"</font>
 <font color="red">.set</font> <font color="blue">len</font> , <font color="orange">. - msg</font>


In this program, which was written using GNU Assembler (gas) syntax, text is coloured according to its type:
* <font color="red">directives</font>
* <font color="green">instructions</font>
* <font color="blue">symbols</font>
* <font color="orange">expressions</font>
* <font color="black">other syntax elements, such as prefixes and delimiters</font>


In GNU assembler, a symbol may be set in one of three ways:
# Using the <code>.set</code> directive (in the example above, len line)
# Using an assignment using an equals sign (in the example above, stdout line), which the GNU assembler treats as an alternative syntax for the <code>.set</code> directive
# As a label (such as _start or msg in the example above). A label set in this way is identified by the trailing colon, and is set to the current memory location in the instruction or data sequence. Labels may be used for loading/storing information, or as the target of branches/jumps.


In the program above:
* .text is a directive (equivalent to the longer directive ".section .text") which specifies that the following instructions/data should be placed in the ".text" section of the output ELF file.
* .rodata is a similar directive which specifies that the following instructions/data should be placed in the .rodata section of the output ELF file. In the case of this program, they could alternately be placed in the .data section, which is for read-write data (data which is write-protected in memory), but .rodata was used because the string is not modified by the program (it's a constant).
* .global (or .globl) is a directive which makes the following symbol visible to the linker. Otherwise, symbols are normally lost by link time. In this case, the linker needs to know the value of the special symbol _start in order to know where execution is to begin in the program (which is not always at the start of the .text section).
* _start is a label which is equivalent to the memory location of the first instruction in the program.
* msg is a label which is equivalent to the memory location of the first byte of the string "Hello, World!\n"
* .set is a directive which sets a symbol (len) equal to the value of an expression (in this example, ". - msg" meaning the current memory location minus the value of the label "msg"). Note that the GNU assembler accepts <code>a=1</code> as equivalent to <code>.set a, 1</code> -- both are counted as directives regardless of the presence of the <code>.set</code> keyword.

Note that symbols are not variables - they are constants that are calculated at compile-time. However, they may contain an address at which a variable is stored.

Note also that the syntax will vary from assembler to assembler and from architecture to architecture.

== 6502 Assembly Language in the Emulator ==

The [[6502 Emulator]] provides a very simple assembler:
* Simple text-substitution macros can be defined with <code>define ''name'' ''value''</code> like this:
  define SCREEN $f000
* The DCB (Declare Constant Byte) directive can be used to create a group of bytes in memory. Byte values are comma-separated and may be double-quoted single printable characters (except space, double quote, or comma), decimal values, or hexadecimal values prefixed with $, like this:
  dcb 12,34,56
  dcb $33,$66,$CC,$FF
  dcb "A"
  dcb "T","e","s","t",$20,"4",".",0
* The current assembly pointer starts at $0600 and increments with output bytes; it can be changed with this syntax:
  *=$0800

To create an assembly language program in the emulator, simply type or paste the code in the text area and hit Assemble. If no error messages are output, the Run button will be enabled, and pressing that will run your code. To save your code, copy and paste it from the text area into an editor.

== Assembly Language on a Linux System ==

On a Linux system, you will need to meet three requirements to get your assembly language program to work:
# Code must be placed in the <code>.text</code> section of the ELF file.
# Data must be placed in either the <code>.rodata</code> (read-only data) or <code>.data</code> (read/write data) sections of the ELF file.
# There must be a globally-defined symbol which the linker (<code>ld</code>) will use to find the entry point to your program. If the code is being directly compiled by the assembler, this symbol must be <code>_start</code> -- but if the code is being compiled by gcc, this symbol must be called <code>main</code> (a preamble will be located at <code>_start</code> which will then transfer control to <code>main</code>).

The file extension should be <code>.s</code> for assembler source without directives (for compilation with the assembler) or <code>.S</code> for assembler with preprocessor directives (for compilation with gcc).

=== Compiling an Assembly Language Program using the GNU Assembler ===

# Run the assembler: <code>as -g -o ''test''.o ''test''.s</code>
# Run the linker: <code>ld -o ''test'' ''test''.o</code>

Note that the <code>-g</code> option assembles the program with symbolic debugging information included.

=== Compiling an Assembly Language Program using the NASM Assembler ===

# Run the assembler: <code>nasm -g -f elf64 -o ''test''.o ''test''.s</code>
# Run the linker: <code>ld -o ''test'' ''test''.o</code>

Notes:
# NASM only works with x86 code.
# The source file must be written using NASM syntax (which is substantially different from the GNU assembler syntax).
# The <code>-f elf64</code> option instructs NASM to assemble the code for a 64-bit target (x86_64).
# The <code>-g</code> option assembles the program with symbolic debugging information included.

=== Compiling an Assembly Language program using GCC ===

# Run the preprocessor, assembler, and linker using the gcc command: <code>gcc -g -o ''test''.o ''test''.S</code>

Note that the <code>-g</code> option assembles the program with symbolic debugging information included, and that the normal GCC optimization options are not available.

=== Instruction Set Architecture Information ===

To get started with specific [[Instruction Set Architecture|instruction set architectures]], see:
* [[x86_64 Register and Instruction Quick Start]]
* [[aarch64 Register and Instruction Quick Start]]

=== Resources ===

* [https://sourceware.org/binutils/docs/as/ Using as, The GNU Assembler] (GAS manual)