Add build information to libavrdude and avrdude and display it #1698

ndim · 2024-02-21T17:35:15Z

The goal of this Draft PR is to develop a way to add useful build information to libavrdude and avrdude, give libavrdude users (like avrdude) access to that buildinfo, and have avrdude show the buildinfo.

The ideas for this were originally discussed in #1681 (comment) and the following comments.

This is a basic proof of concept for showing a long verbose message with build information. The verbosity, the exact information, its representation, the API and ABI are subject to discussion.

At this time, the code is based on PR #1681.

This is quick and dirty and not tested comprehensively:

Switch avrdude's main.c from getopt() to getopt_long() (available on GNU, BSD, and
the existing msvc/getopt.[ch] already implement getopt_long() on
Windows)
Add --version argument which shows a long version message.

As -V is already in use, the version message is available only with the long form --version.
Define build information for libavrdude and the avrdude tool
- in buildinfo.c and libavrdude.h for libavrdude
- in main.c for avrdude

The result looks about like

avrdude (...) 7.3-20240221 (28e6f254)
Copyright (C) ...
License GPL...
This is free software...
avrdude 7.3-20240221 (28e6f254)
  1. buildsystem: autotools
libavrdude 7.3-20240221 (28e6f254)
  1. buildsystem: autotools
  2. libelf
  3. libusb
  4. libusb_1_0
  5. libhidapi
  6. libftdi1
  7. libreadline
  8. libserialport
  9. parport
 10. linuxgpio
 11. linuxspi

ndim · 2024-02-21T20:22:08Z

Interestingly, the msvc x64 build fails when compiling buildinfo.c, because the included libavrdude.h uses PATH_MAX as an array size but PATH_MAX is not defined in the msvc x64 environment.

stefanrueger · 2024-02-22T02:49:47Z

src/libavrdude.h

@@ -1522,8 +1526,8 @@ void terminal_setup_update_progress();
 extern "C" {
 #endif

-void win_sys_config_set(char sys_config[PATH_MAX]);
-void win_usr_config_set(char usr_config[PATH_MAX]);
+void win_sys_config_set(char *sys_config);


Well spotted!

After removing all uses of PATH_MAX from libavrdude.h, it might also be possible to remove the header file #include which used to pull in the header file defining PATH_MAX.

That will certainly improve portability.

stefanrueger · 2024-02-22T02:52:33Z

src/libavrdude.h

@@ -866,7 +866,11 @@ typedef struct {                // Memory cache for a subset of cached pages
 #define OFF                  0 // Many contexts: reset, power, LEDs, ...
 #define ON                   1 // Many contexts

+#ifdef PATH_MAX


I have never been happy with the port[] array in the programmer structure, so I have now created PR #1699 that does away with this array and uses just a const char * pointer. As a consequence PGM_PORTLEN should no longer be needed once that PR is merged.

MCUdude · 2024-02-22T09:26:01Z

src/main.c

+  const char *const *libavrdude_buildinfo = avr_get_buildinfo();
+  printf("libavrdude %s\n", libavrdude_buildinfo[0]);
+  print_buildinfos(libavrdude_buildinfo);
+}


Is there a good reason to use printf instead of msg_info here?

It is a quick hack proof of concept, and I have not familiarized myself with the message API yet, so... No :-)

No worries, take your time. For reference, here are all of them:

avrdude/src/avrdude.h

Lines 64 to 96 in 5c1649d

// Shortcuts

#define msg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_EXT_ERROR, __VA_ARGS__)

#define msg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_ERROR, __VA_ARGS__)

#define msg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_WARNING, __VA_ARGS__)

#define msg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_INFO, __VA_ARGS__)

#define msg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_NOTICE, __VA_ARGS__)

#define msg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_NOTICE2, __VA_ARGS__)

#define msg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_DEBUG, __VA_ARGS__)

#define msg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_TRACE, __VA_ARGS__)

#define msg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_TRACE2, __VA_ARGS__)

#define pmsg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FUNCTION|MSG2_FILELINE|MSG2_TYPE|MSG2_FLUSH, MSG_EXT_ERROR, __VA_ARGS__)

#define pmsg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FUNCTION|MSG2_FILELINE|MSG2_TYPE|MSG2_FLUSH, MSG_ERROR, __VA_ARGS__)

#define pmsg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FUNCTION|MSG2_FILELINE|MSG2_TYPE|MSG2_FLUSH, MSG_WARNING, __VA_ARGS__)

#define pmsg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_INFO, __VA_ARGS__)

#define pmsg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_NOTICE, __VA_ARGS__)

#define pmsg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_NOTICE2, __VA_ARGS__)

#define pmsg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_DEBUG, __VA_ARGS__)

#define pmsg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_TRACE, __VA_ARGS__)

#define pmsg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME|MSG2_FLUSH, MSG_TRACE2, __VA_ARGS__)

#define imsg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1|MSG2_FLUSH, MSG_EXT_ERROR, __VA_ARGS__)

#define imsg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1|MSG2_FLUSH, MSG_ERROR, __VA_ARGS__)

#define imsg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1|MSG2_FLUSH, MSG_WARNING, __VA_ARGS__)

#define imsg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_INFO, __VA_ARGS__)

#define imsg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_NOTICE, __VA_ARGS__)

#define imsg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_NOTICE2, __VA_ARGS__)

#define imsg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_DEBUG, __VA_ARGS__)

#define imsg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_TRACE, __VA_ARGS__)

#define imsg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2|MSG2_FLUSH, MSG_TRACE2, __VA_ARGS__)

#define term_out(...) avrdude_message2(stdout, __LINE__, __FILE__, __func__, MSG2_FLUSH, MSG_INFO, __VA_ARGS__)

#define fmsg_out(fp, ...) avrdude_message2(fp, __LINE__, __FILE__, __func__, MSG2_FLUSH, MSG_INFO, __VA_ARGS__)

There are msg_* macros that just print whatever you insert.

There are pmsg_* that prints avrdude: and then whatever you insert

There are imsg_* that indents so that text printed on the screen will align with p_msg

And suffixes:

There are _info which prints what you insert regardless of mode

There are notice that will print with one or more -v's

There are notice2 that will print with two or more -v's

And more 🙂

ndim · 2024-07-31T16:36:04Z

As build version information is system independent, build version (git branches, etc.) information it relatively simple to add.

Adding information about the optional libraries and features built into this version is a bit more complex. To do that properly, we need to build a bit of build infrastructure, and then make use of that:

cmake buildsystem function generate .c files containing build information for avrdude and libavrdude
automake buildsystem macro generate .c files containing build information for avrdude and libavrdude, possibly emulating the VERSIONINFO_SETUP to fetch that information from the cmake config files
build object file with build information and link that into the avrdude executable and libavrdude library
Add avrdude --version or something similar which shows all that verbose build information (note that avrdude does not support long form arguments until now)

Aiming for a quicker, "good enough" class of solution first, then the proper one.

stefanrueger · 2024-08-06T12:15:29Z

Same here: @ndim Just an advance warning that the team have started testing with a view to release v8.0 around the w/end 17/18 Aug. If you have time to bring this PR into a shape that we can merge even partial progress that would be brill (but no worries if not).

stefanrueger · 2024-08-06T12:18:23Z

BTW, I think the merge conflict comes about b/c the getopt() options were slightly changed: Y was deprecated and has no longer an optional argument, so the last : was removed....

ndim · 2024-08-06T22:25:06Z

Update: Issue solved already. I should read my own commit comments.

The biggest problem here is that my Linux getopt(3) man page says getopt() is part of POSIX.1-2008, while getopt_long() is GNU. And GNU functions do not necessarily work on BSD, OSX, and Windows.

ndim · 2024-08-06T22:28:23Z

Oh, and I want a different C API for the version information. The "list of strings" as used by libgphoto2 has drawbacks. I would prefer a "list of key-value-pairs" type of interface, with keys like "gpiod" and values like "<1.4" or ">=1.4<1.8" or ">= 1.8".

Such an API should be well thought out, as it should last at least 10 years. Not sure this should be rushed within the next 10 days.

ndim · 2024-11-27T01:42:38Z

That this PR now building on the #1936 PR which now introduces the long options like --help in addition to the classic short -? options.

Switch the command line argument parser from getopt(3) to getopt_long(3) and add a few long options as aliases to existing short options, e.g. "--help" and "--part" being aliases for "-?" and "-p", respectively. The getopt_long(3) function is available on GNU, BSD, and the existing msvc/getopt.[ch] already implements getopt_long() on Windows. This should cover all systems avrdude supports. Adapt the avrdude usage message shown by "-?" or "--help" to show the new long options. TODO: Adapt man page and texi manual reflecting the long options. Closes: avrdudes#1922

Add basic buildinfo ideas, quick and dirty and not tested comprehensively: * Define build information for libavrdude and the avrdude CLI tool * Add a long "--version" argument which shows a long version message. This buildinfo contains the name and version of the software component, and then a key-value-list for each buildinfo item.

Next: Create a output messages file, and a C include file. TODO: Name the generated files buildinfo-include.c and buildinfo-messages.txt

* use the same file names for messages and C code * print the same "Configuration summary" output

stefanrueger reviewed Feb 22, 2024

View reviewed changes

mcuee added the enhancement New feature or request label Feb 22, 2024

MCUdude reviewed Feb 22, 2024

View reviewed changes

ndim mentioned this pull request Feb 23, 2024

Improve autotool build (part 1/n) #1681

Merged

ndim force-pushed the add-build-information branch 2 times, most recently from 0fa4d47 to f5bfe97 Compare February 25, 2024 23:10

mcuee added bug Something isn't working and removed bug Something isn't working labels Feb 25, 2024

ndim force-pushed the add-build-information branch from 4e9c7ba to 67330c7 Compare February 29, 2024 07:23

ndim force-pushed the add-build-information branch 2 times, most recently from f09ff55 to 2c53d4b Compare July 31, 2024 15:01

ndim force-pushed the add-build-information branch 2 times, most recently from 2e08789 to fedf11b Compare August 7, 2024 01:32

ndim force-pushed the add-build-information branch 2 times, most recently from fdb0603 to ab7d9dc Compare August 24, 2024 21:18

ndim force-pushed the add-build-information branch from ab7d9dc to 8848265 Compare September 4, 2024 15:29

ndim mentioned this pull request Sep 8, 2024

Support options like --config --part and --port #1922

Open

ndim mentioned this pull request Oct 9, 2024

Add extra version information to avrdude output #1927

Merged

ndim force-pushed the add-build-information branch 5 times, most recently from ad4c30c to 3aad70d Compare November 27, 2024 01:33

ndim added 6 commits November 27, 2024 02:44

XXX buildinfo: initial buildsystem hookups

ce92676

XXX skeleton m4 macros

7800a85

XXX cmake function with arguments

b092255

Next: Create a output messages file, and a C include file. TODO: Name the generated files buildinfo-include.c and buildinfo-messages.txt

XXX same behaviour between automake and cmake builds

6c6b816

* use the same file names for messages and C code * print the same "Configuration summary" output

ndim force-pushed the add-build-information branch 2 times, most recently from 8f900ca to 6c6b816 Compare November 27, 2024 01:52

ndim added 5 commits November 27, 2024 03:08

Move messages for libelf

24dcf8b

Move messages for libusb libusb_1_0

f8f8f24

Move messages for libhidapi

6d1006e

Move messages for linuxspi

eb6737e

FMU cmake output buildinfo on stdout

0fc8e8e

ndim force-pushed the add-build-information branch from 7040fb2 to 0fc8e8e Compare November 27, 2024 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add build information to libavrdude and avrdude and display it #1698

Add build information to libavrdude and avrdude and display it #1698

ndim commented Feb 21, 2024 •

edited

Loading

ndim commented Feb 21, 2024

stefanrueger Feb 22, 2024

ndim Feb 22, 2024

stefanrueger Feb 22, 2024

MCUdude Feb 22, 2024

ndim Feb 22, 2024

MCUdude Feb 22, 2024

ndim commented Jul 31, 2024 •

edited by MCUdude

Loading

stefanrueger commented Aug 6, 2024

stefanrueger commented Aug 6, 2024

ndim commented Aug 6, 2024 •

edited

Loading

ndim commented Aug 6, 2024

ndim commented Nov 27, 2024

	// Shortcuts
	#define msg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_EXT_ERROR, __VA_ARGS__)
	#define msg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_ERROR, __VA_ARGS__)
	#define msg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_WARNING, __VA_ARGS__)
	#define msg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_INFO, __VA_ARGS__)
	#define msg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_NOTICE, __VA_ARGS__)
	#define msg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_NOTICE2, __VA_ARGS__)
	#define msg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_DEBUG, __VA_ARGS__)
	#define msg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_TRACE, __VA_ARGS__)
	#define msg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, 0, MSG_TRACE2, __VA_ARGS__)

	#define pmsg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FUNCTION\|MSG2_FILELINE\|MSG2_TYPE\|MSG2_FLUSH, MSG_EXT_ERROR, __VA_ARGS__)
	#define pmsg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FUNCTION\|MSG2_FILELINE\|MSG2_TYPE\|MSG2_FLUSH, MSG_ERROR, __VA_ARGS__)
	#define pmsg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FUNCTION\|MSG2_FILELINE\|MSG2_TYPE\|MSG2_FLUSH, MSG_WARNING, __VA_ARGS__)
	#define pmsg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_INFO, __VA_ARGS__)
	#define pmsg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_NOTICE, __VA_ARGS__)
	#define pmsg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_NOTICE2, __VA_ARGS__)
	#define pmsg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_DEBUG, __VA_ARGS__)
	#define pmsg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_TRACE, __VA_ARGS__)
	#define pmsg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_PROGNAME\|MSG2_FLUSH, MSG_TRACE2, __VA_ARGS__)

	#define imsg_ext_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1\|MSG2_FLUSH, MSG_EXT_ERROR, __VA_ARGS__)
	#define imsg_error(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1\|MSG2_FLUSH, MSG_ERROR, __VA_ARGS__)
	#define imsg_warning(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT1\|MSG2_FLUSH, MSG_WARNING, __VA_ARGS__)
	#define imsg_info(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_INFO, __VA_ARGS__)
	#define imsg_notice(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_NOTICE, __VA_ARGS__)
	#define imsg_notice2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_NOTICE2, __VA_ARGS__)
	#define imsg_debug(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_DEBUG, __VA_ARGS__)
	#define imsg_trace(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_TRACE, __VA_ARGS__)
	#define imsg_trace2(...) avrdude_message2(stderr, __LINE__, __FILE__, __func__, MSG2_INDENT2\|MSG2_FLUSH, MSG_TRACE2, __VA_ARGS__)

	#define term_out(...) avrdude_message2(stdout, __LINE__, __FILE__, __func__, MSG2_FLUSH, MSG_INFO, __VA_ARGS__)
	#define fmsg_out(fp, ...) avrdude_message2(fp, __LINE__, __FILE__, __func__, MSG2_FLUSH, MSG_INFO, __VA_ARGS__)

Add build information to libavrdude and avrdude and display it #1698

Are you sure you want to change the base?

Add build information to libavrdude and avrdude and display it #1698

Conversation

ndim commented Feb 21, 2024 • edited Loading

ndim commented Feb 21, 2024

stefanrueger Feb 22, 2024

Choose a reason for hiding this comment

ndim Feb 22, 2024

Choose a reason for hiding this comment

stefanrueger Feb 22, 2024

Choose a reason for hiding this comment

MCUdude Feb 22, 2024

Choose a reason for hiding this comment

ndim Feb 22, 2024

Choose a reason for hiding this comment

MCUdude Feb 22, 2024

Choose a reason for hiding this comment

ndim commented Jul 31, 2024 • edited by MCUdude Loading

stefanrueger commented Aug 6, 2024

stefanrueger commented Aug 6, 2024

ndim commented Aug 6, 2024 • edited Loading

ndim commented Aug 6, 2024

ndim commented Nov 27, 2024

ndim commented Feb 21, 2024 •

edited

Loading

ndim commented Jul 31, 2024 •

edited by MCUdude

Loading

ndim commented Aug 6, 2024 •

edited

Loading