SDL  2.0
SDL_dynapi.c File Reference
#include "SDL_config.h"
#include "SDL_dynapi.h"
#include "SDL.h"
#include "SDL_syswm.h"
#include "SDL_vulkan.h"
#include "SDL_dynapi_procs.h"
#include <windows.h>
+ Include dependency graph for SDL_dynapi.c:

Go to the source code of this file.

Data Structures

struct  SDL_DYNAPI_jump_table
 

Macros

#define SDL_DYNAPI_VERSION   1
 
#define DISABLE_JUMP_MAGIC   1
 
#define SDL_DYNAPI_VARARGS_LOGFN(_static, name, initcall, logname, prio)
 
#define SDL_DYNAPI_VARARGS(_static, name, initcall)
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)   SDL_DYNAPIFN_##fn fn;
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)   static rc SDLCALL fn##_DEFAULT params;
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)   fn##_DEFAULT,
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)
 
#define SDL_DYNAPI_PROC_NO_VARARGS   1
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)   rc SDLCALL fn params { ret jump_table.fn args; }
 
#define SDL_DYNAPI_PROC_NO_VARARGS   1
 
#define SDL_DYNAPI_PROC(rc, fn, params, args, ret)   jump_table.fn = fn##_REAL;
 
#define WIN32_LEAN_AND_MEAN   1
 

Typedefs

typedef Sint32(* SDL_DYNAPI_ENTRYFN) (Uint32 apiver, void *table, Uint32 tablesize)
 

Functions

static void SDL_InitDynamicAPI (void)
 
Sint32 SDL_DYNAPI_entry (Uint32, void *, Uint32)
 
static SDL_INLINE voidget_sdlapi_entry (const char *fname, const char *sym)
 
static void SDL_InitDynamicAPILocked (void)
 

Variables

static SDL_DYNAPI_jump_table jump_table
 

Macro Definition Documentation

◆ DISABLE_JUMP_MAGIC

#define DISABLE_JUMP_MAGIC   1

Definition at line 60 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [1/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)
Value:
typedef rc (SDLCALL *SDL_DYNAPIFN_##fn) params; \
static rc SDLCALL fn##_DEFAULT params; \
extern rc SDLCALL fn##_REAL params;
const GLfloat * params
#define SDLCALL
Definition: SDL_internal.h:45

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [2/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)    SDL_DYNAPIFN_##fn fn;

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [3/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)    static rc SDLCALL fn##_DEFAULT params;

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [4/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)    fn##_DEFAULT,

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [5/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)
Value:
static rc SDLCALL fn##_DEFAULT params { \
SDL_InitDynamicAPI(); \
ret jump_table.fn args; \
}
static SDL_DYNAPI_jump_table jump_table
Definition: SDL_dynapi.c:133
const GLfloat * params
#define SDLCALL
Definition: SDL_internal.h:45

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [6/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)    rc SDLCALL fn params { ret jump_table.fn args; }

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC [7/7]

#define SDL_DYNAPI_PROC (   rc,
  fn,
  params,
  args,
  ret 
)    jump_table.fn = fn##_REAL;

Definition at line 158 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC_NO_VARARGS [1/2]

#define SDL_DYNAPI_PROC_NO_VARARGS   1

Definition at line 160 of file SDL_dynapi.c.

◆ SDL_DYNAPI_PROC_NO_VARARGS [2/2]

#define SDL_DYNAPI_PROC_NO_VARARGS   1

Definition at line 160 of file SDL_dynapi.c.

◆ SDL_DYNAPI_VARARGS

#define SDL_DYNAPI_VARARGS (   _static,
  name,
  initcall 
)

Definition at line 71 of file SDL_dynapi.c.

◆ SDL_DYNAPI_VARARGS_LOGFN

#define SDL_DYNAPI_VARARGS_LOGFN (   _static,
  name,
  initcall,
  logname,
  prio 
)
Value:
_static void SDLCALL SDL_Log##logname##name(int category, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) { \
va_list ap; initcall; va_start(ap, fmt); \
jump_table.SDL_LogMessageV(category, SDL_LOG_PRIORITY_##prio, fmt, ap); \
va_end(ap); \
}
GLuint const GLchar * name
#define SDL_Log
#define SDL_PRINTF_FORMAT_STRING
Definition: SDL_stdinc.h:278
#define SDLCALL
Definition: SDL_internal.h:45

Definition at line 64 of file SDL_dynapi.c.

◆ SDL_DYNAPI_VERSION

#define SDL_DYNAPI_VERSION   1

Definition at line 48 of file SDL_dynapi.c.

◆ WIN32_LEAN_AND_MEAN

#define WIN32_LEAN_AND_MEAN   1

Definition at line 209 of file SDL_dynapi.c.

Typedef Documentation

◆ SDL_DYNAPI_ENTRYFN

typedef Sint32( * SDL_DYNAPI_ENTRYFN) (Uint32 apiver, void *table, Uint32 tablesize)

Definition at line 174 of file SDL_dynapi.c.

Function Documentation

◆ get_sdlapi_entry()

static SDL_INLINE void* get_sdlapi_entry ( const char *  fname,
const char *  sym 
)
static

Definition at line 212 of file SDL_dynapi.c.

213 {
214  HANDLE lib = LoadLibraryA(fname);
215  void *retval = NULL;
216  if (lib) {
217  retval = GetProcAddress(lib, sym);
218  if (retval == NULL) {
219  FreeLibrary(lib);
220  }
221  }
222  return retval;
223 }
SDL_bool retval
#define NULL
Definition: begin_code.h:164

◆ SDL_DYNAPI_entry()

Sint32 SDL_DYNAPI_entry ( Uint32  apiver,
void table,
Uint32  tablesize 
)

Definition at line 178 of file SDL_dynapi.c.

179 {
180  SDL_DYNAPI_jump_table *output_jump_table = (SDL_DYNAPI_jump_table *) table;
181 
182  if (apiver != SDL_DYNAPI_VERSION) {
183  /* !!! FIXME: can maybe handle older versions? */
184  return -1; /* not compatible. */
185  } else if (tablesize > sizeof (jump_table)) {
186  return -1; /* newer version of SDL with functions we can't provide. */
187  }
188 
189  /* Init our jump table first. */
190  #define SDL_DYNAPI_PROC(rc,fn,params,args,ret) jump_table.fn = fn##_REAL;
191  #include "SDL_dynapi_procs.h"
192  #undef SDL_DYNAPI_PROC
193 
194  /* Then the external table... */
195  if (output_jump_table != &jump_table) {
196  jump_table.SDL_memcpy(output_jump_table, &jump_table, tablesize);
197  }
198 
199  /* Safe to call SDL functions now; jump table is initialized! */
200 
201  return 0; /* success! */
202 }
GLenum GLsizei GLenum GLenum const void * table
#define SDL_DYNAPI_VERSION
Definition: SDL_dynapi.c:48
static SDL_DYNAPI_jump_table jump_table
Definition: SDL_dynapi.c:133

◆ SDL_InitDynamicAPI()

static void SDL_InitDynamicAPI ( void  )
static

Definition at line 290 of file SDL_dynapi.c.

291 {
292  /* So the theory is that every function in the jump table defaults to
293  * calling this function, and then replaces itself with a version that
294  * doesn't call this function anymore. But it's possible that, in an
295  * extreme corner case, you can have a second thread hit this function
296  * while the jump table is being initialized by the first.
297  * In this case, a spinlock is really painful compared to what spinlocks
298  * _should_ be used for, but this would only happen once, and should be
299  * insanely rare, as you would have to spin a thread outside of SDL (as
300  * SDL_CreateThread() would also call this function before building the
301  * new thread).
302  */
303  static SDL_bool already_initialized = SDL_FALSE;
304 
305  /* SDL_AtomicLock calls SDL mutex functions to emulate if
306  SDL_ATOMIC_DISABLED, which we can't do here, so in such a
307  configuration, you're on your own. */
308  #if !SDL_ATOMIC_DISABLED
309  static SDL_SpinLock lock = 0;
310  SDL_AtomicLock_REAL(&lock);
311  #endif
312 
313  if (!already_initialized) {
315  already_initialized = SDL_TRUE;
316  }
317 
318  #if !SDL_ATOMIC_DISABLED
319  SDL_AtomicUnlock_REAL(&lock);
320  #endif
321 }
static void SDL_InitDynamicAPILocked(void)
Definition: SDL_dynapi.c:260
SDL_bool
Definition: SDL_stdinc.h:139
SDL_mutex * lock
Definition: SDL_events.c:78
int SDL_SpinLock
Definition: SDL_atomic.h:89

◆ SDL_InitDynamicAPILocked()

static void SDL_InitDynamicAPILocked ( void  )
static

Definition at line 260 of file SDL_dynapi.c.

261 {
262  const char *libname = SDL_getenv_REAL("SDL_DYNAMIC_API");
263  SDL_DYNAPI_ENTRYFN entry = SDL_DYNAPI_entry; /* funcs from here by default. */
264 
265  if (libname) {
266  entry = (SDL_DYNAPI_ENTRYFN) get_sdlapi_entry(libname, "SDL_DYNAPI_entry");
267  if (!entry) {
268  /* !!! FIXME: fail to startup here instead? */
269  /* !!! FIXME: definitely warn user. */
270  /* Just fill in the function pointers from this library. */
271  entry = SDL_DYNAPI_entry;
272  }
273  }
274 
275  if (entry(SDL_DYNAPI_VERSION, &jump_table, sizeof (jump_table)) < 0) {
276  /* !!! FIXME: fail to startup here instead? */
277  /* !!! FIXME: definitely warn user. */
278  /* Just fill in the function pointers from this library. */
279  if (entry != SDL_DYNAPI_entry) {
281  /* !!! FIXME: now we're screwed. Should definitely abort now. */
282  }
283  }
284  }
285 
286  /* we intentionally never close the newly-loaded lib, of course. */
287 }
static SDL_INLINE void * get_sdlapi_entry(const char *fname, const char *sym)
Definition: SDL_dynapi.c:212
Sint32(* SDL_DYNAPI_ENTRYFN)(Uint32 apiver, void *table, Uint32 tablesize)
Definition: SDL_dynapi.c:174
#define SDL_DYNAPI_VERSION
Definition: SDL_dynapi.c:48
static SDL_DYNAPI_jump_table jump_table
Definition: SDL_dynapi.c:133
Sint32 SDL_DYNAPI_entry(Uint32, void *, Uint32)
Definition: SDL_dynapi.c:178

Variable Documentation

◆ jump_table

SDL_DYNAPI_jump_table jump_table
static

Definition at line 133 of file SDL_dynapi.c.