Read NASM documentation

[yaobinwen]

Description

I need to learn NASM to better program in the assembly language in order to learn how to build my own OS more easily.

The documentation is very large so I may not read every chapter the same carefully. For the chapters I may not use it for now, I'll just skim them.

• [x] Chatper 1: Introduction
  • [x] Section 1.1: What Is NASM?
    • [x] Section 1.1.1: License
  • [ ] Chatper 2: Running NASM
  • [ ] Section 2.1: NASM Command-Line Syntax
    • [ ] Section 2.1.1: The -o Option: Specifying the Output File Name
    • [ ] Section 2.1.2: The -f Option: Specifying the Output File Format
    • [ ] Section 2.1.3: The -l Option: Generating a Listing File
    • [ ] Section 2.1.4: The -L Option: Additional or Modified Listing Info
    • [ ] Section 2.1.5: The -M Option: Generate Makefile Dependencies
    • [ ] Section 2.1.6: The -MG Option: Generate Makefile Dependencies
    • [ ] Section 2.1.7: The -MF Option: Set Makefile Dependency File
    • [ ] Section 2.1.8: The -MD Option: Assemble and Generate Dependencies
    • [ ] Section 2.1.9: The -MT Option: Dependency Target Name
    • [ ] Section 2.1.10: The -MQ Option: Dependency Target Name (Quoted)
    • [ ] Section 2.1.11: The -MP Option: Emit phony targets
    • [ ] Section 2.1.12: The -MW Option: Watcom Make quoting style
    • [ ] Section 2.1.13: The -F Option: Selecting a Debug Information Format
    • [ ] Section 2.1.14: The -g Option: Enabling Debug Information.
    • [ ] Section 2.1.15: The -X Option: Selecting an Error Reporting Format
    • [ ] Section 2.1.16: The -Z Option: Send Errors to a File
    • [ ] Section 2.1.17: The -s Option: Send Errors to stdout
    • [ ] Section 2.1.18: The -i Option: Include File Search Directories
    • [ ] Section 2.1.19: The -p Option: Pre-Include a File
    • [ ] Section 2.1.20: The -d Option: Pre-Define a Macro
    • [ ] Section 2.1.21: The -u Option: Undefine a Macro
    • [ ] Section 2.1.22: The -E Option: Preprocess Only
    • [ ] Section 2.1.23: The -a Option: Don't Preprocess At All
    • [ ] Section 2.1.24: The -O Option: Specifying Multipass Optimization
    • [ ] Section 2.1.25: The -t Option: Enable TASM Compatibility Mode
    • [ ] Section 2.1.26: The -w and -W Options: Enable or Disable Assembly Warnings
    • [ ] Section 2.1.27: The -v Option: Display Version Info
    • [ ] Section 2.1.28: The --(g|l)prefix, --(g|l)postfix Options.
    • [ ] Section 2.1.29: The --pragma Option
    • [ ] Section 2.1.30: The --before Option
    • [ ] Section 2.1.31: The --limit-X Option
    • [ ] Section 2.1.32: The --keep-all Option
    • [ ] Section 2.1.33: The --no-line Option
    • [ ] Section 2.1.34: The --reproducible Option
    • [ ] Section 2.1.35: The NASMENV Environment Variable
  • [ ] Section 2.2: Quick Start for MASM Users
    • [ ] Section 2.2.1: NASM Is Case-Sensitive
    • [ ] Section 2.2.2: NASM Requires Square Brackets For Memory References
    • [ ] Section 2.2.3: NASM Doesn't Store Variable Types
    • [ ] Section 2.2.4: NASM Doesn't ASSUME
    • [ ] Section 2.2.5: NASM Doesn't Support Memory Models
    • [ ] Section 2.2.6: Floating-Point Differences
    • [ ] Section 2.2.7: Other Differences
    • [ ] Section 2.2.8: MASM compatibility package
  • [x] #214
  • [ ] #215
  • [ ] Section 4.1: Preprocessor Expansions
    • [ ] Section 4.1.1: Continuation Line Collapsing
    • [ ] Section 4.1.2: Comment Removal
    • [ ] Section 4.1.3: %line directives
    • [ ] Section 4.1.4: Conditionals, Loops and Multi-Line Macro Definitions
    • [ ] Section 4.1.5: Directives processing
    • [ ] Section 4.1.6: Inline expansions and other directives
    • [ ] Section 4.1.7: Multi-Line Macro Expansion
    • [ ] Section 4.1.8: Detokenization
  • [ ] Section 4.2: Single-Line Macros
    • [ ] Section 4.2.1: The Normal Way: %define
    • [ ] Section 4.2.2: Resolving %define: %xdefine
    • [ ] Section 4.2.3: Macro Indirection: %[...]
    • [ ] Section 4.2.4: Concatenating Single Line Macro Tokens: %+
    • [ ] Section 4.2.5: The Macro Name Itself: %? and %??
    • [ ] Section 4.2.6: The Single-Line Macro Name: %? and %??
    • [ ] Section 4.2.7: Undefining Single-Line Macros: %undef
    • [ ] Section 4.2.8: Preprocessor Variables: %assign
    • [ ] Section 4.2.9: Defining Strings: %defstr
    • [ ] Section 4.2.10: Defining Tokens: %deftok
    • [ ] Section 4.2.11: Defining Aliases: %defalias
    • [ ] Section 4.2.12: Conditional Comma Operator: %,
  • [ ] Section 4.3: String Manipulation in Macros
    • [ ] Section 4.3.1: Concatenating Strings: %strcat
    • [ ] Section 4.3.2: String Length: %strlen
    • [ ] Section 4.3.3: Extracting Substrings: %substr
  • [ ] Section 4.4: Preprocessor Functions
    • [ ] Section 4.4.1: %abs() Function
    • [ ] Section 4.4.2: %cond() Function
    • [ ] Section 4.4.3: %count() Function
    • [ ] Section 4.4.4: %eval() Function
    • [ ] Section 4.4.5: %is() Family Functions
    • [ ] Section 4.4.6: %num() Function
    • [ ] Section 4.4.7: %sel() Function
    • [ ] Section 4.4.8: %str() Function
    • [ ] Section 4.4.9: %strcat() Function
    • [ ] Section 4.4.10: %strlen() Function
    • [ ] Section 4.4.11: %substr() Function
    • [ ] Section 4.4.12: %tok() function
  • [ ] Section 4.5: Multi-Line Macros: %macro
    • [ ] Section 4.5.1: Overloading Multi-Line Macros
    • [ ] Section 4.5.2: Macro-Local Labels
    • [ ] Section 4.5.3: Greedy Macro Parameters
    • [ ] Section 4.5.4: Macro Parameters Range
    • [ ] Section 4.5.5: Default Macro Parameters
    • [ ] Section 4.5.6: %0: Macro Parameter Counter
    • [ ] Section 4.5.7: %00: Label Preceding Macro
    • [ ] Section 4.5.8: %rotate: Rotating Macro Parameters
    • [ ] Section 4.5.9: Concatenating Macro Parameters
    • [ ] Section 4.5.10: Condition Codes as Macro Parameters
    • [ ] Section 4.5.11: Disabling Listing Expansion
    • [ ] Section 4.5.12: Undefining Multi-Line Macros: %unmacro
  • [ ] Section 4.6: Conditional Assembly
    • [ ] Section 4.6.1: %ifdef: Testing Single-Line Macro Existence
    • [ ] Section 4.6.2: %ifmacro: Testing Multi-Line Macro Existence
    • [ ] Section 4.6.3: %ifctx: Testing the Context Stack
    • [ ] Section 4.6.4: %if: Testing Arbitrary Numeric Expressions
    • [ ] Section 4.6.5: %ifidn and %ifidni: Testing Exact Text Identity
    • [ ] Section 4.6.6: %ifid, %ifnum, %ifstr: Testing Token Types
    • [ ] Section 4.6.7: %iftoken: Test for a Single Token
    • [ ] Section 4.6.8: %ifempty: Test for Empty Expansion
    • [ ] Section 4.6.9: %ifenv: Test If Environment Variable Exists
  • [ ] Section 4.7: Preprocessor Loops: %rep
  • [ ] Section 4.8: Source Files and Dependencies
    • [ ] Section 4.8.1: %include: Including Other Files
    • [ ] Section 4.8.2: %pathsearch: Search the Include Path
    • [ ] Section 4.8.3: %depend: Add Dependent Files
    • [ ] Section 4.8.4: %use: Include Standard Macro Package
  • [ ] Section 4.9: The Context Stack
    • [ ] Section 4.9.1: %push and %pop: Creating and Removing Contexts
    • [ ] Section 4.9.2: Context-Local Labels
    • [ ] Section 4.9.3: Context-Local Single-Line Macros
    • [ ] Section 4.9.4: Context Fall-Through Lookup (deprecated)
    • [ ] Section 4.9.5: %repl: Renaming a Context
    • [ ] Section 4.9.6: Example Use of the Context Stack: Block IFs
  • [ ] Section 4.10: Stack Relative Preprocessor Directives
    • [ ] Section 4.10.1: %arg Directive
    • [ ] Section 4.10.2: %stacksize Directive
    • [ ] Section 4.10.3: %local Directive
  • [ ] Section 4.11: Reporting User-Defined Errors: %error, %warning, %fatal
  • [ ] Section 4.12: %pragma: Setting Options
    • [ ] Section 4.12.1: Preprocessor Pragmas
  • [ ] Section 4.13: Other Preprocessor Directives
    • [ ] Section 4.13.1: %line Directive
    • [ ] Section 4.13.2: %!variable: Read an Environment Variable.
    • [ ] Section 4.13.3: %clear: Clear All Macro Definitions

• [ ] Chatper 5: Standard Macros

  • [ ] Section 5.1: NASM Version Macros
    • [ ] Section 5.1.1: ?NASM_VERSION_ID?: NASM Version ID
    • [ ] Section 5.1.2: __?NASM_VER?__: NASM Version String
  • [ ] Section 5.2: ?FILE? and ?LINE?: File Name and Line Number
  • [ ] Section 5.3: ?BITS?: Current Code Generation Mode
  • [ ] Section 5.4: __?OUTPUT_FORMAT?__: Current Output Format
  • [ ] Section 5.5: __?DEBUG_FORMAT?__: Current Debug Format
  • [ ] Section 5.6: Assembly Date and Time Macros
  • [ ] Section 5.7: __?USE_package?__: Package Include Test
  • [ ] Section 5.8: ?PASS?: Assembly Pass
  • [ ] Section 5.9: Structure Data Types
    • [ ] Section 5.9.1: STRUC and ENDSTRUC: Declaring Structure Data Types
    • [ ] Section 5.9.2: ISTRUC, AT and IEND: Declaring Instances of Structures
  • [ ] Section 5.10: Alignment Control
    • [ ] Section 5.10.1: ALIGN and ALIGNB: Code and Data Alignment
    • [ ] Section 5.10.2: SECTALIGN: - [ ] Section Alignment

• [ ] Chatper 6: Standard Macro Packages

  • [ ] Section 6.1: altreg: Alternate Register Names
  • [ ] Section 6.2: smartalign: Smart ALIGN Macro
  • [ ] Section 6.3: fp: Floating-point macros
  • [ ] Section 6.4: ifunc: Integer functions
    • [ ] Section 6.4.1: Integer logarithms
  • [ ] Section 6.5: masm: MASM compatibility

• [ ] Chatper 7: Assembler Directives

  • [ ] Section 7.1: BITS: Specifying Target Processor Mode
    • [ ] Section 7.1.1: USE16 & USE32: Aliases for BITS
  • [ ] Section 7.2: DEFAULT: Change the assembler defaults
    • [ ] Section 7.2.1: REL & ABS: RIP-relative addressing
    • [ ] Section 7.2.2: BND & NOBND: BND prefix
  • [ ] Section 7.3: - [ ] Section or SEGMENT: Changing and Defining - [ ] Sections
    • [ ] Section 7.3.1: The ?SECT? Macro
  • [ ] Section 7.4: ABSOLUTE: Defining Absolute Labels
  • [ ] Section 7.5: EXTERN: Importing Symbols from Other Modules
  • [ ] Section 7.6: REQUIRED: Unconditionally Importing Symbols from Other Modules
  • [ ] Section 7.7: GLOBAL: Exporting Symbols to Other Modules
  • [ ] Section 7.8: COMMON: Defining Common Data Areas
  • [ ] Section 7.9: STATIC: Local Symbols within Modules
  • [ ] Section 7.10: (G|L)PREFIX, (G|L)POSTFIX: Mangling Symbols
  • [ ] Section 7.11: CPU: Defining CPU Dependencies
  • [ ] Section 7.12: FLOAT: Handling of floating-point constants
  • [ ] Section 7.13: [WARNING]: Enable or disable warnings

• [ ] Chatper 8: Output Formats

  • [ ] Section 8.1: bin: Flat-Form Binary Output
    • [ ] Section 8.1.1: ORG: Binary File Program Origin
    • [ ] Section 8.1.2: bin Extensions to the - [ ] Section Directive, bin extensions to}
    • [ ] Section 8.1.3: Multi- [ ] Section Support for the bin Format
    • [ ] Section 8.1.4: Map Files
  • [ ] Section 8.2: ith: Intel Hex Output
  • [ ] Section 8.3: srec: Motorola S-Records Output
  • [ ] Section 8.4: obj: Microsoft OMF Object Files
    • [ ] Section 8.4.1: obj Extensions to the SEGMENT Directive
    • [ ] Section 8.4.2: GROUP: Defining Groups of Segments
    • [ ] Section 8.4.3: UPPERCASE: Disabling Case Sensitivity in Output
    • [ ] Section 8.4.4: IMPORT: Importing DLL Symbols
    • [ ] Section 8.4.5: EXPORT: Exporting DLL Symbols
    • [ ] Section 8.4.6: ..start: Defining the Program Entry Point
    • [ ] Section 8.4.7: obj Extensions to the EXTERN Directive
    • [ ] Section 8.4.8: obj Extensions to the COMMON Directive
    • [ ] Section 8.4.9: Embedded File Dependency Information
  • [ ] Section 8.5: win32: Microsoft Win32 Object Files
    • [ ] Section 8.5.1: win32 Extensions to the - [ ] Section Directive
    • [ ] Section 8.5.2: win32: Safe Structured Exception Handling
    • [ ] Section 8.5.3: Debugging formats for Windows
  • [ ] Section 8.6: win64: Microsoft Win64 Object Files
    • [ ] Section 8.6.1: win64: Writing Position-Independent Code
    • [ ] Section 8.6.2: win64: Structured Exception Handling
  • [ ] Section 8.7: coff: Common Object File Format
  • [ ] Section 8.8: macho32 and macho64: Mach Object File Format
    • [ ] Section 8.8.1: macho extensions to the - [ ] Section Directive
    • [ ] Section 8.8.2: Thread Local Storage in Mach-O: macho special symbols and WRT
    • [ ] Section 8.8.3: macho specific directive sub- [ ] Sections_via_symbols
    • [ ] Section 8.8.4: macho specific directive no_dead_strip
    • [ ] Section 8.8.5: macho specific extensions to the GLOBAL Directive: private_extern
  • [ ] Section 8.9: elf32, elf64, elfx32: Executable and Linkable Format Object Files
    • [ ] Section 8.9.1: ELF specific directive osabi
    • [ ] Section 8.9.2: ELF extensions to the - [ ] Section Directive
    • [ ] Section 8.9.3: Position-Independent Code: ELF Special Symbols and WRT
    • [ ] Section 8.9.4: Thread Local Storage in ELF: elf Special Symbols and WRT
    • [ ] Section 8.9.5: elf Extensions to the GLOBAL Directive
    • [ ] Section 8.9.6: elf Extensions to the EXTERN Directive
    • [ ] Section 8.9.7: elf Extensions to the COMMON Directive
    • [ ] Section 8.9.8: 16-bit code and ELF
    • [ ] Section 8.9.9: Debug formats and ELF
  • [ ] Section 8.10: aout: Linux a.out Object Files
  • [ ] Section 8.11: aoutb: NetBSD/FreeBSD/OpenBSD a.out Object Files
  • [ ] Section 8.12: as86: Minix/Linux as86 Object Files
  • [ ] Section 8.13: dbg: Debugging Format

• [ ] Chatper 9: Writing 16-bit Code (DOS, Windows 3/3.1)

  • [ ] Section 9.1: Producing .EXE Files
    • [ ] Section 9.1.1: Using the obj Format To Generate .EXE Files
    • [ ] Section 9.1.2: Using the bin Format To Generate .EXE Files
  • [ ] Section 9.2: Producing .COM Files
    • [ ] Section 9.2.1: Using the bin Format To Generate .COM Files
    • [ ] Section 9.2.2: Using the obj Format To Generate .COM Files
  • [ ] Section 9.3: Producing .SYS Files
  • [ ] Section 9.4: Interfacing to 16-bit C Programs
    • [ ] Section 9.4.1: External Symbol Names
    • [ ] Section 9.4.2: Memory Models
    • [ ] Section 9.4.3: Function Definitions and Function Calls
    • [ ] Section 9.4.4: Accessing Data Items
    • [ ] Section 9.4.5: c16.mac: Helper Macros for the 16-bit C Interface
  • [ ] Section 9.5: Interfacing to Borland Pascal Programs
    • [ ] Section 9.5.1: The Pascal Calling Convention
    • [ ] Section 9.5.2: Borland Pascal Segment Name Restrictions
    • [ ] Section 9.5.3: Using c16.mac With Pascal Programs

• [ ] Chatper 10: Writing 32-bit Code (Unix, Win32, DJGPP)

  • [ ] Section 10.1: Interfacing to 32-bit C Programs
    • [ ] Section 10.1.1: External Symbol Names
    • [ ] Section 10.1.2: Function Definitions and Function Calls
    • [ ] Section 10.1.3: Accessing Data Items
    • [ ] Section 10.1.4: c32.mac: Helper Macros for the 32-bit C Interface
  • [ ] Section 10.2: Writing NetBSD/FreeBSD/OpenBSD and Linux/ELF Shared Libraries
    • [ ] Section 10.2.1: Obtaining the Address of the GOT
    • [ ] Section 10.2.2: Finding Your Local Data Items
    • [ ] Section 10.2.3: Finding External and Common Data Items
    • [ ] Section 10.2.4: Exporting Symbols to the Library User
    • [ ] Section 10.2.5: Calling Procedures Outside the Library
    • [ ] Section 10.2.6: Generating the Library File

• [ ] Chatper 11: Mixing 16- and 32-bit Code

  • [ ] Section 11.1: Mixed-Size Jumps
  • [ ] Section 11.2: Addressing Between Different-Size Segments
  • [ ] Section 11.3: Other Mixed-Size Instructions

• [ ] Chatper 12: Writing 64-bit Code (Unix, Win64)

  • [ ] Section 12.1: Register Names in 64-bit Mode
  • [ ] Section 12.2: Immediates and Displacements in 64-bit Mode
  • [ ] Section 12.3: Interfacing to 64-bit C Programs (Unix)
  • [ ] Section 12.4: Interfacing to 64-bit C Programs (Win64)

• [ ] Chatper 13: Troubleshooting

  • [ ] Section 13.1: Common Problems
    • [ ] Section 13.1.1: NASM Generates Inefficient Code
    • [ ] Section 13.1.2: My Jumps are Out of Range
    • [ ] Section 13.1.3: ORG Doesn't Work
    • [ ] Section 13.1.4: TIMES Doesn't Work