osfmk/mach/i386/thread_status.h

   1 /*
   2  * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * @OSF_COPYRIGHT@
  30  */
  31 /*
  32  * Mach Operating System
  33  * Copyright (c) 1991,1990,1989 Carnegie Mellon University
  34  * All Rights Reserved.
  35  *
  36  * Permission to use, copy, modify and distribute this software and its
  37  * documentation is hereby granted, provided that both the copyright
  38  * notice and this permission notice appear in all copies of the
  39  * software, derivative works or modified versions, and any portions
  40  * thereof, and that both notices appear in supporting documentation.
  41  *
  42  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
  43  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  44  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  45  *
  46  * Carnegie Mellon requests users of this software to return to
  47  *
  48  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  49  *  School of Computer Science
  50  *  Carnegie Mellon University
  51  *  Pittsburgh PA 15213-3890
  52  *
  53  * any improvements or extensions that they make and grant Carnegie Mellon
  54  * the rights to redistribute these changes.
  55  */
  56 /*
  57  */
  58 /*
  59  *      File:   thread_status.h
  60  *      Author: Avadis Tevanian, Jr.
  61  *      Date:   1985
  62  *
  63  *      This file contains the structure definitions for the thread
  64  *      state as applied to I386 processors.
  65  */
  66
  67 #ifndef _MACH_I386_THREAD_STATUS_H_
  68 #define _MACH_I386_THREAD_STATUS_H_
  69
  70 #include <mach/i386/_structs.h>
  71 #include <mach/message.h>
  72 #include <mach/i386/fp_reg.h>
  73 #include <mach/i386/thread_state.h>
  74 #include <i386/eflags.h>
  75
  76 /*
  77  * the i386_xxxx form is kept for legacy purposes since these types
  78  * are externally known... eventually they should be deprecated.
  79  * our internal implementation has moved to the following naming convention
  80  *
  81  *   x86_xxxx32 names are used to deal with 32 bit states
  82  *   x86_xxxx64 names are used to deal with 64 bit states
  83  *   x86_xxxx   names are used to deal with either 32 or 64 bit states
  84  *      via a self-describing mechanism
  85  */
  86
  87 /*
  88  * these are the legacy names which should be deprecated in the future
  89  * they are externally known which is the only reason we don't just get
  90  * rid of them
  91  */
  92 #define i386_THREAD_STATE               1
  93 #define i386_FLOAT_STATE                2
  94 #define i386_EXCEPTION_STATE            3
  95
  96 /*
  97  * THREAD_STATE_FLAVOR_LIST 0
  98  *      these are the supported flavors
  99  */
 100 #define x86_THREAD_STATE32              1
 101 #define x86_FLOAT_STATE32               2
 102 #define x86_EXCEPTION_STATE32           3
 103 #define x86_THREAD_STATE64              4
 104 #define x86_FLOAT_STATE64               5
 105 #define x86_EXCEPTION_STATE64           6
 106 #define x86_THREAD_STATE                7
 107 #define x86_FLOAT_STATE                 8
 108 #define x86_EXCEPTION_STATE             9
 109 #define x86_DEBUG_STATE32               10
 110 #define x86_DEBUG_STATE64               11
 111 #define x86_DEBUG_STATE                 12
 112 #define THREAD_STATE_NONE               13
 113 /* 15 and 16 are used for the internal x86_SAVED_STATE flavours */
 114 #define x86_AVX_STATE32                 16
 115 #define x86_AVX_STATE64                 17
 116
 117
 118 /*
 119  * Largest state on this machine:
 120  * (be sure mach/machine/thread_state.h matches!)
 121  */
 122 #define THREAD_MACHINE_STATE_MAX        THREAD_STATE_MAX
 123
 124 /*
 125  * VALID_THREAD_STATE_FLAVOR is a platform specific macro that when passed
 126  * an exception flavor will return if that is a defined flavor for that
 127  * platform. The macro must be manually updated to include all of the valid
 128  * exception flavors as defined above.
 129  */
 130 #define VALID_THREAD_STATE_FLAVOR(x)       \
 131          ((x == x86_THREAD_STATE32)     || \
 132           (x == x86_FLOAT_STATE32)      || \
 133           (x == x86_EXCEPTION_STATE32)  || \
 134           (x == x86_DEBUG_STATE32)      || \
 135           (x == x86_THREAD_STATE64)     || \
 136           (x == x86_FLOAT_STATE64)      || \
 137           (x == x86_EXCEPTION_STATE64)  || \
 138           (x == x86_DEBUG_STATE64)      || \
 139           (x == x86_THREAD_STATE)       || \
 140           (x == x86_FLOAT_STATE)        || \
 141           (x == x86_EXCEPTION_STATE)    || \
 142           (x == x86_DEBUG_STATE)        || \
 143           (x == x86_AVX_STATE32)        || \
 144           (x == x86_AVX_STATE64)        || \
 145           (x == THREAD_STATE_NONE))
 146
 147 struct x86_state_hdr {
 148         int     flavor;
 149         int     count;
 150 };
 151 typedef struct x86_state_hdr x86_state_hdr_t;
 152
 153 /*
 154  * Default segment register values.
 155  */
 156
 157 #define USER_CODE_SELECTOR      0x0017
 158 #define USER_DATA_SELECTOR      0x001f
 159 #define KERN_CODE_SELECTOR      0x0008
 160 #define KERN_DATA_SELECTOR      0x0010
 161
 162 /*
 163  * to be deprecated in the future
 164  */
 165 typedef _STRUCT_X86_THREAD_STATE32 i386_thread_state_t;
 166 #define i386_THREAD_STATE_COUNT ((mach_msg_type_number_t) \
 167     ( sizeof (i386_thread_state_t) / sizeof (int) ))
 168
 169 typedef _STRUCT_X86_THREAD_STATE32 x86_thread_state32_t;
 170 #define x86_THREAD_STATE32_COUNT        ((mach_msg_type_number_t) \
 171     ( sizeof (x86_thread_state32_t) / sizeof (int) ))
 172
 173 /*
 174  * to be deprecated in the future
 175  */
 176 typedef _STRUCT_X86_FLOAT_STATE32 i386_float_state_t;
 177 #define i386_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \
 178                 (sizeof(i386_float_state_t)/sizeof(unsigned int)))
 179
 180 typedef _STRUCT_X86_FLOAT_STATE32 x86_float_state32_t;
 181 #define x86_FLOAT_STATE32_COUNT ((mach_msg_type_number_t) \
 182                 (sizeof(x86_float_state32_t)/sizeof(unsigned int)))
 183
 184 typedef _STRUCT_X86_AVX_STATE32 x86_avx_state32_t;
 185 #define x86_AVX_STATE32_COUNT ((mach_msg_type_number_t) \
 186                 (sizeof(x86_avx_state32_t)/sizeof(unsigned int)))
 187
 188 /*
 189  * to be deprecated in the future
 190  */
 191 typedef _STRUCT_X86_EXCEPTION_STATE32 i386_exception_state_t;
 192 #define i386_EXCEPTION_STATE_COUNT      ((mach_msg_type_number_t) \
 193     ( sizeof (i386_exception_state_t) / sizeof (int) ))
 194
 195 typedef _STRUCT_X86_EXCEPTION_STATE32 x86_exception_state32_t;
 196 #define x86_EXCEPTION_STATE32_COUNT     ((mach_msg_type_number_t) \
 197     ( sizeof (x86_exception_state32_t) / sizeof (int) ))
 198
 199 #define I386_EXCEPTION_STATE_COUNT i386_EXCEPTION_STATE_COUNT
 200
 201 typedef _STRUCT_X86_DEBUG_STATE32 x86_debug_state32_t;
 202 #define x86_DEBUG_STATE32_COUNT       ((mach_msg_type_number_t) \
 203         ( sizeof (x86_debug_state32_t) / sizeof (int) ))
 204
 205 #define X86_DEBUG_STATE32_COUNT x86_DEBUG_STATE32_COUNT
 206
 207 typedef _STRUCT_X86_THREAD_STATE64 x86_thread_state64_t;
 208 #define x86_THREAD_STATE64_COUNT        ((mach_msg_type_number_t) \
 209     ( sizeof (x86_thread_state64_t) / sizeof (int) ))
 210
 211 typedef _STRUCT_X86_FLOAT_STATE64 x86_float_state64_t;
 212 #define x86_FLOAT_STATE64_COUNT ((mach_msg_type_number_t) \
 213                 (sizeof(x86_float_state64_t)/sizeof(unsigned int)))
 214
 215 typedef _STRUCT_X86_AVX_STATE64 x86_avx_state64_t;
 216 #define x86_AVX_STATE64_COUNT ((mach_msg_type_number_t) \
 217                 (sizeof(x86_avx_state64_t)/sizeof(unsigned int)))
 218
 219 typedef _STRUCT_X86_EXCEPTION_STATE64 x86_exception_state64_t;
 220 #define x86_EXCEPTION_STATE64_COUNT     ((mach_msg_type_number_t) \
 221     ( sizeof (x86_exception_state64_t) / sizeof (int) ))
 222
 223 #define X86_EXCEPTION_STATE64_COUNT x86_EXCEPTION_STATE64_COUNT
 224
 225 typedef _STRUCT_X86_DEBUG_STATE64 x86_debug_state64_t;
 226 #define x86_DEBUG_STATE64_COUNT ((mach_msg_type_number_t) \
 227     ( sizeof (x86_debug_state64_t) / sizeof (int) ))
 228
 229 #define X86_DEBUG_STATE64_COUNT x86_DEBUG_STATE64_COUNT
 230
 231 /*
 232  * Combined thread, float and exception states
 233  */
 234 struct x86_thread_state {
 235         x86_state_hdr_t                 tsh;
 236         union {
 237             x86_thread_state32_t        ts32;
 238             x86_thread_state64_t        ts64;
 239         } uts;
 240 };
 241
 242 struct x86_float_state {
 243         x86_state_hdr_t                 fsh;
 244         union {
 245                 x86_float_state32_t     fs32;
 246                 x86_float_state64_t     fs64;
 247         } ufs;
 248 };
 249
 250 struct x86_exception_state {
 251         x86_state_hdr_t                 esh;
 252         union {
 253                 x86_exception_state32_t es32;
 254                 x86_exception_state64_t es64;
 255         } ues;
 256 };
 257
 258 struct x86_debug_state {
 259         x86_state_hdr_t                 dsh;
 260         union {
 261                 x86_debug_state32_t     ds32;
 262                 x86_debug_state64_t     ds64;
 263         } uds;
 264 };
 265
 266 typedef struct x86_thread_state x86_thread_state_t;
 267 #define x86_THREAD_STATE_COUNT  ((mach_msg_type_number_t) \
 268                 ( sizeof (x86_thread_state_t) / sizeof (int) ))
 269
 270 typedef struct x86_float_state x86_float_state_t;
 271 #define x86_FLOAT_STATE_COUNT ((mach_msg_type_number_t) \
 272                 (sizeof(x86_float_state_t)/sizeof(unsigned int)))
 273
 274 typedef struct x86_exception_state x86_exception_state_t;
 275 #define x86_EXCEPTION_STATE_COUNT ((mach_msg_type_number_t) \
 276                 (sizeof(x86_exception_state_t)/sizeof(unsigned int)))
 277
 278 typedef struct x86_debug_state x86_debug_state_t;
 279 #define x86_DEBUG_STATE_COUNT ((mach_msg_type_number_t) \
 280                 (sizeof(x86_debug_state_t)/sizeof(unsigned int)))
 281
 282 /*
 283  * Machine-independent way for servers and Mach's exception mechanism to
 284  * choose the most efficient state flavor for exception RPC's:
 285  */
 286 #define MACHINE_THREAD_STATE            x86_THREAD_STATE
 287 #define MACHINE_THREAD_STATE_COUNT      x86_THREAD_STATE_COUNT
 288
 289 /*
 290  * when reloading the segment registers on
 291  * a return out of the kernel, we may take
 292  * a GeneralProtection or SegmentNotPresent
 293  * fault if one or more of the segment
 294  * registers in the saved state was improperly
 295  * specified via an x86_THREAD_STATE32 call
 296  * the frame we push on top of the existing
 297  * save area looks like this... we need to
 298  * carry this as part of the save area
 299  * in case we get hit so that we have a big
 300  * enough stack
 301  */
 302 struct x86_seg_load_fault32 {
 303         uint16_t        trapno;
 304         uint16_t        cpu;
 305         uint32_t        err;
 306         uint32_t        eip;
 307         uint32_t        cs;
 308         uint32_t        efl;
 309 };
 310
 311 #ifdef XNU_KERNEL_PRIVATE
 312
 313 #define x86_SAVED_STATE32               THREAD_STATE_NONE + 1
 314 #define x86_SAVED_STATE64               THREAD_STATE_NONE + 2
 315
 316 /*
 317  * Subset of saved state stored by processor on kernel-to-kernel
 318  * trap.  (Used by ddb to examine state guaranteed to be present
 319  * on all traps into debugger.)
 320  */
 321 struct x86_saved_state32_from_kernel {
 322         uint32_t        gs;
 323         uint32_t        fs;
 324         uint32_t        es;
 325         uint32_t        ds;
 326         uint32_t        edi;
 327         uint32_t        esi;
 328         uint32_t        ebp;
 329         uint32_t        cr2;    /* kernel esp stored by pusha - we save cr2 here later */
 330         uint32_t        ebx;
 331         uint32_t        edx;
 332         uint32_t        ecx;
 333         uint32_t        eax;
 334         uint16_t        trapno;
 335         uint16_t        cpu;
 336         uint32_t        err;
 337         uint32_t        eip;
 338         uint32_t        cs;
 339         uint32_t        efl;
 340 };
 341
 342 /*
 343  * The format in which thread state is saved by Mach on this machine.  This
 344  * state flavor is most efficient for exception RPC's to kernel-loaded
 345  * servers, because copying can be avoided:
 346  */
 347 struct x86_saved_state32 {
 348         uint32_t        gs;
 349         uint32_t        fs;
 350         uint32_t        es;
 351         uint32_t        ds;
 352         uint32_t        edi;
 353         uint32_t        esi;
 354         uint32_t        ebp;
 355         uint32_t        cr2;    /* kernel esp stored by pusha - we save cr2 here later */
 356         uint32_t        ebx;
 357         uint32_t        edx;
 358         uint32_t        ecx;
 359         uint32_t        eax;
 360         uint16_t        trapno;
 361         uint16_t        cpu;
 362         uint32_t        err;
 363         uint32_t        eip;
 364         uint32_t        cs;
 365         uint32_t        efl;
 366         uint32_t        uesp;
 367         uint32_t        ss;
 368 };
 369 typedef struct x86_saved_state32 x86_saved_state32_t;
 370
 371 #define x86_SAVED_STATE32_COUNT ((mach_msg_type_number_t) \
 372         (sizeof (x86_saved_state32_t)/sizeof(unsigned int)))
 373
 374 #pragma pack(4)
 375 struct x86_saved_state32_tagged {
 376         uint32_t                        tag;
 377         struct x86_saved_state32        state;
 378 };
 379 typedef struct x86_saved_state32_tagged x86_saved_state32_tagged_t;
 380 /* Note: sizeof(x86_saved_state32_tagged_t) is a multiple of 16 bytes */
 381
 382 struct x86_sframe32 {
 383         /*
 384          * in case we throw a fault reloading
 385          * segment registers on a return out of
 386          * the kernel... the 'slf' state is only kept
 387          * long enough to rejigger (i.e. restore
 388          * the save area to its original state)
 389          * the save area and throw the appropriate
 390          * kernel trap pointing to the 'ssf' state
 391          */
 392         struct x86_seg_load_fault32     slf;
 393         struct x86_saved_state32_tagged ssf;
 394 };
 395 typedef struct x86_sframe32 x86_sframe32_t;
 396
 397 /*
 398  * This is the state pushed onto the 64-bit interrupt stack
 399  * on any exception/trap/interrupt.
 400  */
 401 struct x86_64_intr_stack_frame {
 402         uint16_t        trapno;
 403         uint16_t        cpu;
 404         uint32_t        _pad;
 405         uint64_t        trapfn;
 406         uint64_t        err;
 407         uint64_t        rip;
 408         uint64_t        cs;
 409         uint64_t        rflags;
 410         uint64_t        rsp;
 411         uint64_t        ss;
 412 };
 413 typedef struct x86_64_intr_stack_frame x86_64_intr_stack_frame_t;
 414 /* Note: sizeof(x86_64_intr_stack_frame_t) must be a multiple of 16 bytes */
 415
 416 /*
 417  * This defines the state saved before entry into compatibility mode.
 418  * The machine state is pushed automatically and the compat state is
 419  * synthethized in the exception handling code.
 420  */
 421 struct x86_saved_state_compat32 {
 422         struct x86_saved_state32_tagged iss32;
 423         struct x86_64_intr_stack_frame  isf64;
 424 };
 425 typedef struct x86_saved_state_compat32 x86_saved_state_compat32_t;
 426
 427 struct x86_sframe_compat32 {
 428         uint32_t                        pad_for_16byte_alignment[2];
 429         uint64_t                        _register_save_slot;
 430         struct x86_64_intr_stack_frame  slf;
 431         struct x86_saved_state_compat32 ssf;
 432 };
 433 typedef struct x86_sframe_compat32 x86_sframe_compat32_t;
 434 /* Note: sizeof(x86_sframe_compat32_t) must be a multiple of 16 bytes */
 435
 436 /*
 437  * thread state format for task running in 64bit long mode
 438  * in long mode, the same hardware frame is always pushed regardless
 439  * of whether there was a change in privlege level... therefore, there
 440  * is no need for an x86_saved_state64_from_kernel variant
 441  */
 442 struct x86_saved_state64 {
 443         /*
 444          * saved state organized to reflect the
 445          * system call ABI register convention
 446          * so that we can just pass a pointer
 447          * to the saved state when calling through
 448          * to the actual system call functions
 449          * the ABI limits us to 6 args passed in
 450          * registers... I've add v_arg6 - v_arg8
 451          * to accomodate our most 'greedy' system
 452          * calls (both BSD and MACH)... the individual
 453          * system call handlers will fill these in
 454          * via copyin if needed...
 455          */
 456         uint64_t        rdi;            /* arg0 for system call */
 457         uint64_t        rsi;
 458         uint64_t        rdx;
 459         uint64_t        r10;
 460         uint64_t        r8;
 461         uint64_t        r9;             /* arg5 for system call */
 462         uint64_t        v_arg6;
 463         uint64_t        v_arg7;
 464         uint64_t        v_arg8;
 465
 466         uint64_t        cr2;
 467         uint64_t        r15;
 468         uint64_t        r14;
 469         uint64_t        r13;
 470         uint64_t        r12;
 471         uint64_t        r11;
 472         uint64_t        rbp;
 473         uint64_t        rbx;
 474         uint64_t        rcx;
 475         uint64_t        rax;
 476
 477         uint32_t        gs;
 478         uint32_t        fs;
 479
 480         uint32_t        _pad_for_tagged_alignment[3];
 481
 482         struct  x86_64_intr_stack_frame isf;
 483 };
 484 typedef struct x86_saved_state64 x86_saved_state64_t;
 485 #define x86_SAVED_STATE64_COUNT ((mach_msg_type_number_t) \
 486         (sizeof (struct x86_saved_state64)/sizeof(unsigned int)))
 487
 488 struct x86_saved_state64_tagged {
 489         uint32_t                tag;
 490         x86_saved_state64_t     state;
 491 };
 492 typedef struct x86_saved_state64_tagged x86_saved_state64_tagged_t;
 493
 494 struct x86_sframe64 {
 495         uint64_t                        _register_save_slot[2];
 496         struct x86_64_intr_stack_frame  slf;
 497         x86_saved_state64_tagged_t      ssf;
 498 };
 499 typedef struct x86_sframe64 x86_sframe64_t;
 500 /* Note: sizeof(x86_sframe64_t) is a multiple of 16 bytes */
 501
 502 extern uint32_t get_eflags_exportmask(void);
 503
 504 /*
 505  * Unified, tagged saved state:
 506  */
 507 typedef struct {
 508         uint32_t                        flavor;
 509         union {
 510                 x86_saved_state32_t     ss_32;
 511                 x86_saved_state64_t     ss_64;
 512         } uss;
 513 } x86_saved_state_t;
 514 #define ss_32   uss.ss_32
 515 #define ss_64   uss.ss_64
 516 #pragma pack()
 517
 518 static inline boolean_t
 519 is_saved_state64(x86_saved_state_t *iss)
 520 {
 521         return (iss->flavor == x86_SAVED_STATE64);
 522 }
 523
 524 static inline boolean_t
 525 is_saved_state32(x86_saved_state_t *iss)
 526 {
 527         return (iss->flavor == x86_SAVED_STATE32);
 528 }
 529
 530 static inline x86_saved_state32_t *
 531 saved_state32(x86_saved_state_t *iss)
 532 {
 533         return &iss->ss_32;
 534 }
 535
 536 static inline x86_saved_state64_t *
 537 saved_state64(x86_saved_state_t *iss)
 538 {
 539         return &iss->ss_64;
 540 }
 541
 542 #endif /* XNU_KERNEL_PRIVATE */
 543
 544 #endif  /* _MACH_I386_THREAD_STATUS_H_ */