sys/shell: reduce overhead of XFA shell commands

maribu · maribu · commit a7e251509d4c · 2024-11-22T11:14:34.000+01:00
We do not need to add an array of pointers to the shell commands, just
an array of shell commands is sufficient. This reduced the overhead of
XFA by `sizeof(void *)` per command.
diff --git a/sys/include/shell.h b/sys/include/shell.h
@@ -302,15 +302,14 @@ int shell_parse_file(const shell_command_t *commands,
  * ```
  */
 #define SHELL_COMMAND(cmd, help, func) \
-    XFA_USE_CONST(shell_command_xfa_t*, shell_commands_xfa); \
+    XFA_USE_CONST(shell_command_xfa_t, shell_commands_xfa_v2); \
     static FLASH_ATTR const char _xfa_ ## cmd ## _cmd_name[] = #cmd; \
     static FLASH_ATTR const char _xfa_ ## cmd ## _cmd_desc[] = help; \
-    static const shell_command_xfa_t _xfa_ ## cmd ## _cmd = { \
+    XFA_CONST(shell_command_xfa_t, shell_commands_xfa_v2, 0) _xfa_ ## cmd ## _cmd = { \
         .name = _xfa_ ## cmd ## _cmd_name, \
         .desc = _xfa_ ## cmd ## _cmd_desc, \
         .handler = &func \
-    }; \
-    XFA_ADD_PTR(shell_commands_xfa, cmd, cmd, &_xfa_ ## cmd ## _cmd)
+    };
 #endif /* __cplusplus */
 
 #ifdef __cplusplus
diff --git a/sys/shell/shell.c b/sys/shell/shell.c
@@ -36,7 +36,6 @@
 #include <assert.h>
 #include <errno.h>
 
-#include "kernel_defines.h"
 #include "xfa.h"
 #include "shell.h"
 #include "shell_lock.h"
@@ -47,7 +46,7 @@
 #endif
 
 /* define shell command cross file array */
-XFA_INIT_CONST(shell_command_xfa_t*, shell_commands_xfa);
+XFA_INIT_CONST(shell_command_xfa_t, shell_commands_xfa_v2);
 
 #define ETX '\x03'  /** ASCII "End-of-Text", or Ctrl-C */
 #define EOT '\x04'  /** ASCII "End-of-Transmission", or Ctrl-D */
@@ -102,10 +101,10 @@ static shell_command_handler_t search_commands(const shell_command_t *entry,
 
 static shell_command_handler_t search_commands_xfa(char *command)
 {
-    unsigned n = XFA_LEN(shell_command_t*, shell_commands_xfa);
+    unsigned n = XFA_LEN(shell_command_t, shell_commands_xfa_v2);
 
     for (unsigned i = 0; i < n; i++) {
-        const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];
+        const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];
         if (flash_strcmp(command, entry->name) == 0) {
             return entry->handler;
         }
@@ -147,15 +146,15 @@ static void print_commands_json(const shell_command_t *cmd_list)
         }
     }
 
-    unsigned n = XFA_LEN(shell_command_xfa_t*, shell_commands_xfa);
+    unsigned n = XFA_LEN(shell_command_xfa_t, shell_commands_xfa_v2);
     for (unsigned i = 0; i < n; i++) {
         if (first) {
             first = false;
         }
         else {
             printf(", ");
         }
-        const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];
+        const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];
         printf("{\"cmd\": \"%s\", \"desc\": \"%s\"}", entry->name, entry->desc);
     }
     puts("]}");
@@ -170,9 +169,9 @@ static void print_commands(const shell_command_t *entry)
 
 static void print_commands_xfa(void)
 {
-    unsigned n = XFA_LEN(shell_command_xfa_t*, shell_commands_xfa);
+    unsigned n = XFA_LEN(shell_command_xfa_t, shell_commands_xfa_v2);
     for (unsigned i = 0; i < n; i++) {
-        const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];
+        const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];
         printf("%-20" PRIsflash " %" PRIsflash "\n",
                      entry->name, entry->desc);
     }

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,6 @@`
`36`	`36`	`#include <assert.h>`
`37`	`37`	`#include <errno.h>`
`38`	`38`
`39`		`-#include "kernel_defines.h"`
`40`	`39`	`#include "xfa.h"`
`41`	`40`	`#include "shell.h"`
`42`	`41`	`#include "shell_lock.h"`
`@@ -47,7 +46,7 @@`
`47`	`46`	`#endif`
`48`	`47`
`49`	`48`	`/* define shell command cross file array */`
`50`		`-XFA_INIT_CONST(shell_command_xfa_t*, shell_commands_xfa);`
	`49`	`+XFA_INIT_CONST(shell_command_xfa_t, shell_commands_xfa_v2);`
`51`	`50`
`52`	`51`	`#define ETX '\x03' /** ASCII "End-of-Text", or Ctrl-C */`
`53`	`52`	`#define EOT '\x04' /** ASCII "End-of-Transmission", or Ctrl-D */`
`@@ -102,10 +101,10 @@ static shell_command_handler_t search_commands(const shell_command_t *entry,`
`102`	`101`
`103`	`102`	`static shell_command_handler_t search_commands_xfa(char *command)`
`104`	`103`	`{`
`105`		`- unsigned n = XFA_LEN(shell_command_t*, shell_commands_xfa);`
	`104`	`+ unsigned n = XFA_LEN(shell_command_t, shell_commands_xfa_v2);`
`106`	`105`
`107`	`106`	`for (unsigned i = 0; i < n; i++) {`
`108`		`- const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];`
	`107`	`+ const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];`
`109`	`108`	`if (flash_strcmp(command, entry->name) == 0) {`
`110`	`109`	`return entry->handler;`
`111`	`110`	`}`
`@@ -147,15 +146,15 @@ static void print_commands_json(const shell_command_t *cmd_list)`
`147`	`146`	`}`
`148`	`147`	`}`
`149`	`148`
`150`		`- unsigned n = XFA_LEN(shell_command_xfa_t*, shell_commands_xfa);`
	`149`	`+ unsigned n = XFA_LEN(shell_command_xfa_t, shell_commands_xfa_v2);`
`151`	`150`	`for (unsigned i = 0; i < n; i++) {`
`152`	`151`	`if (first) {`
`153`	`152`	`first = false;`
`154`	`153`	`}`
`155`	`154`	`else {`
`156`	`155`	`printf(", ");`
`157`	`156`	`}`
`158`		`- const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];`
	`157`	`+ const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];`
`159`	`158`	`printf("{\"cmd\": \"%s\", \"desc\": \"%s\"}", entry->name, entry->desc);`
`160`	`159`	`}`
`161`	`160`	`puts("]}");`
`@@ -170,9 +169,9 @@ static void print_commands(const shell_command_t *entry)`
`170`	`169`
`171`	`170`	`static void print_commands_xfa(void)`
`172`	`171`	`{`
`173`		`- unsigned n = XFA_LEN(shell_command_xfa_t*, shell_commands_xfa);`
	`172`	`+ unsigned n = XFA_LEN(shell_command_xfa_t, shell_commands_xfa_v2);`
`174`	`173`	`for (unsigned i = 0; i < n; i++) {`
`175`		`- const volatile shell_command_xfa_t *entry = shell_commands_xfa[i];`
	`174`	`+ const volatile shell_command_xfa_t *entry = &shell_commands_xfa_v2[i];`
`176`	`175`	`printf("%-20" PRIsflash " %" PRIsflash "\n",`
`177`	`176`	`entry->name, entry->desc);`
`178`	`177`	`}`