sys/amd64/include/pcb.h

   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  *      from: @(#)pcb.h 5.10 (Berkeley) 5/12/91
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef _AMD64_PCB_H_
  40 #define _AMD64_PCB_H_
  41
  42 /*
  43  * AMD64 process control block
  44  */
  45 #include <machine/fpu.h>
  46 #include <machine/segments.h>
  47
  48 #ifdef __amd64__
  49 /*
  50  * NB: The fields marked with (*) are used by kernel debuggers.  Their
  51  * ABI should be preserved.
  52  */
  53 struct pcb {
  54         register_t      pcb_r15;        /* (*) */
  55         register_t      pcb_r14;        /* (*) */
  56         register_t      pcb_r13;        /* (*) */
  57         register_t      pcb_r12;        /* (*) */
  58         register_t      pcb_rbp;        /* (*) */
  59         register_t      pcb_rsp;        /* (*) */
  60         register_t      pcb_rbx;        /* (*) */
  61         register_t      pcb_rip;        /* (*) */
  62         register_t      pcb_fsbase;
  63         register_t      pcb_gsbase;
  64         register_t      pcb_kgsbase;
  65         register_t      pcb_cr0;
  66         register_t      pcb_cr2;
  67         register_t      pcb_cr3;
  68         register_t      pcb_cr4;
  69         register_t      pcb_dr0;
  70         register_t      pcb_dr1;
  71         register_t      pcb_dr2;
  72         register_t      pcb_dr3;
  73         register_t      pcb_dr6;
  74         register_t      pcb_dr7;
  75
  76         struct region_descriptor pcb_gdt;
  77         struct region_descriptor pcb_idt;
  78         struct region_descriptor pcb_ldt;
  79         uint16_t        pcb_tr;
  80
  81         u_int           pcb_flags;
  82 #define PCB_FULL_IRET   0x01    /* full iret is required */
  83 #define PCB_DBREGS      0x02    /* process using debug registers */
  84 #define PCB_KERNFPU     0x04    /* kernel uses fpu */
  85 #define PCB_FPUINITDONE 0x08    /* fpu state is initialized */
  86 #define PCB_USERFPUINITDONE 0x10 /* fpu user state is initialized */
  87 #define PCB_32BIT       0x40    /* process has 32 bit context (segs etc) */
  88 #define PCB_FPUNOSAVE   0x80    /* no save area for current FPU ctx */
  89
  90         uint16_t        pcb_initial_fpucw;
  91
  92         /* copyin/out fault recovery */
  93         caddr_t         pcb_onfault;
  94
  95         uint64_t        pcb_saved_ucr3;
  96
  97         /* local tss, with i/o bitmap; NULL for common */
  98         struct amd64tss *pcb_tssp;
  99
 100         /* model specific registers */
 101         register_t      pcb_efer;
 102         register_t      pcb_star;
 103         register_t      pcb_lstar;
 104         register_t      pcb_cstar;
 105         register_t      pcb_sfmask;
 106
 107         struct savefpu  *pcb_save;
 108
 109         uint64_t        pcb_pad[5];
 110 };
 111
 112 /* Per-CPU state saved during suspend and resume. */
 113 struct susppcb {
 114         struct pcb      sp_pcb;
 115
 116         /* fpu context for suspend/resume */
 117         void            *sp_fpususpend;
 118 };
 119 #endif
 120
 121 #ifdef _KERNEL
 122 struct trapframe;
 123
 124 void    clear_pcb_flags(struct pcb *pcb, const u_int flags);
 125 void    makectx(struct trapframe *, struct pcb *);
 126 void    set_pcb_flags(struct pcb *pcb, const u_int flags);
 127 void    set_pcb_flags_raw(struct pcb *pcb, const u_int flags);
 128 int     savectx(struct pcb *) __returns_twice;
 129 void    resumectx(struct pcb *);
 130
 131 /* Ensure that pcb_gsbase and pcb_fsbase are up to date */
 132 #define update_pcb_bases(pcb)   set_pcb_flags((pcb), PCB_FULL_IRET)
 133 #endif
 134
 135 #endif /* _AMD64_PCB_H_ */