port_driver_destroy_cb is never called and only appears in tests

Aperta
  • Qualcosa non va?
#2,239 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
c, erlang
Ambito
embedded-iot

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Erlang
Stelle
2.3k
Fork
171
Merge medio
5g 11h
PR unite (30g)
19

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di atomvm/AtomVM

Tutte le issue di atomvm/AtomVM

Issue simili

Altre issue su Embedded & IoT

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.