plugins/common.h

   1 /*****************************************************************************
   2 *
   3 * Monitoring Plugins common include file
   4 *
   5 * License: GPL
   6 * Copyright (c) 1999 Ethan Galstad (nagios@nagios.org)
   7 * Copyright (c) 2003-2007 Monitoring Plugins Development Team
   8 *
   9 * Description:
  10 *
  11 * This file contains common include files and defines used in many of
  12 * the plugins.
  13 *
  14 *
  15 * This program is free software: you can redistribute it and/or modify
  16 * it under the terms of the GNU General Public License as published by
  17 * the Free Software Foundation, either version 3 of the License, or
  18 * (at your option) any later version.
  19 *
  20 * This program is distributed in the hope that it will be useful,
  21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23 * GNU General Public License for more details.
  24 *
  25 * You should have received a copy of the GNU General Public License
  26 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  27 *
  28 *
  29 *****************************************************************************/
  30
  31 #ifndef _COMMON_H_
  32 #define _COMMON_H_
  33
  34 #include "config.h"
  35
  36 #ifdef HAVE_FEATURES_H
  37 #include <features.h>
  38 #endif
  39
  40 #include <stdio.h>                                                      /* obligatory includes */
  41 #include <stdlib.h>
  42 #include <errno.h>
  43
  44 /* This block provides uintmax_t - should be reported to coreutils that this should be added to fsuage.h */
  45 #if HAVE_INTTYPES_H
  46 # include <inttypes.h>
  47 #endif
  48 #if HAVE_STDINT_H
  49 # include <stdint.h>
  50 #endif
  51 #include <unistd.h>
  52 #ifndef UINTMAX_MAX
  53 # define UINTMAX_MAX ((uintmax_t) -1)
  54 #endif
  55
  56 #include <limits.h>     /* This is assumed true, because coreutils assume it too */
  57
  58 #ifdef HAVE_MATH_H
  59 #include <math.h>
  60 #endif
  61
  62 #ifdef _AIX
  63 #ifdef HAVE_MP_H
  64 #include <mp.h>
  65 #endif
  66 #endif
  67
  68 #ifdef HAVE_STRINGS_H
  69 #include <strings.h>
  70 #endif
  71 #ifdef HAVE_STRING_H
  72 #include <string.h>
  73 #endif
  74
  75 #ifdef HAVE_UNISTD_H
  76 #include <unistd.h>
  77 #endif
  78
  79 /* GET_NUMBER_OF_CPUS is a macro to return
  80    number of CPUs, if we can get that data.
  81    Use configure.in to test for various OS ways of
  82    getting that data
  83    Will return -1 if cannot get data
  84 */
  85 #if defined(HAVE_SYSCONF__SC_NPROCESSORS_ONLN)
  86 # define GET_NUMBER_OF_CPUS() sysconf(_SC_NPROCESSORS_ONLN)
  87 #elif defined (HAVE_SYSCONF__SC_NPROCESSORS_CONF)
  88 # define GET_NUMBER_OF_CPUS() sysconf(_SC_NPROCESSORS_CONF)
  89 #else
  90 # define GET_NUMBER_OF_CPUS() -1
  91 #endif
  92
  93 #ifdef TIME_WITH_SYS_TIME
  94 # include <sys/time.h>
  95 # include <time.h>
  96 #else
  97 # ifdef HAVE_SYS_TIME_H
  98 #  include <sys/time.h>
  99 # else
 100 #  include <time.h>
 101 # endif
 102 #endif
 103
 104 #ifdef HAVE_SYS_TYPES_H
 105 #include <sys/types.h>
 106 #endif
 107
 108 #ifdef HAVE_SYS_SOCKET_H
 109 #include <sys/socket.h>
 110 #endif
 111
 112 #ifdef HAVE_SIGNAL_H
 113 #include <signal.h>
 114 #endif
 115
 116 /* GNU Libraries */
 117 #include <getopt.h>
 118 #include "dirname.h"
 119
 120 #include <locale.h>
 121
 122 #ifdef HAVE_SYS_POLL_H
 123 # include "sys/poll.h"
 124 #endif
 125
 126 /*
 127  *
 128  * Missing Functions
 129  *
 130  */
 131
 132 #ifndef HAVE_STRTOL
 133 # define strtol(a,b,c) atol((a))
 134 #endif
 135
 136 #ifndef HAVE_STRTOUL
 137 # define strtoul(a,b,c) (unsigned long)atol((a))
 138 #endif
 139
 140 /* SSL implementations */
 141 #ifdef HAVE_GNUTLS_OPENSSL_H
 142 #  include <gnutls/openssl.h>
 143 #else
 144 #  define OPENSSL_LOAD_CONF /* See the OPENSSL_config(3) man page. */
 145 #  ifdef HAVE_SSL_H
 146 #    include <rsa.h>
 147 #    include <crypto.h>
 148 #    include <x509.h>
 149 #    include <pem.h>
 150 #    include <ssl.h>
 151 #    include <err.h>
 152 #  else
 153 #    ifdef HAVE_OPENSSL_SSL_H
 154 #      include <openssl/rsa.h>
 155 #      include <openssl/crypto.h>
 156 #      include <openssl/x509.h>
 157 #      include <openssl/pem.h>
 158 #      include <openssl/ssl.h>
 159 #      include <openssl/err.h>
 160 #    endif
 161 #  endif
 162 #endif
 163
 164 /* openssl 1.1 does not set OPENSSL_NO_SSL2 by default but ships without ssl2 */
 165 #ifdef OPENSSL_VERSION_NUMBER
 166 #  if OPENSSL_VERSION_NUMBER >= 0x10100000
 167 #   define OPENSSL_NO_SSL2
 168 #  endif
 169 #endif
 170
 171 /*
 172  *
 173  * Standard Values
 174  *
 175  */
 176
 177 /* MariaDB 10.2 client does not set MYSQL_PORT */
 178 #ifndef MYSQL_PORT
 179 #  define MYSQL_PORT 3306
 180 #endif
 181
 182 enum {
 183         OK = 0,
 184         ERROR = -1
 185 };
 186
 187 /* AIX seems to have this defined somewhere else */
 188 #ifndef FALSE
 189 enum {
 190         FALSE,
 191         TRUE
 192 };
 193 #endif
 194
 195 enum {
 196         STATE_OK,
 197         STATE_WARNING,
 198         STATE_CRITICAL,
 199         STATE_UNKNOWN,
 200         STATE_DEPENDENT
 201 };
 202
 203 enum {
 204         DEFAULT_SOCKET_TIMEOUT = 10,     /* timeout after 10 seconds */
 205         MAX_INPUT_BUFFER = 8192,             /* max size of most buffers we use */
 206         MAX_HOST_ADDRESS_LENGTH = 256    /* max size of a host address */
 207 };
 208
 209 /*
 210  *
 211  * Internationalization
 212  *
 213  */
 214 #include "gettext.h"
 215 #define _(String) gettext (String)
 216 #if ! ENABLE_NLS
 217 # undef textdomain
 218 # define textdomain(Domainname) /* empty */
 219 # undef bindtextdomain
 220 # define bindtextdomain(Domainname, Dirname) /* empty */
 221 #endif
 222
 223 /* For non-GNU compilers to ignore __attribute__ */
 224 #ifndef __GNUC__
 225 # define __attribute__(x) /* do nothing */
 226 #endif
 227
 228 /* Try sysconf(_SC_OPEN_MAX) first, as it can be higher than OPEN_MAX.
 229  * If that fails and the macro isn't defined, we fall back to an educated
 230  * guess. There's no guarantee that our guess is adequate and the program
 231  * will die with SIGSEGV if it isn't and the upper boundary is breached. */
 232 #define DEFAULT_MAXFD  256   /* fallback value if no max open files value is set */
 233 #define MAXFD_LIMIT   8192   /* upper limit of open files */
 234 #ifdef _SC_OPEN_MAX
 235 static long maxfd = 0;
 236 #elif defined(OPEN_MAX)
 237 # define maxfd OPEN_MAX
 238 #else   /* sysconf macro unavailable, so guess (may be wildly inaccurate) */
 239 # define maxfd DEFAULT_MAXFD
 240 #endif
 241
 242 #endif /* _COMMON_H_ */