c/pthread_extra/pthread_extra.h

   1 #ifndef __PTHREAD_EXTRA_H__
   2 #define __PTHREAD_EXTRA_H__
   3
   4 #include <pthread.h>
   5 #include <stdbool.h>
   6 #include <stdint.h>
   7 #include <signal.h>
   8 //#include <time.h>
   9
  10 #define PTHREAD_XTIME_NOBLOCK (&(struct timespec){ .tv_sec = 0, .tv_nsec = 0 })
  11 #define PTHREAD_XTIME_FOREVER NULL
  12
  13 // User data
  14
  15 #define PTHREAD_XTHREADS_MAX 65535
  16 #define PTHREAD_XNULL ((pthread_t)NULL)
  17
  18 #ifdef __PTHREAD_EXTRA_INTERNAL
  19 typedef struct pthread_user_data_internal_t {
  20         pthread_t tid; //Thread ID
  21         void *usr; //User pointer
  22         //Internaly used members:
  23         sig_atomic_t running; //pthread_pause
  24 } pthread_user_data_internal_t;
  25
  26 pthread_user_data_internal_t* pthread_user_data_internal(pthread_t thread);
  27 int pthread_user_data_lock();
  28 int pthread_user_data_unlock();
  29 #endif //__PTHREAD_EXTRA_INTERNAL
  30
  31 void** pthread_user_data_ptr(pthread_t thread);
  32 void*  pthread_user_data_get(pthread_t thread);
  33 void   pthread_user_data_set(pthread_t thread, void *usr);
  34 void   pthread_user_data_cleanup(void * arg);
  35 int pthread_user_data_internal_iterate(int (*routine)(pthread_t), void *arg);
  36
  37 // Pausing
  38
  39 //GDB: handle SIG34 nostop noprint
  40 #define PTHREAD_XSIG_STOP (SIGRTMIN+0)
  41 #define PTHREAD_XSIG_CONT (SIGRTMIN+1)
  42 #define PTHREAD_XSIGRTMIN (SIGRTMIN+2) //First unused RT signal
  43
  44 int pthread_extra_create(pthread_t *restrict thread,
  45                           const pthread_attr_t *restrict attr,
  46                           void *(*start_routine)(void *),
  47                           void *restrict arg);
  48 void pthread_unpause_handler();
  49 void pthread_pause_handler();
  50 void pthread_pause_enable();
  51 void pthread_pause_disable();
  52 int pthread_pause(pthread_t thread);
  53 int pthread_unpause(pthread_t thread);
  54 int pthread_pause_all();
  55 int pthread_unpause_all();
  56 int pthread_pause_reschedule(pthread_t thread);
  57 int pthread_extra_yield();
  58
  59 // Message queues
  60
  61 //Flags
  62 typedef uint8_t pthread_mq_flags_t;
  63 #define PTHREAD_XMQ_NONE        0                       ///< No flags specified (default behaviour)
  64 #define PTHREAD_XMQ_FRONT       1                       ///< Send to front of the queue (scheduled for next receive)
  65 #define PTHREAD_XMQ_BACK        PTHREAD_XMQ_NONE        ///< Send to back of the queue (default)
  66 #define PTHREAD_XMQ_PEEK        2                       ///< Only peek, do not remove received item
  67 #define PTHREAD_XMQ_RECV        PTHREAD_XMQ_NONE        ///< Remove received item from queue (default)
  68 #define PTHREAD_XMQ_OVERW       4                       ///< Overwrite item if queue full
  69
  70 typedef struct pthread_mq_t {
  71         pthread_mutex_t lock;
  72         pthread_cond_t cond_readable;
  73         pthread_cond_t cond_writable;
  74         uint8_t * data;
  75         size_t msg_size;
  76         size_t msg_count;
  77         size_t msg_count_max;
  78         size_t head_idx;
  79         char * name;
  80 } pthread_mq_t;
  81
  82 bool pthread_mq_init(pthread_mq_t *mq, size_t msg_size, size_t msg_count_max);
  83 void pthread_mq_free(pthread_mq_t *mq);
  84
  85 bool pthread_mq_reset(pthread_mq_t *mq);
  86 bool pthread_mq_send_generic(pthread_mq_t *mq, void * data, pthread_mq_flags_t flags, const struct timespec *restrict abs_timeout);
  87 bool pthread_mq_receive_generic(pthread_mq_t *mq, void * data, pthread_mq_flags_t flags, const struct timespec *restrict abs_timeout);
  88
  89 size_t pthread_mq_waiting(pthread_mq_t *mq);
  90 size_t pthread_mq_vacant(pthread_mq_t *mq);
  91
  92 // Multi mutex locking
  93
  94 #define pthread_mutex_swap(a, b) { pthread_mutex_t *s; s = (a); a = (b); b = s; }
  95
  96 #define pthread_mutex_lock_two(a,b) pthread_mutex_timedlock_multi_generic((pthread_mutex_t *[2]){(a), (b)}, 2, true, NULL)
  97 #define pthread_mutex_timedlock_two(a,b,tm) pthread_mutex_timedlock_multi_generic((pthread_mutex_t *[2]){(a), (b)}, 2, true, (tm))
  98 #define pthread_mutex_trylock_two(a,b) pthread_mutex_timedlock_multi_generic((pthread_mutex_t *[2]){(a), (b)}, 2, false, NULL)
  99
 100 #define pthread_mutex_lock_multi(lcks,cnt) pthread_mutex_timedlock_multi_generic((lcks),(cnt),true,NULL)
 101 #define pthread_mutex_timedlock_multi(lcks,cnt,tm) pthread_mutex_timedlock_multi_generic((lcks),(cnt),true,(tm))
 102 #define pthread_mutex_trylock_multi(lcks,cnt) pthread_mutex_timedlock_multi_generic((lcks),(cnt),false,NULL)
 103
 104 int pthread_mutex_timedlock_multi_generic(pthread_mutex_t **lck, int cnt, bool block, const struct timespec *restrict abs_timeout);
 105
 106
 107 #endif //__PTHREAD_EXTRA_H__