bsd/kern/sys_work_interval.c

   1 /*
   2  * Copyright (c) 2015 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 #include <sys/param.h>
  29 #include <sys/kernel.h>
  30 #include <sys/kernel_types.h>
  31 #include <sys/sysproto.h>
  32 #include <sys/priv.h>
  33 #include <sys/work_interval.h>
  34 #include <kern/sched_prim.h>
  35 #include <kern/thread.h>
  36 #include <kern/task.h>
  37 #include <kern/work_interval.h>
  38
  39 #include <libkern/libkern.h>
  40
  41 int
  42 work_interval_ctl(__unused proc_t p, struct work_interval_ctl_args *uap,
  43     __unused int32_t *retval)
  44 {
  45         uint32_t        operation = uap->operation;
  46         int             error = 0;
  47         kern_return_t   kret = KERN_SUCCESS;
  48         struct work_interval_notification notification;
  49
  50         struct work_interval_create_params create_params;
  51         struct kern_work_interval_create_args create_args;
  52
  53         switch (operation) {
  54         case WORK_INTERVAL_OPERATION_CREATE:
  55                 return ENOTSUP;
  56         case WORK_INTERVAL_OPERATION_CREATE2:
  57                 if (uap->arg == USER_ADDR_NULL || uap->work_interval_id != 0) {
  58                         return EINVAL;
  59                 }
  60                 if (uap->len < sizeof(create_params)) {
  61                         return EINVAL;
  62                 }
  63
  64                 if ((error = copyin(uap->arg, &create_params, sizeof(create_params)))) {
  65                         return error;
  66                 }
  67
  68                 if ((error = priv_check_cred(kauth_cred_get(), PRIV_WORK_INTERVAL, 0)) != 0) {
  69                         return error;
  70                 }
  71
  72                 create_args = (struct kern_work_interval_create_args) {
  73                         .wica_id            = create_params.wicp_id,
  74                         .wica_port          = create_params.wicp_port,
  75                         .wica_create_flags  = create_params.wicp_create_flags,
  76                 };
  77
  78                 kret = kern_work_interval_create(current_thread(), &create_args);
  79
  80                 /* thread already has a work interval */
  81                 if (kret == KERN_FAILURE) {
  82                         return EALREADY;
  83                 }
  84
  85                 /* port copyout failed */
  86                 if (kret == KERN_RESOURCE_SHORTAGE) {
  87                         return ENOMEM;
  88                 }
  89
  90                 /* some other failure */
  91                 if (kret != KERN_SUCCESS) {
  92                         return EINVAL;
  93                 }
  94
  95                 create_params = (struct work_interval_create_params) {
  96                         .wicp_id = create_args.wica_id,
  97                         .wicp_port = create_args.wica_port,
  98                         .wicp_create_flags = create_args.wica_create_flags,
  99                 };
 100
 101                 if ((error = copyout(&create_params, uap->arg, sizeof(create_params)))) {
 102                         kern_work_interval_destroy(current_thread(), create_args.wica_id);
 103                         return error;
 104                 }
 105                 break;
 106         case WORK_INTERVAL_OPERATION_DESTROY:
 107                 if (uap->arg != USER_ADDR_NULL || uap->work_interval_id == 0) {
 108                         return EINVAL;
 109                 }
 110
 111                 /*
 112                  * No privilege check, we assume a previous WORK_INTERVAL_OPERATION_CREATE
 113                  * operation would have allocated a work interval ID for the current
 114                  * thread, which the scheduler will validate.
 115                  */
 116                 kret = kern_work_interval_destroy(current_thread(), uap->work_interval_id);
 117                 if (kret != KERN_SUCCESS) {
 118                         return EINVAL;
 119                 }
 120
 121                 break;
 122         case WORK_INTERVAL_OPERATION_NOTIFY:
 123                 if (uap->arg == USER_ADDR_NULL || uap->work_interval_id == 0) {
 124                         return EINVAL;
 125                 }
 126
 127                 if (uap->len < sizeof(notification)) {
 128                         return EINVAL;
 129                 }
 130
 131                 /*
 132                  * No privilege check, we assume a previous WORK_INTERVAL_OPERATION_CREATE
 133                  * operation would have allocated a work interval ID for the current
 134                  * thread, which the scheduler will validate.
 135                  */
 136                 if ((error = copyin(uap->arg, &notification, sizeof(notification)))) {
 137                         return error;
 138                 }
 139
 140                 struct kern_work_interval_args kwi_args = {
 141                         .work_interval_id   = uap->work_interval_id,
 142                         .start              = notification.start,
 143                         .finish             = notification.finish,
 144                         .deadline           = notification.deadline,
 145                         .next_start         = notification.next_start,
 146                         .notify_flags       = notification.notify_flags,
 147                         .create_flags       = notification.create_flags,
 148                 };
 149
 150                 kret = kern_work_interval_notify(current_thread(), &kwi_args);
 151                 if (kret != KERN_SUCCESS) {
 152                         return EINVAL;
 153                 }
 154
 155                 break;
 156         case WORK_INTERVAL_OPERATION_JOIN:
 157                 if (uap->arg != USER_ADDR_NULL) {
 158                         return EINVAL;
 159                 }
 160
 161                 /*
 162                  * No privilege check, because the work interval port
 163                  * is a capability.
 164                  */
 165                 kret = kern_work_interval_join(current_thread(),
 166                     (mach_port_name_t)uap->work_interval_id);
 167                 if (kret != KERN_SUCCESS) {
 168                         return EINVAL;
 169                 }
 170
 171                 break;
 172
 173         default:
 174                 return ENOTSUP;
 175         }
 176
 177         return error;
 178 }