Menu
▾
▴
[Nagios-checkins] SF.net SVN: nagios:[2675] nagioscore/trunk/lib
|
From: <ag...@us...> - 2013-03-21 09:19:02
|
Revision: 2675
http://nagios.svn.sourceforge.net/nagios/?rev=2675&view=rev
Author: ageric
Date: 2013-03-21 09:18:52 +0000 (Thu, 21 Mar 2013)
Log Message:
-----------
libnagios headers: Janitor patch; Pre-revamp cleanup is Such Fun(tm)
We do rename the CMD_HAS* macros to RUNCMD_HAS* here, but since
they aren't used by any of the larger modules anyway, we might as
well do it before people start using them.
Signed-off-by: Andreas Ericsson <ae...@op...>
Modified Paths:
--------------
nagioscore/trunk/lib/bitmap.h
nagioscore/trunk/lib/dkhash.h
nagioscore/trunk/lib/iobroker.h
nagioscore/trunk/lib/iocache.h
nagioscore/trunk/lib/kvvec.h
nagioscore/trunk/lib/libnagios.h
nagioscore/trunk/lib/lnag-utils.h
nagioscore/trunk/lib/nsock.h
nagioscore/trunk/lib/nspath.h
nagioscore/trunk/lib/pqueue.h
nagioscore/trunk/lib/runcmd.c
nagioscore/trunk/lib/runcmd.h
nagioscore/trunk/lib/skiplist.h
nagioscore/trunk/lib/squeue.h
nagioscore/trunk/lib/worker.h
Modified: nagioscore/trunk/lib/bitmap.h
===================================================================
--- nagioscore/trunk/lib/bitmap.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/bitmap.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,8 +1,12 @@
#ifndef LIBNAGIOS_bitmap_h__
#define LIBNAGIOS_bitmap_h__
+
/**
* @file bitmap.h
* @brief Bit map API
+ *
+ * The bitmap api is useful for running set operations on objects
+ * indexed by unsigned integers.
* @{
*/
struct bitmap;
Modified: nagioscore/trunk/lib/dkhash.h
===================================================================
--- nagioscore/trunk/lib/dkhash.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/dkhash.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -10,6 +10,8 @@
* much data in Nagios pertains to services (which are uniquely
* identified based on both host_name and service_description), it
* makes sense here.
+ *
+ * @{
*/
/** return flags usable from the callback function of dkhash_walk_data() */
@@ -128,4 +130,5 @@
* @return Number of bucket-slots in hash table
*/
extern unsigned int dkhash_table_size(dkhash_table *t);
+/** @} */
#endif /* LIBNAGIOS_dkhash_h__ */
Modified: nagioscore/trunk/lib/iobroker.h
===================================================================
--- nagioscore/trunk/lib/iobroker.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/iobroker.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,10 +1,16 @@
-#ifndef INCLUDE_iobroker_h__
-#define INCLUDE_iobroker_h__
+#ifndef LIBNAGIOS_iobroker_h__
+#define LIBNAGIOS_iobroker_h__
/**
* @file iobroker.h
* @brief I/O broker library function declarations
*
+ * The I/O broker library handles multiplexing between hundreds or
+ * thousands of sockets with a few simple calls. It's designed to
+ * be as lightweight as possible so as to not cause memory bloat,
+ * and is therefore highly suitable for use by processes that are
+ * fork()-intensive.
+ *
* @{
*/
Modified: nagioscore/trunk/lib/iocache.h
===================================================================
--- nagioscore/trunk/lib/iocache.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/iocache.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,5 +1,5 @@
-#ifndef INCLUDE_iocache_h__
-#define INCLUDE_iocache_h__
+#ifndef LIBNAGIOS_iocache_h__
+#define LIBNAGIOS_iocache_h__
#include <stdlib.h>
#include <sys/types.h>
#include <sys/socket.h>
Modified: nagioscore/trunk/lib/kvvec.h
===================================================================
--- nagioscore/trunk/lib/kvvec.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/kvvec.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,5 +1,5 @@
-#ifndef INCLUDE_kvvec_h__
-#define INCLUDE_kvvec_h__
+#ifndef LIBNAGIOS_kvvec_h__
+#define LIBNAGIOS_kvvec_h__
/**
* @file kvvec.h
@@ -8,6 +8,7 @@
* The kvvec library is nifty as either a configuration meta-format
* or for IPC purposes. Take a look at the buf2kvvec() and kvvec2buf()
* pair of functions for the latter.
+ * @{
*/
/**
@@ -195,4 +196,5 @@
* @return The number of pairs in the created key/value vector
*/
extern int buf2kvvec_prealloc(struct kvvec *kvv, char *str, unsigned int len, const char kvsep, const char pair_sep, int flags);
+/** @} */
#endif /* INCLUDE_kvvec_h__ */
Modified: nagioscore/trunk/lib/libnagios.h
===================================================================
--- nagioscore/trunk/lib/libnagios.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/libnagios.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,3 +1,5 @@
+#ifndef LIBNAGIOS_libnagios_h__
+#define LIBNAGIOS_libnagios_h__
/**
* @file libnagios.h
*
@@ -4,9 +6,8 @@
* @brief Include this for all public parts of libnagios to be accessible
*/
-#ifndef LIB_libnagios_h__
-#define LIB_libnagios_h__
#include "lnag-utils.h"
+#include "nsutils.h"
#include "pqueue.h"
#include "squeue.h"
#include "kvvec.h"
Modified: nagioscore/trunk/lib/lnag-utils.h
===================================================================
--- nagioscore/trunk/lib/lnag-utils.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/lnag-utils.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -6,15 +6,16 @@
/**
* @file lnag-utils.h
- * @brief libnagios helper functions that lack a "real" home.
+ * @brief libnagios helper and compatibility macros that lack a "real" home.
*
+ * This is the home of random macros that must be present for compilation
+ * to succeed but are missing on some platforms.
+ *
* @{
*/
#ifdef __cplusplus
-/**
- * C++ compatibility macro that avoids confusing indentation programs
- */
+/** C++ compatibility macro that avoids confusing indentation programs */
# define NAGIOS_BEGIN_DECL extern "C" {
/**
* Use at end of header file declarations to obtain C++ compatibility
@@ -22,7 +23,9 @@
*/
# define NAGIOS_END_DECL }
#else
+/** C++ compatibility macro that avoids confusing indentation programs */
# define NAGIOS_BEGIN_DECL /* nothing */
+/** C++ compatibility macro that avoid confusing indentation programs */
# define NAGIOS_END_DECL /* more of nothing */
#endif
@@ -45,7 +48,7 @@
#ifdef TRUE
#undef TRUE
#endif
-#define TRUE (!FALSE) /** Not false */
+#define TRUE (!FALSE) /**< Not false */
/** Useful macro to safely avoid double-free memory corruption */
#define my_free(ptr) do { if(ptr) { free(ptr); ptr = NULL; } } while(0)
@@ -60,6 +63,7 @@
#endif
#ifndef offsetof
+/** standard offsetof macro */
# define offsetof(t, f) ((unsigned long)&((t *)0)->f)
#endif
@@ -179,4 +183,4 @@
NAGIOS_END_DECL
/** @} */
-#endif /* NAGIOSINCLUDE_pp_utils_h__ */
+#endif
Modified: nagioscore/trunk/lib/nsock.h
===================================================================
--- nagioscore/trunk/lib/nsock.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/nsock.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,3 +1,7 @@
+#ifndef LIBNAGIOS_nsock_h__
+#define LIBNAGIOS_nsock_h__
+#include <errno.h>
+
/**
* @file nsock.h
* @brief Nagios socket helper library
@@ -6,12 +10,10 @@
* now Nagios core itself makes use of sockets, we might as well
* have some simple wrappers for it that handle the most common
* cases.
+ *
+ * @{
*/
-#ifndef LIBNAGIOS_nsock_h__
-#define LIBNAGIOS_nsock_h__
-#include <errno.h>
-
#define NSOCK_EBIND (-1) /**< failed to bind() */
#define NSOCK_ELISTEN (-2) /**< failed to listen() */
#define NSOCK_ESOCKET (-3) /**< failed to socket() */
@@ -69,4 +71,6 @@
*/
extern int nsock_printf(int sd, const char *fmt, ...)
__attribute__((__format__(__printf__, 2, 3)));
+
+/** @} */
#endif /* LIBNAGIOS_nsock_h__ */
Modified: nagioscore/trunk/lib/nspath.h
===================================================================
--- nagioscore/trunk/lib/nspath.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/nspath.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,3 +1,12 @@
+#ifndef LIBNAGIOS_nspath_h__
+#define LIBNAGIOS_nspath_h__
+#ifndef _GNU_SOURCE
+# define _GNU_SOURCE 1
+#endif
+#include <errno.h>
+#include <sys/stat.h>
+#include "snprintf.h"
+
/**
* @file nspath.h
* @brief path handling functions
@@ -10,11 +19,6 @@
* @{
*/
-#define _GNU_SOURCE 1
-#include <errno.h>
-#include <sys/stat.h>
-#include "snprintf.h"
-
/**
* Normalize a path
* By "normalize", we mean that we convert dot-slash and dot-dot-slash
@@ -81,4 +85,4 @@
/** Don't mkdir() last element of path when calling nspath_mkdir_p() */
#define NSPATH_MKDIR_SKIP_LAST (1 << 0)
-/* @} */
+/** @} */
Modified: nagioscore/trunk/lib/pqueue.h
===================================================================
--- nagioscore/trunk/lib/pqueue.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/pqueue.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -14,28 +14,25 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-/*
- * Altered for Nagios by Andreas Ericsson <ae...@op...> with the excplicit
- * consent of Volkan Yazici <vol...@gm...>. Many thanks.
- * Changed as follows:
- *
- * - pqueue_pri_t is an unsigned long long instead of a double
- * ull comparisons are 107 times faster than double comparisons
- * on my 64-bit laptop
- */
+#ifndef LIBNAGIOS_pqueue_h__
+#define LIBNAGIOS_pqueue_h__
+#include <stdio.h>
/**
* @file pqueue.h
* @brief Priority Queue function declarations
*
+ * This priority queue library was originally written by Volkan Yazici
+ * <vol...@gm...>. It was lated adapted for Nagios by
+ * Andreas Ericsson <ae...@op...>. Changes compared to the original
+ * version are pretty much limited to changing pqueue_pri_t to be
+ * an unsigned long long instead of a double, since ULL comparisons
+ * are 107 times faster on my 64-bit laptop.
+ *
* @{
*/
-#ifndef LIB_pqueue_h__
-#define LIB_pqueue_h__
-#include <stdio.h>
-
/** priority data type (used to be double, but ull is 107 times faster) */
typedef unsigned long long pqueue_pri_t;
@@ -184,6 +181,5 @@
*/
int pqueue_is_valid(pqueue_t *q);
-
-#endif /* PQUEUE_H */
+#endif
/** @} */
Modified: nagioscore/trunk/lib/runcmd.c
===================================================================
--- nagioscore/trunk/lib/runcmd.c 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/runcmd.c 2013-03-21 09:18:52 UTC (rev 2675)
@@ -193,13 +193,13 @@
case '|':
if (!in_quotes) {
- add_ret(CMD_HAS_REDIR);
+ add_ret(RUNCMD_HAS_REDIR);
}
break;
case '&': case ';':
if (!in_quotes) {
set_state(STATE_SPECIAL);
- add_ret(CMD_HAS_JOBCONTROL);
+ add_ret(RUNCMD_HAS_JOBCONTROL);
if (i && str[i - 1] != *p) {
argz[a++] = 0;
out_argv[arg++] = &argz[a];
@@ -209,28 +209,28 @@
case '`':
if (!(state & STATE_INSQ)) {
- add_ret(CMD_HAS_SUBCOMMAND);
+ add_ret(RUNCMD_HAS_SUBCOMMAND);
}
break;
case '(': case ')':
if (!in_quotes) {
- add_ret(CMD_HAS_PAREN);
+ add_ret(RUNCMD_HAS_PAREN);
}
break;
case '$':
if (!(state & STATE_INSQ)) {
if (p[1] == '(')
- add_ret(CMD_HAS_SUBCOMMAND);
+ add_ret(RUNCMD_HAS_SUBCOMMAND);
else
- add_ret(CMD_HAS_SHVAR);
+ add_ret(RUNCMD_HAS_SHVAR);
}
break;
case '*': case '?':
if (!in_quotes) {
- add_ret(CMD_HAS_WILDCARD);
+ add_ret(RUNCMD_HAS_WILDCARD);
}
/* fallthrough */
@@ -252,9 +252,9 @@
argz[a++] = 0;
if (have_state(STATE_INSQ))
- add_ret(CMD_HAS_UBSQ);
+ add_ret(RUNCMD_HAS_UBSQ);
if (have_state(STATE_INDQ))
- add_ret(CMD_HAS_UBDQ);
+ add_ret(RUNCMD_HAS_UBDQ);
*out_argc = arg;
Modified: nagioscore/trunk/lib/runcmd.h
===================================================================
--- nagioscore/trunk/lib/runcmd.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/runcmd.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,6 +1,5 @@
-#ifndef INCLUDE_runcmd_h__
-#define INCLUDE_runcmd_h__
-
+#ifndef LIBNAGIOS_runcmd_h__
+#define LIBNAGIOS_runcmd_h__
#include <signal.h>
/**
@@ -8,20 +7,20 @@
* @brief runcmd library function declarations
*
* @note This is inherited from the nagiosplugins project, although
- * I (AE) wrote the original code, and it might need of refactoring
+ * I (AE) wrote the original code, and it might need refactoring
* for performance later.
* @{
*/
/** Return code bitflags for runcmd_cmd2strv() */
-#define CMD_HAS_REDIR (1 << 0) /**< I/O redirection */
-#define CMD_HAS_SUBCOMMAND (1 << 1) /**< subcommands present */
-#define CMD_HAS_PAREN (1 << 2) /**< parentheses present in command */
-#define CMD_HAS_JOBCONTROL (1 << 3) /**< job control stuff present */
-#define CMD_HAS_UBSQ (1 << 4) /**< unbalanced single quotes */
-#define CMD_HAS_UBDQ (1 << 5) /**< unbalanced double quotes */
-#define CMD_HAS_WILDCARD (1 << 6) /**< wildcards present */
-#define CMD_HAS_SHVAR (1 << 7) /**< shell variables present */
+#define RUNCMD_HAS_REDIR (1 << 0) /**< I/O redirection */
+#define RUNCMD_HAS_SUBCOMMAND (1 << 1) /**< subcommands present */
+#define RUNCMD_HAS_PAREN (1 << 2) /**< parentheses present in command */
+#define RUNCMD_HAS_JOBCONTROL (1 << 3) /**< job control stuff present */
+#define RUNCMD_HAS_UBSQ (1 << 4) /**< unbalanced single quotes */
+#define RUNCMD_HAS_UBDQ (1 << 5) /**< unbalanced double quotes */
+#define RUNCMD_HAS_WILDCARD (1 << 6) /**< wildcards present */
+#define RUNCMD_HAS_SHVAR (1 << 7) /**< shell variables present */
#define RUNCMD_EFD (-1) /**< Failed to pipe() or open() */
@@ -86,7 +85,7 @@
* @param[out] out_argv The argument vector
* @return 0 on (great) success, or a bitmask of failure-codes
* representing f.e. unclosed quotes, job control or output redirection.
- * See the CMD_HAS_* and their ilk to find out about the flag.
+ * See the RUNCMD_HAS_* and their ilk to find out about the flag.
*/
extern int runcmd_cmd2strv(const char *str, int *out_argc, char **out_argv);
Modified: nagioscore/trunk/lib/skiplist.h
===================================================================
--- nagioscore/trunk/lib/skiplist.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/skiplist.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -19,13 +19,16 @@
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
************************************************************************/
-#ifndef _SKIPLIST_H
-#define _SKIPLIST_H
+#ifndef LIBNAGIOS_skiplist_h__
+#define LIBNAGIOS_skiplist_h__
#include "lnag-utils.h"
/**
* @file skiplist.h
* @brief Skiplist library functions
+ *
+ * http://en.wikipedia.org/wiki/Skiplist
+ *
* @{
*/
Modified: nagioscore/trunk/lib/squeue.h
===================================================================
--- nagioscore/trunk/lib/squeue.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/squeue.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,3 +1,8 @@
+#ifndef LIBNAGIOS_squeue_h__
+#define LIBNAGIOS_squeue_h__
+#include <sys/time.h>
+#include <time.h>
+#include "pqueue.h"
/**
* @file squeue.h
* @brief Scheduling queue function declarations
@@ -7,13 +12,9 @@
* for insert() and remove(), and O(1) time for peek().
* @note There is no "find". Callers must maintain pointers to their
* scheduled events if they wish to be able to remove them.
+ *
* @{
*/
-#ifndef INCLUDE_squeue_h__
-#define INCLUDE_squeue_h__
-#include <sys/time.h>
-#include <time.h>
-#include "pqueue.h"
/*
* All opaque types here.
Modified: nagioscore/trunk/lib/worker.h
===================================================================
--- nagioscore/trunk/lib/worker.h 2013-03-21 04:56:55 UTC (rev 2674)
+++ nagioscore/trunk/lib/worker.h 2013-03-21 09:18:52 UTC (rev 2675)
@@ -1,5 +1,5 @@
-#ifndef INCLUDE_worker_h__
-#define INCLUDE_worker_h__
+#ifndef LIBNAGIOS_worker_h__
+#define LIBNAGIOS_worker_h__
#include <errno.h>
#include <sys/socket.h>
#include <stdio.h>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|