SIMULATOR(1)

📦
version 15.1 · 2 versions
  • 15.1 · debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking (latest)
  • 12.1 · debian bookworm
, in debian trixie, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

👑 SIMULATOR — the GNU simulator for AVR, bestie edition

okay so. this is the manual page for simulator, the GNU simulator for AVR, and it lives in section 1 of the manual, under User Commands. it's literally the whole vibe. let's get into it 💅

✨ NAME ✨

simulator — GNU simulator for AVR. that's the name, that's the game, no cap.

🌸 SYNOPSIS 🌸

avr-run [options] [VAR=VAL|--] program [program args]

like... that's it. that's the whole entrance exam. options, then a program, and optionally some env vars or a -- and then the program's own args. iconic behavior honestly 🦋

🎀 OPTIONS 🎀

here's where it gets long, bestie. strap in. every single one of these is real and every single one matters.

  • -t[on|off], --trace[=on|off] — trace useful things ✨ the general-purpose tracing switch.
  • --trace-insn[=on|off] — do instruction tracing. one instruction at a time, we love to see it.
  • --trace-disasm[=on|off] — disassemble instructions. it's slower, but more accurate — pick your fighter.
  • --trace-decode[=on|off] — trace instruction decoding.
  • --trace-extract[=on|off] — trace instruction extraction.
  • --trace-linenum[=on|off] — do line number tracing. heads up: this implies --trace-insn, so it comes with friends.
  • --trace-memory[=on|off] — trace memory operations.
  • --trace-alu[=on|off] — trace ALU (Arithmetic Logic Unit) operations.
  • --trace-fpu[=on|off] — trace FPU (Floating Point Unit) operations.
  • --trace-vpu[=on|off] — trace VPU (Vector Processing Unit) operations.
  • --trace-branch[=on|off] — trace branching. where are we going?? nowhere, we're branching.
  • --trace-semantics[=on|off] — does ALU, FPU, VPU, MEMORY, and BRANCH tracing all at once. the combo meal 🍓
  • --trace-model[=on|off] — include model performance data.
  • --trace-core[=on|off] — trace core operations.
  • --trace-events[=on|off] — trace events.
  • --trace-syscall[=on|off] — trace system calls.
  • --trace-register[=on|off] — trace cpu register accesses.
  • --trace-debug[=on|off] — adds information useful for debugging the simulator itself to the tracing output. simulator-ception.
  • --trace-file FILE NAME — specify the tracing output file.
  • -p[on|off], --profile[=on|off] — do profiling.
  • --profile-insn[=on|off] — do instruction profiling.
  • --profile-memory[=on|off] — do memory profiling.
  • --profile-core[=on|off] — do CORE profiling.
  • --profile-model[=on|off] — do model profiling.
  • --profile-cpu-frequency CPU FREQUENCY — specify the speed of the simulated cpu clock.
  • --profile-file FILE NAME — specify the profile output file.
  • --profile-pc[=on|off] — do PC profiling.
  • -F PC PROFILE FREQUENCY, --profile-pc-frequency PC PROFILE FREQUENCY — the specified PC profiling frequency.
  • -S PC PROFILE SIZE, --profile-pc-size PC PROFILE SIZE — specify PC profiling size.
  • --profile-pc-granularity PC PROFILE GRANULARITY — specify PC profiling sample coverage.
  • --profile-pc-range BASE,BOUND — specify PC profiling address range.
  • --hw-info, --info-hw — list configurable hw regions.
  • --hw-trace[=on|off], --trace-hw — trace all hardware devices. all of them. every last one 🔥
  • --hw-device DEVICE — add the specified device.
  • --hw-list — list the device tree.
  • --hw-file FILE — add the devices listed in the file.
  • --sockser-addr SOCKET ADDRESS — set serial emulation socket address.
  • --watch-cycles-ACTION [+]COUNT — watch the simulator, take ACTION in COUNT cycles (+ for every COUNT cycles). ACTION is int breakpoint.
  • --watch-pc-ACTION [!]ADDRESS — watch the PC, take ACTION when it matches ADDRESS (in range ADDRESS,ADDRESS). ! negates the test.
  • --watch-clock-ACTION [+]MILLISECONDS — watch the clock, take ACTION after MILLISECONDS (+ for every MILLISECONDS).
  • --watch-delete IDENT|all|pc|cycles|clock — delete a watchpoint.
  • --watch-info — list scheduled watchpoints.
  • --memory-delete ADDRESS|all, --delete-memory ADDRESS — delete memory at ADDRESS (or all addresses).
  • --memory-region ADDRESS,SIZE[,MODULO] — add a memory region.
  • --memory-alias ADDRESS,SIZE{,ADDRESS} — add memory shadow.
  • --memory-size <size>[in bytes, Kb (k suffix), Mb (m suffix) or Gb (g suffix)] — add memory at address zero.
  • --memory-fill VALUE — fill subsequently added memory regions.
  • --memory-clear — clear subsequently added memory regions.
  • --memory-mapfile FILE — memory-map the next memory region from a file.
  • --memory-info, --info-memory — list configurable memory regions.
  • --map-info — list mapped regions.
  • --model MODEL — specify the model to simulate.
  • --model-info, --info-model — list selectable models.
  • -v, --verbose — verbose output. say more, king.
  • -E B|big|L|little, --endian B|big|L|little — set endianness.
  • --environment user|virtual|operating — set running environment.
  • --alignment strict|nonstrict|forced — set memory access alignment.
  • -D, --debug — print debugging messages.
  • --debug-insn — print instruction debugging messages.
  • --debug-file FILE NAME — specify the debugging output file.
  • --do-command COMMAND — (the original page gives no description here, bestie. it's giving mystery. we simply report it and move on 🙈)
  • -h, --help — print help information.
  • --version — print version information.
  • --architecture MACHINE — specify the architecture to use.
  • --architecture-info, --info-architecture — list supported architectures.
  • --target BFDNAME — specify the object-code format for the object files.
  • --target-info, --info-target — list supported targets.
  • --load-{lma,vma} — use VMA or LMA addresses when loading the image. default is LMA.
  • --sysroot SYSROOT — root for system calls with absolute file-names and cwd at start.
  • --argv0 ARGV0 — set argv[0] to the specified string.
  • --env-set VAR=VAL — set the variable in the program's environment.
  • --env-unset VAR — unset the variable in the program's environment.
  • --env-clear — clear the program's environment.
📌 Note: depending on the simulator configuration, some options may not be applicable. so if one of these is ghosting you, that might be why.

and then the two positional-ish things:

  • VAR=VAL — environment variables to set. ignored if -- is used.
  • program args — arguments to pass to the simulated program.
💀 Note: very few simulators support this. (the program args thing. just so you know what you're walking into.)

Copyright © 2023 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>

This is free software: you are free to change and redistribute it.

There is NO WARRANTY, to the extent permitted by law.

(that's the actual legal text, bestie — free software means free to change and redistribute, and NO WARRANTY means exactly that, no cap.)

🌈 SEE ALSO 🌈

the full documentation for simulator is maintained as a Texinfo manual. if the info and simulator programs are properly installed at your site, the command

info simulator

should give you access to the complete manual. go read it, it's the director's cut 🫶

and that's a wrap, babes 💜 this was GNU simulator (SIM) 13.2, dated September 2023. periodt. ✨

📦 where this page comes from