Start on a new library (libsysdecode) that provides routines for decoding

system call information such as system call arguments.  Initially this
will consist of pulling duplicated code out of truss and kdump though it
may prove useful for other utilities in the future.

This commit moves the shared utrace(2) record parser out of kdump into
the library and updates kdump and truss to use it.  One difference from
the previous version is that the library version treats unknown events
that start with the "RTLD" signature as unknown events.  This simplifies
the interface and allows the consumer to decide how to handle all
non-recognized events.  Instead, this function only generates a string
description for known malloc() and RTLD records.

Reviewed by:	bdrewery
Differential Revision:	https://reviews.freebsd.org/D4537

4 files changed, 6 insertions, 191 deletions

diff --git a/usr.bin/kdump/Makefile b/usr.bin/kdump/Makefile
index 5048fdd..52c0a09 100644
--- a/usr.bin/kdump/Makefile
+++ b/usr.bin/kdump/Makefile
@@ -6,11 +6,12 @@
 .PATH: ${.CURDIR}/../ktrace
 
 PROG=		kdump
-SRCS=		kdump_subr.c kdump_subr.h kdump.c ioctl.c subr.c utrace.c
+SRCS=		kdump_subr.c kdump_subr.h kdump.c ioctl.c subr.c
 CFLAGS+=	-I${.CURDIR}/../ktrace -I${.CURDIR} -I${.CURDIR}/../.. -I.
 
+LIBADD=		sysdecode
 .if ${MK_CASPER} != "no"
-LIBADD=	capsicum
+LIBADD+=	capsicum
 CFLAGS+=-DHAVE_LIBCAPSICUM
 .endif
 
diff --git a/usr.bin/kdump/Makefile.depend b/usr.bin/kdump/Makefile.depend
index e0397fe..f86656e 100644
--- a/usr.bin/kdump/Makefile.depend
+++ b/usr.bin/kdump/Makefile.depend
@@ -13,6 +13,7 @@ DIRDEPS = \
 	lib/libcapsicum \
 	lib/libcompiler_rt \
 	lib/libnv \
+	lib/libsysdecode \
 
 
 .include <dirdeps.mk>
diff --git a/usr.bin/kdump/kdump.c b/usr.bin/kdump/kdump.c
index 4804a81..8165bc7 100644
--- a/usr.bin/kdump/kdump.c
+++ b/usr.bin/kdump/kdump.c
@@ -83,6 +83,7 @@ extern int errno;
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <sysdecode.h>
 #include <termios.h>
 #include <time.h>
 #include <unistd.h>
@@ -116,7 +117,6 @@ void ktrfaultend(struct ktr_faultend *);
 void limitfd(int fd);
 void usage(void);
 void ioctlname(unsigned long, int);
-int kdump_print_utrace(FILE *, void *, size_t, int);
 
 #define	TIMESTAMP_NONE		0x0
 #define	TIMESTAMP_ABSOLUTE	0x1
@@ -1541,7 +1541,7 @@ ktruser(int len, void *p)
 {
 	unsigned char *cp;
 
-	if (kdump_print_utrace(stdout, p, len, decimal)) {
+	if (sysdecode_utrace(stdout, p, len)) {
 		printf("\n");
 		return;
 	}
diff --git a/usr.bin/kdump/utrace.c b/usr.bin/kdump/utrace.c
deleted file mode 100644
index e719365..0000000
--- a/usr.bin/kdump/utrace.c
+++ /dev/null
@@ -1,187 +0,0 @@
-/*-
- * Copyright (c) 1988, 1993
- *	The Regents of the University of California.  All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in the
- *    documentation and/or other materials provided with the distribution.
- * 4. Neither the name of the University nor the names of its contributors
- *    may be used to endorse or promote products derived from this software
- *    without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
- * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
- * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
- * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- */
-
-#include <sys/cdefs.h>
-__FBSDID("$FreeBSD$");
-
-#include <sys/param.h>
-#include <dlfcn.h>
-#include <stdio.h>
-#include <strings.h>
-
-int kdump_print_utrace(FILE *, void *, size_t, int);
-
-#define	UTRACE_DLOPEN_START		1
-#define	UTRACE_DLOPEN_STOP		2
-#define	UTRACE_DLCLOSE_START		3
-#define	UTRACE_DLCLOSE_STOP		4
-#define	UTRACE_LOAD_OBJECT		5
-#define	UTRACE_UNLOAD_OBJECT		6
-#define	UTRACE_ADD_RUNDEP		7
-#define	UTRACE_PRELOAD_FINISHED		8
-#define	UTRACE_INIT_CALL		9
-#define	UTRACE_FINI_CALL		10
-#define	UTRACE_DLSYM_START		11
-#define	UTRACE_DLSYM_STOP		12
-
-struct utrace_rtld {
-	char sig[4];				/* 'RTLD' */
-	int event;
-	void *handle;
-	void *mapbase;
-	size_t mapsize;
-	int refcnt;
-	char name[MAXPATHLEN];
-};
-
-static void
-print_utrace_rtld(FILE *fp, void *p, size_t len, int decimal)
-{
-	struct utrace_rtld *ut = p;
-	unsigned char *cp;
-	void *parent;
-	int mode;
-
-	switch (ut->event) {
-	case UTRACE_DLOPEN_START:
-		mode = ut->refcnt;
-		fprintf(fp, "dlopen(%s, ", ut->name);
-		switch (mode & RTLD_MODEMASK) {
-		case RTLD_NOW:
-			fprintf(fp, "RTLD_NOW");
-			break;
-		case RTLD_LAZY:
-			fprintf(fp, "RTLD_LAZY");
-			break;
-		default:
-			fprintf(fp, "%#x", mode & RTLD_MODEMASK);
-		}
-		if (mode & RTLD_GLOBAL)
-			fprintf(fp, " | RTLD_GLOBAL");
-		if (mode & RTLD_TRACE)
-			fprintf(fp, " | RTLD_TRACE");
-		if (mode & ~(RTLD_MODEMASK | RTLD_GLOBAL | RTLD_TRACE))
-			fprintf(fp, " | %#x", mode &
-			    ~(RTLD_MODEMASK | RTLD_GLOBAL | RTLD_TRACE));
-		fprintf(fp, ")");
-		break;
-	case UTRACE_DLOPEN_STOP:
-		fprintf(fp, "%p = dlopen(%s) ref %d", ut->handle, ut->name,
-		    ut->refcnt);
-		break;
-	case UTRACE_DLCLOSE_START:
-		fprintf(fp, "dlclose(%p) (%s, %d)", ut->handle, ut->name,
-		    ut->refcnt);
-		break;
-	case UTRACE_DLCLOSE_STOP:
-		fprintf(fp, "dlclose(%p) finished", ut->handle);
-		break;
-	case UTRACE_LOAD_OBJECT:
-		fprintf(fp, "RTLD: loaded   %p @ %p - %p (%s)", ut->handle,
-		    ut->mapbase, (char *)ut->mapbase + ut->mapsize - 1,
-		    ut->name);
-		break;
-	case UTRACE_UNLOAD_OBJECT:
-		fprintf(fp, "RTLD: unloaded %p @ %p - %p (%s)", ut->handle,
-		    ut->mapbase, (char *)ut->mapbase + ut->mapsize - 1,
-		    ut->name);
-		break;
-	case UTRACE_ADD_RUNDEP:
-		parent = ut->mapbase;
-		fprintf(fp, "RTLD: %p now depends on %p (%s, %d)", parent,
-		    ut->handle, ut->name, ut->refcnt);
-		break;
-	case UTRACE_PRELOAD_FINISHED:
-		fprintf(fp, "RTLD: LD_PRELOAD finished");
-		break;
-	case UTRACE_INIT_CALL:
-		fprintf(fp, "RTLD: init %p for %p (%s)", ut->mapbase, ut->handle,
-		    ut->name);
-		break;
-	case UTRACE_FINI_CALL:
-		fprintf(fp, "RTLD: fini %p for %p (%s)", ut->mapbase, ut->handle,
-		    ut->name);
-		break;
-	case UTRACE_DLSYM_START:
-		fprintf(fp, "RTLD: dlsym(%p, %s)", ut->handle, ut->name);
-		break;
-	case UTRACE_DLSYM_STOP:
-		fprintf(fp, "RTLD: %p = dlsym(%p, %s)", ut->mapbase, ut->handle,
-		    ut->name);
-		break;
-	default:
-		cp = p;
-		cp += 4;
-		len -= 4;
-		fprintf(fp, "RTLD: %zu ", len);
-		while (len--)
-			if (decimal)
-				fprintf(fp, " %d", *cp++);
-			else
-				fprintf(fp, " %02x", *cp++);
-	}
-}
-
-struct utrace_malloc {
-	void *p;
-	size_t s;
-	void *r;
-};
-
-static void
-print_utrace_malloc(FILE *fp, void *p)
-{
-	struct utrace_malloc *ut = p;
-
-	if (ut->p == (void *)(intptr_t)(-1))
-		fprintf(fp, "malloc_init()");
-	else if (ut->s == 0)
-		fprintf(fp, "free(%p)", ut->p);
-	else if (ut->p == NULL)
-		fprintf(fp, "%p = malloc(%zu)", ut->r, ut->s);
-	else
-		fprintf(fp, "%p = realloc(%p, %zu)", ut->r, ut->p, ut->s);
-}
-
-int
-kdump_print_utrace(FILE *fp, void *p, size_t len, int decimal)
-{
-
-	if (len >= 8 && bcmp(p, "RTLD", 4) == 0) {
-		print_utrace_rtld(fp, p, len, decimal);
-		return (1);
-	}
-
-	if (len == sizeof(struct utrace_malloc)) {
-		print_utrace_malloc(fp, p);
-		return (1);
-	}
-	
-	return (0);
-}