osfmk/kperf/task_samplers.h

   1 /*
   2  * Copyright (c) 2016 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 #ifndef KPERF_TASK_SAMPLERS_H
  30 #define KPERF_TASK_SAMPLERS_H
  31
  32 #include <kperf/context.h>
  33 #include <kern/task.h>
  34
  35 struct kperf_task_snapshot {
  36         uint64_t kptksn_flags;
  37         uint64_t kptksn_user_time_in_terminated_threads;
  38         uint64_t kptksn_system_time_in_terminated_threads;
  39         int kptksn_suspend_count;
  40         int kptksn_pageins;
  41 };
  42
  43 #define KPERF_TASK_FLAG_DARWIN_BG               (1U << 0)
  44 #define KPERF_TASK_FLAG_FOREGROUND              (1U << 1)
  45 #define KPERF_TASK_FLAG_BOOSTED                 (1U << 2)
  46 #define KPERF_TASK_FLAG_DIRTY                   (1U << 3)
  47 #define KPERF_TASK_FLAG_WQ_FLAGS_VALID          (1U << 4)
  48 #define KPERF_TASK_FLAG_WQ_EXCEEDED_TOTAL       (1U << 5)
  49 #define KPERF_TASK_FLAG_WQ_EXCEEDED_CONSTRAINED (1U << 6)
  50 #define KPERF_TASK_FLAG_DIRTY_TRACKED           (1U << 7)
  51 #define KPERF_TASK_ALLOW_IDLE_EXIT              (1U << 8)
  52
  53 void kperf_task_snapshot_sample(task_t task, struct kperf_task_snapshot *tksn);
  54 void kperf_task_snapshot_log(struct kperf_task_snapshot *tksn);
  55 void kperf_task_info_log(struct kperf_context *ctx);
  56
  57 #endif /* !defined(KPERF_TASK_SAMPLERS_H) */