git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 09/13] parse-options API: don't restrict OPT_SUBCOMMAND() to one *_fn type

From
Đoàn Trần Công Danh <congdanhqx@gmail.com>
Date
Nov 5, 2022, 11:34 UTC
Message-ID
<Y2ZKHPkEXViv9wcp@danh.dev>
In-Reply-To
<df855ba1-52b1-1007-68e8-2e28e85b6822@web.de>
 
On 2022-11-05 09:32:44+0100, René Scharfe <l.s.r@web.de> wrote:
Show 64 quoted lines
> > diff --git a/parse-options.h b/parse-options.h
> > index b6ef86e0d15..61e3016c3fc 100644
> > --- a/parse-options.h
> > +++ b/parse-options.h
> > @@ -128,19 +128,24 @@ typedef int parse_opt_subcommand_fn(int argc, const char **argv,
> >   *			 the option takes optional argument.
> >   *
> >   * `callback`::
> > - *   pointer to the callback to use for OPTION_CALLBACK
> > + *   pointer to the callback to use for OPTION_CALLBACK and OPTION_SUBCOMMAND.
> >   *
> >   * `defval`::
> >   *   default value to fill (*->value) with for PARSE_OPT_OPTARG.
> >   *   OPTION_{BIT,SET_INT} store the {mask,integer} to put in the value when met.
> > + *   OPTION_SUBCOMMAND stores the pointer the function selected for
> > + *   the subcommand.
> > + *
> >   *   CALLBACKS can use it like they want.
> >   *
> >   * `ll_callback`::
> >   *   pointer to the callback to use for OPTION_LOWLEVEL_CALLBACK
> >   *
> >   * `subcommand_fn`::
> > - *   pointer to a function to use for OPTION_SUBCOMMAND.
> > - *   It will be put in value when the subcommand is given on the command line.
> > + *   pointer to the callback used with OPT_SUBCOMMAND() and
> > + *   OPT_SUBCOMMAND_F(). Internally we store the same value in
> > + *   `defval`. This is only here to give the OPT_SUBCOMMAND{,_F}()
> > + *   common case type safety.
> >   */
> >  struct option {
> >  	enum parse_opt_type type;
> > @@ -217,12 +222,24 @@ struct option {
> >  #define OPT_ALIAS(s, l, source_long_name) \
> >  	{ OPTION_ALIAS, (s), (l), (source_long_name) }
> >
> > +static inline int parse_options_pick_subcommand_cb(const struct option *option,
> > +						   const char *arg UNUSED,
> > +						   int unset UNUSED)
> > +{
> > +	parse_opt_subcommand_fn *fn = (parse_opt_subcommand_fn *)option->defval;
> > +	*(parse_opt_subcommand_fn **)option->value = fn;
> 
> ->defval is of type intptr_t and ->value is a void pointer.  The result
> of converting a void pointer value to an intptr_t and back is a void
> pointer equal to the original pointer if I read 6.3.2.3 (Pointers,
> paragraphs 5 and 6) and 7.18.1.4 (Integer types capable of holding
> object pointers) in C99 correctly.
> 
> 6.3.2.3 paragraph 8 says that casting between function pointers of
> different type is OK and you can get your original function pointer
> back and use it in a call if you convert it back to the right type.
> 
> Casting between a function pointer and an object pointer is undefined,
> though.  They don't have to be of the same size, so a function pointer
> doesn't have to fit into an intptr_t.  I wouldn't be surprised if CHERI
> (https://www.cl.cam.ac.uk/research/security/ctsrd/cheri/) was an actual
> example of that.
> 
> Why is this trickery needed?  Above you write that callbacks in
> builtin/bisect--helper.c can't use subcommand_fn because they need
> their own argument.  Can we extend subcommand_fn or use a global
> variable to pass that extra thing instead?  The latter may be ugly, but
> at least it's valid C..

Not the author, but I fully agree with you, I think instead of adding new API for some arbitrary subcommand_fn, I would change the subcommand_fn to type:

	int (*)(int argc, const char **argv, const char *prefix, void *context)

The last argument would be an object pointer, which will be casted to the correct type inside the callback.

Let me cherry-picking this series on top of mine to see how things would progress.

Show 22 quoted lines
> > +	return 0;
> > +}
> > +
> >  #define OPT_SUBCOMMAND_F(l, v, fn, f) { \
> >  	.type = OPTION_SUBCOMMAND, \
> >  	.long_name = (l), \
> >  	.value = (v), \
> >  	.flags = (f), \
> > -	.subcommand_fn = (fn) }
> > +	.defval = (intptr_t)(fn), \
> > +	.subcommand_fn = (fn), \
> > +	.callback = parse_options_pick_subcommand_cb, \
> 
> Getting the address of an inline function feels weird, but the compiler
> is free to emit to ignore that keyword and will provide an addressable
> function object here.
> 
> > +}
> >  #define OPT_SUBCOMMAND(l, v, fn)    OPT_SUBCOMMAND_F((l), (v), (fn), 0)
> >
> >  /*
> 
-- 
Danh
Previous: René ScharfeNext: Phillip Wood
Message 87 of 106 in “"git bisect run" strips "--log" from the list of arguments”
  1. Lukáš DoktorNov 4, 2022
  2. Jeff KingNov 4, 2022
  3. Đoàn Trần Công DanhNov 4, 2022
  4. Jeff KingNov 4, 2022
  5. Ævar Arnfjörð BjarmasonNov 4, 2022
  6. Jeff KingNov 4, 2022
  7. Ævar Arnfjörð BjarmasonNov 4, 2022
  8. SZEDER GáborNov 4, 2022
  9. Jeff KingNov 4, 2022
  10. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 4, 2022
  11. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 4, 2022
  12. Jeff KingNov 4, 2022
  13. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 4, 2022
  14. Jeff KingNov 4, 2022
  15. Ævar Arnfjörð BjarmasonNov 4, 2022
  16. Đoàn Trần Công DanhNov 4, 2022
  17. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 4, 2022
  18. Jeff KingNov 4, 2022
  19. Ævar Arnfjörð BjarmasonNov 4, 2022
  20. Đoàn Trần Công DanhNov 4, 2022
  21. Ævar Arnfjörð BjarmasonNov 4, 2022
  22. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 5, 2022
  23. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 5, 2022
  24. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 5, 2022
  25. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 5, 2022
  26. Đoàn Trần Công DanhNov 5, 2022
  27. 00/13 Turn git-bisect to be builtinĐoàn Trần Công Danh, Nov 5, 2022
  28. 01/13 bisect tests: test for v2.30.0 "bisect run" regressionsĐoàn Trần Công Danh, Nov 5, 2022
  29. Ævar Arnfjörð BjarmasonNov 7, 2022
  30. Đoàn Trần Công DanhNov 8, 2022
  31. 02/13 bisect: refactor bisect_run() to match CodingGuidelinesĐoàn Trần Công Danh, Nov 5, 2022
  32. 03/13 bisect--helper: pass arg[cv] down to do_bisect_runĐoàn Trần Công Danh, Nov 5, 2022
  33. 04/13 bisect: fix output regressions in v2.30.0Đoàn Trần Công Danh, Nov 5, 2022
  34. 05/13 bisect run: keep some of the post-v2.30.0 outputĐoàn Trần Công Danh, Nov 5, 2022
  35. Ævar Arnfjörð BjarmasonNov 7, 2022
  36. Đoàn Trần Công DanhNov 8, 2022
  37. Ævar Arnfjörð BjarmasonNov 8, 2022
  38. 06/13 bisect--helper: remove unused arguments from do_bisect_runĐoàn Trần Công Danh, Nov 5, 2022
  39. 07/13 bisect--helper: pretend we're real bisect when report errorĐoàn Trần Công Danh, Nov 5, 2022
  40. Ævar Arnfjörð BjarmasonNov 7, 2022
  41. 08/13 bisect test: test exit codes on bad usageĐoàn Trần Công Danh, Nov 5, 2022
  42. 09/13 bisect--helper: emit usage for "git bisect"Đoàn Trần Công Danh, Nov 5, 2022
  43. 10/13 bisect--helper: make `state` optionalĐoàn Trần Công Danh, Nov 5, 2022
  44. 11/13 bisect--helper: remove subcommand stateĐoàn Trần Công Danh, Nov 5, 2022
  45. Ævar Arnfjörð BjarmasonNov 7, 2022
  46. Đoàn Trần Công DanhNov 8, 2022
  47. 12/13 bisect--helper: log: allow arbitrary number of argumentsĐoàn Trần Công Danh, Nov 5, 2022
  48. 13/13 Turn `git bisect` into a full built-inĐoàn Trần Công Danh, Nov 5, 2022
  49. Taylor BlauNov 5, 2022
  50. 0/3 Convert git-bisect--helper to OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 10, 2022
  51. 1/3 bisect--helper: remove unused optionsĐoàn Trần Công Danh, Nov 10, 2022
  52. Ævar Arnfjörð BjarmasonNov 11, 2022
  53. 2/3 bisect--helper: move all subcommands into their own functionsĐoàn Trần Công Danh, Nov 10, 2022
  54. Ævar Arnfjörð BjarmasonNov 11, 2022
  55. 3/3 bisect--helper: parse subcommand with OPT_SUBCOMMANDĐoàn Trần Công Danh, Nov 10, 2022
  56. 00/11 Turn git-bisect to be builtinĐoàn Trần Công Danh, Nov 10, 2022
  57. 02/11 bisect: refactor bisect_run() to match CodingGuidelinesĐoàn Trần Công Danh, Nov 10, 2022
  58. 01/11 bisect tests: test for v2.30.0 "bisect run" regressionsĐoàn Trần Công Danh, Nov 10, 2022
  59. 03/11 bisect: fix output regressions in v2.30.0Đoàn Trần Công Danh, Nov 10, 2022
  60. 04/11 bisect run: keep some of the post-v2.30.0 outputĐoàn Trần Công Danh, Nov 10, 2022
  61. 05/11 bisect-run: verify_good: account for non-negative exit statusĐoàn Trần Công Danh, Nov 10, 2022
  62. 06/11 bisect--helper: identify as bisect when report errorĐoàn Trần Công Danh, Nov 10, 2022
  63. 07/11 bisect test: test exit codes on bad usageĐoàn Trần Công Danh, Nov 10, 2022
  64. 08/11 bisect--helper: emit usage for "git bisect"Đoàn Trần Công Danh, Nov 10, 2022
  65. 09/11 bisect--helper: handle states directlyĐoàn Trần Công Danh, Nov 10, 2022
  66. 10/11 bisect--helper: log: allow arbitrary number of argumentsĐoàn Trần Công Danh, Nov 10, 2022
  67. Ævar Arnfjörð BjarmasonNov 11, 2022
  68. 11/11 Turn `git bisect` into a full built-inĐoàn Trần Công Danh, Nov 10, 2022
  69. Ævar Arnfjörð BjarmasonNov 11, 2022
  70. Jeff KingNov 11, 2022
  71. Ævar Arnfjörð BjarmasonNov 11, 2022
  72. Taylor BlauNov 11, 2022
  73. Taylor BlauNov 15, 2022
  74. Jeff KingNov 15, 2022
  75. Taylor BlauNov 15, 2022
  76. Ævar Arnfjörð BjarmasonNov 11, 2022
  77. 00/13 bisect: v2.30.0 "run" regressions + make it built-inÆvar Arnfjörð Bjarmason, Nov 4, 2022
  78. 01/13 bisect tests: test for v2.30.0 "bisect run" regressionsÆvar Arnfjörð Bjarmason, Nov 4, 2022
  79. 02/13 bisect: refactor bisect_run() to match CodingGuidelinesÆvar Arnfjörð Bjarmason, Nov 4, 2022
  80. 04/13 bisect run: fix "--log" eating regression in v2.30.0Ævar Arnfjörð Bjarmason, Nov 4, 2022
  81. 03/13 bisect: fix output regressions in v2.30.0Ævar Arnfjörð Bjarmason, Nov 4, 2022
  82. 05/13 bisect run: keep some of the post-v2.30.0 outputÆvar Arnfjörð Bjarmason, Nov 4, 2022
  83. 06/13 bisect test: test exit codes on bad usageÆvar Arnfjörð Bjarmason, Nov 4, 2022
  84. 07/13 bisect--helper: emit usage for "git bisect"Ævar Arnfjörð Bjarmason, Nov 4, 2022
  85. 09/13 parse-options API: don't restrict OPT_SUBCOMMAND() to one *_fn typeÆvar Arnfjörð Bjarmason, Nov 4, 2022
  86. René ScharfeNov 5, 2022
  87. Đoàn Trần Công DanhNov 5, 2022
  88. Phillip WoodNov 5, 2022
  89. Ævar Arnfjörð BjarmasonNov 5, 2022
  90. Phillip WoodNov 5, 2022
  91. Ævar Arnfjörð BjarmasonNov 5, 2022
  92. René ScharfeNov 5, 2022
  93. Ævar Arnfjörð BjarmasonNov 5, 2022
  94. René ScharfeNov 6, 2022
  95. Ævar Arnfjörð BjarmasonNov 6, 2022
  96. René ScharfeNov 12, 2022
  97. Jeff KingNov 12, 2022
  98. Ævar Arnfjörð BjarmasonNov 12, 2022
  99. René ScharfeNov 13, 2022
  100. 08/13 bisect--helper: have all functions take state, argc, argv, prefixÆvar Arnfjörð Bjarmason, Nov 4, 2022
  101. 10/13 bisect--helper: remove dead --bisect-{next-check,autostart} codeÆvar Arnfjörð Bjarmason, Nov 4, 2022
  102. 11/13 bisect--helper: convert to OPT_SUBCOMMAND_CB()Ævar Arnfjörð Bjarmason, Nov 4, 2022
  103. 12/13 bisect--helper: make `state` optionalÆvar Arnfjörð Bjarmason, Nov 4, 2022
  104. 13/13 Turn `git bisect` into a full built-inÆvar Arnfjörð Bjarmason, Nov 4, 2022
  105. Taylor BlauNov 5, 2022
  106. Johannes SchindelinNov 10, 2022

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.