Issue #277 (bdwgc).
This API is useful to support coroutines.
* include/gc.h (GC_get_my_stackbottom, GC_set_stackbottom): New API
function declaration.
* misc.c [!THREADS] (GC_set_stackbottom, GC_get_my_stackbottom): New
function definition.
* pthread_support.c [GC_PTHREADS && !GC_WIN32_THREADS]
(GC_set_stackbottom, GC_get_my_stackbottom): Likewise.
* win32_threads.c [GC_WIN32_THREADS] (GC_set_stackbottom,
GC_get_my_stackbottom): Likewise.
* tests/test.c (struct thr_hndl_sb_s): Define.
* tests/test.c (set_stackbottom): New function (which calls
GC_set_stackbottom).
* tests/test.c (run_one_test): Define thr_hndl_sb local variable;
call GC_get_my_stackbottom() and set_stackbottom().
* win32_threads.c [GC_WIN32_THREADS && I386] (struct GC_Thread_Rep):
Add initial_stack_base field.
* win32_threads.c [GC_WIN32_THREADS && I386] (GC_record_stack_base,
GC_call_with_gc_active): Set initial_stack_base field.
* win32_threads.c [GC_WIN32_THREADS && I386] (GC_push_stack_for): Handle
the case when GetThreadContext() might return stale register values,
thread stack_base != initial_stack_base but the stack is not inside
the TIB stack (use context.Esp but call WARN); add TODO.
GC_API int GC_CALL GC_get_stack_base(struct GC_stack_base *)
GC_ATTR_NONNULL(1);
+/* Fill in the GC_stack_base structure with the cold end (bottom) of */
+/* the stack of the current thread (or coroutine). */
+/* Unlike GC_get_stack_base, it retrieves the value stored in the */
+/* collector (which is initially set by the collector upon the thread */
+/* is started or registered manually but it could be later updated by */
+/* client using GC_set_stackbottom). Returns the GC-internal non-NULL */
+/* handle of the thread which could be passed to GC_set_stackbottom */
+/* later. It is assumed that the collector is already initialized and */
+/* the thread is registered. Acquires the GC lock to avoid data races. */
+GC_API void * GC_CALL GC_get_my_stackbottom(struct GC_stack_base *)
+ GC_ATTR_NONNULL(1);
+
+/* Set the cool end of the user (coroutine) stack of the specified */
+/* thread. The GC thread handle is either the one returned by */
+/* GC_get_my_stackbottom or NULL (the latter designates the current */
+/* thread). The caller should hold the GC lock (e.g. using */
+/* GC_call_with_alloc_lock). Also, the function could be used for */
+/* setting GC_stackbottom value (the bottom of the primordial thread) */
+/* before the collector is initialized (the GC lock is not needed to be */
+/* acquired in this case). */
+GC_API void GC_CALL GC_set_stackbottom(void * /* gc_thread_handle */,
+ const struct GC_stack_base *)
+ GC_ATTR_NONNULL(2);
+
/* The following routines are primarily intended for use with a */
/* preprocessor which inserts calls to check C pointer arithmetic. */
/* They indicate failure by invoking the corresponding _print_proc. */
GC_blocked_sp = NULL;
}
+ GC_API void GC_CALL GC_set_stackbottom(void *gc_thread_handle,
+ const struct GC_stack_base *sb)
+ {
+ GC_ASSERT(sb -> mem_base != NULL);
+ GC_ASSERT(NULL == gc_thread_handle || &GC_stackbottom == gc_thread_handle);
+ GC_ASSERT(NULL == GC_blocked_sp
+ && NULL == GC_traced_stack_sect); /* for now */
+ (void)gc_thread_handle;
+
+ GC_stackbottom = (char *)sb->mem_base;
+# ifdef IA64
+ GC_register_stackbottom = (ptr_t)sb->reg_base;
+# endif
+ }
+
+ GC_API void * GC_CALL GC_get_my_stackbottom(struct GC_stack_base *sb)
+ {
+ GC_ASSERT(GC_is_initialized);
+ sb -> mem_base = GC_stackbottom;
+# ifdef IA64
+ sb -> reg_base = GC_register_stackbottom;
+# endif
+ return &GC_stackbottom; /* gc_thread_handle */
+ }
#endif /* !THREADS */
GC_API void * GC_CALL GC_do_blocking(GC_fn_type fn, void * client_data)
UNLOCK();
}
+GC_API void GC_CALL GC_set_stackbottom(void *gc_thread_handle,
+ const struct GC_stack_base *sb)
+{
+ GC_thread t = (GC_thread)gc_thread_handle;
+
+ GC_ASSERT(sb -> mem_base != NULL);
+ if (!EXPECT(GC_is_initialized, TRUE)) {
+ GC_ASSERT(NULL == t);
+ } else {
+ GC_ASSERT(I_HOLD_LOCK());
+ if (NULL == t) /* current thread? */
+ t = GC_lookup_thread(pthread_self());
+ GC_ASSERT((t -> flags & FINISHED) == 0);
+ GC_ASSERT(!(t -> thread_blocked)
+ && NULL == t -> traced_stack_sect); /* for now */
+
+ if ((t -> flags & MAIN_THREAD) == 0) {
+ t -> stack_end = (ptr_t)sb->mem_base;
+# ifdef IA64
+ t -> backing_store_end = (ptr_t)sb->reg_base;
+# endif
+ return;
+ }
+ /* Otherwise alter the stack bottom of the primordial thread. */
+ }
+
+ GC_stackbottom = (char*)sb->mem_base;
+# ifdef IA64
+ GC_register_stackbottom = (ptr_t)sb->reg_base;
+# endif
+}
+
+GC_API void * GC_CALL GC_get_my_stackbottom(struct GC_stack_base *sb)
+{
+ pthread_t self = pthread_self();
+ GC_thread me;
+ DCL_LOCK_STATE;
+
+ LOCK();
+ me = GC_lookup_thread(self);
+ /* The thread is assumed to be registered. */
+ if ((me -> flags & MAIN_THREAD) == 0) {
+ sb -> mem_base = me -> stack_end;
+# ifdef IA64
+ sb -> reg_base = me -> backing_store_end;
+# endif
+ } else {
+ sb -> mem_base = GC_stackbottom;
+# ifdef IA64
+ sb -> reg_base = GC_register_stackbottom;
+# endif
+ }
+ UNLOCK();
+ return (void *)me; /* gc_thread_handle */
+}
+
/* GC_call_with_gc_active() has the opposite to GC_do_blocking() */
/* functionality. It might be called from a user function invoked by */
/* GC_do_blocking() to temporarily back allow calling any GC function */
return NULL;
}
+struct thr_hndl_sb_s {
+ void *gc_thread_handle;
+ struct GC_stack_base sb;
+};
+
+void * GC_CALLBACK set_stackbottom(void *cd)
+{
+ GC_set_stackbottom(((struct thr_hndl_sb_s *)cd)->gc_thread_handle,
+ &((struct thr_hndl_sb_s *)cd)->sb);
+ return NULL;
+}
+
#ifndef MIN_WORDS
# define MIN_WORDS 2
#endif
pid_t pid;
int wstatus;
# endif
+ struct thr_hndl_sb_s thr_hndl_sb;
GC_FREE(0);
# ifdef THREADS
GC_FREE(GC_MALLOC_IGNORE_OFF_PAGE(2));
}
}
+ thr_hndl_sb.gc_thread_handle = GC_get_my_stackbottom(&thr_hndl_sb.sb);
# ifdef GC_GCJ_SUPPORT
GC_REGISTER_DISPLACEMENT(sizeof(struct fake_vtable *));
GC_init_gcj_malloc(0, (void *)(GC_word)fake_gcj_mark_proc);
exit(0);
}
# endif
+ (void)GC_call_with_alloc_lock(set_stackbottom, &thr_hndl_sb);
+
/* Repeated list reversal test. */
# ifndef NO_CLOCK
GET_TIME(start_time);
# ifdef IA64
ptr_t backing_store_end;
ptr_t backing_store_ptr;
+# elif defined(I386)
+ ptr_t initial_stack_base;
+ /* The cold end of the stack saved by */
+ /* GC_record_stack_base (never modified */
+ /* by GC_set_stackbottom). */
# endif
ptr_t thread_blocked_sp; /* Protected by GC lock. */
me -> stack_base = (ptr_t)sb->mem_base;
# ifdef IA64
me -> backing_store_end = (ptr_t)sb->reg_base;
+# elif defined(I386)
+ me -> initial_stack_base = (ptr_t)sb->mem_base;
# endif
if (me -> stack_base == NULL)
ABORT("Bad stack base in GC_register_my_thread");
/* Adjust our stack bottom pointer (this could happen unless */
/* GC_get_stack_base() was used which returned GC_SUCCESS). */
GC_ASSERT(me -> stack_base != NULL);
- if ((word)me->stack_base < (word)(&stacksect))
+ if ((word)me->stack_base < (word)(&stacksect)) {
me -> stack_base = (ptr_t)(&stacksect);
+# if defined(I386)
+ me -> initial_stack_base = me -> stack_base;
+# endif
+ }
if (me -> thread_blocked_sp == NULL) {
/* We are not inside GC_do_blocking() - do nothing more. */
return client_data; /* result */
}
+GC_API void GC_CALL GC_set_stackbottom(void *gc_thread_handle,
+ const struct GC_stack_base *sb)
+{
+ GC_thread t = (GC_thread)gc_thread_handle;
+
+ GC_ASSERT(sb -> mem_base != NULL);
+ if (!EXPECT(GC_is_initialized, TRUE)) {
+ GC_ASSERT(NULL == t);
+ GC_stackbottom = (char *)sb->mem_base;
+# ifdef IA64
+ GC_register_stackbottom = (ptr_t)sb->reg_base;
+# endif
+ return;
+ }
+
+ GC_ASSERT(I_HOLD_LOCK());
+ if (NULL == t) { /* current thread? */
+ t = GC_lookup_thread_inner(GetCurrentThreadId());
+ CHECK_LOOKUP_MY_THREAD(t);
+ }
+ GC_ASSERT(!KNOWN_FINISHED(t));
+ GC_ASSERT(NULL == t -> thread_blocked_sp
+ && NULL == t -> traced_stack_sect); /* for now */
+ t -> stack_base = (ptr_t)sb->mem_base;
+ t -> last_stack_min = ADDR_LIMIT; /* reset the known minimum */
+# ifdef IA64
+ t -> backing_store_end = (ptr_t)sb->reg_base;
+# endif
+}
+
+GC_API void * GC_CALL GC_get_my_stackbottom(struct GC_stack_base *sb)
+{
+ DWORD thread_id = GetCurrentThreadId();
+ GC_thread me;
+ DCL_LOCK_STATE;
+
+ LOCK();
+ me = GC_lookup_thread_inner(thread_id);
+ CHECK_LOOKUP_MY_THREAD(me); /* the thread is assumed to be registered */
+ sb -> mem_base = me -> stack_base;
+# ifdef IA64
+ sb -> reg_base = me -> backing_store_end;
+# endif
+ UNLOCK();
+ return (void *)me; /* gc_thread_handle */
+}
+
#ifdef GC_PTHREADS
/* A quick-and-dirty cache of the mapping between pthread_t */
# endif
GC_ASSERT(!((word)thread->stack_base
COOLER_THAN (word)tib->StackBase));
+ if (thread->stack_base != thread->initial_stack_base) {
+ /* We are in a coroutine. */
+ if ((word)thread->stack_base <= (word)sp /* StackLimit */
+ || (word)tib->StackBase < (word)thread->stack_base) {
+ /* The coroutine stack is not within TIB stack. */
+ sp = (ptr_t)context.Esp;
+ WARN("GetThreadContext might return stale register values"
+ " including ESP=%p\n", sp);
+ /* TODO: Because of WoW64 bug, there is no guarantee that */
+ /* sp really points to the stack top but, for now, we do */
+ /* our best as the TIB stack limit/base cannot be used */
+ /* while we are inside a coroutine. */
+ }
+ }
} else {
# ifdef DEBUG_THREADS
{
projects / gc / commitdiff