/*
- * Copyright (C) 1997-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
*
* Licensed under the GPL v2. For licencing details see COPYING.
*/
#include <sys/un.h> /* needed by create_pf_socket */
#include <string.h>
#include <assert.h>
+#include <stdbool.h>
#include "gcc-compat.h"
/** used in various contexts */
typeof(x) _x = (x); \
_x > 0? _x : -_x; })
+
+extern __printf_2_3 void (*para_log)(int, const char*, ...);
/**
* Define a standard log function that always writes to stderr.
*
+ * \param funcname The name of the function to be defined.
+ *
* \param loglevel_barrier If the loglevel of the current message
* is less than that, the message is going to be ignored.
*
*/
-#define INIT_STDERR_LOGGING(loglevel_barrier) \
- __printf_2_3 void para_log(int ll, const char* fmt,...) \
+#define DEFINE_STDERR_LOGGER(funcname, loglevel_barrier) \
+ static __printf_2_3 void funcname(int ll, const char* fmt,...) \
{ \
va_list argp; \
if (ll < loglevel_barrier) \
vfprintf(stderr, fmt, argp); \
va_end(argp); \
}
-
-/** Version text used by various commands if -V switch was given. */
-#define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION \
- " (" GIT_VERSION ": " CODENAME ")" "\n" \
- "Copyright (C) 2010 Andre Noll\n" \
- "This is free software with ABSOLUTELY NO WARRANTY." \
- " See COPYING for details.\n" \
- "Written by Andre Noll.\n" \
- "Report bugs to <maan@systemlinux.org>.\n"
-
-/** Print out \p VERSION_TEXT and exit if version flag was given. */
-#define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
- if (_args_info_struct.version_given) { \
- printf("%s", VERSION_TEXT(_prefix)); \
- exit(EXIT_SUCCESS); \
- }
+/**
+ * Define the standard log function and activate it.
+ *
+ * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER.
+ */
+#define INIT_STDERR_LOGGING(loglevel_barrier) \
+ DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \
+ __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
/** Sent by para_client to initiate the authentication procedure. */
#define AUTH_REQUEST_MSG "auth rsa "
-/** Sent by para_server for commands that expect a data file. */
-#define AWAITING_DATA_MSG "\nAwaiting Data."
-/** Sent by para_server if authentication was successful. */
-#define PROCEED_MSG "Proceed."
-/** Length of the \p PROCEED_MSG string. */
-#define PROCEED_MSG_LEN strlen(PROCEED_MSG)
-/** Sent by para_client to indicate the end of the command line. */
-#define EOC_MSG "\nEnd of Command."
/* exec */
int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
/* time */
-int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff);
-long unsigned tv2ms(const struct timeval*);
-void d2tv(double, struct timeval*);
-void tv_add(const struct timeval*, const struct timeval *, struct timeval *);
-void tv_scale(const unsigned long, const struct timeval *, struct timeval *);
+int tv_diff(const struct timeval *b, const struct timeval *a,
+ struct timeval *diff);
+long unsigned tv2ms(const struct timeval *tv);
+void d2tv(double x, struct timeval *tv);
+void tv_add(const struct timeval *a, const struct timeval *b,
+ struct timeval *sum);
+void tv_scale(const unsigned long mult, const struct timeval *tv,
+ struct timeval *result);
void tv_divide(const unsigned long divisor, const struct timeval *tv,
- struct timeval *result);
+ struct timeval *result);
int tv_convex_combination(const long a, const struct timeval *tv1,
const long b, const struct timeval *tv2,
struct timeval *result);
-void ms2tv(const long unsigned n, struct timeval *tv);
+void ms2tv(long unsigned n, struct timeval *tv);
void compute_chunk_time(long unsigned chunk_num,
struct timeval *chunk_tv, struct timeval *stream_start,
struct timeval *result);
+struct timeval *clock_get_realtime(struct timeval *tv);
/** The enum of all status items. */
enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS};
int for_each_stat_item(char *item_buf, size_t num_bytes,
int (*item_handler)(int, char *));
-__printf_2_3 void para_log(int, const char*, ...);
/**
- * Write a log message to a dynamically allocated string.
+ * Return a random non-negative integer in an interval.
*
- * \param fmt Usual format string.
- * \param p Result pointer.
+ * \param max Determines maximal possible return value.
*
- * \sa printf(3). */
-#define PARA_VSPRINTF(fmt, p) \
-{ \
- int n; \
- size_t size = 100; \
- p = para_malloc(size); \
- while (1) { \
- va_list ap; \
- /* Try to print in the allocated space. */ \
- va_start(ap, fmt); \
- n = vsnprintf(p, size, fmt, ap); \
- va_end(ap); \
- /* If that worked, return the string. */ \
- if (n > -1 && n < size) \
- break; \
- /* Else try again with more space. */ \
- if (n > -1) /* glibc 2.1 */ \
- size = n + 1; /* precisely what is needed */ \
- else /* glibc 2.0 */ \
- size *= 2; /* twice the old size */ \
- p = para_realloc(p, size); \
- } \
+ * \return An integer between zero and \p max - 1, inclusively.
+ */
+_static_inline_ long int para_random(unsigned max)
+{
+ return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
}
/**
- * Return a random non-negative integer in an interval.
+ * Simple sanity check for I/O vectors.
*
- * \param max Determines maximal possible return value.
+ * \param iov Pointer to the I/O vector to check.
*
- * \return An integer between zero and \p max - 1, inclusively.
+ * \return True if \a iov points to a non-empty buffer.
*/
-_static_inline_ long int para_random(unsigned max)
+_static_inline_ bool iov_valid(const struct iovec *iov)
{
- return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
+ return iov && iov->iov_len > 0 && iov->iov_base;
}
+/** Round up x to next multiple of y. */
+#define ROUND_UP(x, y) ({ \
+ const typeof(y) _divisor = y; \
+ ((x) + _divisor - 1) / _divisor * _divisor; })
+
+/** Round down x to multiple of y. */
+#define ROUND_DOWN(x, y) ({ \
+ const typeof(y) _divisor = y; \
+ (x) / _divisor * _divisor; })
+
/** Divide and round up to next integer. */
#define DIV_ROUND_UP(x, y) ({ \
typeof(y) _divisor = y; \
((x) + _divisor - 1) / _divisor; })
+/**
+ * Assert a build-time dependency, as an expression.
+ *
+ * \param cond The compile-time condition which must be true.
+ *
+ * Compilation will fail if the condition isn't true, or can't be evaluated by
+ * the compiler. This can be used in an expression: its value is "0".
+ *
+ * Taken from ccan.
+ */
+#define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1)
+
+/** &a[0] degrades to a pointer: a different type from an array */
+#define _array_size_chk(arr) EXPR_BUILD_ASSERT(\
+ !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0])))
/** Get the size of an array */
-#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+#define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]) + _array_size_chk(arr))
/**
* Wrapper for isspace.
/** Data that indicates an eof-condition for a fec-encoded stream. */
#define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \
"\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0"
+/** The number of bytes of the \a FEC_EOF_PACKET. */
#define FEC_EOF_PACKET_LEN 32
/** Used to avoid a shortcoming in vim's syntax highlighting. */
#define EMBRACE(...) { __VA_ARGS__}
+/** A nice cup of STFU for Mr gcc. */
+#define do_nothing do {/* nothing */} while (0)
+
/**
* The sample formats supported by paraslash.
*
SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \
SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \
+/** \cond sample_format */
#define SAMPLE_FORMAT(a, b) a
enum sample_format {SAMPLE_FORMATS};
#undef SAMPLE_FORMAT
#define SAMPLE_FORMAT(a, b) b
+/** \endcond sample_format */
/** Debug loglevel, gets really noisy. */
#define LL_DEBUG 0
/** Log messages with lower priority than that will not be compiled in. */
#define COMPILE_TIME_LOGLEVEL 0
-/** \cond */
+/** \cond log */
#if LL_DEBUG >= COMPILE_TIME_LOGLEVEL
#define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
#else
#else
#define PARA_EMERG_LOG(...)
#endif
-/** \endcond */
+/** \endcond log */
projects / paraslash.git / blobdiff