tls-generic.cpp revision 1c94c0a63ba68be1a7b2c640e70d7a06464e4fca
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/* $Id$ */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/** @file
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * innotek Portable Runtime - Thread Local Storage (TSL), Generic Implementation.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/*
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * Copyright (C) 2008 Sun Microsystems, Inc.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * available from http://www.virtualbox.org. This file is free software;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * you can redistribute it and/or modify it under the terms of the GNU
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * General Public License (GPL) as published by the Free Software
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * The contents of this file may alternatively be used under the terms
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * of the Common Development and Distribution License Version 1.0
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * VirtualBox OSE distribution, in which case the provisions of the
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * CDDL are applicable instead of those of the GPL.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * You may elect to license modified versions of this file under the
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * terms and conditions of either the GPL or the CDDL or both.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * additional information or have any questions.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/*******************************************************************************
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync* Header Files *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync*******************************************************************************/
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#define LOG_GROUP RTLOGGROUP_THREAD
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include <iprt/thread.h>
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include <iprt/err.h>
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include <iprt/asm.h>
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include <iprt/log.h>
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include <iprt/assert.h>
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync#include "internal/thread.h"
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/*******************************************************************************
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync* Global Variables *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync*******************************************************************************/
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/** Allocation bitmap. Set bits indicates allocated entries. */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncstatic uint32_t volatile g_au32AllocatedBitmap[(RTTHREAD_TLS_ENTRIES + 31) / 32];
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/** Destructors for each of the TLS entries. */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncstatic PFNRTTLSDTOR g_apfnDestructors[RTTHREAD_TLS_ENTRIES];
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(RTTLS) RTTlsAlloc(void)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync RTTLS iTls;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync int rc = RTTlsAllocEx(&iTls, NULL);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return RT_SUCCESS(rc) ? iTls : NIL_RTTLS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(int) RTTlsAllocEx(PRTTLS piTls, PFNRTTLSDTOR pfnDestructor)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync for (unsigned i = 0; i < 128; i++)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync int iTls = ASMBitFirstClear(&g_au32AllocatedBitmap[0], RTTHREAD_TLS_ENTRIES);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (iTls < 0)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *piTls = NIL_RTTLS;
fb1a9f79a0cd51c5793428dc7a5882780ab91930vboxsync return VERR_NO_MEMORY;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (!ASMAtomicBitTestAndSet(&g_au32AllocatedBitmap[0], iTls))
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync g_apfnDestructors[iTls] = pfnDestructor;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *piTls = iTls;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VINF_SUCCESS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync AssertFailed();
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VERR_NO_MEMORY;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(int) RTTlsFree(RTTLS iTls)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (iTls == NIL_RTTLS)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VINF_SUCCESS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if ( iTls < 0
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || iTls >= RTTHREAD_TLS_ENTRIES
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || !ASMBitTest(&g_au32AllocatedBitmap[0], iTls))
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VERR_INVALID_PARAMETER;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync ASMAtomicWritePtr((void * volatile *)&g_apfnDestructors[iTls], NULL);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync rtThreadClearTlsEntry(iTls);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync ASMAtomicBitClear(&g_au32AllocatedBitmap[0], iTls);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VINF_SUCCESS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(void *) RTTlsGet(RTTLS iTls)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync void *pv;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync int rc = RTTlsGetEx(iTls, &pv);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return RT_SUCCESS(rc) ? pv : NULL;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(int) RTTlsGetEx(RTTLS iTls, void **ppvValue)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (RT_UNLIKELY( iTls < 0
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || iTls >= RTTHREAD_TLS_ENTRIES
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || !ASMBitTest(&g_au32AllocatedBitmap[0], iTls)))
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VERR_INVALID_PARAMETER;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync PRTTHREADINT pThread = rtThreadGet(RTThreadSelf());
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync AssertReturn(pThread, VERR_NOT_SUPPORTED);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync void *pv = pThread->apvTlsEntries[iTls];
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync rtThreadRelease(pThread);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *ppvValue = pv;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VINF_SUCCESS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncRTR3DECL(int) RTTlsSet(RTTLS iTls, void *pvValue)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (RT_UNLIKELY( iTls < 0
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || iTls >= RTTHREAD_TLS_ENTRIES
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync || !ASMBitTest(&g_au32AllocatedBitmap[0], iTls)))
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VERR_INVALID_PARAMETER;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync PRTTHREADINT pThread = rtThreadGet(RTThreadSelf());
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync AssertReturn(pThread, VERR_NOT_SUPPORTED);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync pThread->apvTlsEntries[iTls] = pvValue;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync rtThreadRelease(pThread);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync return VINF_SUCCESS;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync/**
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * Called at thread termination to invoke TLS destructors.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync *
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync * @param pThread The current thread.
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync */
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsyncvoid rtThreadTlsDestruction(PRTTHREADINT pThread)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync{
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync for (RTTLS iTls = 0; iTls < RTTHREAD_TLS_ENTRIES; iTls++)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync void *pv = pThread->apvTlsEntries[iTls];
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (pv)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync PFNRTTLSDTOR pfnDestructor = (PFNRTTLSDTOR)(uintptr_t)ASMAtomicUoReadPtr((void * volatile *)(uintptr_t)&g_apfnDestructors[iTls]);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync if (pfnDestructor)
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync {
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync pThread->apvTlsEntries[iTls] = NULL;
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync pfnDestructor(pv);
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync }
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync}
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync
2748ec9a37a53b7f444e11e02e7b1a538558d557vboxsync