https://github.com/andrewchambers/minias

A mini x86-64 assembler for fun and learning.
https://github.com/andrewchambers/minias

assembler assembly x86-64

Last synced: about 1 month ago
JSON representation

A mini x86-64 assembler for fun and learning.

• Host: GitHub
• URL: https://github.com/andrewchambers/minias
• Owner: andrewchambers
• License: isc
• Created: 2021-10-02T04:40:19.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-10-26T11:10:39.000Z (over 3 years ago)
• Last Synced: 2024-12-15T16:56:50.991Z (about 2 months ago)
• Topics: assembler, assembly, x86-64
• Language: C
• Homepage:
• Size: 826 KB
• Stars: 204
• Watchers: 9
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# minias

A mini assembler for x86-64, written for fun and learning.

Minias can assemble large amounts of real world software after they have been compiled with the [cproc C compiler](https://sr.ht/~mcf/cproc/). It can also

assemble self hosted cproc, meaning it can indirectly assemble itself.

Project Goals:

- A simple, tiny, fast implementation (in that order).

- Assemble the output of [cproc](https://sr.ht/~mcf/cproc/)/[qbe](https://c9x.me/compile/) and [chibicc](https://github.com/rui314/chibicc).

- Relocatable elf output.

Non Goals:

- Assemble every assembly instruction.

- Assemble other architectures.

- Work as a library.

# Building

Install the [peg/leg](https://www.piumarta.com/software/peg/) parser generator, make and a C compiler and run:

```

make

```

or 

```

leg asm.peg > asm.peg.inc

cc -O2 *.c -o minias

```

# Roadmap

Essential features:

- [x] Self host with cproc.

- [ ] Self host with chibicc.

Bonus features:

- [ ] A man page explaining what is supported.

- [x] Two pass jump relaxing.

- [x] Immediate relaxing.

- [ ] Simple immediate expressions.

- [ ] Assemble a libc.

- [ ] Test every opcode with all variants in our test suite.

- [ ] Parser that doesn't depend on peg/leg or an optimized peg that checks common prefixes.

# Notes

- The implementation deliberately does not free allocated memory as it all is

  freed by the OS at the end of execution. Memory usage is still

  quite light as it uses string and value interning. In the future

  we could use an arena allocator for minias and still avoid manual calls to free.

- The implementation deliberately uses global variables in a style similar class members in C++.

  This is a more traditional unix style where the unit of data encapsulation is a

  small program. This choice makes sense given we don't aim to build a library.

- Minias deliberately keeps the peg grammar quite repetitive

  and simple, please keep it this way as it is easy to understand and

  it leaves the door open for code generation.

- Performance is limited by the parser, it would be interesting

  to see if we can improve the parser generator upstream. That being said,

  performance is often better than gnu as and much better than the clang assembler,

- One day it would be nice to write a 'minipeg' in a single .c

  file that can be bundled in projects.

# Contact

Ask questions on the [mailing list](https://lists.sr.ht/~ach/minias).

Submit bugs to the [ticket system](https://todo.sr.ht/~ach/minias).

# Resources

- [intel reference](https://software.intel.com/content/dam/develop/external/us/en/documents-tps/325383-sdm-vol-2abcd.pdf) - Specifically chapter 2.1 and chapter 3.1.

- [elf spec](https://refspecs.linuxfoundation.org/elf/elf.pdf)

- [osdev wiki](https://wiki.osdev.org/X86-64_Instruction_Encoding)

- [goas](https://github.com/DQNEO/goas)

- [neatas](https://repo.or.cz/neatas.git)