From: Stefano Brivio <sbrivio@redhat.com>
To: David Gibson <david@gibson.dropbear.id.au>,
Laine Stump <laine@redhat.com>
Cc: passt-dev@passt.top, laine@laine.org
Subject: Re: [PATCH v2 2/9] add errexit() to log an error message and exit with a single call
Date: Mon, 13 Feb 2023 11:46:18 +0100 [thread overview]
Message-ID: <20230213114618.40cf2021@elisabeth> (raw)
In-Reply-To: <Y+ms+Q0qV0BI/8fZ@yekko>
On Mon, 13 Feb 2023 14:22:33 +1100
David Gibson <david@gibson.dropbear.id.au> wrote:
> On Thu, Feb 09, 2023 at 06:45:32PM +0100, Stefano Brivio wrote:
> > On Wed, 8 Feb 2023 12:48:31 -0500
> > Laine Stump <laine@redhat.com> wrote:
> >
> > > Almost all occurences of err() are either immediately followed by
> > > exit(EXIT_FAILURE), usage(argv[0]) (which itself then calls
> > > exit(EXIT_FAILURE), or that is what's done immediately after returning
> > > from the function that calls err(). Modify the errfn macro so that its
> > > instantiations can include exit(EXIT_FAILURE) at the end, and use that
> > > to create a new function errxit() that will log an error and then
> > > exit.
> > >
> > > Signed-off-by: Laine Stump <laine@redhat.com>
> > > ---
> > > log.c | 13 ++++++++-----
> > > log.h | 1 +
> > > 2 files changed, 9 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/log.c b/log.c
> > > index 0ab0adf..4956914 100644
> > > --- a/log.c
> > > +++ b/log.c
> > > @@ -45,7 +45,7 @@ static char log_header[BUFSIZ]; /* File header, written back on cuts */
> > > static time_t log_start; /* Start timestamp */
> > > int log_trace; /* --trace mode enabled */
> > >
> > > -#define logfn(name, level) \
> > > +#define logfn(name, level, doexit) \
> > > void name(const char *format, ...) { \
> > > struct timespec tp; \
> > > va_list args; \
> > > @@ -76,6 +76,8 @@ void name(const char *format, ...) { \
> > > if (format[strlen(format)] != '\n') \
> > > fprintf(stderr, "\n"); \
> > > } \
> > > + if (doexit) \
> >
> > A blank line before this would make it more consistent.
> >
> > > + exit(EXIT_FAILURE); \
> > > }
> > >
> > > /* Prefixes for log file messages, indexed by priority */
> > > @@ -88,10 +90,11 @@ const char *logfile_prefix[] = {
> > > " ", /* LOG_DEBUG */
> > > };
> > >
> > > -logfn(err, LOG_ERR)
> > > -logfn(warn, LOG_WARNING)
> > > -logfn(info, LOG_INFO)
> > > -logfn(debug, LOG_DEBUG)
> > > +logfn(errexit, LOG_ERR, 1)
> > > +logfn(err, LOG_ERR, 0)
> > > +logfn(warn, LOG_WARNING, 0)
> > > +logfn(info, LOG_INFO, 0)
> > > +logfn(debug, LOG_DEBUG, 0)
> > >
> > > /**
> > > * log_go_daemon() - tell logging subsystem that the process has been
> > > diff --git a/log.h b/log.h
> > > index a57c777..ed19415 100644
> > > --- a/log.h
> > > +++ b/log.h
> > > @@ -10,6 +10,7 @@
> > > #define LOGFILE_CUT_RATIO 30 /* When full, cut ~30% size */
> > > #define LOGFILE_SIZE_MIN (5UL * MAX(BUFSIZ, PAGE_SIZE))
> > >
> > > +void errexit(const char *format, ...);
> > > void err(const char *format, ...);
> > > void warn(const char *format, ...);
> > > void info(const char *format, ...);
> >
> > Other than that, this looks good to me.
>
> LGTM. Personally I like to call such functions "die()".
I was about to suggest that (it's shorter and conveys the same meaning),
then I thought die() would be a common library function. Actually, it's
not -- so I would also favour die() here.
--
Stefano
next prev parent reply other threads:[~2023-02-13 10:46 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-08 17:48 [PATCH v2 0/9] error logging fixes Laine Stump
2023-02-08 17:48 ` [PATCH v2 1/9] log to stderr until process is daemonized, even if a logfile is set Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-14 3:41 ` Laine Stump
2023-02-08 17:48 ` [PATCH v2 2/9] add errexit() to log an error message and exit with a single call Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-13 3:22 ` David Gibson
2023-02-13 10:46 ` Stefano Brivio [this message]
2023-02-08 17:48 ` [PATCH v2 3/9] eliminate most calls to usage() in conf() Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-08 17:48 ` [PATCH v2 4/9] make conf_ports() exit immediately after logging error Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-08 17:48 ` [PATCH v2 5/9] make conf_pasta_ns() " Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-08 17:48 ` [PATCH v2 6/9] make conf_ugid() " Laine Stump
2023-02-13 4:23 ` Laine Stump
2023-02-08 17:48 ` [PATCH v2 7/9] make conf_netns_opt() " Laine Stump
2023-02-08 17:48 ` [PATCH v2 8/9] log a detailed error (not usage()) when there are extra non-option arguments Laine Stump
2023-02-09 17:45 ` Stefano Brivio
2023-02-08 17:48 ` [PATCH v2 9/9] convert all remaining err() followed by exit() to errexit() Laine Stump
2023-02-09 17:45 ` Stefano Brivio
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230213114618.40cf2021@elisabeth \
--to=sbrivio@redhat.com \
--cc=david@gibson.dropbear.id.au \
--cc=laine@laine.org \
--cc=laine@redhat.com \
--cc=passt-dev@passt.top \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://passt.top/passt
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for IMAP folder(s).