src/thread/SDL_thread_c.h

   1 /*
   2   Simple DirectMedia Layer
   3   Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
   4
   5   This software is provided 'as-is', without any express or implied
   6   warranty.  In no event will the authors be held liable for any damages
   7   arising from the use of this software.
   8
   9   Permission is granted to anyone to use this software for any purpose,
  10   including commercial applications, and to alter it and redistribute it
  11   freely, subject to the following restrictions:
  12
  13   1. The origin of this software must not be misrepresented; you must not
  14      claim that you wrote the original software. If you use this software
  15      in a product, an acknowledgment in the product documentation would be
  16      appreciated but is not required.
  17   2. Altered source versions must be plainly marked as such, and must not be
  18      misrepresented as being the original software.
  19   3. This notice may not be removed or altered from any source distribution.
  20 */
  21 #include "../SDL_internal.h"
  22
  23 #ifndef SDL_thread_c_h_
  24 #define SDL_thread_c_h_
  25
  26 #include "SDL_thread.h"
  27
  28 /* Need the definitions of SYS_ThreadHandle */
  29 #if SDL_THREADS_DISABLED
  30 #include "generic/SDL_systhread_c.h"
  31 #elif SDL_THREAD_PTHREAD
  32 #include "pthread/SDL_systhread_c.h"
  33 #elif SDL_THREAD_WINDOWS
  34 #include "windows/SDL_systhread_c.h"
  35 #elif SDL_THREAD_PSP
  36 #include "psp/SDL_systhread_c.h"
  37 #elif SDL_THREAD_STDCPP
  38 #include "stdcpp/SDL_systhread_c.h"
  39 #elif SDL_THREAD_OS2
  40 #include "os2/SDL_systhread_c.h"
  41 #else
  42 #error Need thread implementation for this platform
  43 #include "generic/SDL_systhread_c.h"
  44 #endif
  45 #include "../SDL_error_c.h"
  46
  47 typedef enum SDL_ThreadState
  48 {
  49     SDL_THREAD_STATE_ALIVE,
  50     SDL_THREAD_STATE_DETACHED,
  51     SDL_THREAD_STATE_ZOMBIE,
  52     SDL_THREAD_STATE_CLEANED,
  53 } SDL_ThreadState;
  54
  55 /* This is the system-independent thread info structure */
  56 struct SDL_Thread
  57 {
  58     SDL_threadID threadid;
  59     SYS_ThreadHandle handle;
  60     int status;
  61     SDL_atomic_t state;  /* SDL_THREAD_STATE_* */
  62     SDL_error errbuf;
  63     char *name;
  64     size_t stacksize;  /* 0 for default, >0 for user-specified stack size. */
  65     int (SDLCALL * userfunc) (void *);
  66     void *userdata;
  67     void *data;
  68     void *endfunc;  /* only used on some platforms. */
  69 };
  70
  71 /* This is the function called to run a thread */
  72 extern void SDL_RunThread(SDL_Thread *thread);
  73
  74 /* This is the system-independent thread local storage structure */
  75 typedef struct {
  76     unsigned int limit;
  77     struct {
  78         void *data;
  79         void (SDLCALL *destructor)(void*);
  80     } array[1];
  81 } SDL_TLSData;
  82
  83 /* This is how many TLS entries we allocate at once */
  84 #define TLS_ALLOC_CHUNKSIZE 4
  85
  86 /* Get cross-platform, slow, thread local storage for this thread.
  87    This is only intended as a fallback if getting real thread-local
  88    storage fails or isn't supported on this platform.
  89  */
  90 extern SDL_TLSData *SDL_Generic_GetTLSData(void);
  91
  92 /* Set cross-platform, slow, thread local storage for this thread.
  93    This is only intended as a fallback if getting real thread-local
  94    storage fails or isn't supported on this platform.
  95  */
  96 extern int SDL_Generic_SetTLSData(SDL_TLSData *data);
  97
  98 #endif /* SDL_thread_c_h_ */
  99
 100 /* vi: set ts=4 sw=4 expandtab: */