mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-09-24 16:35:44 +00:00
927cfaf467
We had a memory leak on a very arcane OOM situation (unlikely to ever hit in practice, but who knows if libvirt.so would ever be linked into some other program that exhausts all thread-local storage keys?). I found it by code inspection, while analyzing a valgrind report generated by Alex Jia. * src/util/threads.h (virThreadLocalSet): Alter signature. * src/util/threads-pthread.c (virThreadHelper): Reduce allocation lifetime. (virThreadLocalSet): Detect failure. * src/util/threads-win32.c (virThreadLocalSet): Likewise. (virCondWait): Fix caller. * src/util/virterror.c (virLastErrorObject): Likewise.
118 lines
3.8 KiB
C
118 lines
3.8 KiB
C
/*
|
|
* threads.h: basic thread synchronization primitives
|
|
*
|
|
* Copyright (C) 2009-2011 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*
|
|
*/
|
|
|
|
#ifndef __THREADS_H_
|
|
# define __THREADS_H_
|
|
|
|
# include "internal.h"
|
|
|
|
typedef struct virMutex virMutex;
|
|
typedef virMutex *virMutexPtr;
|
|
|
|
typedef struct virCond virCond;
|
|
typedef virCond *virCondPtr;
|
|
|
|
typedef struct virThreadLocal virThreadLocal;
|
|
typedef virThreadLocal *virThreadLocalPtr;
|
|
|
|
typedef struct virThread virThread;
|
|
typedef virThread *virThreadPtr;
|
|
|
|
typedef struct virOnceControl virOnceControl;
|
|
typedef virOnceControl *virOnceControlPtr;
|
|
|
|
typedef void (*virOnceFunc)(void);
|
|
|
|
int virThreadInitialize(void) ATTRIBUTE_RETURN_CHECK;
|
|
void virThreadOnExit(void);
|
|
|
|
typedef void (*virThreadFunc)(void *opaque);
|
|
|
|
int virThreadCreate(virThreadPtr thread,
|
|
bool joinable,
|
|
virThreadFunc func,
|
|
void *opaque) ATTRIBUTE_RETURN_CHECK;
|
|
void virThreadSelf(virThreadPtr thread);
|
|
bool virThreadIsSelf(virThreadPtr thread);
|
|
void virThreadJoin(virThreadPtr thread);
|
|
|
|
/* These next two functions are for debugging only, since they are not
|
|
* guaranteed to give unique values for distinct threads on all
|
|
* architectures, nor are the two functions guaranteed to give the same
|
|
* value for the same thread. */
|
|
int virThreadSelfID(void);
|
|
int virThreadID(virThreadPtr thread);
|
|
|
|
/* Static initialization of mutexes is not possible, so we instead
|
|
* provide for guaranteed one-time initialization via a callback
|
|
* function. Usage:
|
|
* static virOnceControl once = VIR_ONCE_CONTROL_INITIALIZER;
|
|
* static void initializer(void) { ... }
|
|
* void myfunc()
|
|
* {
|
|
* if (virOnce(&once, initializer) < 0)
|
|
* goto error;
|
|
* ...now guaranteed that initializer has completed exactly once
|
|
* }
|
|
*/
|
|
int virOnce(virOnceControlPtr once, virOnceFunc init)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
int virMutexInit(virMutexPtr m) ATTRIBUTE_RETURN_CHECK;
|
|
int virMutexInitRecursive(virMutexPtr m) ATTRIBUTE_RETURN_CHECK;
|
|
void virMutexDestroy(virMutexPtr m);
|
|
|
|
void virMutexLock(virMutexPtr m);
|
|
void virMutexUnlock(virMutexPtr m);
|
|
|
|
|
|
|
|
int virCondInit(virCondPtr c) ATTRIBUTE_RETURN_CHECK;
|
|
int virCondDestroy(virCondPtr c) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
/* virCondWait, virCondWaitUntil:
|
|
* These functions can return without the associated predicate
|
|
* changing value. Therefore in nearly all cases they
|
|
* should be enclosed in a while loop that checks the predicate.
|
|
*/
|
|
int virCondWait(virCondPtr c, virMutexPtr m) ATTRIBUTE_RETURN_CHECK;
|
|
int virCondWaitUntil(virCondPtr c, virMutexPtr m, unsigned long long whenms) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
void virCondSignal(virCondPtr c);
|
|
void virCondBroadcast(virCondPtr c);
|
|
|
|
|
|
typedef void (*virThreadLocalCleanup)(void *);
|
|
int virThreadLocalInit(virThreadLocalPtr l,
|
|
virThreadLocalCleanup c) ATTRIBUTE_RETURN_CHECK;
|
|
void *virThreadLocalGet(virThreadLocalPtr l);
|
|
int virThreadLocalSet(virThreadLocalPtr l, void*) ATTRIBUTE_RETURN_CHECK;
|
|
|
|
# ifdef WIN32
|
|
# include "threads-win32.h"
|
|
# elif defined HAVE_PTHREAD_MUTEXATTR_INIT
|
|
# include "threads-pthread.h"
|
|
# else
|
|
# error "Either pthreads or Win32 threads are required"
|
|
# endif
|
|
|
|
#endif
|