xref: /freebsd/sys/compat/linux/linux_util.h (revision 8ec6c4a38bfc988f6300ed6c37a8db352f983329)

/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1994 Christos Zoulas
 * Copyright (c) 1995 Frank van der Linden
 * Copyright (c) 1995 Scott Bartram
 * 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
 *
 * from: svr4_util.h,v 1.5 1994/11/18 02:54:31 christos Exp
 * from: linux_util.h,v 1.2 1995/03/05 23:23:50 fvdl Exp
 * $FreeBSD$
 */

#ifndef	_LINUX_UTIL_H_
#define	_LINUX_UTIL_H_

#include <vm/vm.h>
#include <vm/vm_param.h>
#include <vm/pmap.h>
#include <sys/exec.h>
#include <sys/sysent.h>
#include <sys/syslog.h>
#include <sys/cdefs.h>
#include <sys/uio.h>

MALLOC_DECLARE(M_LINUX);
MALLOC_DECLARE(M_EPOLL);
MALLOC_DECLARE(M_FUTEX);
MALLOC_DECLARE(M_FUTEX_WP);

extern char linux_emul_path[];
extern int linux_use_emul_path;

int linux_emul_convpath(struct thread *, const char *, enum uio_seg, char **, int, int);

#define LUSECONVPATH(td) atomic_load_int(&linux_use_emul_path)

#define LCONVPATH_AT(td, upath, pathp, i, dfd)				\
	do {								\
		int _error;						\
									\
		_error = linux_emul_convpath(td, upath, UIO_USERSPACE,	\
		    pathp, i, dfd);					\
		if (*(pathp) == NULL)					\
			return (_error);				\
	} while (0)

#define LCONVPATH(td, upath, pathp, i)	\
   LCONVPATH_AT(td, upath, pathp, i, AT_FDCWD)

#define LCONVPATHEXIST(td, upath, pathp) LCONVPATH(td, upath, pathp, 0)
#define LCONVPATHEXIST_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 0, dfd)
#define LCONVPATHCREAT(td, upath, pathp) LCONVPATH(td, upath, pathp, 1)
#define LCONVPATHCREAT_AT(td, upath, pathp, dfd) LCONVPATH_AT(td, upath, pathp, 1, dfd)
#define LFREEPATH(path)	free(path, M_TEMP)

#define DUMMY(s)							\
LIN_SDT_PROBE_DEFINE0(dummy, s, entry);					\
LIN_SDT_PROBE_DEFINE0(dummy, s, not_implemented);			\
LIN_SDT_PROBE_DEFINE1(dummy, s, return, "int");				\
int									\
linux_ ## s(struct thread *td, struct linux_ ## s ## _args *args)	\
{									\
	static pid_t pid;						\
									\
	LIN_SDT_PROBE0(dummy, s, entry);				\
									\
	if (pid != td->td_proc->p_pid) {				\
		linux_msg(td, "syscall %s not implemented", #s);	\
		LIN_SDT_PROBE0(dummy, s, not_implemented);		\
		pid = td->td_proc->p_pid;				\
	};								\
									\
	LIN_SDT_PROBE1(dummy, s, return, ENOSYS);			\
	return (ENOSYS);						\
}									\
struct __hack

/*
 * This is for the syscalls that are not even yet implemented in Linux.
 *
 * They're marked as UNIMPL in syscall.master so it will
 * have nosys record in linux_sysent[].
 */
#define UNIMPLEMENTED(s)

void linux_msg(const struct thread *td, const char *fmt, ...)
	__printflike(2, 3);

struct linux_device_handler {
	char	*bsd_driver_name;
	char	*linux_driver_name;
	char	*bsd_device_name;
	char	*linux_device_name;
	int	linux_major;
	int	linux_minor;
	int	linux_char_device;
};

int	linux_device_register_handler(struct linux_device_handler *h);
int	linux_device_unregister_handler(struct linux_device_handler *h);
char	*linux_driver_get_name_dev(device_t dev);
int	linux_driver_get_major_minor(const char *node, int *major, int *minor);
int	linux_vn_get_major_minor(const struct vnode *vn, int *major, int *minor);
char	*linux_get_char_devices(void);
void	linux_free_get_char_devices(char *string);

#if defined(KTR)

#define	KTR_LINUX				KTR_SUBSYS
#define	LINUX_CTRFMT(nm, fmt)	#nm"("fmt")"

#define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6) do {			\
		CTR6(KTR_LINUX, LINUX_CTRFMT(f, m),			\
		    p1, p2, p3, p4, p5, p6);				\
} while (0)

#define	LINUX_CTR(f)			LINUX_CTR6(f, "", 0, 0, 0, 0, 0, 0)
#define	LINUX_CTR0(f, m)		LINUX_CTR6(f, m, 0, 0, 0, 0, 0, 0)
#define	LINUX_CTR1(f, m, p1)		LINUX_CTR6(f, m, p1, 0, 0, 0, 0, 0)
#define	LINUX_CTR2(f, m, p1, p2)	LINUX_CTR6(f, m, p1, p2, 0, 0, 0, 0)
#define	LINUX_CTR3(f, m, p1, p2, p3)	LINUX_CTR6(f, m, p1, p2, p3, 0, 0, 0)
#define	LINUX_CTR4(f, m, p1, p2, p3, p4)	LINUX_CTR6(f, m, p1, p2, p3, p4, 0, 0)
#define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, 0)
#else
#define	LINUX_CTR(f)
#define	LINUX_CTR0(f, m)
#define	LINUX_CTR1(f, m, p1)
#define	LINUX_CTR2(f, m, p1, p2)
#define	LINUX_CTR3(f, m, p1, p2, p3)
#define	LINUX_CTR4(f, m, p1, p2, p3, p4)
#define	LINUX_CTR5(f, m, p1, p2, p3, p4, p5)
#define	LINUX_CTR6(f, m, p1, p2, p3, p4, p5, p6)
#endif

/*
 * Some macros for rate limiting messages:
 *  - noisy if compat.linux.debug = 1
 *  - print only once if compat.linux.debug > 1
 */
#define LINUX_RATELIMIT_MSG_NOTTESTED(_what)			\
	do {						\
		static int seen = 0;			\
							\
		if (seen == 0 && linux_debug >= 2) {			\
			linux_msg(curthread, "%s is not tested, please report on emulation@FreeBSD.org how it works", _what);	\
							\
			if (linux_debug < 3)		\
				seen = 1;		\
		}					\
	} while (0)

#define LINUX_RATELIMIT_MSG_OPT1(_message, _opt1)	 	\
	do {							\
		static int seen = 0;				\
								\
		if (seen == 0) {				\
			linux_msg(curthread, _message, _opt1);	\
								\
			if (linux_debug < 3)			\
				seen = 1;			\
		}						\
	} while (0)

#endif /* ! _LINUX_UTIL_H_ */