platform.h

/*
 * vim: ts=8:sw=8:tw=79:noet
 *
 * Copyright (c) 2011-2012, the Locksmith authors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 
 * 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.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.
 */

#ifndef LKSMITH_UTIL_PLATFORM_H
#define LKSMITH_UTIL_PLATFORM_H

/**
 * Interface for making platform-specific calls.
 */

#include <unistd.h> /* for size_t */

/**
 * Create a name for the current thread.
 *
 * If the platform supports getting the kernel thread ID, we will retrieve
 * that.  Otherwise, we'll create an arbitrary identifier.
 *
 * @param out		(out param) the buffer to write to
 * @param out_len	length of the out buffer
 */
void platform_create_thread_name(char * __restrict out, size_t out_len);

/**
 * Find a function named 'fname' in a library other than the current one.  We
 * need this to forward methods that we have intercepted onwards to the
 * "real" pthreads functions.
 *
 * @param fname		The function name to look for
 *
 * @return		NULL if the function could not be found; the function
 *			pointer otherwise.  Technically, a void pointer should
 *			never be cast to a function pointer, since the C
 *			standard allows them to have different sizes.  However,
 *			the POSIX dlsym functions we're calling ignore this
 *			nicety, and alternative interfaces are not available.
 *			So there seems to be little point in being pedantic about
 *			it in the code.
 */
void* get_dlsym_next(const char *fname);

#endif