pcp-testsuite 4.0.1-1 / var / lib / pcp / testsuite / src / scanmeta.c

/*
 * Scan an archive metadata file from disk, no libpcp layers in the
 * way.
 *
 * Optionally warn about:
 * - same indom records with duplicated timestamps
 *
 * Copyright (c) 2018 Ken McDonell.  All Rights Reserved.
 */

#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <pcp/pmapi.h>
#include "libpcp.h"

/* from internal.h ... */
#ifdef HAVE_NETWORK_BYTEORDER
#define __ntohpmInDom(a)        (a)
#define __ntohpmUnits(a)        (a)
#define __ntohpmID(a)           (a)
#else
#define __ntohpmInDom(a)        ntohl(a)
#define __ntohpmID(a)           ntohl(a)
#endif

/* from endian.c ... */
#ifndef __ntohpmUnits
pmUnits
__ntohpmUnits(pmUnits units)
{
    unsigned int	x;

    x = ntohl(*(unsigned int *)&units);
    units = *(pmUnits *)&x;

    return units;
}
#endif


static int	hflag;
static int	iflag;
static int	lflag;
static int	mflag;
static int	wflag;
static int	nrec;

void
usage(void)
{
    fprintf(stderr, "Usage: %s [options] in.meta\n", pmGetProgname());
    fprintf(stderr, "Options:\n");
    fprintf(stderr, " -a               report all, i.e. -hilm\n");
    fprintf(stderr, " -D debug         set debug options\n");
    fprintf(stderr, " -h               report (help) text records\n");
    fprintf(stderr, " -i               report instance domain records\n");
    fprintf(stderr, " -l               report label records\n");
    fprintf(stderr, " -m               report metric records [default]\n");
    fprintf(stderr, " -w               only warn about badness\n");
    fprintf(stderr, " -W               only warn verbosely about badness\n");
    fprintf(stderr, " -z               set reporting timezone to pmcd from archive\n");
    fprintf(stderr, " -Z timezone      set reporting timezone\n");
}

/*
 * linked list of indoms at the same time
 */
typedef struct elt {
    struct elt	*next;
    pmInDom	indom;
    int		numinst;
    int		*inst;
    char	**iname;
} elt_t;

void
unpack_indom(elt_t *ep, pmInDom indom, int numinst, uint32_t *buf)
{
    char	*str;
    uint32_t	*index;
    int		j;

    if (ep->numinst > 0) {
	str = (char *)&buf[numinst];
	ep->inst = (int *)malloc(numinst * sizeof(int));
	if (ep->inst == NULL) {
	    fprintf(stderr, "Arrgh: inst[] malloc failed for indom %s\n", pmInDomStr(indom));
	    exit(1);
	}
	ep->iname = (char **)malloc(numinst * sizeof(char *));
	if (ep->iname == NULL) {
	    fprintf(stderr, "Arrgh: iname[] malloc failed for indom %s\n", pmInDomStr(indom));
	    exit(1);
	}
	index = &buf[ep->numinst];
	str = (char *)&buf[ep->numinst + ep->numinst];
	for (j = 0; j < numinst; j++) {
	    ep->inst[j] = ntohl(buf[j]);
	    ep->iname[j] = strdup(&str[ntohl(index[j])]);
	    if (ep->iname[j] == NULL) {
		fprintf(stderr, "Arrgh: iname[%d] malloc failed for indom %s\n", j, pmInDomStr(indom));
		exit(1);
	    }
#ifdef DEBUG
printf("[%d] inst=%d iname=%s\n", j, ep->inst[j], ep->iname[j]);
#endif
	}
    }
}

void
free_elt_fields(elt_t *ep)
{
    if (ep->inst != NULL)
	free(ep->inst);
    if (ep->iname != NULL) {
	int	j;
	for (j = 0; j < ep->numinst; j++) {
	    if (ep->iname[j] != NULL)
		free(ep->iname[j]);
	}
	free(ep->iname);
    }
}

void
do_indom(uint32_t *buf)
{
    static pmTimeval	prior_stamp = { 0, 0 };
    static elt_t	*head = NULL;
    static elt_t	dup = { NULL, 0, 0, NULL, NULL };
    static int		ndup = 0;
    pmTimeval		*tvp;
    pmInDom		this_indom;
    pmTimeval		this_stamp;
    int			this_numinst;
    int			warn;
    elt_t		*ep = NULL;	/* pander to gcc */
    elt_t		*tp;
    elt_t		*dp = &dup;

    tvp = (pmTimeval *)buf;
    this_stamp.tv_sec = ntohl(tvp->tv_sec);
    this_stamp.tv_usec = ntohl(tvp->tv_usec);
    this_indom = __ntohpmInDom(buf[2]);
    this_numinst = ntohl(buf[3]);
    warn = 0;
    if (prior_stamp.tv_sec != 0) {
	/*
	 * Not the first indom record, so check for duplicate timestamps
	 * for the same indom.
	 * Use a linked list of indoms previously seen.
	 */
	if (__pmTimevalSub(&this_stamp, &prior_stamp) == 0) {
	    /* same timestamp as previous indom */
	    for (ep = head; ep != NULL; ep = ep->next) {
		if (ep->indom == this_indom) {
		    /* indom match => duplicate */
		    ndup++;
		    warn++;
		    break;
		}
	    }
	    if (ep == NULL) {
		/*
		 * indom not seen before at this timestamp, add
		 * to head of linked list
		 */
		ep = (elt_t *)malloc(sizeof(elt_t));
		if (ep == NULL) {
		    fprintf(stderr, "Arrgh: elt malloc failed for indom %s @ ", pmInDomStr(this_indom));
		    __pmPrintTimeval(stderr, &this_stamp);
		    exit(1);
		}
		ep->next = head;
		head = ep;
	    }
	}
	else {
	    /* new timestamp, clear linked list */
	    for (ep = head; ep != NULL; ) {
		free_elt_fields(ep);
		tp = ep->next;
		free(ep);
		ep = tp;
	    }
	    ep = head = (elt_t *)malloc(sizeof(elt_t));
	    if (head == NULL) {
		fprintf(stderr, "Arrgh: head malloc failed for indom %s @ ", pmInDomStr(this_indom));
		__pmPrintTimeval(stderr, &this_stamp);
		exit(1);
	    }
	    ep->next = NULL;
	    ndup = 0;
	}
	ep->indom = this_indom;
	ep->numinst = this_numinst;
	ep->inst = NULL;
	ep->iname = NULL;
	if (wflag == 2) {
	    /* -W, so unpack indom */
	    unpack_indom(ep, this_indom, this_numinst, &buf[4]);
	}
    }
    if (iflag || (warn && wflag > 0)) {
	/* if warn is set, ep must have been assigned a value */
	printf("[%d] @ ", nrec);
	__pmPrintTimeval(stdout, &this_stamp);
	printf(" indom %s numinst %d", pmInDomStr(this_indom), this_numinst);
	if (warn) {
	    int	o, d;
	    int	diffs = 0;
	    printf(" duplicate #%d\n", ndup);
	    dp->indom = this_indom;
	    dp->numinst = this_numinst;
	    dp->inst = NULL;
	    unpack_indom(dp, this_indom, this_numinst, &buf[4]);
	    if (ep->numinst != dp->numinst)
		printf("  numinst changed from %d to %d\n", ep->numinst, dp->numinst);
	    for (o = 0; o < ep->numinst; o++) {
		for (d = 0; d < dp->numinst; d++) {
		    if (ep->inst[o] == dp->inst[d]) {
			if (strcmp(ep->iname[o], dp->iname[d]) != 0) {
			    printf("  inst %d: changed ext name from \"%s\" to \"%s\"\n", ep->inst[o], ep->iname[o], dp->iname[d]);
			    diffs++;
			}
#ifdef DEBUG
			else
			    printf("  inst %d: same\n", ep->inst[o]);
#endif
			dp->inst[d] = -1;
			break;
		    }
		}
		if (d == dp->numinst) {
		    printf("  inst %d: dropped (\"%s\")\n", ep->inst[o], ep->iname[o]);
		    diffs++;
		}
	    }
	    for (d = 0; d < dp->numinst; d++) {
		if (dp->inst[d] != -1) {
		    printf("  inst %d: added (\"%s\")\n", dp->inst[d], dp->iname[d]);
		    diffs++;
		}
	    }
	    if (diffs == 0)
		printf(" no differences\n");
	    free_elt_fields(dp);
	}
	else
	    putchar('\n');
    }
    prior_stamp = this_stamp;
}

void
do_desc(uint32_t *buf)
{
    pmDesc	*dp;
    int		numnames;
    int		i;
    int		len;
    char	*cp;
    char	**names;

    dp = (pmDesc *)buf;
    dp->type = ntohl(dp->type);

    dp->sem = ntohl(dp->sem);
    dp->indom = __ntohpmInDom(dp->indom);
    dp->units = __ntohpmUnits(dp->units);
    dp->pmid = __ntohpmID(dp->pmid);
    printf("[%d] metric %s (", nrec, pmIDStr(dp->pmid));
    numnames = ntohl(buf[sizeof(pmDesc)/sizeof(int)]);
    names = (char **)malloc(numnames*sizeof(char *));
    if (names == NULL) {
	fprintf(stderr, "Arrgh: names x %d malloc failed\n", numnames);
	exit(1);
    }
    for (i = 0; i < numnames; i++) {
	names[i] = NULL;
    }
    cp = (char *)&buf[sizeof(pmDesc)/sizeof(int) + 1];
    for (i = 0; i < numnames; i++) {
	memmove(&len, cp, sizeof(len));
	len = htonl(len);
	cp += sizeof(len);
	names[i] = (char *)malloc(len + 1);
	if (names == NULL) {
	    fprintf(stderr, "Arrgh: names[%d] malloc failed\n", i);
	    exit(1);
	}
	strncpy(names[i], cp, len);
	names[i][len] = '\0';
	cp += len;
    }
    __pmPrintMetricNames(stdout, numnames, names, " or ");
    printf(")\n");
    pmPrintDesc(stdout, dp);
    for (i = 0; i < numnames; i++) {
	free(names[i]);
    }
    free(names);
}

void
do_label(uint32_t *buf)
{
    int		type;
    int		ident;
    pmTimeval	*tvp;

    tvp = (pmTimeval *)buf;
    tvp->tv_sec = ntohl(tvp->tv_sec);
    tvp->tv_usec = ntohl(tvp->tv_usec);
    type = ntohl(buf[2]);
    ident = ntohl(buf[3]);
    printf("[%d] label @ ", nrec);
    __pmPrintTimeval(stdout, tvp);
    printf(" type %d ident %d", type, ident);
    printf(" TODO");
    putchar('\n');
}

void
do_help(uint32_t *buf)
{
    int		type;
    pmID	pmid;
    pmInDom	indom;
    char	*p;

    printf("[%d] text ", nrec);
    type = ntohl(buf[0]);
    if (type & PM_TEXT_INDOM) {
	pmid = __ntohpmInDom(buf[1]);
	printf("pmid %s ", pmIDStr(pmid));
    }
    else {
	indom = __ntohpmID(buf[1]);
	printf("indom %s ", pmInDomStr(indom));
    }
    printf("\n    ");
    for (p = (char *)&buf[2]; *p; p++) {
	putchar(*p);
	if (*p == '\n')
	    printf("    ");
    }
    putchar('\n');
}

int
main(int argc, char *argv[])
{
    int		len;
    int		buflen;
    uint32_t	*buf ;
    int		in;
    int		nb;
    int		c;
    int		sts;
    int		errflag = 0;
    int		tzh;				/* initial timezone handle */
    int		zflag = 0;			/* for -z */
    char 	*tz = NULL;			/* for -Z timezone */
    off_t	offset;
    __pmLogHdr	hdr;

    pmSetProgname(argv[0]);
    setlinebuf(stdout);
    setlinebuf(stderr);

    while ((c = getopt(argc, argv, "aD:hilmwWzZ:")) != EOF) {
	switch (c) {

	case 'a':	/* report all */
	    hflag = iflag = lflag = mflag = 1;
	    break;

	case 'D':	/* debug options */
	    sts = pmSetDebug(optarg);
	    if (sts < 0) {
		fprintf(stderr, "%s: unrecognized debug options specification (%s)\n",
		    pmGetProgname(), optarg);
		errflag++;
	    }
	    break;

	case 'h':	/* report help text */
	    hflag = 1;
	    break;

	case 'i':	/* report indoms */
	    iflag = 1;
	    break;

	case 'l':	/* report labels */
	    lflag = 1;
	    break;

	case 'm':	/* report metrics */
	    mflag = 1;
	    break;

	case 'w':	/* report warnings */
	    wflag = 1;
	    break;

	case 'W':	/* verbosely report warnings */
	    wflag = 2;
	    break;

	case 'z':	/* timezone from archive */
	    if (tz != NULL) {
		fprintf(stderr, "%s: at most one of -Z and/or -z allowed\n", pmGetProgname());
		errflag++;
	    }
	    zflag++;
	    break;

	case 'Z':	/* $TZ timezone */
	    if (zflag) {
		fprintf(stderr, "%s: at most one of -Z and/or -z allowed\n", pmGetProgname());
		errflag++;
	    }
	    tz = optarg;
	    break;

	case '?':
	default:
	    errflag++;
	    break;
	}
    }

    if (errflag || optind != argc-1) {
	usage();
	exit(1);
    }

    if (hflag + iflag + lflag + mflag + wflag == 0)
	mflag = 1;	/* default */

    if ((sts = pmNewContext(PM_CONTEXT_ARCHIVE, argv[optind])) < 0) {
	fprintf(stderr, "%s: Warning: pmNewContext failed: %s\n",
	    pmGetProgname(), pmErrStr(sts));
    }

    if (zflag) {
	if (sts >= 0) {
	    if ((tzh = pmNewContextZone()) < 0) {
		fprintf(stderr, "%s: Cannot set context timezone: %s\n",
		    pmGetProgname(), pmErrStr(tzh));
		exit(1);
	    }
	    printf("Note: timezone set to local timezone of pmcd from archive\n");
	}
	else
	    fprintf(stderr, "No context, skipping -z\n");
    }
    else if (tz != NULL) {
	if (sts >= 0) {
	    if ((tzh = pmNewZone(tz)) < 0) {
		fprintf(stderr, "%s: Cannot set timezone to \"%s\": %s\n",
		    pmGetProgname(), tz, pmErrStr(tzh));
		exit(1);
	    }
	    printf("Note: timezone set to \"TZ=%s\"\n", tz);
	}
	else
	    fprintf(stderr, "No context, skipping -Z\n");
    }

    if ((in = open(argv[optind], O_RDONLY)) < 0) {
	fprintf(stderr, "Failed to open %s: %s\n", argv[optind], strerror(errno));
	exit(1);
    }
    buflen = 0;
    buf = (uint32_t *)malloc(buflen);
    if (buf == NULL) {
	fprintf(stderr, "Arrgh: buf malloc failed\n");
	exit(1);
    }

    for (nrec = 0; ; nrec++) {
	offset = lseek(in, 0, SEEK_CUR);
	if ((nb = read(in, &hdr, sizeof(hdr))) != sizeof(hdr)) {
	    if (nb == 0) {
		if (nrec == 0)
		    fprintf(stderr, "error: %s is empty file\n", argv[optind]);
		break;
	    }
	    if (nb < 0)
		fprintf(stderr, "[%d] hdr read error: %s\n", nrec, strerror(errno));
	    else {
		/* Strange eof logic here ... from __pmLogLoadMeta(), a short
		 * read is treated as end-of-file
		 */
		break;
	    }
	    exit(1);
	}
	hdr.len = ntohl(hdr.len);
	hdr.type = ntohl(hdr.type);
	if (pmDebugOptions.log)
	    fprintf(stderr, "read: len=%d type=%d @ offset=%ld\n", hdr.len, hdr.type, (long)offset);
	if (nrec == 0 && hdr.len != (int)sizeof(__pmLogLabel)+2*(int)sizeof(int)) {
	    fprintf(stderr, "error: %s does not start with label record (hdr len=%d not %d), not a PCP archive file?\n", argv[optind], hdr.len, (int)sizeof(pmLogLabel)+2*(int)sizeof(int));
	    exit(1);
	}
	len = hdr.len - sizeof(hdr);
	if (len > buflen) {
	    buflen = len;
	    buf = (uint32_t *)realloc(buf, buflen);
	    if (buf == NULL) {
		fprintf(stderr, "Arrgh: buf realloc failed\n");
		exit(1);
	    }
	}
	if ((nb = read(in, buf, len)) != len) {
	    if (nb == 0)
		fprintf(stderr, "[%d] body read error: end of file\n", nrec);
	    else if (nb < 0)
		fprintf(stderr, "[%d] body read error: %s\n", nrec, strerror(errno));
	    else
		fprintf(stderr, "[%d] body read error: expected %d bytes, got %d\n",
			nrec, len, nb);
	    exit(1);
	}

	switch (hdr.type) {
	    case TYPE_INDOM:
		do_indom(buf);
		break;

	    case TYPE_DESC:
		if (!mflag)
		    break;
		do_desc(buf);
		break;

	    case TYPE_LABEL:
		if (!lflag)
		    break;
		do_label(buf);
		break;

	    case TYPE_TEXT:
		if (!hflag)
		    break;
		do_help(buf);
		break;

	    default:
		if (nrec != 0) {
		    fprintf(stderr, "[%d] error bad type %d\n", nrec, hdr.type);
		    exit(1);
		}
		if (hdr.type == (PM_LOG_MAGIC | PM_LOG_VERS02))
		    continue;
		fprintf(stderr, "[%d] error bad magic %x != %x\n", nrec, hdr.type, (PM_LOG_MAGIC | PM_LOG_VERS02));
		exit(1);

	}
    }
    return 0;
}