ea90ca8666
This is the second of two commits in a series that must be picked together.
This series of two commits moves parts of lib/krb5/ infrastructure
functionality to lib/base/, leaving behind wrappers.
Some parts of libkrb5 are entirely generic or easily made so, and could
be useful in various parts of Heimdal that are not specific to the krb5
API, such as:
- lib/gssapi/ (especially since the integration of NegoEx)
- lib/hx509/
- bx509d (which should really move out of kdc/)
For the above we need to move these bits of lib/krb5/:
- lib/krb5/config_file.c (all of it, leaving forwardings behind)
- lib/krb5/config_reg.c (all of it)
- lib/krb5/plugin.c (all of it, leaving forwardings behind)
- lib/krb5/log.c (all of it, ditto)
- lib/krb5/heim_err.et (all of it)
And because of those two, these too must also move:
- lib/krb5/expand_path.c (all of it, leaving forwardings behind)
- lib/krb5/warn.c (just the warning functions, ditto)
The changes to the moved files are mostly quite straightforward and are
best reviewed with --word-diff=color.
We're also creating a heim_context and a heim API to go with it. But
it's as thin as possible, with as little state as necessary to enable
this move. Functions for dealing with error messages use callbacks.
Moving plugin.c does have one knock-on effect on all users of the old
krb5 plugin API (which remains), which is that a global search and
replace of struct krb5_plugin_data to struct heim_plugin_data was
needed, though the layout and size of that structure doesn't change, so
the ABI doesn't either.
As well, we now build lib/vers/ and lib/com_err/ before lib/base/ so as
to be able to move lib/krb5/heim_err.et to lib/base/ so that we can make
use of HEIM_ERR_* in lib/base/, specifically in the files that moved.
Once this is all done we'll be able to use config files and plugins in
lib/hx509/, we'll be able to move bx509d out of kdc/, and so on.
Most if not all of the new functions in lib/base/ are Heimdal-private,
thus calling conventions for them are not declared.
Status:
- builds and passes CIs (Travis, Appveyor)
- ran make check-valgrind and no new leaks or other memory errors
- ready for review
HOW TO REVIEW:
$ # Review file moves:
$ git log --stat -n1 HEAD^
$
$ # Review changes to moved files using --word-diff=color
$ git log -p -b -w --word-diff=color HEAD^..HEAD \
lib/base/config_file.c \
lib/base/config_reg.c \
lib/base/expand_path.c \
lib/base/warn.c \
lib/krb5/config_file.c \
lib/krb5/config_reg.c \
lib/krb5/expand_path.c \
lib/krb5/warn.c
$
$ # Review the whole thing, possibly adding -b and/or -w, and
$ # maybe --word-diff=color:
$ git log -p origin/master..HEAD
$ git log -p -b -w origin/master..HEAD
$ git log -p -b -w --word-diff=color origin/master..HEAD
TBD (future commits):
- make lib/gssapi use the new heimbase functions
- move kx509/bx509d common code to lib/hx509/ or other approp. location
- move bx509d out of kdc/
371 lines
12 KiB
C
371 lines
12 KiB
C
/*
|
|
* Copyright (c) 2003-2016 Kungliga Tekniska Högskolan
|
|
* (Royal Institute of Technology, Stockholm, Sweden).
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of the Institute nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
|
|
/* $Id$ */
|
|
|
|
/*
|
|
* Provide wrapper macros for thread synchronization primitives so we
|
|
* can use native thread functions for those operating system that
|
|
* supports it.
|
|
*
|
|
* This is so libkrb5.so (or more importantly, libgssapi.so) can have
|
|
* thread support while the program that that dlopen(3)s the library
|
|
* don't need to be linked to libpthread.
|
|
*/
|
|
|
|
#ifndef HEIM_THREADS_H
|
|
#define HEIM_THREADS_H 1
|
|
|
|
#include <errno.h>
|
|
|
|
#ifdef _MSC_VER
|
|
|
|
#define HEIMDAL_THREAD_LOCAL __declspec(thread)
|
|
|
|
#else
|
|
|
|
#if defined(__clang__) || defined(__GNUC__) || defined(__SUNPRO_C)
|
|
#define HEIMDAL_THREAD_LOCAL __thread
|
|
#else
|
|
#error "thread-local attribute not defined for your compiler"
|
|
#endif /* clang or gcc */
|
|
|
|
#endif /* _MSC_VER */
|
|
|
|
/* For testing the for-Windows implementation of thread keys on non-Windows */
|
|
typedef unsigned long HEIM_PRIV_thread_key;
|
|
|
|
|
|
/* assume headers already included */
|
|
|
|
#if defined(__NetBSD__) && __NetBSD_Version__ >= 106120000 && __NetBSD_Version__< 299001200 && defined(ENABLE_PTHREAD_SUPPORT)
|
|
|
|
/*
|
|
* NetBSD have a thread lib that we can use that part of libc that
|
|
* works regardless if application are linked to pthreads or not.
|
|
* NetBSD newer then 2.99.11 just use pthread.h, and the same thing
|
|
* will happen.
|
|
*/
|
|
#include <threadlib.h>
|
|
|
|
#define HEIMDAL_MUTEX mutex_t
|
|
#define HEIMDAL_MUTEX_INITIALIZER MUTEX_INITIALIZER
|
|
#define HEIMDAL_MUTEX_init(m) mutex_init(m, NULL)
|
|
#define HEIMDAL_MUTEX_lock(m) mutex_lock(m)
|
|
#define HEIMDAL_MUTEX_unlock(m) mutex_unlock(m)
|
|
#define HEIMDAL_MUTEX_destroy(m) mutex_destroy(m)
|
|
|
|
#define HEIMDAL_RWLOCK rwlock_t
|
|
#define HEIMDAL_RWLOCK_INITIALIZER RWLOCK_INITIALIZER
|
|
#define HEIMDAL_RWLOCK_init(l) rwlock_init(l, NULL)
|
|
#define HEIMDAL_RWLOCK_rdlock(l) rwlock_rdlock(l)
|
|
#define HEIMDAL_RWLOCK_wrlock(l) rwlock_wrlock(l)
|
|
#define HEIMDAL_RWLOCK_tryrdlock(l) rwlock_tryrdlock(l)
|
|
#define HEIMDAL_RWLOCK_trywrlock(l) rwlock_trywrlock(l)
|
|
#define HEIMDAL_RWLOCK_unlock(l) rwlock_unlock(l)
|
|
#define HEIMDAL_RWLOCK_destroy(l) rwlock_destroy(l)
|
|
|
|
#define HEIMDAL_thread_key thread_key_t
|
|
#define HEIMDAL_key_create(k,d,r) do { r = thr_keycreate(k,d); } while(0)
|
|
#define HEIMDAL_setspecific(k,s,r) do { r = thr_setspecific(k,s); } while(0)
|
|
#define HEIMDAL_getspecific(k) thr_getspecific(k)
|
|
#define HEIMDAL_key_delete(k) thr_keydelete(k)
|
|
|
|
#define HEIMDAL_THREAD_ID thr_t
|
|
#define HEIMDAL_THREAD_create(t,f,a) thr_create((t), 0, (f), (a))
|
|
|
|
#elif defined(ENABLE_PTHREAD_SUPPORT) && (!defined(__NetBSD__) || __NetBSD_Version__ >= 299001200)
|
|
|
|
#include <pthread.h>
|
|
|
|
#define HEIMDAL_MUTEX pthread_mutex_t
|
|
#define HEIMDAL_MUTEX_INITIALIZER PTHREAD_MUTEX_INITIALIZER
|
|
#define HEIMDAL_MUTEX_init(m) pthread_mutex_init(m, NULL)
|
|
#define HEIMDAL_MUTEX_lock(m) pthread_mutex_lock(m)
|
|
#define HEIMDAL_MUTEX_unlock(m) pthread_mutex_unlock(m)
|
|
#define HEIMDAL_MUTEX_destroy(m) pthread_mutex_destroy(m)
|
|
|
|
#define HEIMDAL_RWLOCK pthread_rwlock_t
|
|
#define HEIMDAL_RWLOCK_INITIALIZER PTHREAD_RWLOCK_INITIALIZER
|
|
#define HEIMDAL_RWLOCK_init(l) pthread_rwlock_init(l, NULL)
|
|
#define HEIMDAL_RWLOCK_rdlock(l) pthread_rwlock_rdlock(l)
|
|
#define HEIMDAL_RWLOCK_wrlock(l) pthread_rwlock_wrlock(l)
|
|
#define HEIMDAL_RWLOCK_tryrdlock(l) pthread_rwlock_tryrdlock(l)
|
|
#define HEIMDAL_RWLOCK_trywrlock(l) pthread_rwlock_trywrlock(l)
|
|
#define HEIMDAL_RWLOCK_unlock(l) pthread_rwlock_unlock(l)
|
|
#define HEIMDAL_RWLOCK_destroy(l) pthread_rwlock_destroy(l)
|
|
|
|
#ifdef HEIM_BASE_MAINTAINER
|
|
#define HEIMDAL_thread_key unsigned long
|
|
#define HEIM_PRIV_thread_key HEIMDAL_thread_key
|
|
#define HEIMDAL_key_create(k,d,r) do { r = heim_w32_key_create(k,d); } while(0)
|
|
#define HEIMDAL_setspecific(k,s,r) do { r = heim_w32_setspecific(k,s); } while(0)
|
|
#define HEIMDAL_getspecific(k) (heim_w32_getspecific(k))
|
|
#define HEIMDAL_key_delete(k) (heim_w32_delete_key(k))
|
|
#else
|
|
#define HEIMDAL_thread_key pthread_key_t
|
|
#define HEIMDAL_key_create(k,d,r) do { r = pthread_key_create(k,d); } while(0)
|
|
#define HEIMDAL_setspecific(k,s,r) do { r = pthread_setspecific(k,s); } while(0)
|
|
#define HEIMDAL_getspecific(k) pthread_getspecific(k)
|
|
#define HEIMDAL_key_delete(k) pthread_key_delete(k)
|
|
#endif
|
|
|
|
#define HEIMDAL_THREAD_ID pthread_t
|
|
#define HEIMDAL_THREAD_create(t,f,a) pthread_create((t), 0, (f), (a))
|
|
|
|
#elif defined(_WIN32)
|
|
|
|
typedef struct heim_mutex {
|
|
HANDLE h;
|
|
} heim_mutex_t;
|
|
|
|
static inline int
|
|
heim_mutex_init(heim_mutex_t *m)
|
|
{
|
|
m->h = CreateSemaphore(NULL, 1, 1, NULL);
|
|
if (m->h == INVALID_HANDLE_VALUE)
|
|
return EAGAIN;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_mutex_lock(heim_mutex_t *m)
|
|
{
|
|
HANDLE h, new_h;
|
|
int created = 0;
|
|
|
|
h = InterlockedCompareExchangePointer(&m->h, m->h, m->h);
|
|
if (h == INVALID_HANDLE_VALUE || h == NULL) {
|
|
created = 1;
|
|
new_h = CreateSemaphore(NULL, 0, 1, NULL);
|
|
if (new_h == INVALID_HANDLE_VALUE)
|
|
return EAGAIN;
|
|
if (InterlockedCompareExchangePointer(&m->h, new_h, h) != h) {
|
|
created = 0;
|
|
CloseHandle(new_h);
|
|
}
|
|
}
|
|
if (!created)
|
|
WaitForSingleObject(m->h, INFINITE);
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_mutex_unlock(heim_mutex_t *m)
|
|
{
|
|
if (ReleaseSemaphore(m->h, 1, NULL) == FALSE)
|
|
return EPERM;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_mutex_destroy(heim_mutex_t *m)
|
|
{
|
|
HANDLE h;
|
|
|
|
h = InterlockedCompareExchangePointer(&m->h, INVALID_HANDLE_VALUE, m->h);
|
|
if (h != INVALID_HANDLE_VALUE)
|
|
CloseHandle(h);
|
|
return 0;
|
|
}
|
|
|
|
#define HEIMDAL_MUTEX heim_mutex_t
|
|
#define HEIMDAL_MUTEX_INITIALIZER { INVALID_HANDLE_VALUE }
|
|
#define HEIMDAL_MUTEX_init(m) heim_mutex_init((m))
|
|
#define HEIMDAL_MUTEX_lock(m) heim_mutex_lock((m))
|
|
#define HEIMDAL_MUTEX_unlock(m) heim_mutex_unlock((m))
|
|
#define HEIMDAL_MUTEX_destroy(m) heim_mutex_destroy((m))
|
|
|
|
typedef struct heim_rwlock {
|
|
SRWLOCK lock;
|
|
int exclusive;
|
|
} heim_rwlock_t;
|
|
|
|
static inline int
|
|
heim_rwlock_init(heim_rwlock_t *l)
|
|
{
|
|
InitializeSRWLock(&l->lock);
|
|
l->exclusive = 0;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_rdlock(heim_rwlock_t *l)
|
|
{
|
|
AcquireSRWLockShared(&l->lock);
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_wrlock(heim_rwlock_t *l)
|
|
{
|
|
AcquireSRWLockExclusive(&l->lock);
|
|
l->exclusive = 1;
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_tryrdlock(heim_rwlock_t *l)
|
|
{
|
|
if (TryAcquireSRWLockShared(&l->lock))
|
|
return 0;
|
|
return EBUSY;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_trywrlock(heim_rwlock_t *l)
|
|
{
|
|
if (TryAcquireSRWLockExclusive(&l->lock))
|
|
return 0;
|
|
return EBUSY;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_unlock(heim_rwlock_t *l)
|
|
{
|
|
if (l->exclusive) {
|
|
l->exclusive = 0;
|
|
ReleaseSRWLockExclusive(&(l)->lock);
|
|
} else {
|
|
ReleaseSRWLockShared(&(l)->lock);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static inline int
|
|
heim_rwlock_destroy(heim_rwlock_t *l)
|
|
{
|
|
/* SRW locks cannot be destroyed so re-initialize */
|
|
InitializeSRWLock(&l->lock);
|
|
l->exclusive = 0;
|
|
return 0;
|
|
}
|
|
|
|
#define HEIMDAL_RWLOCK heim_rwlock_t
|
|
#define HEIMDAL_RWLOCK_INITIALIZER {SRWLOCK_INIT, 0}
|
|
#define HEIMDAL_RWLOCK_init(l) heim_rwlock_init((l))
|
|
#define HEIMDAL_RWLOCK_rdlock(l) heim_rwlock_rdlock((l))
|
|
#define HEIMDAL_RWLOCK_wrlock(l) heim_rwlock_wrlock((l))
|
|
#define HEIMDAL_RWLOCK_tryrdlock(l) heim_rwlock_tryrdlock((l))
|
|
#define HEIMDAL_RWLOCK_trywrlock(l) heim_rwlock_trywrlock((l))
|
|
#define HEIMDAL_RWLOCK_unlock(l) heim_rwlock_unlock((l))
|
|
#define HEIMDAL_RWLOCK_destroy(l) heim_rwlock_destroy((l))
|
|
|
|
#define HEIMDAL_thread_key unsigned long
|
|
#define HEIM_PRIV_thread_key HEIMDAL_thread_key
|
|
#define HEIMDAL_key_create(k,d,r) do { r = heim_w32_key_create(k,d); } while(0)
|
|
#define HEIMDAL_setspecific(k,s,r) do { r = heim_w32_setspecific(k,s); } while(0)
|
|
#define HEIMDAL_getspecific(k) (heim_w32_getspecific(k))
|
|
#define HEIMDAL_key_delete(k) (heim_w32_delete_key(k))
|
|
|
|
#define HEIMDAL_THREAD_ID DWORD
|
|
#define HEIMDAL_THREAD_create(t,f,a) \
|
|
((CreateThread(0, 0, (f), (a), 0, (t)) == INVALID_HANDLE_VALUE) ? EINVAL : 0)
|
|
|
|
#elif defined(HEIMDAL_DEBUG_THREADS)
|
|
|
|
/* no threads support, just do consistency checks */
|
|
#include <stdlib.h>
|
|
|
|
#define HEIMDAL_MUTEX int
|
|
#define HEIMDAL_MUTEX_INITIALIZER 0
|
|
#define HEIMDAL_MUTEX_init(m) do { (*(m)) = 0; } while(0)
|
|
#define HEIMDAL_MUTEX_lock(m) do { if ((*(m))++ != 0) abort(); } while(0)
|
|
#define HEIMDAL_MUTEX_unlock(m) do { if ((*(m))-- != 1) abort(); } while(0)
|
|
#define HEIMDAL_MUTEX_destroy(m) do {if ((*(m)) != 0) abort(); } while(0)
|
|
|
|
#define HEIMDAL_RWLOCK rwlock_t int
|
|
#define HEIMDAL_RWLOCK_INITIALIZER 0
|
|
#define HEIMDAL_RWLOCK_init(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_rdlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_wrlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_tryrdlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_trywrlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_unlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_destroy(l) do { } while(0)
|
|
|
|
#define HEIMDAL_internal_thread_key 1
|
|
|
|
#define HEIMDAL_THREAD_ID int
|
|
#define HEIMDAL_THREAD_create(t,f,a) abort()
|
|
|
|
#else /* no thread support, no debug case */
|
|
|
|
#define HEIMDAL_MUTEX int
|
|
#define HEIMDAL_MUTEX_INITIALIZER 0
|
|
#define HEIMDAL_MUTEX_init(m) do { (void)(m); } while(0)
|
|
#define HEIMDAL_MUTEX_lock(m) do { (void)(m); } while(0)
|
|
#define HEIMDAL_MUTEX_unlock(m) do { (void)(m); } while(0)
|
|
#define HEIMDAL_MUTEX_destroy(m) do { (void)(m); } while(0)
|
|
|
|
#define HEIMDAL_RWLOCK rwlock_t int
|
|
#define HEIMDAL_RWLOCK_INITIALIZER 0
|
|
#define HEIMDAL_RWLOCK_init(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_rdlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_wrlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_tryrdlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_trywrlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_unlock(l) do { } while(0)
|
|
#define HEIMDAL_RWLOCK_destroy(l) do { } while(0)
|
|
|
|
#define HEIMDAL_THREAD_ID int
|
|
#define HEIMDAL_THREAD_create(t,f,a) abort()
|
|
|
|
#define HEIMDAL_internal_thread_key 1
|
|
|
|
#endif /* no thread support */
|
|
|
|
#ifdef HEIMDAL_internal_thread_key
|
|
|
|
typedef struct heim_thread_key {
|
|
void *value;
|
|
void (*destructor)(void *);
|
|
} heim_thread_key;
|
|
|
|
#define HEIMDAL_thread_key heim_thread_key
|
|
#define HEIMDAL_key_create(k,d,r) \
|
|
do { (k)->value = NULL; (k)->destructor = (d); r = 0; } while(0)
|
|
#define HEIMDAL_setspecific(k,s,r) do { (k).value = s ; r = 0; } while(0)
|
|
#define HEIMDAL_getspecific(k) ((k).value)
|
|
#define HEIMDAL_key_delete(k) do { (*(k).destructor)((k).value); } while(0)
|
|
|
|
#undef HEIMDAL_internal_thread_key
|
|
#endif /* HEIMDAL_internal_thread_key */
|
|
|
|
int heim_w32_key_create(HEIM_PRIV_thread_key *, void (*)(void *));
|
|
int heim_w32_delete_key(HEIM_PRIV_thread_key);
|
|
int heim_w32_setspecific(HEIM_PRIV_thread_key, void *);
|
|
void *heim_w32_getspecific(HEIM_PRIV_thread_key);
|
|
|
|
#endif /* HEIM_THREADS_H */
|