threads.h File Reference

#include <libxml/xmlversion.h>

Include dependency graph for threads.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct _xmlMutex	xmlMutex
typedef xmlMutex *	xmlMutexPtr
typedef struct _xmlRMutex	xmlRMutex
typedef xmlRMutex *	xmlRMutexPtr

Functions
XMLPUBFUN int	xmlCheckThreadLocalStorage (void)
XMLPUBFUN xmlMutexPtr	xmlNewMutex (void)
XMLPUBFUN void	xmlMutexLock (xmlMutexPtr tok)
XMLPUBFUN void	xmlMutexUnlock (xmlMutexPtr tok)
XMLPUBFUN void	xmlFreeMutex (xmlMutexPtr tok)
XMLPUBFUN xmlRMutexPtr	xmlNewRMutex (void)
XMLPUBFUN void	xmlRMutexLock (xmlRMutexPtr tok)
XMLPUBFUN void	xmlRMutexUnlock (xmlRMutexPtr tok)
XMLPUBFUN void	xmlFreeRMutex (xmlRMutexPtr tok)
XML_DEPRECATED XMLPUBFUN void	xmlInitThreads (void)
XMLPUBFUN void	xmlLockLibrary (void)
XMLPUBFUN void	xmlUnlockLibrary (void)
XML_DEPRECATED XMLPUBFUN int	xmlGetThreadId (void)
XML_DEPRECATED XMLPUBFUN int	xmlIsMainThread (void)
XML_DEPRECATED XMLPUBFUN void	xmlCleanupThreads (void)

Typedef Documentation

xmlMutex

typedef struct _xmlMutex xmlMutex

Summary: interfaces for thread handling Description: set of generic threading related routines should work with pthreads, Windows native or TLS threads

Copy: See Copyright for the status of this software.

Author: Daniel Veillard

Definition at line 23 of file threads.h.

xmlMutexPtr

typedef xmlMutex* xmlMutexPtr

Definition at line 24 of file threads.h.

xmlRMutex

typedef struct _xmlRMutex xmlRMutex

Definition at line 29 of file threads.h.

xmlRMutexPtr

typedef xmlRMutex* xmlRMutexPtr

Definition at line 30 of file threads.h.

Function Documentation

xmlCheckThreadLocalStorage()

XMLPUBFUN int xmlCheckThreadLocalStorage

(

void

)

xmlCheckThreadLocalStorage:

Check whether thread-local storage could be allocated.

In cross-platform code running in multithreaded environments, this function should be called once in each thread before calling other library functions to make sure that thread-local storage was allocated properly.

Returns 0 on success or -1 if a memory allocation failed. A failed allocation signals a typically fatal and irrecoverable out-of-memory situation. Don't call any library functions in this case.

This function never fails if the library is compiled with support for thread-local storage.

This function never fails for the "main" thread which is the first thread calling xmlInitParser.

Available since v2.12.0.

Definition at line 945 of file globals.c.

                                 {
#if defined(LIBXML_THREAD_ENABLED) && !defined(USE_TLS)
    if ((!xmlIsMainThreadInternal()) && (xmlGetThreadLocalStorage(1) == NULL))
        return(-1);
#endif
    return(0);
}

xmlCleanupThreads()

XML_DEPRECATED XMLPUBFUN void xmlCleanupThreads

(

void

)

xmlCleanupThreads:

DEPRECATED: This function is a no-op. Call xmlCleanupParser to free global state but see the warnings there. xmlCleanupParser should be only called once at program exit. In most cases, you don't have call cleanup functions at all.

Definition at line 435 of file threads.c.

{
}

xmlFreeMutex()

XMLPUBFUN void xmlFreeMutex

(

xmlMutexPtr

tok

)

xmlFreeMutex: @tok: the simple mutex

Free a mutex.

Definition at line 185 of file threads.c.

{
    if (tok == NULL)
        return;
 
    xmlCleanupMutex(tok);
    free(tok);
}

Referenced by xsltCleanupGlobals().

xmlFreeRMutex()

XMLPUBFUN void xmlFreeRMutex

(

xmlRMutexPtr tok

ATTRIBUTE_UNUSED

)

xmlFreeRMutex: @tok: the reentrant mutex

xmlRFreeMutex() is used to reclaim resources associated with a reentrant mutex.

Definition at line 275 of file threads.c.

{
    if (tok == NULL)
        return;
#ifdef HAVE_POSIX_THREADS
    if (XML_IS_NEVER_THREADED() == 0) {
        pthread_mutex_destroy(&tok->lock);
        pthread_cond_destroy(&tok->cv);
    }
#elif defined HAVE_WIN32_THREADS
    DeleteCriticalSection(&tok->cs);
#endif
    free(tok);
}

Referenced by xsltUninit().

xmlGetThreadId()

XML_DEPRECATED XMLPUBFUN int xmlGetThreadId

(

void

)

xmlGetThreadId:

DEPRECATED: Internal function, do not use.

xmlGetThreadId() find the current thread ID number Note that this is likely to be broken on some platforms using pthreads as the specification doesn't mandate pthread_t to be an integer type

Returns the current thread ID number

Definition at line 372 of file threads.c.

{
#ifdef HAVE_POSIX_THREADS
    pthread_t id;
    int ret;
 
    if (XML_IS_THREADED() == 0)
        return (0);
    id = pthread_self();
    /* horrible but preserves compat, see warning above */
    memcpy(&ret, &id, sizeof(ret));
    return (ret);
#elif defined HAVE_WIN32_THREADS
    return GetCurrentThreadId();
#else
    return ((int) 0);
#endif
}

xmlInitThreads()

XML_DEPRECATED XMLPUBFUN void xmlInitThreads

(

void

)

xmlInitThreads:

DEPRECATED: Alias for xmlInitParser.

Definition at line 421 of file threads.c.

{
    xmlInitParser();
}

xmlIsMainThread()

XML_DEPRECATED XMLPUBFUN int xmlIsMainThread

(

void

)

xmlIsMainThread:

DEPRECATED: Internal function, do not use.

Check whether the current thread is the main thread.

Returns 1 if the current thread is the main thread, 0 otherwise

Definition at line 694 of file globals.c.

                      {
    return(xmlIsMainThreadInternal());
}

xmlLockLibrary()

XMLPUBFUN void xmlLockLibrary

(

void

)

xmlLockLibrary:

xmlLockLibrary() is used to take out a re-entrant lock on the libxml2 library.

Definition at line 398 of file threads.c.

{
    xmlRMutexLock(xmlLibraryLock);
}

xmlMutexLock()

XMLPUBFUN void xmlMutexLock

(

xmlMutexPtr

tok

)

xmlMutexLock: @tok: the simple mutex

xmlMutexLock() is used to lock a libxml2 token.

Definition at line 201 of file threads.c.

{
    if (tok == NULL)
        return;
#ifdef HAVE_POSIX_THREADS
    /*
     * This assumes that __libc_single_threaded won't change while the
     * lock is held.
     */
    if (XML_IS_THREADED() != 0)
        pthread_mutex_lock(&tok->lock);
#elif defined HAVE_WIN32_THREADS
    EnterCriticalSection(&tok->cs);
#endif
 
}

Referenced by xmlDictFree(), xmlDictReference(), xmlMallocAtomicLoc(), xmlMallocLoc(), xmlMemBlocks(), xmlMemDisplay(), xmlMemDisplayLast(), xmlMemFree(), xmlMemShow(), xmlMemStrdupLoc(), xmlRandom(), xmlReallocLoc(), xmlThrDefBufferAllocScheme(), xmlThrDefDefaultBufferSize(), xmlThrDefDeregisterNodeDefault(), xmlThrDefDoValidityCheckingDefaultValue(), xmlThrDefGetWarningsDefaultValue(), xmlThrDefKeepBlanksDefaultValue(), xmlThrDefLineNumbersDefaultValue(), xmlThrDefLoadExtDtdDefaultValue(), xmlThrDefOutputBufferCreateFilenameDefault(), xmlThrDefParserDebugEntities(), xmlThrDefParserInputBufferCreateFilenameDefault(), xmlThrDefPedanticParserDefaultValue(), xmlThrDefRegisterNodeDefault(), xmlThrDefSetGenericErrorFunc(), xmlThrDefSetStructuredErrorFunc(), xmlThrDefSubstituteEntitiesDefaultValue(), xsltCleanupGlobals(), xsltDebugDumpExtensions(), xsltExtModuleElementLookup(), xsltExtModuleElementPreComputeLookup(), xsltExtModuleFunctionLookup(), xsltExtModuleTopLevelLookup(), xsltGetExtData(), xsltPreComputeExtModuleElement(), xsltRegisterExtModuleElement(), xsltRegisterExtModuleFull(), xsltRegisterExtModuleFunction(), xsltRegisterExtModuleTopLevel(), xsltRegisterExtPrefix(), xsltStyleInitializeStylesheetModule(), xsltUnregisterAllExtModuleElement(), xsltUnregisterAllExtModuleFunction(), xsltUnregisterAllExtModules(), xsltUnregisterAllExtModuleTopLevel(), xsltUnregisterExtModule(), xsltUnregisterExtModuleElement(), xsltUnregisterExtModuleFunction(), and xsltUnregisterExtModuleTopLevel().

xmlMutexUnlock()

XMLPUBFUN void xmlMutexUnlock

(

xmlMutexPtr

tok

)

xmlMutexUnlock: @tok: the simple mutex

xmlMutexUnlock() is used to unlock a libxml2 token.

Definition at line 225 of file threads.c.

{
    if (tok == NULL)
        return;
#ifdef HAVE_POSIX_THREADS
    if (XML_IS_THREADED() != 0)
        pthread_mutex_unlock(&tok->lock);
#elif defined HAVE_WIN32_THREADS
    LeaveCriticalSection(&tok->cs);
#endif
}

Referenced by xmlDictFree(), xmlDictReference(), xmlMallocAtomicLoc(), xmlMallocLoc(), xmlMemBlocks(), xmlMemDisplay(), xmlMemDisplayLast(), xmlMemFree(), xmlMemShow(), xmlMemStrdupLoc(), xmlRandom(), xmlReallocLoc(), xmlThrDefBufferAllocScheme(), xmlThrDefDefaultBufferSize(), xmlThrDefDeregisterNodeDefault(), xmlThrDefDoValidityCheckingDefaultValue(), xmlThrDefGetWarningsDefaultValue(), xmlThrDefKeepBlanksDefaultValue(), xmlThrDefLineNumbersDefaultValue(), xmlThrDefLoadExtDtdDefaultValue(), xmlThrDefOutputBufferCreateFilenameDefault(), xmlThrDefParserDebugEntities(), xmlThrDefParserInputBufferCreateFilenameDefault(), xmlThrDefPedanticParserDefaultValue(), xmlThrDefRegisterNodeDefault(), xmlThrDefSetGenericErrorFunc(), xmlThrDefSetStructuredErrorFunc(), xmlThrDefSubstituteEntitiesDefaultValue(), xsltCleanupGlobals(), xsltDebugDumpExtensions(), xsltExtModuleElementLookup(), xsltExtModuleElementPreComputeLookup(), xsltExtModuleFunctionLookup(), xsltExtModuleTopLevelLookup(), xsltGetExtData(), xsltPreComputeExtModuleElement(), xsltRegisterExtModuleElement(), xsltRegisterExtModuleFull(), xsltRegisterExtModuleFunction(), xsltRegisterExtModuleTopLevel(), xsltRegisterExtPrefix(), xsltStyleInitializeStylesheetModule(), xsltUnregisterAllExtModuleElement(), xsltUnregisterAllExtModuleFunction(), xsltUnregisterAllExtModules(), xsltUnregisterAllExtModuleTopLevel(), xsltUnregisterExtModule(), xsltUnregisterExtModuleElement(), xsltUnregisterExtModuleFunction(), and xsltUnregisterExtModuleTopLevel().

xmlNewMutex()

XMLPUBFUN xmlMutexPtr xmlNewMutex

(

void

)

xmlNewMutex:

xmlNewMutex() is used to allocate a libxml2 token struct for use in synchronizing access to data.

Returns a new simple mutex pointer or NULL in case of error

Definition at line 149 of file threads.c.

{
    xmlMutexPtr tok;
 
    if ((tok = malloc(sizeof(xmlMutex))) == NULL)
        return (NULL);
    xmlInitMutex(tok);
    return (tok);
}

Referenced by xsltInitGlobals().

xmlNewRMutex()

XMLPUBFUN xmlRMutexPtr xmlNewRMutex

(

void

)

xmlNewRMutex:

xmlRNewMutex() is used to allocate a reentrant mutex for use in synchronizing access to data. token_r is a re-entrant lock and thus useful for synchronizing access to data structures that may be manipulated in a recursive fashion.

Returns the new reentrant mutex pointer or NULL in case of error

Definition at line 248 of file threads.c.

{
    xmlRMutexPtr tok;
 
    if ((tok = malloc(sizeof(xmlRMutex))) == NULL)
        return (NULL);
#ifdef HAVE_POSIX_THREADS
    if (XML_IS_NEVER_THREADED() == 0) {
        pthread_mutex_init(&tok->lock, NULL);
        tok->held = 0;
        tok->waiters = 0;
        pthread_cond_init(&tok->cv, NULL);
    }
#elif defined HAVE_WIN32_THREADS
    InitializeCriticalSection(&tok->cs);
#endif
    return (tok);
}

Referenced by xsltInit().

xmlRMutexLock()

XMLPUBFUN void xmlRMutexLock

(

xmlRMutexPtr

tok

)

xmlRMutexLock: @tok: the reentrant mutex

xmlRMutexLock() is used to lock a libxml2 token_r.

Definition at line 297 of file threads.c.

{
    if (tok == NULL)
        return;
#ifdef HAVE_POSIX_THREADS
    if (XML_IS_THREADED() == 0)
        return;
 
    pthread_mutex_lock(&tok->lock);
    if (tok->held) {
        if (pthread_equal(tok->tid, pthread_self())) {
            tok->held++;
            pthread_mutex_unlock(&tok->lock);
            return;
        } else {
            tok->waiters++;
            while (tok->held)
                pthread_cond_wait(&tok->cv, &tok->lock);
            tok->waiters--;
        }
    }
    tok->tid = pthread_self();
    tok->held = 1;
    pthread_mutex_unlock(&tok->lock);
#elif defined HAVE_WIN32_THREADS
    EnterCriticalSection(&tok->cs);
#endif
}

Referenced by xmlLockLibrary(), and xsltFreeLocales().

xmlRMutexUnlock()

XMLPUBFUN void xmlRMutexUnlock

(

xmlRMutexPtr tok

ATTRIBUTE_UNUSED

)

xmlRMutexUnlock: @tok: the reentrant mutex

xmlRMutexUnlock() is used to unlock a libxml2 token_r.

Definition at line 333 of file threads.c.

{
    if (tok == NULL)
        return;
#ifdef HAVE_POSIX_THREADS
    if (XML_IS_THREADED() == 0)
        return;
 
    pthread_mutex_lock(&tok->lock);
    tok->held--;
    if (tok->held == 0) {
        if (tok->waiters)
            pthread_cond_signal(&tok->cv);
        memset(&tok->tid, 0, sizeof(tok->tid));
    }
    pthread_mutex_unlock(&tok->lock);
#elif defined HAVE_WIN32_THREADS
    LeaveCriticalSection(&tok->cs);
#endif
}

Referenced by xmlUnlockLibrary(), and xsltFreeLocales().

xmlUnlockLibrary()

XMLPUBFUN void xmlUnlockLibrary

(

void

)

xmlUnlockLibrary:

xmlUnlockLibrary() is used to release a re-entrant lock on the libxml2 library.

Definition at line 410 of file threads.c.

{
    xmlRMutexUnlock(xmlLibraryLock);
}