freebsd-dev/usr.bin/kdump/linux.c

/*-
 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
 *
 * Copyright (c) 2022 Dmitry Chagin <dchagin@FreeBSD.org>
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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 <sys/uio.h>
#include <sys/ktrace.h>
#include <err.h>
#include <errno.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <sysdecode.h>

#include "kdump.h"

#ifdef __amd64__
#include <amd64/linux/linux.h>
#include <amd64/linux32/linux32_syscall.h>
#elif __aarch64__
#include <arm64/linux/linux.h>
#elif __i386__
#include <i386/linux/linux.h>
#endif

#include <compat/linux/linux.h>
#include <compat/linux/linux_file.h>

static void
print_linux_signal(int signo)
{
	const char *signame;

	signame = sysdecode_linux_signal(signo);
	if (signame != NULL)
		printf("%s", signame);
	else
		printf("SIG %d", signo);
}

void
ktrsyscall_linux(struct ktr_syscall *ktr, register_t **resip,
    int *resnarg, char *resc)
{
	int narg = ktr->ktr_narg;
	register_t *ip, *first;
	int quad_align, quad_slots;
	char c;

	ip = first = &ktr->ktr_args[0];
	c = *resc;
	quad_align = 0;
	quad_slots = 1;
	switch (ktr->ktr_code) {
	case LINUX_SYS_linux_faccessat:
	case LINUX_SYS_linux_fchmodat:
	case LINUX_SYS_linux_fchownat:
#ifdef LINUX_SYS_linux_newfstatat
	case LINUX_SYS_linux_newfstatat:
#endif
#ifdef LINUX_SYS_linux_fstatat64
	case LINUX_SYS_linux_fstatat64:
#endif
#ifdef LINUX_SYS_linux_futimesat
	case LINUX_SYS_linux_futimesat:
#endif
	case LINUX_SYS_linux_linkat:
	case LINUX_SYS_linux_mkdirat:
	case LINUX_SYS_linux_mknodat:
	case LINUX_SYS_linux_openat:
	case LINUX_SYS_linux_readlinkat:
	case LINUX_SYS_linux_renameat:
	case LINUX_SYS_linux_unlinkat:
	case LINUX_SYS_linux_utimensat:
		putchar('(');
		print_integer_arg_valid(sysdecode_atfd, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	}
	switch (ktr->ktr_code) {
#ifdef LINUX_SYS_linux_access
	case LINUX_SYS_linux_access:
#endif
	case LINUX_SYS_linux_faccessat:
		print_number(ip, narg, c);
		putchar(',');
		print_mask_arg(sysdecode_access_mode, *ip);
		ip++;
		narg--;
		break;
#ifdef LINUX_SYS_linux_chmod
	case LINUX_SYS_linux_chmod:
#endif
	case LINUX_SYS_linux_fchmodat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
	case LINUX_SYS_linux_mknodat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
#ifdef LINUX_SYS_linux_mkdir
	case LINUX_SYS_linux_mkdir:
#endif
	case LINUX_SYS_linux_mkdirat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
	case LINUX_SYS_linux_linkat:
	case LINUX_SYS_linux_renameat:
	case LINUX_SYS_linux_symlinkat:
		print_number(ip, narg, c);
		putchar(',');
		print_integer_arg_valid(sysdecode_atfd, *ip);
		ip++;
		narg--;
		print_number(ip, narg, c);
		break;
	case LINUX_SYS_linux_fchownat:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		break;
#ifdef LINUX_SYS_linux_newfstatat
	case LINUX_SYS_linux_newfstatat:
#endif
#ifdef LINUX_SYS_linux_fstatat64
	case LINUX_SYS_linux_fstatat64:
#endif
	case LINUX_SYS_linux_utimensat:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		break;
	case LINUX_SYS_linux_unlinkat:
		print_number(ip, narg, c);
		break;
	case LINUX_SYS_linux_clock_gettime:
	case LINUX_SYS_linux_clock_settime:
	case LINUX_SYS_linux_clock_getres:
	case LINUX_SYS_linux_timer_create:
		putchar('(');
		sysdecode_linux_clockid(stdout, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	case LINUX_SYS_linux_clock_nanosleep:
		putchar('(');
		sysdecode_linux_clockid(stdout, *ip);
		putchar(',');
		ip++;
		narg--;
		print_mask_arg0(sysdecode_linux_clock_flags, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	case LINUX_SYS_linux_kill:
	case LINUX_SYS_linux_tkill:
	case LINUX_SYS_linux_rt_sigqueueinfo:
		print_number(ip, narg, c);
		putchar(',');
		print_linux_signal(*ip);
		ip++;
		narg--;
		break;
	case LINUX_SYS_linux_tgkill:
	case LINUX_SYS_linux_rt_tgsigqueueinfo:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		putchar(',');
		print_linux_signal(*ip);
		ip++;
		narg--;
		break;
#ifdef LINUX_SYS_linux_open
	case LINUX_SYS_linux_open:
#endif
	case LINUX_SYS_linux_openat:
		print_number(ip, narg, c);
		putchar(',');
		print_mask_arg(sysdecode_linux_open_flags, ip[0]);
		if ((ip[0] & LINUX_O_CREAT) == LINUX_O_CREAT) {
			putchar(',');
			decode_filemode(ip[1]);
		}
		ip += 2;
		narg -= 2;
		break;
	case LINUX_SYS_linux_rt_sigaction:
		putchar('(');
		print_linux_signal(*ip);
		ip++;
		narg--;
		c = ',';
		break;
	case LINUX_SYS_linux_ftruncate:
	case LINUX_SYS_linux_truncate:
		print_number(ip, narg, c);
		print_number64(first, ip, narg, c);
		break;
	case LINUX_SYS_linux_getitimer:
	case LINUX_SYS_linux_setitimer:
		putchar('(');
		print_integer_arg(sysdecode_itimer, *ip);
		ip++;
		narg--;
		c = ',';
		break;
	case LINUX_SYS_linux_rt_sigprocmask:
#ifdef LINUX_SYS_linux_sigprocmask
	case LINUX_SYS_linux_sigprocmask:
#endif
		putchar('(');
		print_integer_arg(sysdecode_linux_sigprocmask_how, *ip);
		ip++;
		narg--;
		c = ',';
		break;
	}
	switch (ktr->ktr_code) {
	case LINUX_SYS_linux_fchownat:
	case LINUX_SYS_linux_faccessat:
	case LINUX_SYS_linux_fchmodat:
#ifdef LINUX_SYS_linux_newfstatat
	case LINUX_SYS_linux_newfstatat:
#endif
#ifdef LINUX_SYS_linux_fstatat64
	case LINUX_SYS_linux_fstatat64:
#endif
	case LINUX_SYS_linux_linkat:
	case LINUX_SYS_linux_unlinkat:
	case LINUX_SYS_linux_utimensat:
		putchar(',');
		print_mask_arg0(sysdecode_linux_atflags, *ip);
		ip++;
		narg--;
		break;
	}
	*resc = c;
	*resip = ip;
	*resnarg = narg;
}

#if defined(__amd64__)
void
ktrsyscall_linux32(struct ktr_syscall *ktr, register_t **resip,
    int *resnarg, char *resc)
{
	int narg = ktr->ktr_narg;
	register_t *ip, *first;
	int quad_align, quad_slots;
	char c;

	ip = first = &ktr->ktr_args[0];
	c = *resc;
	quad_align = 0;
	quad_slots = 2;
	switch (ktr->ktr_code) {
	case LINUX32_SYS_linux_faccessat:
	case LINUX32_SYS_linux_fchmodat:
	case LINUX32_SYS_linux_fchownat:
	case LINUX32_SYS_linux_fstatat64:
	case LINUX32_SYS_linux_futimesat:
	case LINUX32_SYS_linux_linkat:
	case LINUX32_SYS_linux_mkdirat:
	case LINUX32_SYS_linux_mknodat:
	case LINUX32_SYS_linux_openat:
	case LINUX32_SYS_linux_readlinkat:
	case LINUX32_SYS_linux_renameat:
	case LINUX32_SYS_linux_unlinkat:
	case LINUX32_SYS_linux_utimensat:
		putchar('(');
		print_integer_arg_valid(sysdecode_atfd, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	}
	switch (ktr->ktr_code) {
	case LINUX32_SYS_linux_access:
	case LINUX32_SYS_linux_faccessat:
		print_number(ip, narg, c);
		putchar(',');
		print_mask_arg(sysdecode_access_mode, *ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_chmod:
	case LINUX32_SYS_fchmod:
	case LINUX32_SYS_linux_fchmodat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_mknodat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_mkdir:
	case LINUX32_SYS_linux_mkdirat:
		print_number(ip, narg, c);
		putchar(',');
		decode_filemode(*ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_linkat:
	case LINUX32_SYS_linux_renameat:
	case LINUX32_SYS_linux_symlinkat:
		print_number(ip, narg, c);
		putchar(',');
		print_integer_arg_valid(sysdecode_atfd, *ip);
		ip++;
		narg--;
		print_number(ip, narg, c);
		break;
	case LINUX32_SYS_linux_fchownat:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		break;
	case LINUX32_SYS_linux_fstatat64:
	case LINUX32_SYS_linux_utimensat:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		break;
	case LINUX32_SYS_linux_unlinkat:
		print_number(ip, narg, c);
		break;
	case LINUX32_SYS_linux_clock_gettime:
	case LINUX32_SYS_linux_clock_settime:
	case LINUX32_SYS_linux_clock_getres:
	case LINUX32_SYS_linux_timer_create:
	case LINUX32_SYS_linux_clock_gettime64:
	case LINUX32_SYS_linux_clock_settime64:
	case LINUX32_SYS_linux_clock_getres_time64:
		putchar('(');
		sysdecode_linux_clockid(stdout, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_clock_nanosleep:
		putchar('(');
		sysdecode_linux_clockid(stdout, *ip);
		putchar(',');
		ip++;
		narg--;
		print_mask_arg0(sysdecode_linux_clock_flags, *ip);
		c = ',';
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_kill:
	case LINUX32_SYS_linux_tkill:
	case LINUX32_SYS_linux_rt_sigqueueinfo:
		print_number(ip, narg, c);
		putchar(',');
		print_linux_signal(*ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_tgkill:
	case LINUX32_SYS_linux_rt_tgsigqueueinfo:
		print_number(ip, narg, c);
		print_number(ip, narg, c);
		putchar(',');
		print_linux_signal(*ip);
		ip++;
		narg--;
		break;
	case LINUX32_SYS_linux_open:
	case LINUX32_SYS_linux_openat:
		print_number(ip, narg, c);
		putchar(',');
		print_mask_arg(sysdecode_linux_open_flags, ip[0]);
		if ((ip[0] & LINUX_O_CREAT) == LINUX_O_CREAT) {
			putchar(',');
			decode_filemode(ip[1]);
		}
		ip += 2;
		narg -= 2;
		break;
	case LINUX32_SYS_linux_signal:
	case LINUX32_SYS_linux_sigaction:
	case LINUX32_SYS_linux_rt_sigaction:
		putchar('(');
		print_linux_signal(*ip);
		ip++;
		narg--;
		c = ',';
		break;
	case LINUX32_SYS_linux_ftruncate:
	case LINUX32_SYS_linux_truncate:
		print_number(ip, narg, c);
		print_number64(first, ip, narg, c);
		break;
	case LINUX32_SYS_linux_getitimer:
	case LINUX32_SYS_linux_setitimer:
		putchar('(');
		print_integer_arg(sysdecode_itimer, *ip);
		ip++;
		narg--;
		c = ',';
		break;
	case LINUX32_SYS_linux_rt_sigprocmask:
	case LINUX32_SYS_linux_sigprocmask:
		putchar('(');
		print_integer_arg(sysdecode_linux_sigprocmask_how, *ip);
		ip++;
		narg--;
		c = ',';
		break;
	}
	switch (ktr->ktr_code) {
	case LINUX32_SYS_linux_fchownat:
	case LINUX32_SYS_linux_faccessat:
	case LINUX32_SYS_linux_fchmodat:
	case LINUX32_SYS_linux_fstatat64:
	case LINUX32_SYS_linux_linkat:
	case LINUX32_SYS_linux_unlinkat:
	case LINUX32_SYS_linux_utimensat:
		putchar(',');
		print_mask_arg0(sysdecode_linux_atflags, *ip);
		ip++;
		narg--;
		break;
	}
	*resc = c;
	*resip = ip;
	*resnarg = narg;
}
#endif /* __amd64__ */

static void
ktrsigset(const char *name, const l_sigset_t *mask, size_t sz)
{
	unsigned long i, c;

	printf("%s [ ", name);
	c = 0;
	for (i = 1; i <= sz * CHAR_BIT; i++) {
		if (!LINUX_SIGISMEMBER(*mask, i))
			continue;
		if (c != 0)
			printf(", ");
		printf("%s", sysdecode_linux_signal(i));
		c++;
	}
	if (c == 0)
		printf("empty ]\n");
	else
		printf(" ]\n");
}

bool
ktrstruct_linux(const char *name, const char *data, size_t datalen)
{
	l_sigset_t mask;

	if (strcmp(name, "l_sigset_t") == 0) {
		/* Old Linux sigset_t is one word size. */
		if (datalen < sizeof(int) || datalen > sizeof(l_sigset_t))
			return (false);
		memcpy(&mask, data, datalen);
		ktrsigset(name, &mask, datalen);
	} else
		return (false);

	return (true);
}