ALSA Sound Integration not Working

[Alexander207]

I switched my WSL distro to Ubuntu 22.04, installed pulseaudio and SDL, built brickEmu, and now I'm getting this error now:

Starting: ./emu 45001
serverport=45001
Server started.
Starting server...Connected to server via 3.
Debugging-Server started on port 39829.
Connecting to Environment-Server at localhost port 45001.
BrickEmu: Preparing to Initialize Sound
Starting GUI...
Access type not available for playback: Invalid argument
BrickEmu: Sound Initialized
BrickEmu: Buttons Initialized
BrickEmu: LCD Initialized
BrickEmu: Initialization Complete
Overrun: 25
commit res: -77
Overrun: 54
commit res: -77
Overrun: 3
commit res: -77
Overrun: 196
==873==ERROR: AddressSanitizer: stack-buffer-overflow on address 0x7ffe3967583c at pc 0x56139a60e8b4 bp 0x7ffe39675770 sp 0x7ffe39675760
READ of size 4 at 0x7ffe3967583c thread T0
    # 0 0x56139a60e8b3 in sound_update /home/aconklin/brickEmu-master/sound_alsa.c:110
    # 1 0x56139a5f52c3 in t8_incr_tcnt /home/aconklin/brickEmu-master/timer8.c:180
    # 2 0x56139a5f54d3 in t8_update_time /home/aconklin/brickEmu-master/timer8.c:247
    # 3 0x56139a5f0c96 in wait_peripherals /home/aconklin/brickEmu-master/peripherals.c:282
    # 4 0x56139a5f0c96 in check_irq /home/aconklin/brickEmu-master/peripherals.c:327
    # 5 0x56139a5e814c in run_cpu /home/aconklin/brickEmu-master/h8300.c:292
    # 6 0x56139a5e736b in main /home/aconklin/brickEmu-master/main.c:109
    # 7 0x7f5623397d8f  (/lib/x86_64-linux-gnu/libc.so.6+0x29d8f)
    # 8 0x7f5623397e3f in __libc_start_main (/lib/x86_64-linux-gnu/libc.so.6+0x29e3f)
    # 9 0x56139a5e7904 in _start (/home/aconklin/brickEmu-master/emu+0xc904)
Address 0x7ffe3967583c is located in stack of thread T0 at offset 108 in frame
    #0 0x56139a60e0ff in sound_update /home/aconklin/brickEmu-master/sound_alsa.c:40
   This frame has 6 object(s):
    [48, 56) 'mmap_areas' (line 55)
    [80, 88) 'offset' (line 56)
    [112, 120) 'frames' (line 56) <== Memory access at offset 108 underflows this variable
    [144, 152) 'delay' (line 84)
    [176, 180) 'step' (line 100)
    [192, 200) 'sptr' (line 99)
HINT: this may be a false positive if your program uses some custom stack unwind mechanism, swapcontext or vfork
      (longjmp and C++ exceptions *are* supported)
SUMMARY: AddressSanitizer: stack-buffer-overflow /home/aconklin/brickEmu-master/sound_alsa.c:110 in sound_update
Shadow bytes around the buggy address:
  0x1000472c6ab0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6ac0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6ad0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6ae0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6af0: 00 00 00 00 00 00 00 00 00 00 f1 f1 f1 f1 f1 f1
=>0x1000472c6b00: 00 f2 f2 f2 00 f2 f2[f2]00 f2 f2 f2 00 f2 f2 f2
  0x1000472c6b10: 04 f2 00 f3 f3 f3 00 00 00 00 00 00 00 00 00 00
  0x1000472c6b20: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6b30: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6b40: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  0x1000472c6b50: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Shadow byte legend (one shadow byte represents 8 application bytes):
  Addressable:           00
  Partially addressable: 01 02 03 04 05 06 07
  Heap left redzone:       fa
  Freed heap region:       fd
  Stack left redzone:      f1
  Stack mid redzone:       f2
  Stack right redzone:     f3
  Stack after return:      f5
  Stack use after scope:   f8
  Global redzone:          f9
  Global init order:       f6
  Poisoned by user:        f7
  Container overflow:      fc
  Array cookie:            ac
  Intra object redzone:    bb
  ASan internal:           fe
  Left alloca redzone:     ca
  Right alloca redzone:    cb
  Shadow gap:              cc
==873==ABORTING
Stream closed!

[mesheets]

Though sounds has worked on native installs, sound has yet to work under WSL.

More recent Ubuntu packages of GCC are prebuilt with a different set of compiler flags than previously, which potentially also might be why builds that otherwise used to run on earlier versions of Ubuntu no longer do on more recent versions of Ubuntu with newer GCC packages (c.f. the CI action in place for this repo, where the Ubuntu OS version matrix succeeds for older versions but not the latest, and this change happened sometime within the last ~6 months).

[mesheets]

…just to confirm, this is reported with Ubuntu version 22.04? In this GitHub project, the continuous integration tests are still passing under 22.04 but started failing under 24.04 sometime within the last ~6 months. Those test runners are not running under WSL, so not sure yet whether WSL is part of the equation here.

Something environmentally seems to have changed within the last ~6 months, as continuous integration runs and local builds from that time were fine, and there hadn't been any code changes since that time.

[mesheets]

A couple possible things to try:

• As the messages above appear to be related to sound support, make SOUND=mute should build the project without sound support (c.f. Makefile). Not that this would be a fix, but this might help identify whether the problem is limited to sound support or might merely be a symptom of something larger.
• Are there any differences if building the branch cycle-count-typedef? That branch has some newer code that has not yet been merged.

[Alexander207]

I uninstalled alsa and recomiled and I see this every time I exit brickEmu:

=================================================================
==2027==ERROR: LeakSanitizer: detected memory leaks
Direct leak of 160 byte(s) in 4 object(s) allocated from:
    #0 0x7fe88b0e5a57 in __interceptor_calloc ../../../../src/libsanitizer/asan/asan_malloc_linux.cpp:154
    #1 0x55a5cf765f12 in hash_init /home/aconklin/brickEmu/hash.c:33
    #2 0x55a5cf74f233 in run_cpu /home/aconklin/brickEmu/h8300.inc:714
    #3 0x55a5cf749f6b in main /home/aconklin/brickEmu/main.c:109
    #4 0x7fe88ae15d8f  (/lib/x86_64-linux-gnu/libc.so.6+0x29d8f)
Direct leak of 88 byte(s) in 1 object(s) allocated from:
    #0 0x7fe88b0e5a57 in __interceptor_calloc ../../../../src/libsanitizer/asan/asan_malloc_linux.cpp:154
    #1 0x55a5cf7662af in hash_grow /home/aconklin/brickEmu/hash.c:70
    #2 0x55a5cf7662af in hash_create /home/aconklin/brickEmu/hash.c:90
    #3 0x55a5cf7598b7 in frame_add_callee /home/aconklin/brickEmu/frame.c:234
    #4 0x55a5cf75acfd in frame_end /home/aconklin/brickEmu/frame.c:404
    #5 0x55a5cf74c57f in run_cpu /home/aconklin/brickEmu/h8300.inc:617
    #6 0x55a5cf749f6b in main /home/aconklin/brickEmu/main.c:109
    #7 0x7fe88ae15d8f  (/lib/x86_64-linux-gnu/libc.so.6+0x29d8f)
SUMMARY: AddressSanitizer: 248 byte(s) leaked in 5 allocation(s).

[mesheets]

If this message appears when exiting, does brickEmu at least run now? Was this built against the cycle-count-typedef branch?

…also, a minor usage note: when pasting chunks of content, please use a code block instead of a quote block, as due to GitHub automatic linking and tagging, GitHub is automatically creating associations where there should not be, which ends up confusing things. :-)

[Alexander207]

It does run, and it was not built against the 'cycle-count-typedef' branch.

[mesheets]

Had a chance to check sound under WSL2 on Ubuntu 24.04, and it is working with SDL.

Under Debian packaging, libsdl-sound1.2 has a dependency on libsdl1.2debian, and in turn libsdl1.2debian has a dependency on ALSA (libasound2). Because of that, sound generated using SDL might not work if installing an SDL package with a libsdl1.2debian dependency but then uninstalling ALSA.

The brickEmu Makefile checked for "mute", ALSA, and SDL in that order. On system with packages like those above, this means that even when SDL is installed, ALSA would still be selected because it is found first. For now, I've switched the Makefile check order so that SDL will be checked before ALSA.

With this, sound is working under WSL2, and there are no overrun messages while running (which is a message specific to the ALSA integration) and no errors when exiting.

Any contributions to fix the ALSA interface would be welcome.