xnu-4903.270.47.tar.gz

[apple/xnu.git] / osfmk / ipc / ipc_importance.h

diff --git a/osfmk/ipc/ipc_importance.h b/osfmk/ipc/ipc_importance.h
index 6f3bc5744d3091489fa81ab7076717b973ff8987..9f69a6af193c14d2ab2d09f8333a6050013d9cd0 100644 (file)
--- a/osfmk/ipc/ipc_importance.h
+++ b/osfmk/ipc/ipc_importance.h
@@ -2,7 +2,7 @@
  * Copyright (c) 2013 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 2013 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

- * 
+ *

  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in
  * This file contains Original Code and/or Modifications of Original Code
  * as defined in and that are subject to the Apple Public Source License
  * Version 2.0 (the 'License'). You may not use this file except in


@@ -11,10 +11,10 @@
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.
  * unlawful or unlicensed copies of an Apple operating system, or to
  * circumvent, violate, or enable the circumvention or violation of, any
  * terms of an Apple operating system software license agreement.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.

- * 
+ *

  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * The Original Code and all software distributed under the License are
  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,


@@ -22,11 +22,11 @@
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.
  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  * Please see the License for the specific language governing rights and
  * limitations under the License.

- * 
+ *

  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */

-#ifndef        _IPC_IPC_IMPORTANCE_H_
-#define        _IPC_IPC_IMPORTANCE_H_
+#ifndef _IPC_IPC_IMPORTANCE_H_
+#define _IPC_IPC_IMPORTANCE_H_

 
 #include <mach/mach_types.h>
 #include <mach/mach_voucher_types.h>
 
 #include <mach/mach_types.h>
 #include <mach/mach_voucher_types.h>


@@ -59,120 +59,119 @@
  */
 
 struct ipc_importance_elem {
  */
 
 struct ipc_importance_elem {

-       uint32_t                                iie_bits;       /* type and refs */
-       mach_voucher_attr_value_reference_t     iie_made;       /* references given to vouchers */
-       queue_head_t                            iie_kmsgs;      /* list of kmsgs inheriting from this */
-       uint32_t                                iie_externcnt;  /* number of externalized boosts */
-       uint32_t                                iie_externdrop; /* number of those dropped already */
+       uint32_t                                iie_bits;       /* type and refs */
+       mach_voucher_attr_value_reference_t     iie_made;       /* references given to vouchers */
+       queue_head_t                            iie_kmsgs;      /* list of kmsgs inheriting from this */
+       uint32_t                                iie_externcnt;  /* number of externalized boosts */
+       uint32_t                                iie_externdrop; /* number of those dropped already */

 #define IIE_REF_DEBUG 0
 #if IIE_REF_DEBUG
 #define IIE_REF_DEBUG 0
 #if IIE_REF_DEBUG

-       uint32_t iie_refs_added;                        /* all refs added via all means */
-       uint32_t iie_refs_dropped;                      /* all refs dropped via all means */
-       uint32_t iie_kmsg_refs_added;                   /* all refs added by kmsgs taking a ref */
-       uint32_t iie_kmsg_refs_inherited;               /* kmsg refs consumed by a new inherit */
-       uint32_t iie_kmsg_refs_coalesced;               /* kmsg refs coalesced into an existing inherit */
-       uint32_t iie_kmsg_refs_dropped;                 /* kmsg refs dropped by not accepting msg importance */
-       uint32_t iie_task_refs_added;                   /* refs added by a task reference call */
-       uint32_t iie_task_refs_added_inherit_from;      /* task references added by inherit from */
-       uint32_t iie_task_refs_added_transition;        /* task references added by imp transition code */
-       uint32_t iie_task_refs_self_added;              /* task refs added by self-boost */
-       uint32_t iie_task_refs_inherited;               /* task refs consumed by a new inherit */
-       uint32_t iie_task_refs_coalesced;               /* task refs coalesced into an existing inherit */
-       uint32_t iie_task_refs_dropped;                 /* all refs dropped via all task means */
+       uint32_t iie_refs_added;                        /* all refs added via all means */
+       uint32_t iie_refs_dropped;                      /* all refs dropped via all means */
+       uint32_t iie_kmsg_refs_added;                   /* all refs added by kmsgs taking a ref */
+       uint32_t iie_kmsg_refs_inherited;               /* kmsg refs consumed by a new inherit */
+       uint32_t iie_kmsg_refs_coalesced;               /* kmsg refs coalesced into an existing inherit */
+       uint32_t iie_kmsg_refs_dropped;                 /* kmsg refs dropped by not accepting msg importance */
+       uint32_t iie_task_refs_added;                   /* refs added by a task reference call */
+       uint32_t iie_task_refs_added_inherit_from;      /* task references added by inherit from */
+       uint32_t iie_task_refs_added_transition;        /* task references added by imp transition code */
+       uint32_t iie_task_refs_self_added;              /* task refs added by self-boost */
+       uint32_t iie_task_refs_inherited;               /* task refs consumed by a new inherit */
+       uint32_t iie_task_refs_coalesced;               /* task refs coalesced into an existing inherit */
+       uint32_t iie_task_refs_dropped;                 /* all refs dropped via all task means */

 #endif
 };
 
 #endif
 };
 

-#define IIE_TYPE_MASK          0x80000000      /* Just the high bit for now */
-#define IIE_TYPE_TASK          0x00000000      /* Element is a task element */
-#define IIE_TYPE_INHERIT       0x80000000      /* Element inherits from a previous element */
-#define IIE_TYPE(e)            ((e)->iie_bits & IIE_TYPE_MASK)
+#define IIE_TYPE_MASK           0x80000000      /* Just the high bit for now */
+#define IIE_TYPE_TASK           0x00000000      /* Element is a task element */
+#define IIE_TYPE_INHERIT        0x80000000      /* Element inherits from a previous element */
+#define IIE_TYPE(e)             ((e)->iie_bits & IIE_TYPE_MASK)

 
 

-#define IIE_REFS_MASK          0x7FFFFFFF      /* Mask to extract references */
-#define IIE_REFS_MAX           0x7FFFFFFF
-#define IIE_REFS(e)            ((e)->iie_bits & IIE_REFS_MASK)
+#define IIE_REFS_MASK           0x7FFFFFFF      /* Mask to extract references */
+#define IIE_REFS_MAX            0x7FFFFFFF
+#define IIE_REFS(e)             ((e)->iie_bits & IIE_REFS_MASK)

 
 

-#define IIE_EXTERN(e)          ((e)->iie_externcnt - (e)->iie_externdrop)
+#define IIE_EXTERN(e)           ((e)->iie_externcnt - (e)->iie_externdrop)

 
 #if !IIE_REF_DEBUG
 
 #if !IIE_REF_DEBUG

-#define ipc_importance_reference_internal(elem)                \
+#define ipc_importance_reference_internal(elem)         \

        (hw_atomic_add(&(elem)->iie_bits, 1) & IIE_REFS_MASK)
 
        (hw_atomic_add(&(elem)->iie_bits, 1) & IIE_REFS_MASK)
 

-#define ipc_importance_release_internal(elem)          \
+#define ipc_importance_release_internal(elem)           \

        (hw_atomic_sub(&(elem)->iie_bits, 1) & IIE_REFS_MASK)
 #endif
 
 struct ipc_importance_task {
        (hw_atomic_sub(&(elem)->iie_bits, 1) & IIE_REFS_MASK)
 #endif
 
 struct ipc_importance_task {

-       struct ipc_importance_elem iit_elem;    /* common element parts */
-       task_t                  iit_task;       /* task associated with */
-       queue_head_t            iit_inherits;   /* list of inherit elems hung off this */
-       queue_t                 iit_updateq;    /* queue chained on for task policy updates */
-       queue_chain_t           iit_updates;    /* link on update chain */
-       queue_chain_t           iit_props;      /* link on propagation chain */
-       uint64_t                iit_updatetime; /* timestamp of our last policy update request */
-       uint64_t                iit_transitions;/* total number of boost transitions (lifetime) */
-       uint32_t                iit_assertcnt;  /* net number of boost assertions (internal, external and legacy) */
-       uint32_t                iit_legacy_externcnt;  /* Legacy external boost count */
-       uint32_t                iit_legacy_externdrop; /* Legacy external boost drop count */
-       uint32_t                iit_receiver:1, /* the task can receive importance boost */
-                               iit_denap:1,    /* the task can be awaked from App Nap */
-                               iit_donor:1,    /* the task always sends boosts regardless of boost status */
-                               iit_live_donor:1,      /* the task temporarily sends boosts regardless of boost status */
-                               iit_updatepolicy:1,    /* enqueue for policy update at the end of propagation */
-                               iit_reserved:3,        /* reserved for future use */
-                               iit_filelocks:24;      /* number of file lock boosts */
+       struct ipc_importance_elem iit_elem;    /* common element parts */
+       task_t                  iit_task;       /* task associated with */
+       queue_head_t            iit_inherits;   /* list of inherit elems hung off this */
+       queue_t                 iit_updateq;    /* queue chained on for task policy updates */
+       queue_chain_t           iit_updates;    /* link on update chain */
+       queue_chain_t           iit_props;      /* link on propagation chain */
+       uint64_t                iit_updatetime; /* timestamp of our last policy update request */
+       uint64_t                iit_transitions;/* total number of boost transitions (lifetime) */
+       uint32_t                iit_assertcnt;  /* net number of boost assertions (internal, external and legacy) */
+       uint32_t                iit_legacy_externcnt;  /* Legacy external boost count */
+       uint32_t                iit_legacy_externdrop; /* Legacy external boost drop count */
+       uint32_t                iit_receiver:1, /* the task can receive importance boost */
+           iit_denap:1,                        /* the task can be awaked from App Nap */
+           iit_donor:1,                        /* the task always sends boosts regardless of boost status */
+           iit_live_donor:1,                          /* the task temporarily sends boosts regardless of boost status */
+           iit_updatepolicy:1,                        /* enqueue for policy update at the end of propagation */
+           iit_reserved:3,                            /* reserved for future use */
+           iit_filelocks:24;                          /* number of file lock boosts */

 #if DEVELOPMENT || DEBUG
 #if DEVELOPMENT || DEBUG

-       char                    iit_procname[20];      /* name of proc */
-       uint32_t                iit_bsd_pid;           /* pid of proc creating this iit */
-       queue_chain_t           iit_allocation;        /* link on global iit allocation chain */
+       char                    iit_procname[20];      /* name of proc */
+       uint32_t                iit_bsd_pid;           /* pid of proc creating this iit */
+       queue_chain_t           iit_allocation;        /* link on global iit allocation chain */

 #endif
 #endif

-

 };
 };

-#define iit_bits               iit_elem.iie_bits
-#define iit_made               iit_elem.iie_made
-#define iit_kmsgs              iit_elem.iie_kmsgs
-#define iit_externcnt          iit_elem.iie_externcnt
-#define iit_externdrop         iit_elem.iie_externdrop
+#define iit_bits                iit_elem.iie_bits
+#define iit_made                iit_elem.iie_made
+#define iit_kmsgs               iit_elem.iie_kmsgs
+#define iit_externcnt           iit_elem.iie_externcnt
+#define iit_externdrop          iit_elem.iie_externdrop

 
 

-#define IIT_REFS_MAX           IIE_REFS_MAX
-#define IIT_REFS(t)            IIE_REFS(&(t)->iit_elem)
-#define IIT_EXTERN(t)          IIE_EXTERN(&(t)->iit_elem)
-#define IIT_LEGACY_EXTERN(t)   ((t)->iit_legacy_externcnt - (t)->iit_legacy_externdrop)
+#define IIT_REFS_MAX            IIE_REFS_MAX
+#define IIT_REFS(t)             IIE_REFS(&(t)->iit_elem)
+#define IIT_EXTERN(t)           IIE_EXTERN(&(t)->iit_elem)
+#define IIT_LEGACY_EXTERN(t)    ((t)->iit_legacy_externcnt - (t)->iit_legacy_externdrop)

 
 #if !IIE_REF_DEBUG
 
 #if !IIE_REF_DEBUG

-#define ipc_importance_task_reference_internal(task_imp)       \
+#define ipc_importance_task_reference_internal(task_imp)        \

        (ipc_importance_reference_internal(&(task_imp)->iit_elem))
 
        (ipc_importance_reference_internal(&(task_imp)->iit_elem))
 

-#define ipc_importance_task_release_internal(task_imp)         \
+#define ipc_importance_task_release_internal(task_imp)          \

        (assert(1 < IIT_REFS(task_imp)), ipc_importance_release_internal(&(task_imp)->iit_elem))
 #endif
 
 typedef int iit_update_type_t;
        (assert(1 < IIT_REFS(task_imp)), ipc_importance_release_internal(&(task_imp)->iit_elem))
 #endif
 
 typedef int iit_update_type_t;

-#define IIT_UPDATE_HOLD                        ((iit_update_type_t)1)
-#define IIT_UPDATE_DROP                ((iit_update_type_t)2)
+#define IIT_UPDATE_HOLD                 ((iit_update_type_t)1)
+#define IIT_UPDATE_DROP                 ((iit_update_type_t)2)

 
 struct ipc_importance_inherit {
 
 struct ipc_importance_inherit {

-       struct ipc_importance_elem      iii_elem;         /* common element partss */
-       boolean_t                       iii_donating;     /* is this donating importance */
-       uint32_t                        iii_depth;        /* nesting depth */
-       ipc_importance_task_t           iii_to_task;      /* donating to */
-       ipc_importance_elem_t           iii_from_elem;    /* other elem contributing */
-       queue_chain_t                   iii_inheritance;  /* inherited from link */
+       struct ipc_importance_elem      iii_elem;         /* common element partss */
+       boolean_t                       iii_donating;     /* is this donating importance */
+       uint32_t                        iii_depth;        /* nesting depth */
+       ipc_importance_task_t           iii_to_task;      /* donating to */
+       ipc_importance_elem_t           iii_from_elem;    /* other elem contributing */
+       queue_chain_t                   iii_inheritance;  /* inherited from link */

 };
 };

-#define iii_bits                       iii_elem.iie_bits
-#define iii_made                       iii_elem.iie_made
-#define iii_kmsgs                      iii_elem.iie_kmsgs
-#define iii_externcnt                  iii_elem.iie_externcnt
-#define iii_externdrop                 iii_elem.iie_externdrop
-#define III_REFS_MAX                   IIE_REFS_MAX
-#define III_REFS(i)                    IIE_REFS(&(i)->iii_elem)
-#define III_EXTERN(i)                  IIE_EXTERN(&(i)->iii_elem)
-
-#define III_DEPTH_RESET                        0x80000000
-#define III_DEPTH_MASK                 0x000000FF
-#define III_DEPTH(i)                   ((i)->iii_depth & III_DEPTH_MASK)
-#define III_DEPTH_MAX                  32      /* maximum inherit->inherit chain depth */
-
-#define ipc_importance_inherit_reference_internal(inherit)     \
+#define iii_bits                        iii_elem.iie_bits
+#define iii_made                        iii_elem.iie_made
+#define iii_kmsgs                       iii_elem.iie_kmsgs
+#define iii_externcnt                   iii_elem.iie_externcnt
+#define iii_externdrop                  iii_elem.iie_externdrop
+#define III_REFS_MAX                    IIE_REFS_MAX
+#define III_REFS(i)                     IIE_REFS(&(i)->iii_elem)
+#define III_EXTERN(i)                   IIE_EXTERN(&(i)->iii_elem)
+
+#define III_DEPTH_RESET                 0x80000000
+#define III_DEPTH_MASK                  0x000000FF
+#define III_DEPTH(i)                    ((i)->iii_depth & III_DEPTH_MASK)
+#define III_DEPTH_MAX                   32      /* maximum inherit->inherit chain depth */
+
+#define ipc_importance_inherit_reference_internal(inherit)      \

        (ipc_importance_reference_internal(&(inherit)->iii_elem))
 
 __BEGIN_DECLS
        (ipc_importance_reference_internal(&(inherit)->iii_elem))
 
 __BEGIN_DECLS


@@ -227,18 +226,18 @@ extern boolean_t ipc_importance_check_circularity(ipc_port_t port, ipc_port_t de
 
 /* prepare importance attributes for sending */
 extern boolean_t ipc_importance_send(
 
 /* prepare importance attributes for sending */
 extern boolean_t ipc_importance_send(

-       ipc_kmsg_t              kmsg,
-       mach_msg_option_t       option);
+       ipc_kmsg_t              kmsg,
+       mach_msg_option_t       option);

 
 /* receive importance attributes from message */
 extern void ipc_importance_receive(
 
 /* receive importance attributes from message */
 extern void ipc_importance_receive(

-       ipc_kmsg_t              kmsg,
-       mach_msg_option_t       option);
+       ipc_kmsg_t              kmsg,
+       mach_msg_option_t       option);

 
 /* undo receive of importance attributes from message */
 extern void ipc_importance_unreceive(
 
 /* undo receive of importance attributes from message */
 extern void ipc_importance_unreceive(

-       ipc_kmsg_t              kmsg,
-       mach_msg_option_t       option);
+       ipc_kmsg_t              kmsg,
+       mach_msg_option_t       option);

 
 /* clean importance attributes out of destroyed message */
 extern void ipc_importance_clean(ipc_kmsg_t kmsg);
 
 /* clean importance attributes out of destroyed message */
 extern void ipc_importance_clean(ipc_kmsg_t kmsg);


@@ -256,7 +255,7 @@ extern void ipc_importance_thread_call_init(void);
 extern void task_importance_update_owner_info(task_t task);
 #endif
 
 extern void task_importance_update_owner_info(task_t task);
 #endif
 

-#if XNU_KERNEL_PRIVATE 
+#if XNU_KERNEL_PRIVATE

 #define TASK_IMP_LIST_DONATING_PIDS  0x1
 extern int task_importance_list_pids(task_t task, int flags, char *pid_list, unsigned int max_count);
 #endif
 #define TASK_IMP_LIST_DONATING_PIDS  0x1
 extern int task_importance_list_pids(task_t task, int flags, char *pid_list, unsigned int max_count);
 #endif


@@ -264,5 +263,5 @@ extern int task_importance_list_pids(task_t task, int flags, char *pid_list, uns
 __END_DECLS
 
 #endif /* MACH_KERNEL_PRIVATE */
 __END_DECLS
 
 #endif /* MACH_KERNEL_PRIVATE */

-                                            
-#endif /* _IPC_IPC_IMPORTANCE_H_ */
+
+#endif  /* _IPC_IPC_IMPORTANCE_H_ */