cleanup(core,samples,tests): dropped m_mod_ctx API.

FedeDP · FedeDP · commit 1b6890b4e9ee · 2023-01-03T22:43:06.000+01:00
Signed-off-by: Federico Di Pierro &lt;nierro92@gmail.com&gt;
diff --git a/Lib/core/ctx.h b/Lib/core/ctx.h
@@ -7,6 +7,13 @@
 
 #define M_CTX_DEFAULT_EVENTS    64
 
+// #define M_CTX() m_ctx_t *c = m_ctx();
+// 
+// #define M_CTX_ASSERT(c) \
+// M_CTX(); \
+// M_RET_ASSERT(c, -EPIPE); \
+// M_RET_ASSERT(c->state != M_CTX_ZOMBIE, -EACCES)
+
 #define M_CTX_ASSERT(c) \
     M_PARAM_ASSERT(c); \
     M_RET_ASSERT(c->state != M_CTX_ZOMBIE, -EACCES)
diff --git a/Lib/core/main.c b/Lib/core/main.c
@@ -32,7 +32,6 @@ _public_ _weak_ int main(int argc, char *argv[]) {
     const int ret = m_ctx_loop(c);
     m_ctx_post_loop(c, argc, argv);
     m_ctx_deregister(&c); // default_ctx may be NULL here, if eg: all modules where deregistered. We don't care
-    m_mem_unrefp((void **)&c);
     return ret;
 }
 
diff --git a/Lib/core/mod.c b/Lib/core/mod.c
@@ -635,14 +635,6 @@ _public_ int m_mod_stats(const m_mod_t *mod, m_mod_stats_t *stats) {
     return 0;
 }
 
-_public_ m_ctx_t *m_mod_ctx(const m_mod_t *mod) {
-    M_RET_ASSERT(mod, NULL);
-    M_RET_ASSERT(!m_mod_is(mod, M_MOD_ZOMBIE), NULL);
-    M_RET_ASSERT(!(mod->flags & M_MOD_DENY_CTX), NULL);
-
-    return mod->ctx;
-}
-
 /** Module state setters **/
 
 #define M_MOD_BOUND(fn) \
diff --git a/Lib/core/public/module/mod.h b/Lib/core/public/module/mod.h
@@ -205,9 +205,6 @@ int m_mod_register(const char *name, m_ctx_t *c, OUT m_mod_t **mod_ref, const m_
                    m_mod_flags flags, const void *userdata);
 int m_mod_deregister(OUT m_mod_t **mod);
 
-/* Retrieve module context */
-m_ctx_t *m_mod_ctx(const m_mod_t *mod);
-
 /* Retrieve module name */
 const char *m_mod_name(const m_mod_t *mod);
 
diff --git a/Lib/core/public/module/mod_easy.h b/Lib/core/public/module/mod_easy.h
@@ -14,8 +14,8 @@
  * dtors order:
  * 0) each m_mod_dtor() (only mod_easy API)
  */
-#define _m_ctor0_         __attribute__((constructor (113)))
-#define _m_ctor1_         __attribute__((constructor (114)))
+#define _m_ctor0_         __attribute__((constructor (111)))
+#define _m_ctor1_         __attribute__((constructor (112)))
 #define _m_dtor0_         __attribute__((destructor (111)))
 
 /* Simple macro to automatically manage module lifecycle and callbacks */
diff --git a/Samples/Easy/doggo.c b/Samples/Easy/doggo.c
@@ -64,7 +64,7 @@ static void m_mod_on_evt(m_mod_t *mod, const m_queue_t *const evts) {
                      * Test runtime module loading; loaded module won't have direct access to CTX.
                      * We own a ref on it! 
                      */
-                    m_mod_register("./libtestmod.so", m_mod_ctx(mod), &plugin, NULL, M_MOD_DENY_CTX, NULL);
+                    m_mod_register("./libtestmod.so", m_ctx(), &plugin, NULL, M_MOD_DENY_CTX, NULL);
                 } else if (!strcmp((char *)msg->ps_evt->data, "ByeBye")) {
                     m_mod_log(mod, "Sob...\n");
                 } else if (!strcmp((char *)msg->ps_evt->data, "WakeUp")) {
@@ -87,7 +87,7 @@ static void m_mod_on_evt_sleeping(m_mod_t *mod, const m_queue_t *const evts) {
                 if (!strcmp((char *)msg->ps_evt->data, "WakeUp")) {
                     m_mod_unbecome(mod);
                     m_mod_log(mod, "Yawn...\n");
-                    m_ctx_dump(m_mod_ctx(mod));
+                    m_ctx_dump(m_ctx());
                     m_mod_deregister(&plugin);
                     m_mod_src_deregister(mod, M_PS_MOD_STARTED);
                 } else {
diff --git a/Samples/Easy/pippo.c b/Samples/Easy/pippo.c
@@ -42,7 +42,7 @@ static bool m_mod_on_start(m_mod_t *mod) {
     doggo = m_mod_lookup(mod, "Doggo");
     
     // let context tick every 5s and subscribe to it
-    m_ctx_set_tick(m_mod_ctx(mod), (uint64_t)5 * 1000 * 1000 * 1000);
+    m_ctx_set_tick(m_ctx(), (uint64_t)5 * 1000 * 1000 * 1000);
     m_mod_src_register(mod, M_PS_CTX_TICK, 0, NULL);
     return true;
 }
@@ -86,7 +86,7 @@ static void m_mod_on_evt(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'q':
                     m_mod_log(mod, "I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", "ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
@@ -96,7 +96,7 @@ static void m_mod_on_evt(m_mod_t *mod, const m_queue_t *const evts) {
                     break;
             }
         } else if (strcmp((char *)msg->ps_evt->data, "BauBau") == 0) {
-            m_ctx_dump(m_mod_ctx(mod));
+            m_ctx_dump(m_ctx());
             m_mod_become(mod, m_mod_on_evt_ready);
             m_mod_log(mod, "Press 'p' to play with Doggo! Or 'f' to feed your Doggo. 's' to have a nap. 'w' to wake him up. 'q' to leave him for now.\n");
         }
@@ -146,7 +146,7 @@ static void m_mod_on_evt_ready(m_mod_t *mod, const m_queue_t *const evts) {
                     m_mod_dump(mod);
                     m_mod_log(mod, "I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", "ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
@@ -159,7 +159,7 @@ static void m_mod_on_evt_ready(m_mod_t *mod, const m_queue_t *const evts) {
             m_mod_log(mod, "Received ctx tick.\n");
             if (++tick_ctr == 5) {
                 m_mod_log(mod, "Stop playing and get back to do stuff!\n");
-                m_ctx_quit(m_mod_ctx(mod), -EPIPE);
+                m_ctx_quit(m_ctx(), -EPIPE);
             }
         }
     });
diff --git a/Samples/Poll/pippo.c b/Samples/Poll/pippo.c
@@ -59,7 +59,7 @@ static void m_mod_on_evt(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'q':
                     m_mod_log(mod,"I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", "ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
@@ -99,7 +99,7 @@ static void m_mod_on_evt_ready(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'p':
                     m_mod_log(mod,"Doggo, let's play a bit!\n");
                     m_mod_ps_tell(mod, doggo, "LetsPlay", 0);
-                    m_ctx_dump(m_mod_ctx(mod));
+                    m_ctx_dump(m_ctx());
                     break;
                 case 's':
                     m_mod_log(mod,"Doggo, you should sleep a bit!\n");
@@ -116,7 +116,7 @@ static void m_mod_on_evt_ready(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'q':
                     m_mod_log(mod, "I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", "ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
diff --git a/Samples/SharedSrc/mod.c b/Samples/SharedSrc/mod.c
@@ -61,7 +61,7 @@ static void A_recv(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'q':
                     m_mod_log(mod, "I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", (unsigned char *)"ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
@@ -106,7 +106,7 @@ static void A_recv_ready(m_mod_t *mod, const m_queue_t *const evts) {
                 case 'q':
                     m_mod_log(mod, "I have to go now!\n");
                     m_mod_ps_publish(mod, "leaving", (unsigned char *)"ByeBye", 0);
-                    m_ctx_quit(m_mod_ctx(mod), 0);
+                    m_ctx_quit(m_ctx(), 0);
                     break;
                 default:
                     /* Avoid newline */
diff --git a/Samples/Task/pippo.c b/Samples/Task/pippo.c
@@ -50,7 +50,7 @@ static void m_mod_on_evt(m_mod_t *mod, const m_queue_t *const evts) {
             int *data = (int *)msg->userdata;
             if (*data == 5) {
                 m_mod_log(mod, "Timed out.\n");
-                m_ctx_quit(m_mod_ctx(mod), 0);
+                m_ctx_quit(m_ctx(), 0);
                 m_mod_log(mod,"Final data val: %d\n", thData);
             } else {
                 (*data)++;
diff --git a/TODO.md b/TODO.md
@@ -7,7 +7,7 @@
 - [x] store ctxs in thread local storage (pthread_setspecific API)? https://pubs.opengroup.org/onlinepubs/009695399/functions/pthread_key_create.html `__find_thread_by_id` and loop over /proc/self/task? -> https://stackoverflow.com/questions/3707358/get-all-the-thread-id-created-with-pthread-created-within-an-process
 - [ ] we could then drop: (since every context is thread specific data)
 - - [x] global ctx map and mutex
-- - [ ] m_mod_ctx() api
+- - [x] m_mod_ctx() api
 - - [x] m_ctx_ref() api
 - - [x] m_mod_ref() api should become m_mod_lookup() and let users manage its lifecyle (ie: m_mem_ref it if needed)
 - - [ ] m_mod_t->ctx field -> this would help us enforce that module API is called by same thread that registered a context
diff --git a/docs/core/ctx.md b/docs/core/ctx.md
@@ -58,7 +58,7 @@ int m_ctx_deregister(m_ctx_t **c);
 * `c`: ctx handler storage, reset to NULL after the call  
 
 ```C
-m_ctx_t *m_ctx(const char *ctx_name);
+m_ctx_t *m_ctx(void);
 ```
 > Retrieves ctx associated with current thread, if existent.  
 > NOTE: this API **does not** increment number of references on ctx object;  
diff --git a/tests/test_ctx.c b/tests/test_ctx.c
@@ -13,7 +13,7 @@ static void logger(const m_mod_t *self, const char *fmt, va_list args) {
     const char *context = NULL;
     if (self) {
         name = m_mod_name(self);
-        context = m_ctx_name(m_mod_ctx(self));
+        context = m_ctx_name(m_ctx());
     }
     printf("%s@%s:\t* ", name ? name : "null", context ? context : "null");
     vprintf(fmt, args);

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ _public_ _weak_ int main(int argc, char *argv[]) {`
`32`	`32`	`const int ret = m_ctx_loop(c);`
`33`	`33`	`m_ctx_post_loop(c, argc, argv);`
`34`	`34`	`m_ctx_deregister(&c); // default_ctx may be NULL here, if eg: all modules where deregistered. We don't care`
`35`		`- m_mem_unrefp((void **)&c);`
`36`	`35`	`return ret;`
`37`	`36`	`}`
`38`	`37`