1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2003 Peter Wemm.
5 * Copyright (c) 1990 The Regents of the University of California.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * William Jolitz.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 */
35
36#ifndef _AMD64_PCB_H_
37#define _AMD64_PCB_H_
38
39/*
40 * AMD64 process control block
41 */
42#include <machine/fpu.h>
43#include <machine/segments.h>
44
45#ifdef __amd64__
46/*
47 * NB: The fields marked with (*) are used by kernel debuggers. Their
48 * ABI should be preserved.
49 */
50struct pcb {
51 register_t pcb_r15; /* (*) */
52 register_t pcb_r14; /* (*) */
53 register_t pcb_r13; /* (*) */
54 register_t pcb_r12; /* (*) */
55 register_t pcb_rbp; /* (*) */
56 register_t pcb_rsp; /* (*) */
57 register_t pcb_rbx; /* (*) */
58 register_t pcb_rip; /* (*) */
59 register_t pcb_fsbase;
60 register_t pcb_gsbase;
61 register_t pcb_kgsbase;
62 register_t pcb_cr0;
63 register_t pcb_cr2;
64 register_t pcb_cr3;
65 register_t pcb_cr4;
66 register_t pcb_dr0;
67 register_t pcb_dr1;
68 register_t pcb_dr2;
69 register_t pcb_dr3;
70 register_t pcb_dr6;
71 register_t pcb_dr7;
72
73 struct region_descriptor pcb_gdt;
74 struct region_descriptor pcb_idt;
75 struct region_descriptor pcb_ldt;
76 uint16_t pcb_tr;
77
78 u_int pcb_flags;
79#define PCB_FULL_IRET 0x0001 /* full iret is required */
80#define PCB_DBREGS 0x0002 /* process using debug registers */
81#define PCB_KERNFPU 0x0004 /* kernel uses fpu */
82#define PCB_FPUINITDONE 0x0008 /* fpu state is initialized */
83#define PCB_USERFPUINITDONE 0x0010 /* fpu user state is initialized */
84#define PCB_KERNFPU_THR 0x0020 /* fpu_kern_thread() */
85#define PCB_32BIT 0x0040 /* process has 32 bit context (segs etc) */
86#define PCB_FPUNOSAVE 0x0080 /* no save area for current FPU ctx */
87#define PCB_TLSBASE 0x0100 /* tlsbase was set */
88
89 uint16_t pcb_initial_fpucw;
90
91 /* copyin/out fault recovery */
92 caddr_t pcb_onfault;
93
94 uint64_t pcb_saved_ucr3;
95
96 /* local tss, with i/o bitmap; NULL for common */
97 struct amd64tss *pcb_tssp;
98
99 /* model specific registers */
100 register_t pcb_efer;
101 register_t pcb_star;
102 register_t pcb_lstar;
103 register_t pcb_cstar;
104 register_t pcb_sfmask;
105
106 struct savefpu *pcb_save;
107
108 register_t pcb_tlsbase; /* not same as pcb_fsbase */
109 uint64_t pcb_pad[4];
110};
111
112/* Per-CPU state saved during suspend and resume. */
113struct susppcb {
114 struct pcb sp_pcb;
115
116 /* fpu context for suspend/resume */
117 void *sp_fpususpend;
118};
119#else /* 32bit */
120struct pcb {
121 uint64_t pcb_dummy[40];
122};
123#endif
124
125#ifdef _KERNEL
126struct trapframe;
127
128void clear_pcb_flags(struct pcb *pcb, const u_int flags);
129void makectx(struct trapframe *, struct pcb *);
130void set_pcb_flags(struct pcb *pcb, const u_int flags);
131void set_pcb_flags_raw(struct pcb *pcb, const u_int flags);
132int savectx(struct pcb *) __returns_twice;
133void resumectx(struct pcb *);
134
135/* Ensure that pcb_gsbase and pcb_fsbase are up to date */
136#define update_pcb_bases(pcb) set_pcb_flags((pcb), PCB_FULL_IRET)
137#endif
138
139#endif /* _AMD64_PCB_H_ */