xref: /src/sys/compat/linux/common/linux_sched.h

/*	$NetBSD: linux_sched.h,v 1.11 2024/09/28 19:35:56 christos Exp $	*/

/*-
 * Copyright (c) 1999 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
 * NASA Ames Research Center.
 *
 * 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */

#ifndef _LINUX_SCHED_H
#define	_LINUX_SCHED_H

/*
 * Flags passed to the Linux __clone(2) system call.
 */
#define	LINUX_CLONE_CSIGNAL	0x000000ff	/* signal to be sent at exit */
#define	LINUX_CLONE_VM		0x00000100	/* share address space */
#define	LINUX_CLONE_FS		0x00000200	/* share "file system" info */
#define	LINUX_CLONE_FILES	0x00000400	/* share file descriptors */
#define	LINUX_CLONE_SIGHAND	0x00000800	/* share signal actions */
#define	LINUX_CLONE_PID		0x00001000	/* share process ID */
#define	LINUX_CLONE_PTRACE	0x00002000	/* ptrace(2) continues on
						   child */
#define	LINUX_CLONE_VFORK	0x00004000	/* parent blocks until child
						   exits */
#define LINUX_CLONE_PARENT	0x00008000	/* want same parent as cloner */
#define LINUX_CLONE_THREAD	0x00010000	/* same thread group */
#define LINUX_CLONE_NEWNS	0x00020000	/* new namespace group */
#define LINUX_CLONE_SYSVSEM	0x00040000	/* share SysV SEM_UNDO */
#define LINUX_CLONE_SETTLS	0x00080000	/* create new TLS for child */
#define LINUX_CLONE_PARENT_SETTID \
				0x00100000	/* set TID in the parent */
#define LINUX_CLONE_CHILD_CLEARTID \
				0x00200000	/* clear TID in the child */
#define LINUX_CLONE_DETACHED	0x00400000	/* unused */
#define LINUX_CLONE_UNTRACED	0x00800000	/* set if parent cannot force CLONE_PTRACE */
#define LINUX_CLONE_CHILD_SETTID \
				0x01000000	/* set TID in the child */
#define LINUX_CLONE_STOPPED	0x02000000	/* start in stopped state */

/*
 * Flags that clone supports but are yet to be supported in NetBSD
 */

#define	LINUX_CLONE_PIDFD		0x00001000	/* since Linux 5.2 */
#define	LINUX_CLONE_NEWCGROUP		0x02000000	/* New cgroup NS */
#define	LINUX_CLONE_NEWUTS		0x04000000
#define	LINUX_CLONE_NEWIPC		0x08000000
#define	LINUX_CLONE_NEWUSER		0x10000000
#define	LINUX_CLONE_NEWPID		0x20000000
#define	LINUX_CLONE_NEWNET		0x40000000
#define	LINUX_CLONE_IO			0x80000000

/* Flags for the clone3() syscall. */
#define	LINUX_CLONE_CLEAR_SIGHAND	0x100000000ULL
#define	LINUX_CLONE_INTO_CGROUP		0x200000000ULL
#define	LINUX_CLONE_NEWTIME		0x00000080

#define	LINUX_CLONE_LEGACY_FLAGS	0xffffffffULL

#define LINUX_CLONE_ALLOWED_FLAGS ( \
    LINUX_CLONE_VM | LINUX_CLONE_FS | LINUX_CLONE_FILES | \
    LINUX_CLONE_SIGHAND | LINUX_CLONE_THREAD | LINUX_CLONE_VFORK | \
    LINUX_CLONE_PARENT_SETTID | LINUX_CLONE_CHILD_CLEARTID | \
    LINUX_CLONE_CHILD_SETTID | LINUX_CLONE_SETTLS)

#define LINUX_CLONE_UNIMPLEMENTED_FLAGS ( \
    LINUX_CLONE_NEWNS | LINUX_CLONE_NEWUTS | LINUX_CLONE_NEWIPC | \
    LINUX_CLONE_NEWUSER | LINUX_CLONE_NEWPID | LINUX_CLONE_NEWNET | \
    LINUX_CLONE_PIDFD)

#define	LINUX_CSIGNAL			0x000000ff
struct linux_sched_param {
	int	sched_priority;
};

#define LINUX_SCHED_OTHER	0
#define LINUX_SCHED_FIFO	1
#define LINUX_SCHED_RR		2

struct linux_timespec {
	linux_time_t	tv_sec;		/* seconds */
	long		tv_nsec;	/* nanoseconds */
};

struct linux_itimerspec {
	struct linux_timespec it_interval;
	struct linux_timespec it_value;
};

struct linux_user_clone3_args {
	uint64_t flags;        /* Flags bit mask */
	uint64_t pidfd;        /* Where to store PID file descriptor (int *) */
	uint64_t child_tid;    /* Where to store child TID, in child's memory
				  (pid_t *) */
	uint64_t parent_tid;   /* Where to store child TID, in parent's memory
				  (pid_t *) */
	uint64_t exit_signal;  /* Signal to deliver to parent on child
				  termination */
	uint64_t stack;        /* Pointer to lowest byte of stack */
	uint64_t stack_size;   /* Size of stack */
	uint64_t tls;          /* Location of new TLS */
	uint64_t set_tid;      /* Pointer to a pid_t array (since Linux 5.5) */
	uint64_t set_tid_size; /* Number of elements in set_tid (since Linux
				  5.5) */
	uint64_t cgroup;       /* File descriptor for target cgroup of child
				  (since Linux 5.7) */
};


#define LINUX_CLOCK_REALTIME		0
#define LINUX_CLOCK_MONOTONIC		1
#define LINUX_CLOCK_PROCESS_CPUTIME_ID	2
#define LINUX_CLOCK_THREAD_CPUTIME_ID	3
#define LINUX_CLOCK_MONOTONIC_RAW	4
#define	LINUX_CLOCK_REALTIME_COARSE	5
#define	LINUX_CLOCK_MONOTONIC_COARSE	6
#define	LINUX_CLOCK_BOOTTIME		7
#define	LINUX_CLOCK_BOOTTIME_ALARM	8
#define	LINUX_CLOCK_REALTIME_ALARM	9

#define LINUX_TIMER_ABSTIME		0x01

int	linux_to_native_clockid(clockid_t *, clockid_t);

void	native_to_linux_timespec(struct linux_timespec *,
	    const struct timespec *);
void	linux_to_native_timespec(struct timespec *,
	    const struct linux_timespec *);

void	native_to_linux_itimerspec(struct linux_itimerspec *,
	    const struct itimerspec *);
void	linux_to_native_itimerspec(struct itimerspec *,
	    const struct linux_itimerspec *);

int	linux_to_native_timer_create_clockid(clockid_t *, clockid_t);

int	linux_to_native_timerfd_settime_flags(int *, int);

#endif /* _LINUX_SCHED_H */