1 /* a fast and simple context switching library */
3 /* Copyright (c) 2004-2008 the SimGrid team. */
4 /* All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #ifndef _XBT_CONTEXT_PRIVATE_H
10 #define _XBT_CONTEXT_PRIVATE_H
12 #include "xbt/sysdep.h"
13 #include "xbt/context.h"
18 /* *********************** */
19 /* Context type definition */
20 /* *********************** */
21 /* the following function pointers describe the interface that all context concepts must implement */
22 typedef void (*xbt_pfn_context_free_t) (xbt_context_t); /* pointer type to the function used to destroy the specified context */
24 typedef void (*xbt_pfn_context_kill_t) (xbt_context_t); /* pointer type to the function used to kill the specified context */
26 typedef void (*xbt_pfn_context_schedule_t) (xbt_context_t); /* pointer type to the function used to resume the specified context */
28 typedef void (*xbt_pfn_context_yield_t) (void); /* pointer type to the function used to yield the specified context */
30 typedef void (*xbt_pfn_context_start_t) (xbt_context_t); /* pointer type to the function used to start the specified context */
32 typedef void (*xbt_pfn_context_stop_t) (int); /* pointer type to the function used to stop the current context */
34 /* each context type must contain this macro at its begining -- OOP in C :/ */
35 #define XBT_CTX_BASE_T \
36 s_xbt_swag_hookup_t hookup; \
38 void_f_pvoid_t cleanup_func; \
40 ex_ctx_t *exception; \
42 xbt_main_func_t code; \
45 void_f_pvoid_t startup_func; \
47 xbt_pfn_context_free_t free; \
48 xbt_pfn_context_kill_t kill; \
49 xbt_pfn_context_schedule_t schedule; \
50 xbt_pfn_context_yield_t yield; \
51 xbt_pfn_context_start_t start; \
52 xbt_pfn_context_stop_t stop
54 /* all other context types derive from this structure */
55 typedef struct s_xbt_context {
59 /* ****************** */
60 /* Globals definition */
61 /* ****************** */
64 extern xbt_context_t current_context;
66 extern xbt_context_t maestro_context;
69 extern xbt_swag_t context_living;
71 extern xbt_swag_t context_to_destroy;
73 /* *********************** */
74 /* factory type definition */
75 /* *********************** */
76 typedef struct s_xbt_context_factory *xbt_context_factory_t;
78 /* this function describes the interface that all context factory must implement */
79 typedef xbt_context_t(*xbt_pfn_context_factory_create_context_t) (const
90 int (*xbt_pfn_context_factory_create_maestro_context_t) (xbt_context_t
93 /* this function finalize the specified context factory */
94 typedef int (*xbt_pfn_context_factory_finalize_t) (xbt_context_factory_t
97 /* this interface is used by the xbt context module to create the appropriate concept */
98 typedef struct s_xbt_context_factory {
99 xbt_pfn_context_factory_create_maestro_context_t create_maestro_context; /* create the context of the maestro */
100 xbt_pfn_context_factory_create_context_t create_context; /* create a new context */
101 xbt_pfn_context_factory_finalize_t finalize; /* finalize the context factory */
102 const char *name; /* the name of the context factory */
104 } s_xbt_context_factory_t;
107 * This function select a context factory associated with the name specified by
108 * the parameter name.
109 * If successful the function returns 0. Otherwise the function returns the error
113 xbt_context_select_factory(const char *name);
116 * This function initialize a context factory from the name specified by the parameter
118 * If the factory cannot be found, an exception is raised.
129 xbt_context_init_factory_by_name(xbt_context_factory_t * factory,
133 /* All factories init */
134 void xbt_ctx_thread_factory_init(xbt_context_factory_t * factory);
136 void xbt_ctx_sysv_factory_init(xbt_context_factory_t * factory);
138 void xbt_ctx_java_factory_init(xbt_context_factory_t * factory);
145 #endif /* !_XBT_CONTEXT_PRIVATE_H */