Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

pthread_spin_destroy(3) [freebsd man page]

PTHREAD_SPIN_INIT(3)					   BSD Library Functions Manual 				      PTHREAD_SPIN_INIT(3)

NAME
pthread_spin_init, pthread_spin_destroy -- initialize or destroy a spin lock LIBRARY
POSIX Threads Library (libpthread, -lpthread) SYNOPSIS
#include <pthread.h> int pthread_spin_init(pthread_spinlock_t *lock, int pshared); int pthread_spin_destroy(pthread_spinlock_t *lock); DESCRIPTION
The pthread_spin_init() function will initialize lock to an unlocked state and allocate any resources necessary to begin using it. If pshared is set to PTHREAD_PROCESS_SHARED, any thread, whether belonging to the process in which the spinlock was created or not, that has access to the memory area where lock resides, can use lock. If it is set to PTHREAD_PROCESS_PRIVATE, it can only be used by threads within the same process. The pthread_spin_destroy() function will destroy lock and release any resources that may have been allocated on its behalf. RETURN VALUES
If successful, both pthread_spin_init() and pthread_spin_destroy() will return zero. Otherwise, an error number will be returned to indicate the error. Neither of these functions will return EINTR. ERRORS
The pthread_spin_init() and pthread_spin_destroy() functions will fail if: [EBUSY] An attempt to initialize or destroy lock while it is in use. [EINVAL] The value specified by lock is invalid. The pthread_spin_init() function will fail if: [EAGAIN] Insufficient resources, other than memory, to initialize lock. [ENOMEM] Insufficient memory to initialize lock. SEE ALSO
pthread_spin_lock(3), pthread_spin_unlock(3) HISTORY
The pthread_spin_init() and pthread_spin_destroy() functions first appeared in N:M Threading Library (libkse, -lkse) in FreeBSD 5.2, and in 1:1 Threading Library (libthr, -lthr) in FreeBSD 5.3. BUGS
The implementation of pthread_spin_init() does not fully conform to IEEE Std 1003.2 (``POSIX.2'') because the pshared argument is ignored in 1:1 Threading Library (libthr, -lthr), and in N:M Threading Library (libkse, -lkse) if any value other than PTHREAD_PROCESSES_PRIVATE is specified, it returns EINVAL. BSD
January 22, 2004 BSD

Check Out this Related Man Page

PTHREAD_SPIN_LOCK(3)					   BSD Library Functions Manual 				      PTHREAD_SPIN_LOCK(3)

NAME
pthread_spin_lock, pthread_spin_trylock, pthread_spin_unlock -- lock or unlock a spin lock LIBRARY
POSIX Threads Library (libpthread, -lpthread) SYNOPSIS
#include <pthread.h> int pthread_spin_lock(pthread_spinlock_t *lock); int pthread_spin_trylock(pthread_spinlock_t *lock); int pthread_spin_unlock(pthread_spinlock_t *lock); DESCRIPTION
The pthread_spin_lock() function will acquire lock if it is not currently owned by another thread. If the lock cannot be acquired immedi- ately, it will spin attempting to acquire the lock (it will not sleep) until it becomes available. The pthread_spin_trylock() function is the same as pthread_spin_lock() except that if it cannot acquire lock immediately it will return with an error. The pthread_spin_unlock() function will release lock, which must have been previously locked by a call to pthread_spin_lock() or pthread_spin_trylock(). RETURN VALUES
If successful, all these functions will return zero. Otherwise, an error number will be returned to indicate the error. None of these functions will return EINTR. ERRORS
The pthread_spin_lock(), pthread_spin_trylock() and pthread_spin_unlock() functions will fail if: [EINVAL] The value specified by lock is invalid or is not initialized. The pthread_spin_lock() function may fail if: [EDEADLK] The calling thread already owns the lock. The pthread_spin_trylock() function will fail if: [EBUSY] Another thread currently holds lock. The pthread_spin_unlock() function may fail if: [EPERM] The calling thread does not own lock. SEE ALSO
pthread_spin_destroy(3), pthread_spin_init(3) HISTORY
The pthread_spin_lock(), pthread_spin_trylock() and pthread_spin_unlock() functions first appeared in N:M Threading Library (libkse, -lkse) in FreeBSD 5.2, and in 1:1 Threading Library (libthr, -lthr) in FreeBSD 5.3. BUGS
The implementation of pthread_spin_lock(), pthread_spin_trylock() and pthread_spin_unlock() is expected to conform to IEEE Std 1003.2 (``POSIX.2''). BSD
January 22, 2004 BSD
Man Page