Option -c added to sadf: Upgrade an old sa datafile

This patch adds option -c to sadf. This option enables the user to
upgrade ("convert") an old system activity datafile (version 9.1.6 and
later) to the up-to-date format (11.1.1 as of today).
Enter "sadf -c old_datafile >new_datafile".

Signed-off-by: Sebastien GODARD <[email protected]>

Author: sysstat

Makefile.in

@@ -208,6 +208,8 @@ format.o: format.c sadf.h
 
 sadf_misc.o: sadf_misc.c sadf.h sa.h
 
+sa_conv.o: sa_conv.c sadf.h sa.h sa_conv.h
+
 # Explicit rules needed to prevent possible file corruption
 # when using parallel execution.
 libsyscom.a: common.o ioconf.o
@@ -233,7 +235,7 @@ sar: sar.o act_sar.o sa_common.o pr_stats.o libsyscom.a
 
 sadf.o: sadf.c sadf.h version.h sa.h common.h ioconf.h sysconfig.h
 
-sadf: sadf.o act_sadf.o format.o sadf_misc.o rndr_stats.o xml_stats.o json_stats.o sa_common.o libsyscom.a
+sadf: sadf.o act_sadf.o format.o sadf_misc.o sa_conv.o rndr_stats.o xml_stats.o json_stats.o sa_common.o libsyscom.a
 
 iostat.o: iostat.c iostat.h version.h common.h ioconf.h sysconfig.h rd_stats.h count.h
 

format.c

@@ -94,6 +94,19 @@ struct report_format json_fmt = {
 	.f_comment	= print_json_comment
 };
 
+/*
+ * Display only datafile header.
+ */
+struct report_format conv_fmt = {
+	.id		= F_CONV_OUTPUT,
+	.options	= FO_BAD_FILE_FORMAT,
+	.f_header	= NULL,
+	.f_statistics	= NULL,
+	.f_timestamp	= NULL,
+	.f_restart	= NULL,
+	.f_comment	= NULL
+};
+
 /*
  * Array of output formats.
  */
@@ -102,5 +115,6 @@ struct report_format *fmt[NR_FMT] = {
 	&db_fmt,
 	&ppc_fmt,
 	&xml_fmt,
-	&json_fmt
+	&json_fmt,
+	&conv_fmt
 };

sa.h

@@ -487,6 +487,9 @@ struct activity {
  */
 #define FORMAT_MAGIC	0x2173
 
+/* Previous datafile format magic number used by older sysstat versions */
+#define PREVIOUS_FORMAT_MAGIC	0x2171
+
 /* Structure for file magic header data */
 struct file_magic {
 	/*
@@ -508,10 +511,17 @@ struct file_magic {
 	 * Size of file's header (size of file_header structure used by file).
 	 */
 	unsigned int header_size;
+	/*
+	 * Set to non zero if data file has been converted with "sadf -c" from
+	 * an old format (version x.y.z) to a newest format (version X.Y.Z).
+	 * In this case, the value is: Y*16 + Z + 1.
+	 * The FORMAT_MAGIC value of the file can be used to determine X.
+	 */
+	unsigned char upgraded;
 	/*
 	 * Padding. Reserved for future use while avoiding a format change.
 	 */
-	unsigned char pad[64];
+	unsigned char pad[63];
 };
 
 #define FILE_MAGIC_SIZE	(sizeof(struct file_magic))
@@ -829,6 +839,8 @@ extern int
 	datecmp(struct tm *, struct tstamp *);
 extern void
 	display_sa_file_version(FILE *, struct file_magic *);
+extern void
+	enum_version_nr(struct file_magic *);
 extern void
 	free_bitmaps(struct activity * []);
 extern void
@@ -871,6 +883,8 @@ extern int
 	reallocate_vol_act_structures(struct activity * [], unsigned int, unsigned int);
 extern int
 	sa_fread(int, void *, int, int);
+extern int
+	sa_open_read_magic(int *, char *, struct file_magic *, int);
 extern void
 	select_all_activities(struct activity * []);
 extern void

sa_common.c

@@ -31,6 +31,7 @@
 #include <sys/types.h>
 #include <sys/stat.h>
 
+#include "version.h"
 #include "sa.h"
 #include "common.h"
 #include "ioconf.h"
@@ -1209,37 +1210,30 @@ void read_file_stat_bunch(struct activity *act[], int curr, int ifd, int act_nr,
 
 /*
  ***************************************************************************
- * Open a data file, and perform various checks before reading.
+ * Open a sysstat activity data file and read its magic structure.
  *
  * IN:
- * @dfile	Name of system activity data file
- * @act		Array of activities.
+ * @dfile	Name of system activity data file.
  * @ignore	Set to 1 if a true sysstat activity file but with a bad
  * 		format should not yield an error message. Useful with
  * 		sadf -H.
  *
  * OUT:
- * @ifd		System activity data file descriptor
+ * @fd		System activity data file descriptor.
  * @file_magic	file_magic structure containing data read from file magic
- *		header
- * @file_hdr	file_hdr structure containing data read from file standard
- * 		header
- * @file_actlst	Acvtivity list in file.
- * @id_seq	Activity sequence.
+ *		header.
+ *
+ * RETURNS:
+ * -1 if data file is a sysstat file with an old format, 0 otherwise.
  ***************************************************************************
  */
-void check_file_actlst(int *ifd, char *dfile, struct activity *act[],
-		       struct file_magic *file_magic, struct file_header *file_hdr,
-		       struct file_activity **file_actlst, unsigned int id_seq[],
+int sa_open_read_magic(int *fd, char *dfile, struct file_magic *file_magic,
 		       int ignore)
 {
-	int i, j, n, p;
-	unsigned int a_cpu = FALSE;
-	struct file_activity *fal;
-	void *buffer = NULL;
+	int n;
 
 	/* Open sa data file */
-	if ((*ifd = open(dfile, O_RDONLY)) < 0) {
+	if ((*fd = open(dfile, O_RDONLY)) < 0) {
 		int saved_errno = errno;
 
 		fprintf(stderr, _("Cannot open %s: %s\n"), dfile, strerror(errno));
@@ -1251,22 +1245,55 @@ void check_file_actlst(int *ifd, char *dfile, struct activity *act[],
 	}
 
 	/* Read file magic data */
-	n = read(*ifd, file_magic, FILE_MAGIC_SIZE);
+	n = read(*fd, file_magic, FILE_MAGIC_SIZE);
 
 	if ((n != FILE_MAGIC_SIZE) ||
 	    (file_magic->sysstat_magic != SYSSTAT_MAGIC) ||
-	    (file_magic->format_magic != FORMAT_MAGIC)) {
-
-		if (ignore &&
-		    (n == FILE_MAGIC_SIZE) &&
-		    (file_magic->sysstat_magic == SYSSTAT_MAGIC))
-			/* Don't display error message. This is for sadf -H */
-			return;
-		else {
-			/* Display error message and exit */
-			handle_invalid_sa_file(ifd, file_magic, dfile, n);
-		}
+	    ((file_magic->format_magic != FORMAT_MAGIC) && !ignore)) {
+		/* Display error message and exit */
+		handle_invalid_sa_file(fd, file_magic, dfile, n);
 	}
+	if (file_magic->format_magic != FORMAT_MAGIC)
+		/* This is an old sa datafile format */
+		return -1;
+
+	return 0;
+}
+
+/*
+ ***************************************************************************
+ * Open a data file, and perform various checks before reading.
+ *
+ * IN:
+ * @dfile	Name of system activity data file.
+ * @act		Array of activities.
+ * @ignore	Set to 1 if a true sysstat activity file but with a bad
+ * 		format should not yield an error message. Useful with
+ * 		sadf -H.
+ *
+ * OUT:
+ * @ifd		System activity data file descriptor.
+ * @file_magic	file_magic structure containing data read from file magic
+ *		header.
+ * @file_hdr	file_hdr structure containing data read from file standard
+ * 		header.
+ * @file_actlst	Acvtivity list in file.
+ * @id_seq	Activity sequence.
+ ***************************************************************************
+ */
+void check_file_actlst(int *ifd, char *dfile, struct activity *act[],
+		       struct file_magic *file_magic, struct file_header *file_hdr,
+		       struct file_activity **file_actlst, unsigned int id_seq[],
+		       int ignore)
+{
+	int i, j, p;
+	unsigned int a_cpu = FALSE;
+	struct file_activity *fal;
+	void *buffer = NULL;
+
+	/* Open sa data file and read its magic structure */
+	if (sa_open_read_magic(ifd, dfile, file_magic, ignore) < 0)
+		return;
 
 	SREALLOC(buffer, char, file_magic->header_size);
 
@@ -1940,3 +1967,40 @@ double compute_ifutil(struct stats_net_dev *st_net_dev, double rx, double tx)
 	return 0;
 }
 
+/*
+ ***************************************************************************
+ * Fill system activity file magic header.
+ *
+ * IN:
+ * @file_magic	System activity file magic header.
+ ***************************************************************************
+ */
+void enum_version_nr(struct file_magic *fm)
+{
+	char *v;
+	char version[16];
+
+	fm->sysstat_extraversion = 0;
+
+	strcpy(version, VERSION);
+
+	/* Get version number */
+	if ((v = strtok(version, ".")) == NULL)
+		return;
+	fm->sysstat_version = atoi(v) & 0xff;
+
+	/* Get patchlevel number */
+	if ((v = strtok(NULL, ".")) == NULL)
+		return;
+	fm->sysstat_patchlevel = atoi(v) & 0xff;
+
+	/* Get sublevel number */
+	if ((v = strtok(NULL, ".")) == NULL)
+		return;
+	fm->sysstat_sublevel = atoi(v) & 0xff;
+
+	/* Get extraversion number. Don't necessarily exist */
+	if ((v = strtok(NULL, ".")) == NULL)
+		return;
+	fm->sysstat_extraversion = atoi(v) & 0xff;
+}