private/private.h

   1 /*
   2  * Copyright (c) 2012 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 #ifndef __PTHREAD_PRIVATE_H__
  25 #define __PTHREAD_PRIVATE_H__
  26
  27 #include <sys/cdefs.h>
  28 #include <Availability.h>
  29 #include <pthread/tsd_private.h>
  30
  31 /* get the thread specific errno value */
  32 __header_always_inline int
  33 _pthread_get_errno_direct(void)
  34 {
  35         return *(int*)_pthread_getspecific_direct(_PTHREAD_TSD_SLOT_ERRNO);
  36 }
  37
  38 /* set the thread specific errno value */
  39 __header_always_inline void
  40 _pthread_set_errno_direct(int value)
  41 {
  42         *((int*)_pthread_getspecific_direct(_PTHREAD_TSD_SLOT_ERRNO)) = value;
  43 }
  44
  45 __API_AVAILABLE(macos(10.9), ios(7.0))
  46 pthread_t pthread_main_thread_np(void);
  47
  48 struct _libpthread_functions {
  49         unsigned long version;
  50         void (*exit)(int); // added with version=1
  51         void *(*malloc)(size_t); // added with version=2
  52         void (*free)(void *); // added with version=2
  53 };
  54
  55 /*!
  56  * @function pthread_chdir_np
  57  *
  58  * @abstract
  59  * Sets the per-thread current working directory.
  60  *
  61  * @discussion
  62  * This will set the per-thread current working directory to the provided path.
  63  * If this is used on a workqueue (dispatch) thread, it MUST be unset with
  64  * pthread_fchdir_np(-1) before returning.
  65  *
  66  * posix_spawn_file_actions_addchdir_np is a better approach if this call would
  67  * only be used to spawn a new process with a given working directory.
  68  *
  69  * @param path
  70  * The path of the new working directory.
  71  *
  72  * @result
  73  * 0 upon success, -1 upon error and errno is set.
  74  */
  75 __API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
  76 int pthread_chdir_np(const char *path);
  77
  78 /*!
  79  * @function pthread_fchdir_np
  80  *
  81  * @abstract
  82  * Sets the per-thread current working directory.
  83  *
  84  * @discussion
  85  * This will set the per-thread current working directory to the provided
  86  * directory fd.  If this is used on a workqueue (dispatch) thread, it MUST be
  87  * unset with pthread_fchdir_np(-1) before returning.
  88  *
  89  * posix_spawn_file_actions_addfchdir_np is a better approach if this call would
  90  * only be used to spawn a new process with a given working directory.
  91  *
  92  * @param fd
  93  * A file descriptor to the new working directory.  Pass -1 to unset the
  94  * per-thread working directory.
  95  *
  96  * @result
  97  * 0 upon success, -1 upon error and errno is set.
  98  */
  99 __API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
 100 int pthread_fchdir_np(int fd);
 101
 102 __API_AVAILABLE(macos(10.14), ios(12.0), tvos(12.0), watchos(5.0))
 103 int pthread_attr_setcpupercent_np(pthread_attr_t * __restrict, int, unsigned long);
 104
 105 __API_AVAILABLE(macos(10.15), ios(13.0), tvos(13.0), watchos(6.0))
 106 int pthread_current_stack_contains_np(const void *, size_t);
 107
 108 #ifdef _os_tsd_get_base
 109
 110 #ifdef __LP64__
 111 #define _PTHREAD_STRUCT_DIRECT_THREADID_OFFSET -8
 112 #else
 113 #define _PTHREAD_STRUCT_DIRECT_THREADID_OFFSET -16
 114 #endif
 115
 116 /* N.B. DO NOT USE UNLESS YOU ARE REBUILT AS PART OF AN OS TRAIN WORLDBUILD */
 117 __header_always_inline uint64_t
 118 _pthread_threadid_self_np_direct(void)
 119 {
 120 #ifndef __i386__
 121         if (_pthread_has_direct_tsd()) {
 122 #ifdef OS_GS_RELATIVE
 123                 return *(uint64_t OS_GS_RELATIVE *)(_PTHREAD_STRUCT_DIRECT_THREADID_OFFSET);
 124 #else
 125                 return *(uint64_t*)((char *)_os_tsd_get_base() + _PTHREAD_STRUCT_DIRECT_THREADID_OFFSET);
 126 #endif
 127         }
 128 #endif
 129         uint64_t threadid = 0;
 130         pthread_threadid_np(NULL, &threadid);
 131         return threadid;
 132 }
 133
 134 #endif // _os_tsd_get_base
 135
 136 #endif // __PTHREAD_PRIVATE_H__