pthread 函數(shù)解釋

#ifndef _PTHREAD_H_
#define _PTHREAD_H_

#include <limits.h>
#include <bits/pthread_types.h>
#include <sched.h>
#include <sys/cdefs.h>
#include <sys/types.h>
#include <time.h>

__BEGIN_DECLS

enum {
    PTHREAD_MUTEX_NORMAL = 0,
    PTHREAD_MUTEX_RECURSIVE = 1,
    PTHREAD_MUTEX_ERRORCHECK = 2,

    PTHREAD_MUTEX_ERRORCHECK_NP = PTHREAD_MUTEX_ERRORCHECK,
    PTHREAD_MUTEX_RECURSIVE_NP  = PTHREAD_MUTEX_RECURSIVE,

    PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL
};

#define PTHREAD_MUTEX_INITIALIZER { { ((PTHREAD_MUTEX_NORMAL & 3) << 14) } }
#define PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_RECURSIVE & 3) << 14) } }
#define PTHREAD_ERRORCHECK_MUTEX_INITIALIZER_NP { { ((PTHREAD_MUTEX_ERRORCHECK & 3) << 14) } }

#define PTHREAD_COND_INITIALIZER  { { 0 } }

#define PTHREAD_RWLOCK_INITIALIZER  { { 0 } }

enum {
    PTHREAD_RWLOCK_PREFER_READER_NP = 0,
    PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP = 1,
};

#define PTHREAD_ONCE_INIT 0

#if __ANDROID_API__ >= __ANDROID_API_N__
#define PTHREAD_BARRIER_SERIAL_THREAD -1
#endif

#if defined(__LP64__)
#define PTHREAD_STACK_MIN (4 * PAGE_SIZE)
#else
#define PTHREAD_STACK_MIN (2 * PAGE_SIZE)
#endif

#define PTHREAD_CREATE_DETACHED  0x00000001
#define PTHREAD_CREATE_JOINABLE  0x00000000

#define PTHREAD_PROCESS_PRIVATE  0
#define PTHREAD_PROCESS_SHARED   1

#define PTHREAD_SCOPE_SYSTEM     0
#define PTHREAD_SCOPE_PROCESS    1


#if __ANDROID_API__ >= 12
int pthread_atfork(void (*__prepare)(void), void (*__parent)(void), void (*__child)(void)) __INTRODUCED_IN(12);
#endif /* __ANDROID_API__ >= 12 */


//刪除線程屬性
int pthread_attr_destroy(pthread_attr_t* __attr);
//以下是獲取線程相關(guān)的屬性
//線程的分離狀態(tài)
int pthread_attr_getdetachstate(const pthread_attr_t* __attr, int* __state);
// 線程棧末尾的警戒緩沖區(qū)大小
int pthread_attr_getguardsize(const pthread_attr_t* __attr, size_t* __size);
// 線程的調(diào)度參數(shù)
int pthread_attr_getschedparam(const pthread_attr_t* __attr, struct sched_param* __param);
//線程調(diào)度策略
int pthread_attr_getschedpolicy(const pthread_attr_t* __attr, int* __policy);
// 線程的作用域
int pthread_attr_getscope(const pthread_attr_t* __attr, int* __scope);
//線程棧的位置
int pthread_attr_getstack(const pthread_attr_t* __attr, void** __addr, size_t* __size);
// 線程棧的大小
int pthread_attr_getstacksize(const pthread_attr_t* __attr, size_t* __size);
//初始化線程屬性
int pthread_attr_init(pthread_attr_t* __attr);
//設(shè)置線程相關(guān)屬性
int pthread_attr_setdetachstate(pthread_attr_t* __attr, int __state);
int pthread_attr_setguardsize(pthread_attr_t* __attr, size_t __size);
int pthread_attr_setschedparam(pthread_attr_t* __attr, const struct sched_param* __param);
int pthread_attr_setschedpolicy(pthread_attr_t* __attr, int __policy);
int pthread_attr_setscope(pthread_attr_t* __attr, int __scope);
int pthread_attr_setstack(pthread_attr_t* __attr, void* __addr, size_t __size);
int pthread_attr_setstacksize(pthread_attr_t* __addr, size_t __size);

//條件變量 銷毀
int pthread_condattr_destroy(pthread_condattr_t* __attr);

#if __ANDROID_API__ >= 21
int pthread_condattr_getclock(const pthread_condattr_t* __attr, clockid_t* __clock) __INTRODUCED_IN(21);
#endif /* __ANDROID_API__ >= 21 */

int pthread_condattr_getpshared(const pthread_condattr_t* __attr, int* __shared)
//條件變量初始化
int pthread_condattr_init(pthread_condattr_t* __attr);

#if __ANDROID_API__ >= 21
int pthread_condattr_setclock(pthread_condattr_t* __attr, clockid_t __clock) __INTRODUCED_IN(21);
#endif /* __ANDROID_API__ >= 21 */

int pthread_condattr_setpshared(pthread_condattr_t* __attr, int __shared);
//多個(gè)線程處于堵塞等待狀態(tài),必須使用此函數(shù)喚醒
int pthread_cond_broadcast(pthread_cond_t* __cond);
//銷毀
int pthread_cond_destroy(pthread_cond_t* __cond);
//初始化
int pthread_cond_init(pthread_cond_t* __cond, const pthread_condattr_t* __attr);
// 發(fā)信號 給正在等待條件變量的另一個(gè)線程
int pthread_cond_signal(pthread_cond_t* __cond);
//阻塞調(diào)用線程
int pthread_cond_timedwait(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __timeout);
int pthread_cond_wait(pthread_cond_t* __cond, pthread_mutex_t* __mutex);

/**
 *
 * @param __pthread_ptr  新線程的標(biāo)識符,為一個(gè)long
 * @param __attr   設(shè)置新線程的屬性,傳遞NULL表示設(shè)置為默認(rèn)線程屬性
 * @param __start_routine  指定新線程運(yùn)行時(shí)函數(shù)  start_routine返回時(shí),這個(gè)線程就退出了
 * @return  成功返回0, 失敗返回錯(cuò)誤號
 */
int pthread_create(pthread_t* __pthread_ptr, pthread_attr_t const* __attr, void* (*__start_routine)(void*), void*);


//1.在任何一個(gè)時(shí)間點(diǎn)上,線程是可結(jié)合的(joinable)或者是分離的(detached)。
//
//2.一個(gè)可結(jié)合的線程能夠被其他線程收回其資源和殺死。在被其他線程回收之前,它的存儲器資源
//(例如棧)是不釋放的。(默認(rèn)情況下線程的創(chuàng)建都是可結(jié)合的)
//
//3.一個(gè)分離的線程是不能被其他線程回收或殺死的,它的存儲器 資源在它終止時(shí)由系統(tǒng)自動釋放。
//
//4. 如果一個(gè)可結(jié)合線程結(jié)束運(yùn)行但沒有被join,會導(dǎo)致部分資源沒有被回收,
// 所以創(chuàng)建線程者應(yīng)該調(diào)用pthread_join來等待線程運(yùn)行結(jié)束,并可得到線程的退出代碼,回收其資源。

/**
 *  非阻塞 立即返回  這將該子線程的狀態(tài)設(shè)置為分離的(detached)
 *  ,該線程運(yùn)行結(jié)束后會自動釋放所有資源。
 * @param __pthread
 * @return
 */
int pthread_detach(pthread_t __pthread);

// 線程終止自己
/**
 * @param __return_value  是void *類型,其它線程可以調(diào)用pthread_join獲得這個(gè)指針
 * 通過retval參數(shù)向線程的回收者傳遞其退出信息。它執(zhí)行之后不會返回到調(diào)用者,且永遠(yuǎn)不會失敗。
 * 需要注意,pthread_exit或者return返回的指針?biāo)赶虻膬?nèi)存單元必須是全局的或者是由malloc分 配的,
 * 不能在線程函數(shù)的棧上分配,因?yàn)楫?dāng)其它線程得到這個(gè)返回指針時(shí)線程函數(shù)已經(jīng)退出了。
 */
void pthread_exit(void* __return_value) __noreturn;

// 用于比較兩個(gè)pthread_t是否相等
int pthread_equal(pthread_t __lhs, pthread_t __rhs);

int pthread_getattr_np(pthread_t __pthread, pthread_attr_t* __attr);

int pthread_getcpuclockid(pthread_t __pthread, clockid_t* __clock);

int pthread_getschedparam(pthread_t __pthread, int* __policy, struct sched_param* __param);

void* pthread_getspecific(pthread_key_t __key);


#if __ANDROID_API__ >= 21
pid_t pthread_gettid_np(pthread_t __pthread) __INTRODUCED_IN(21);
#endif /* __ANDROID_API__ >= 21 */


/**
 * 線程等待
 * 調(diào)用該函數(shù)的線程將掛起等待,直到id為__pthread的線程終止。
 * @param __pthread
 * @param __return_value_ptr
 * @return
 */
int pthread_join(pthread_t __pthread, void** __return_value_ptr);

int pthread_key_create(pthread_key_t* __key_ptr, void (*__key_destructor)(void*));
int pthread_key_delete(pthread_key_t __key);

int pthread_mutexattr_destroy(pthread_mutexattr_t* __attr);
int pthread_mutexattr_getpshared(const pthread_mutexattr_t* __attr, int* __shared);
int pthread_mutexattr_gettype(const pthread_mutexattr_t* __attr, int* __type);

int pthread_mutexattr_init(pthread_mutexattr_t* __attr);
int pthread_mutexattr_setpshared(pthread_mutexattr_t* __attr, int __shared);
int pthread_mutexattr_settype(pthread_mutexattr_t* __attr, int __type);

//銷毀互斥量
int pthread_mutex_destroy(pthread_mutex_t* __mutex);
// 創(chuàng)建互斥量
int pthread_mutex_init(pthread_mutex_t* __mutex, const pthread_mutexattr_t* __attr);
//鎖住互斥量
int pthread_mutex_lock(pthread_mutex_t* __mutex);

#if __ANDROID_API__ >= 21
int pthread_mutex_timedlock(pthread_mutex_t* __mutex, const struct timespec* __timeout)
  __INTRODUCED_IN(21);
#endif /* __ANDROID_API__ >= 21 */

//非阻塞鎖住互斥量
int pthread_mutex_trylock(pthread_mutex_t* __mutex);
// 解鎖互斥量
int pthread_mutex_unlock(pthread_mutex_t* __mutex);

#if __ANDROID_API__ < 21
/*
 * Cruft for supporting old API levels. Pre-L we didn't have the proper POSIX
 * APIs for things, but instead had some locally grown, artisan equivalents.
 * Keep exposing the old prototypes on old API levels so we don't regress
 * functionality.
 *
 * See the following bugs:
 *  * https://github.com/android-ndk/ndk/issues/420
 *  * https://github.com/android-ndk/ndk/issues/423
 *  * https://stackoverflow.com/q/44580542/632035
 */
int pthread_mutex_lock_timeout_np(pthread_mutex_t* __mutex, unsigned __timeout_ms);
int pthread_cond_timeout_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, unsigned __timeout_ms);
int pthread_cond_timedwait_monotonic_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __timeout);
int pthread_cond_timedwait_relative_np(pthread_cond_t* __cond, pthread_mutex_t* __mutex, const struct timespec* __relative_timeout);
#endif

int pthread_once(pthread_once_t* __once, void (*__init_routine)(void));

int pthread_rwlockattr_init(pthread_rwlockattr_t* __attr);
int pthread_rwlockattr_destroy(pthread_rwlockattr_t* __attr);
int pthread_rwlockattr_getpshared(const pthread_rwlockattr_t* __attr, int* __shared);
int pthread_rwlockattr_setpshared(pthread_rwlockattr_t* __attr, int __shared);

#if __ANDROID_API__ >= 23
int pthread_rwlockattr_getkind_np(const pthread_rwlockattr_t* __attr, int* __kind)
  __INTRODUCED_IN(23);
int pthread_rwlockattr_setkind_np(pthread_rwlockattr_t* __attr, int __kind) __INTRODUCED_IN(23);
#endif /* __ANDROID_API__ >= 23 */

//讀寫鎖 同一時(shí)間,可以有多個(gè)線程獲取到 讀鎖, 但只有一個(gè)線程可以獲取到 寫鎖.
//銷毀
int pthread_rwlock_destroy(pthread_rwlock_t* __rwlock);
// 創(chuàng)建
int pthread_rwlock_init(pthread_rwlock_t* __rwlock, const pthread_rwlockattr_t* __attr);
// 獲取讀鎖
int pthread_rwlock_rdlock(pthread_rwlock_t* __rwlock);
// 獲取 讀鎖  設(shè)置了讀鎖的時(shí)間
int pthread_rwlock_timedrdlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout);
// 獲取 寫鎖  設(shè)置了寫鎖的時(shí)間
int pthread_rwlock_timedwrlock(pthread_rwlock_t* __rwlock, const struct timespec* __timeout);
// 非阻塞獲取讀鎖
int pthread_rwlock_tryrdlock(pthread_rwlock_t* __rwlock);
//非阻塞獲取寫鎖
int pthread_rwlock_trywrlock(pthread_rwlock_t* __rwlock);
//釋放鎖
int pthread_rwlock_unlock(pthread_rwlock_t* __rwlock);
//獲取寫鎖
int pthread_rwlock_wrlock(pthread_rwlock_t* __rwlock);

#if __ANDROID_API__ >= __ANDROID_API_N__
int pthread_barrierattr_init(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24);
int pthread_barrierattr_destroy(pthread_barrierattr_t* __attr) __INTRODUCED_IN(24);
int pthread_barrierattr_getpshared(const pthread_barrierattr_t* __attr, int* __shared) __INTRODUCED_IN(24);
int pthread_barrierattr_setpshared(pthread_barrierattr_t* __attr, int __shared) __INTRODUCED_IN(24);
#endif

#if __ANDROID_API__ >= __ANDROID_API_N__
int pthread_barrier_init(pthread_barrier_t* __barrier, const pthread_barrierattr_t* __attr, unsigned __count) __INTRODUCED_IN(24);
int pthread_barrier_destroy(pthread_barrier_t* __barrier) __INTRODUCED_IN(24);
int pthread_barrier_wait(pthread_barrier_t* __barrier) __INTRODUCED_IN(24);
#endif

#if __ANDROID_API__ >= __ANDROID_API_N__
int pthread_spin_destroy(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24);
int pthread_spin_init(pthread_spinlock_t* __spinlock, int __shared) __INTRODUCED_IN(24);
int pthread_spin_lock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24);
int pthread_spin_trylock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24);
int pthread_spin_unlock(pthread_spinlock_t* __spinlock) __INTRODUCED_IN(24);
#endif

//函數(shù)用于獲得本線程的pthread_t
pthread_t pthread_self(void) __attribute_const__;

#if defined(__USE_GNU)

#if __ANDROID_API__ >= 26
int pthread_getname_np(pthread_t __pthread, char* __buf, size_t __n) __INTRODUCED_IN(26);
#endif /* __ANDROID_API__ >= 26 */

#endif
/* TODO: this should be __USE_GNU too. */
int pthread_setname_np(pthread_t __pthread, const char* __name);

int pthread_setschedparam(pthread_t __pthread, int __policy, const struct sched_param* __param);

#if __ANDROID_API__ >= __ANDROID_API_FUTURE__
int pthread_setschedprio(pthread_t __pthread, int __priority) __INTRODUCED_IN_FUTURE;
#endif /* __ANDROID_API__ >= __ANDROID_API_FUTURE__ */


int pthread_setspecific(pthread_key_t __key, const void* __value);

typedef void (*__pthread_cleanup_func_t)(void*);

typedef struct __pthread_cleanup_t {
    struct __pthread_cleanup_t*   __cleanup_prev;
    __pthread_cleanup_func_t      __cleanup_routine;
    void*                         __cleanup_arg;
} __pthread_cleanup_t;

// 注冊線程結(jié)束時(shí) 自動調(diào)用的清理函數(shù) 注冊的函數(shù)安裝順序壓入一個(gè)棧內(nèi),調(diào)用的時(shí)候就一個(gè)個(gè)的出棧。
void __pthread_cleanup_push(__pthread_cleanup_t* c, __pthread_cleanup_func_t, void*);
// 調(diào)用棧頂函數(shù)
void __pthread_cleanup_pop(__pthread_cleanup_t*, int);

/* Believe or not, the definitions of pthread_cleanup_push and
 * pthread_cleanup_pop below are correct. Posix states that these
 * can be implemented as macros that might introduce opening and
 * closing braces, and that using setjmp/longjmp/return/break/continue
 * between them results in undefined behavior.
 */
#define  pthread_cleanup_push(routine, arg)                      \
    do {                                                         \
        __pthread_cleanup_t  __cleanup;                          \
        __pthread_cleanup_push( &__cleanup, (routine), (arg) );  \

#define  pthread_cleanup_pop(execute)                  \
        __pthread_cleanup_pop( &__cleanup, (execute)); \
    } while (0);                                       \

__END_DECLS

#endif


?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容