Skip to content

Enable logging in the Simulator #591

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
doc-hex merged 6 commits into from
Jan 2, 2026
Merged

Enable logging in the Simulator #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f85fe5e
chore: Simulator Docker instructions
tadeubas Dec 29, 2025
279a30f
chore: removed Docker
tadeubas Dec 30, 2025
ac0453d
feat: add --log flag to enable simulator logging
tadeubas Dec 30, 2025
0223c31
refactor(simulator): --log output path respects --segregate
tadeubas Dec 31, 2025
68c746b
refactor: drop --shallow-submodules since lwIP submodule does not sup…
tadeubas Dec 31, 2025
a316117
chore: revert .gitignore
tadeubas Jan 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions unix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ wallet (on testnet, always with the same seed). But there are other options:
- `--segregate` => scroll down to `Running simulators in parallel` section
- `--bricked` => simulate a system w/ bricked SE1: no more pin tries, etc.
- `--fails N` => simulate N wrong PIN attempts before login, where (1 <= N <= 13)
- `--log` => enable logging to `/tmp/cc_simulator.log`, or to `/tmp/cc-simulators/<pid>/cc_simulator.log` when used with `--segregate`

See `variant/sim_settings.py` for the details of settings-related options.

Expand Down
19 changes: 17 additions & 2 deletions unix/simulator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,12 +863,15 @@ def sock_cleanup():
cc_mpy = os.path.join(cwd, "coldcard-mpy")
sim_boot = os.path.join(cwd, "sim_boot.py")

log_base_dir = "/tmp"

if segregate:
os.makedirs("/tmp/cc-simulators", exist_ok=True)
os.chdir("/tmp/cc-simulators")
# our new work /tmp/cc-simulators/<PID>
os.mkdir(str(pid))
os.chdir(str(pid))
log_base_dir = os.getcwd()
os.mkdir("MicroSD")
os.mkdir("settings")
os.mkdir("VirtDisk")
Expand Down Expand Up @@ -903,8 +906,20 @@ def sock_cleanup():
child.kill()
return

xterm = subprocess.Popen(['xterm', '-title', 'Coldcard Simulator REPL',
'-geom', '132x40+650+40', '-e'] + cc_cmd,
xterm_args = ['xterm', '-title', 'Coldcard Simulator REPL', '-geom', '132x40+650+40']

log = ("--log" in sys.argv)
if log:
logfile = os.path.join(log_base_dir, 'cc_simulator.log')
# create or truncate logfile and set correct permissions before starting xterm
file_desc = os.open(logfile, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o644)
os.close(file_desc)

xterm_args.extend(['-l', '-lf', logfile, '-e'])
else:
xterm_args.extend(['-e'])

xterm = subprocess.Popen(xterm_args + cc_cmd,
env=env,
stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL,
pass_fds=pass_fds, shell=False)
Expand Down