osfmk/arm64/machine_task.c

   1 /*
   2  * Copyright (c) 2000-2016 Apple 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 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 #include <kern/task.h>
  58 #include <kern/thread.h>
  59 #include <arm/misc_protos.h>
  60
  61 extern zone_t ads_zone;
  62
  63 kern_return_t
  64 machine_task_set_state(
  65                 task_t task,
  66                 int flavor,
  67                 thread_state_t state,
  68                 mach_msg_type_number_t state_count)
  69 {
  70         switch (flavor) {
  71         case ARM_DEBUG_STATE:
  72         {
  73                 arm_legacy_debug_state_t *tstate = (arm_legacy_debug_state_t *) state;
  74                 if (task_has_64BitAddr(task) ||
  75                                 (state_count != ARM_LEGACY_DEBUG_STATE_COUNT) ||
  76                                 (!debug_legacy_state_is_valid(tstate))) {
  77                         return KERN_INVALID_ARGUMENT;
  78                 }
  79
  80                 if (task->task_debug == NULL) {
  81                         task->task_debug = zalloc(ads_zone);
  82                         if (task->task_debug == NULL)
  83                                 return KERN_FAILURE;
  84                 }
  85
  86                 copy_legacy_debug_state(tstate, (arm_legacy_debug_state_t *) task->task_debug, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
  87
  88                 return KERN_SUCCESS;
  89         }
  90         case ARM_DEBUG_STATE32:
  91         {
  92                 arm_debug_state32_t *tstate = (arm_debug_state32_t *) state;
  93                 if (task_has_64BitAddr(task) ||
  94                                 (state_count != ARM_DEBUG_STATE32_COUNT) ||
  95                                 (!debug_state_is_valid32(tstate))) {
  96                         return KERN_INVALID_ARGUMENT;
  97                 }
  98
  99                 if (task->task_debug == NULL) {
 100                         task->task_debug = zalloc(ads_zone);
 101                         if (task->task_debug == NULL)
 102                                 return KERN_FAILURE;
 103                 }
 104
 105                 copy_debug_state32(tstate, (arm_debug_state32_t *) task->task_debug, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
 106
 107                 return KERN_SUCCESS;
 108         }
 109         case ARM_DEBUG_STATE64:
 110         {
 111                 arm_debug_state64_t *tstate = (arm_debug_state64_t *) state;
 112
 113                 if ((!task_has_64BitAddr(task)) ||
 114                                 (state_count != ARM_DEBUG_STATE64_COUNT) ||
 115                                 (!debug_state_is_valid64(tstate))) {
 116                         return KERN_INVALID_ARGUMENT;
 117                 }
 118
 119                 if (task->task_debug == NULL) {
 120                         task->task_debug = zalloc(ads_zone);
 121                         if (task->task_debug == NULL)
 122                                 return KERN_FAILURE;
 123                 }
 124
 125                 copy_debug_state64(tstate, (arm_debug_state64_t *) task->task_debug, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
 126
 127                 return KERN_SUCCESS;
 128         }
 129         case THREAD_STATE_NONE:         /* Using this flavor to clear task_debug */
 130         {
 131                 if (task->task_debug != NULL) {
 132                         zfree(ads_zone, task->task_debug);
 133                         task->task_debug = NULL;
 134
 135                         return KERN_SUCCESS;
 136                 }
 137                 return KERN_FAILURE;
 138         }
 139         default:
 140           {
 141                 return KERN_INVALID_ARGUMENT;
 142           }
 143         }
 144
 145         return KERN_FAILURE;
 146 }
 147
 148 kern_return_t
 149 machine_task_get_state(task_t task,
 150                 int flavor,
 151                 thread_state_t state,
 152                 mach_msg_type_number_t *state_count)
 153 {
 154         switch (flavor) {
 155         case ARM_DEBUG_STATE:
 156         {
 157                 arm_legacy_debug_state_t *tstate = (arm_legacy_debug_state_t *) state;
 158
 159                 if (task_has_64BitAddr(task) || (*state_count != ARM_LEGACY_DEBUG_STATE_COUNT)) {
 160                         return KERN_INVALID_ARGUMENT;
 161                 }
 162
 163                 if (task->task_debug == NULL) {
 164                         bzero(state, sizeof(*tstate));
 165                 } else {
 166                         copy_legacy_debug_state((arm_legacy_debug_state_t*) task->task_debug, tstate, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
 167                 }
 168
 169                 return KERN_SUCCESS;
 170         }
 171         case ARM_DEBUG_STATE32:
 172         {
 173                 arm_debug_state32_t *tstate = (arm_debug_state32_t *) state;
 174
 175                 if (task_has_64BitAddr(task) || (*state_count != ARM_DEBUG_STATE32_COUNT)) {
 176                         return KERN_INVALID_ARGUMENT;
 177                 }
 178
 179                 if (task->task_debug == NULL) {
 180                         bzero(state, sizeof(*tstate));
 181                 } else {
 182                         copy_debug_state32((arm_debug_state32_t*) task->task_debug, tstate, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
 183                 }
 184
 185                 return KERN_SUCCESS;
 186         }
 187         case ARM_DEBUG_STATE64:
 188         {
 189                 arm_debug_state64_t *tstate = (arm_debug_state64_t *) state;
 190
 191                 if ((!task_has_64BitAddr(task)) || (*state_count != ARM_DEBUG_STATE64_COUNT)) {
 192                         return KERN_INVALID_ARGUMENT;
 193                 }
 194
 195                 if (task->task_debug == NULL) {
 196                         bzero(state, sizeof(*tstate));
 197                 } else {
 198                         copy_debug_state64((arm_debug_state64_t*) task->task_debug, tstate, FALSE); /* FALSE OR TRUE doesn't matter since we are ignoring it for arm */
 199                 }
 200
 201                 return KERN_SUCCESS;
 202         }
 203         default:
 204           {
 205                 return KERN_INVALID_ARGUMENT;
 206           }
 207
 208         }
 209         return KERN_FAILURE;
 210 }
 211
 212 void
 213 machine_task_terminate(task_t task)
 214 {
 215         if (task) {
 216                 void *task_debug;
 217
 218                 task_debug = task->task_debug;
 219                 if (task_debug != NULL) {
 220                         task->task_debug = NULL;
 221                         zfree(ads_zone, task_debug);
 222                 }
 223         }
 224 }
 225
 226
 227 kern_return_t
 228 machine_thread_inherit_taskwide(
 229                                 thread_t thread,
 230                                 task_t parent_task)
 231 {
 232         if (parent_task->task_debug) {
 233                 int flavor;
 234                 mach_msg_type_number_t count;
 235
 236                 flavor = task_has_64BitAddr(parent_task) ? ARM_DEBUG_STATE64 : ARM_DEBUG_STATE32;
 237                 count = task_has_64BitAddr(parent_task) ? ARM_DEBUG_STATE64_COUNT : ARM_DEBUG_STATE32_COUNT;
 238
 239                 return machine_thread_set_state(thread, flavor, parent_task->task_debug, count);
 240         }
 241
 242         return KERN_SUCCESS;
 243 }
 244
 245
 246 void
 247 machine_task_init(__unused task_t new_task,
 248                   __unused task_t parent_task,
 249                   __unused boolean_t memory_inherit)
 250 {
 251 }