Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix upslog legacy code #2762

Merged
merged 4 commits into from
Jan 15, 2025
Merged

Fix upslog legacy code #2762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a17b8e1
clients/upslog.{c,h}: move definitions of logtarget_t and monhost_ups…
jimklimov Jan 11, 2025
1bc6526
clients/upslog.c: main loop: do not rely on "ups" variable as such
jimklimov Jan 11, 2025
38e6d38
clients/upslog.{c,h}, NEWS.adoc: refactor to pass monhost_ups_t* to m…
jimklimov Jan 11, 2025
4761ab4
clients/upslog.c, docs/man/upslog.txt, NEWS.adoc: Added `-N` to prefi…
jimklimov Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions NEWS.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,12 +324,17 @@ https://github.com/networkupstools/nut/milestone/11
and `-l <logfile>`) along with newer tuple(s) for multiple-system logging
(repeatable `-m <system,logfile>`), previously the single-system options
were overridden by the tuple(s); now they become part of the list.
* Internally, changed from use of shared global variables to query one UPS
at a time, populated from the new list of tuples during each loop cycle,
to passing and using the new tuple structures directly.
* The `upsname` in the `system=upsname[@hostname[:port]]` parameter may
be an asterisk `*` to query for devices currently served by the hostname.
* Same log file may safely be used in different logging tuples (it is
then recommended to use `%UPSHOST%` in a custom formatting string).
* Fixed printing of `%UPSHOST%` when multiple systems are being logged.
* A `%t` for a TAB character can now be used in the formatting string.
* Added `-N` to prefix `%UPSHOST%%t` before the format string (whether
default or custom). Useful when logging many systems into same target.
* Added `-D` for debugging (and foregrounding by default), like with
other NUT daemons.
* Added systemd and SMF service integration. [#1803]
Expand Down
128 changes: 75 additions & 53 deletions clients/upslog.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,37 +49,20 @@

static int reopen_flag = 0, exit_flag = 0;
static size_t max_loops = 0;
static char *upsname = NULL;
static UPSCONN_t *ups = NULL;

static char *logfn = NULL, *monhost = NULL;
#ifndef WIN32
static sigset_t nut_upslog_sigmask;
#endif
/* NOTE: The logbuffer is reused for each loop cycle (each device)
* and the logformat is one for all "systems" in this program run */
static char logbuffer[LARGEBUF], *logformat = NULL;

static flist_t *fhead = NULL;
struct logtarget_t {
char *logfn;
FILE *logfile;
struct logtarget_t *next;
};
/* FIXME: To be valgrind-clean, free these at exit */
static struct logtarget_t *logfile_anchor = NULL;

struct monhost_ups {
char *monhost;
char *upsname;
char *hostname;
uint16_t port;
UPSCONN_t *ups;
struct logtarget_t *logtarget;
struct monhost_ups *next;
};
/* FIXME: To be valgrind-clean, free these at exit */
static struct monhost_ups *monhost_ups_anchor = NULL;
static struct monhost_ups *monhost_ups_current = NULL;
static struct monhost_ups *monhost_ups_prev = NULL;
static struct logtarget_t *logfile_anchor = NULL;
static struct monhost_ups_t *monhost_ups_anchor = NULL;
static struct monhost_ups_t *monhost_ups_current = NULL;
static struct monhost_ups_t *monhost_ups_prev = NULL;


#define DEFAULT_LOGFORMAT "%TIME @Y@m@d @H@M@S% %VAR battery.charge% " \
Expand Down Expand Up @@ -113,7 +96,7 @@ static struct logtarget_t *add_logfile(const char *logfn_arg)
if (!logfn_arg || !(*logfn_arg))
return p;

p = xcalloc(1, sizeof(struct monhost_ups));
p = xcalloc(1, sizeof(struct monhost_ups_t));
p->logfn = xstrdup(logfn_arg);
p->logfile = NULL;

Expand Down Expand Up @@ -211,6 +194,8 @@ static void help(const char *prog)

printf(" -f <format> - Log format. See below for details.\n");
printf(" - Use -f \"<format>\" so your shell doesn't break it up.\n");
printf(" -N - Prefix \"%%UPSHOST%%%%t\" before the format (default/custom)");
printf(" - Useful when logging many systems into same target.\n");
printf(" -i <interval> - Time between updates, in seconds\n");
printf(" -d <count> - Exit after specified amount of updates\n");
printf(" -l <logfile> - Log file name, or - for stdout (foreground by default)\n");
Expand Down Expand Up @@ -249,11 +234,12 @@ static void help(const char *prog)
}

/* print current host name */
static void do_host(const char *arg)
static void do_host(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
int ret;
char hn[LARGEBUF];
NUT_UNUSED_VARIABLE(arg);
NUT_UNUSED_VARIABLE(monhost_ups_print);

ret = gethostname(hn, sizeof(hn));

Expand All @@ -265,26 +251,28 @@ static void do_host(const char *arg)
snprintfcat(logbuffer, sizeof(logbuffer), "%s", hn);
}

static void do_upshost(const char *arg)
static void do_upshost(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
NUT_UNUSED_VARIABLE(arg);

snprintfcat(logbuffer, sizeof(logbuffer), "%s", monhost);
snprintfcat(logbuffer, sizeof(logbuffer), "%s", monhost_ups_print->monhost);
}

static void do_pid(const char *arg)
static void do_pid(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
NUT_UNUSED_VARIABLE(arg);
NUT_UNUSED_VARIABLE(monhost_ups_print);

snprintfcat(logbuffer, sizeof(logbuffer), "%ld", (long)getpid());
}

static void do_time(const char *arg)
static void do_time(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
unsigned int i;
char timebuf[SMALLBUF], *format;
time_t tod;
struct tm tmbuf;
NUT_UNUSED_VARIABLE(monhost_ups_print);

format = xstrdup(arg);

Expand All @@ -301,19 +289,19 @@ static void do_time(const char *arg)
free(format);
}

static void getvar(const char *var)
static void getvar(const char *var, const struct monhost_ups_t *monhost_ups_print)
{
int ret;
size_t numq, numa;
const char *query[4];
char **answer;

query[0] = "VAR";
query[1] = upsname;
query[1] = monhost_ups_print->upsname;
query[2] = var;
numq = 3;

ret = upscli_get(ups, numq, query, &numa, &answer);
ret = upscli_get(monhost_ups_print->ups, numq, query, &numa, &answer);

if ((ret < 0) || (numa < numq)) {
snprintfcat(logbuffer, sizeof(logbuffer), "NA");
Expand All @@ -323,7 +311,7 @@ static void getvar(const char *var)
snprintfcat(logbuffer, sizeof(logbuffer), "%s", answer[3]);
}

static void do_var(const char *arg)
static void do_var(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
if ((!arg) || (strlen(arg) < 1)) {
snprintfcat(logbuffer, sizeof(logbuffer), "INVALID");
Expand All @@ -337,30 +325,33 @@ static void do_var(const char *arg)
}

/* a UPS name is now required */
if (!upsname) {
if (!monhost_ups_print->upsname) {
snprintfcat(logbuffer, sizeof(logbuffer), "INVALID");
return;
}

getvar(arg);
getvar(arg, monhost_ups_print);
}

static void do_etime(const char *arg)
static void do_etime(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
time_t tod;
NUT_UNUSED_VARIABLE(arg);
NUT_UNUSED_VARIABLE(monhost_ups_print);

time(&tod);
snprintfcat(logbuffer, sizeof(logbuffer), "%lu", (unsigned long) tod);
}

static void print_literal(const char *arg)
static void print_literal(const char *arg, const struct monhost_ups_t *monhost_ups_print)
{
NUT_UNUSED_VARIABLE(monhost_ups_print);

snprintfcat(logbuffer, sizeof(logbuffer), "%s", arg);
}

/* register another parsing function to be called later */
static void add_call(void (*fptr)(const char *arg), const char *arg)
static void add_call(void (*fptr)(const char *arg, const struct monhost_ups_t *monhost_ups_print), const char *arg)
{
flist_t *tmp, *last;

Expand Down Expand Up @@ -476,7 +467,7 @@ static void compile_format(void)
}

/* go through the list of functions and call them in order */
static void run_flist(struct monhost_ups *monhost_ups_print)
static void run_flist(const struct monhost_ups_t *monhost_ups_print)
{
flist_t *tmp;

Expand All @@ -485,7 +476,7 @@ static void run_flist(struct monhost_ups *monhost_ups_print)
memset(logbuffer, 0, sizeof(logbuffer));

while (tmp) {
tmp->fptr(tmp->arg);
tmp->fptr(tmp->arg, monhost_ups_print);

tmp = tmp->next;
}
Expand All @@ -496,27 +487,30 @@ static void run_flist(struct monhost_ups *monhost_ups_print)

/* -s <monhost>
* -l <log file>
* -m <monhost,logfile>
* -i <interval>
* -f <format>
* -u <username>
*/

int main(int argc, char **argv)
{
int interval = 30, i, foreground = -1;
int interval = 30, i, foreground = -1, prefix_UPSHOST = 0, logformat_allocated = 0;
size_t monhost_len = 0, loop_count = 0;
const char *prog = xbasename(argv[0]);
time_t now, nextpoll = 0;
const char *user = NULL;
struct passwd *new_uid = NULL;
const char *pidfilebase = prog;
/* For legacy single-ups -s/-l args: */
static char *logfn = NULL, *monhost = NULL;

logformat = DEFAULT_LOGFORMAT;
user = RUN_AS_USER;

print_banner_once(prog, 0);

while ((i = getopt(argc, argv, "+hDs:l:i:d:f:u:Vp:FBm:")) != -1) {
while ((i = getopt(argc, argv, "+hDs:l:i:d:Nf:u:Vp:FBm:")) != -1) {
switch(i) {
case 'h':
help(prog);
Expand All @@ -532,7 +526,7 @@ int main(int argc, char **argv)
char *m_arg, *s;

monhost_ups_prev = monhost_ups_current;
monhost_ups_current = xmalloc(sizeof(struct monhost_ups));
monhost_ups_current = xmalloc(sizeof(struct monhost_ups_t));
if (monhost_ups_anchor == NULL)
monhost_ups_anchor = monhost_ups_current;
else
Expand Down Expand Up @@ -606,6 +600,10 @@ int main(int argc, char **argv)
logformat = optarg;
break;

case 'N':
prefix_UPSHOST = 1;
break;

case 'u':
user = optarg;
break;
Expand Down Expand Up @@ -663,6 +661,7 @@ int main(int argc, char **argv)

logformat = xmalloc(LARGEBUF);
memset(logformat, '\0', LARGEBUF);
logformat_allocated = 1;

for (i = 3; i < argc; i++)
snprintfcat(logformat, LARGEBUF, "%s ", argv[i]);
Expand All @@ -678,7 +677,7 @@ int main(int argc, char **argv)

/* May be or not be NULL here: */
monhost_ups_prev = monhost_ups_current;
monhost_ups_current = xmalloc(sizeof(struct monhost_ups));
monhost_ups_current = xmalloc(sizeof(struct monhost_ups_t));
if (monhost_ups_anchor == NULL) {
/* Become the single-entry list */
monhost_ups_anchor = monhost_ups_current;
Expand All @@ -702,6 +701,23 @@ int main(int argc, char **argv)
if (!logformat)
fatalx(EXIT_FAILURE, "No format defined - but this should be impossible");

if (prefix_UPSHOST) {
char *s = xstrdup(logformat);
if (s) {
if (!logformat_allocated) {
logformat = xmalloc(LARGEBUF);
if (!logformat)
fatalx(EXIT_FAILURE, "Failed re-allocation to prepend UPSHOST to formatting string");
memset(logformat, '\0', LARGEBUF);
}
snprintf(logformat, LARGEBUF, "%%UPSHOST%%%%t%s", s);
free(s);
} else {
upslogx(LOG_WARNING, "Failed to prepend UPSHOST to formatting string");
}
}
upsdebugx(1, "logformat: %s", logformat);

/* shouldn't happen */
if (!monhost_len)
fatalx(EXIT_FAILURE, "No UPS defined for monitoring - use -s <system> -l <logfile>, or use -m <ups,logfile>");
Expand Down Expand Up @@ -756,7 +772,7 @@ int main(int argc, char **argv)
}

while (upscli_list_next(conn, numq, query, &numa, &answer) == 1) {
struct monhost_ups *mu = NULL;
struct monhost_ups_t *mu = NULL;
char buf[LARGEBUF];

/* UPS <upsname> <description> */
Expand All @@ -767,7 +783,7 @@ int main(int argc, char **argv)
found++;
upsdebugx(1, "FOUND: %s: %s", answer[1], answer[2]);

mu = xmalloc(sizeof(struct monhost_ups));
mu = xmalloc(sizeof(struct monhost_ups_t));
snprintf(buf, sizeof(buf), "%s@%s:%" PRIu16,
answer[1],
monhost_ups_current->hostname,
Expand Down Expand Up @@ -863,7 +879,7 @@ int main(int argc, char **argv)
if (monhost_ups_current->logtarget->logfile != stdout)
upslogx(LOG_INFO, "NOTE: File %s is already receiving other logs",
monhost_ups_current->logtarget->logfn);
upslogx(LOG_INFO, "NOTE: Consider adding %%UPSHOST%% to the log formatting string");
upslogx(LOG_INFO, "NOTE: Consider adding %%UPSHOST%% to the log formatting string, e.g. pass -N on CLI");
}
} else {
if (strcmp(monhost_ups_current->logtarget->logfn, "-") == 0)
Expand Down Expand Up @@ -930,19 +946,20 @@ int main(int argc, char **argv)
monhost_ups_current != NULL;
monhost_ups_current = monhost_ups_current->next
) {
ups = monhost_ups_current->ups; /* XXX Not ideal */
upsname = monhost_ups_current->upsname; /* XXX Not ideal */
monhost = monhost_ups_current->monhost; /* XXX Not ideal */
/* reconnect if necessary */
if (upscli_fd(ups) < 0) {
upscli_connect(ups, monhost_ups_current->hostname, monhost_ups_current->port, 0);
if (upscli_fd(monhost_ups_current->ups) < 0) {
upscli_connect(
monhost_ups_current->ups,
monhost_ups_current->hostname,
monhost_ups_current->port,
0);
}

run_flist(monhost_ups_current);

/* don't keep connection open if we don't intend to use it shortly */
if (interval > 30) {
upscli_disconnect(ups);
upscli_disconnect(monhost_ups_current->ups);
}
}

Expand Down Expand Up @@ -974,6 +991,11 @@ int main(int argc, char **argv)
upscli_disconnect(monhost_ups_current->ups);
}

if (logformat_allocated) {
free(logformat);
logformat = NULL;
}

exit(EXIT_SUCCESS);
}

Expand Down
Loading
Loading