port_driver_destroy_cb is never called and only appears in tests

Open
  • Is something wrong?
#2,239 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
c, erlang
Domain
embedded-iot

Research direction

Read src/platforms/esp32/test/main/test_main.c and the app_main() entry points in src/platforms/esp32/main.c and src/platforms/rp2/src/main.c, then trace port_driver_destroy_all and nif_collection_destroy_all in the named source files. Check which cleanup calls belong at shutdown in each platform and how the existing driver cleanup tests cover them. Done means the ESP32 and RP2 shutdown paths perform the intended cleanup and relevant tests pass.

Written by the indexing model from the issue text.

Description

port_driver_destroy_cb is a field of PortDriverDef in portnifloader.h that is set to the DESTROY_CB parameter by the REGISTER_PORT_DRIVER macro.

The field is used by the port_driver_destroy_all functions in src/libAtomVM/portnifloader.c and src/platforms/rp2/src/lib/sys.c

port_driver_driver_destroy_all is only called in src/platforms/esp32/test/main/test_main.c

It is never called in actual code.

I believe it is meant to do global cleanup of all the instances or ports of the driver.

Very few of the drivers in the esp32 tree use the destroy callback, but it is still used in a few drivers such as socket_driver.c

My driver can do cleanup with a "close" mailbox action, but I still think a driver-wide cleanup like you have in your design makes sense in case there is any other driver-wide shutdown needed or as a fallback to get the hardware to a sane state if mailbox messages aren't delivered.

test_main.c shows a pattern for how it could be inserted into src/platforms/esp32/main.c:app_main() at the end.
The RP2 tree also may need to call it in src/platforms/rp2/src/main.c:app_main()

nif_collection_destroy_all isn't called in the ESP32 tree either, but it is called in RP2.

Or maybe I'm missing something and these functions are called elsewhere.

It looks like a possibly smart API design sign, just a mistake in not calling it. I can write a PR to add those missing calls if needed, let me know. It might need a lot of testing since it is an unused code path that some drivers implement but haven't tested.

Dominant language
Erlang
Stars
2.3k
Forks
171
Avg merge
4d 11h
Merged PRs (30d)
20

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from atomvm/AtomVM

All issues in atomvm/AtomVM

Similar issues

More Embedded & IoT issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.