xref: /freebsd/sys/compat/linux/linux_emul.h (revision 77013d11e6483b970af25e13c9b892075742f7e5)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2006 Roman Divacky
5  * All rights reserved.
6  * Copyright (c) 2013 Dmitry Chagin <dchagin@FreeBSD.org>
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _LINUX_EMUL_H_
33 #define	_LINUX_EMUL_H_
34 
35 struct image_params;
36 struct note_info_list;
37 
38 /* Linux core notes are labeled "CORE" */
39 #define	LINUX_ABI_VENDOR	"CORE"
40 
41 /*
42  * modeled after similar structure in NetBSD
43  * this will be extended as we need more functionality
44  */
45 struct linux_emuldata {
46 	int    *child_set_tid;	/* in clone(): Child's TID to set on clone */
47 	int    *child_clear_tid;/* in clone(): Child's TID to clear on exit */
48 
49 	int	flags;			/* thread emuldata flags */
50 	int	em_tid;			/* thread id */
51 
52 	struct	linux_robust_list_head	*robust_futexes;
53 };
54 
55 struct linux_emuldata	*em_find(struct thread *);
56 
57 int	linux_exec_imgact_try(struct image_params *);
58 void	linux_proc_init(struct thread *, struct thread *, int);
59 void	linux_on_exit(struct proc *);
60 void	linux_schedtail(struct thread *);
61 void	linux_on_exec(struct proc *, struct image_params *);
62 void	linux_thread_dtor(struct thread *);
63 void	linux_thread_detach(struct thread *);
64 int	linux_common_execve(struct thread *, struct image_args *);
65 void 	linux32_prepare_notes(struct thread *, struct note_info_list *, size_t *);
66 void 	linux64_prepare_notes(struct thread *, struct note_info_list *, size_t *);
67 
68 /* process emuldata flags */
69 #define	LINUX_XDEPR_REQUEUEOP	0x00000001	/* uses deprecated
70 						   futex REQUEUE op*/
71 #define	LINUX_XUNSUP_EPOLL	0x00000002	/* unsupported epoll events */
72 #define	LINUX_XUNSUP_FUTEXPIOP	0x00000004	/* uses unsupported pi futex */
73 
74 struct linux_pemuldata {
75 	uint32_t	flags;		/* process emuldata flags */
76 	struct sx	pem_sx;		/* lock for this struct */
77 	uint32_t	persona;	/* process execution domain */
78 	uint32_t	ptrace_flags;	/* used by ptrace(2) */
79 };
80 
81 #define	LINUX_PEM_XLOCK(p)	sx_xlock(&(p)->pem_sx)
82 #define	LINUX_PEM_XUNLOCK(p)	sx_xunlock(&(p)->pem_sx)
83 #define	LINUX_PEM_SLOCK(p)	sx_slock(&(p)->pem_sx)
84 #define	LINUX_PEM_SUNLOCK(p)	sx_sunlock(&(p)->pem_sx)
85 
86 struct linux_pemuldata	*pem_find(struct proc *);
87 
88 #endif	/* !_LINUX_EMUL_H_ */
89