src/ipc.c

   1 /**
   2  * collectd - src/ipc.c, based on src/memcached.c
   3  * Copyright (C) 2010       Andres J. Diaz <ajdiaz@connectical.com>
   4  * Copyright (C) 2010       Manuel L. Sanmartin <manuel.luis@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License as published by the
   8  * Free Software Foundation; either version 2 of the License, or (at your
   9  * option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  *
  20  * Authors:
  21  *   Andres J. Diaz <ajdiaz@connectical.com>
  22  *   Manuel L. Sanmartin <manuel.luis@gmail>
  23  **/
  24
  25 /* Many of this code is based on busybox ipc implementation, which is:
  26  *   (C) Rodney Radford <rradford@mindspring.com> and distributed under GPLv2.
  27  */
  28
  29 #include "collectd.h"
  30
  31 #include "common.h"
  32 #include "plugin.h"
  33
  34 #if KERNEL_LINUX
  35 /* _GNU_SOURCE is needed for struct shm_info.used_ids on musl libc */
  36 #define _GNU_SOURCE
  37
  38 /* X/OPEN tells us to use <sys/{types,ipc,sem}.h> for semctl() */
  39 /* X/OPEN tells us to use <sys/{types,ipc,msg}.h> for msgctl() */
  40 /* X/OPEN tells us to use <sys/{types,ipc,shm}.h> for shmctl() */
  41 #include <sys/ipc.h>
  42 #include <sys/msg.h>
  43 #include <sys/sem.h>
  44 #include <sys/shm.h>
  45 #include <sys/types.h>
  46
  47 /* For older kernels the same holds for the defines below */
  48 #ifndef MSG_STAT
  49 #define MSG_STAT 11
  50 #define MSG_INFO 12
  51 #endif
  52
  53 #ifndef SHM_STAT
  54 #define SHM_STAT 13
  55 #define SHM_INFO 14
  56 struct shm_info {
  57   int used_ids;
  58   ulong shm_tot; /* total allocated shm */
  59   ulong shm_rss; /* total resident shm */
  60   ulong shm_swp; /* total swapped shm */
  61   ulong swap_attempts;
  62   ulong swap_successes;
  63 };
  64 #endif
  65
  66 #ifndef SEM_STAT
  67 #define SEM_STAT 18
  68 #define SEM_INFO 19
  69 #endif
  70
  71 /* The last arg of semctl is a union semun, but where is it defined?
  72    X/OPEN tells us to define it ourselves, but until recently
  73    Linux include files would also define it. */
  74 #if defined(__GNU_LIBRARY__) && !defined(_SEM_SEMUN_UNDEFINED)
  75 /* union semun is defined by including <sys/sem.h> */
  76 #else
  77 /* according to X/OPEN we have to define it ourselves */
  78 union semun {
  79   int val;
  80   struct semid_ds *buf;
  81   unsigned short *array;
  82   struct seminfo *__buf;
  83 };
  84 #endif
  85 static long pagesize_g;
  86 /* #endif  KERNEL_LINUX */
  87 #elif KERNEL_AIX
  88 #include <sys/ipc_info.h>
  89 /* #endif KERNEL_AIX */
  90 #else
  91 #error "No applicable input method."
  92 #endif
  93
  94 __attribute__((nonnull(1))) static void
  95 ipc_submit_g(const char *plugin_instance, const char *type,
  96              const char *type_instance, gauge_t value) /* {{{ */
  97 {
  98   value_list_t vl = VALUE_LIST_INIT;
  99
 100   vl.values = &(value_t){.gauge = value};
 101   vl.values_len = 1;
 102   sstrncpy(vl.plugin, "ipc", sizeof(vl.plugin));
 103   sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
 104   sstrncpy(vl.type, type, sizeof(vl.type));
 105   if (type_instance != NULL)
 106     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
 107
 108   plugin_dispatch_values(&vl);
 109 } /* }}} */
 110
 111 #if KERNEL_LINUX
 112 static int ipc_read_sem(void) /* {{{ */
 113 {
 114   struct seminfo seminfo;
 115   union semun arg;
 116   int status;
 117
 118   arg.array = (void *)&seminfo;
 119
 120   status = semctl(/* id = */ 0, /* num = */ 0, SEM_INFO, arg);
 121   if (status == -1) {
 122     ERROR("ipc plugin: semctl(2) failed: %s. "
 123           "Maybe the kernel is not configured for semaphores?",
 124           STRERRNO);
 125     return -1;
 126   }
 127
 128   ipc_submit_g("sem", "count", "arrays", seminfo.semusz);
 129   ipc_submit_g("sem", "count", "total", seminfo.semaem);
 130
 131   return 0;
 132 } /* }}} int ipc_read_sem */
 133
 134 static int ipc_read_shm(void) /* {{{ */
 135 {
 136   struct shm_info shm_info;
 137   int status;
 138
 139   status = shmctl(/* id = */ 0, SHM_INFO, (void *)&shm_info);
 140   if (status == -1) {
 141     ERROR("ipc plugin: shmctl(2) failed: %s. "
 142           "Maybe the kernel is not configured for shared memory?",
 143           STRERRNO);
 144     return -1;
 145   }
 146
 147   ipc_submit_g("shm", "segments", NULL, shm_info.used_ids);
 148   ipc_submit_g("shm", "bytes", "total", shm_info.shm_tot * pagesize_g);
 149   ipc_submit_g("shm", "bytes", "rss", shm_info.shm_rss * pagesize_g);
 150   ipc_submit_g("shm", "bytes", "swapped", shm_info.shm_swp * pagesize_g);
 151   return 0;
 152 }
 153 /* }}} int ipc_read_shm */
 154
 155 static int ipc_read_msg(void) /* {{{ */
 156 {
 157   struct msginfo msginfo;
 158
 159   if (msgctl(0, MSG_INFO, (struct msqid_ds *)(void *)&msginfo) < 0) {
 160     ERROR("Kernel is not configured for message queues");
 161     return -1;
 162   }
 163   ipc_submit_g("msg", "count", "queues", msginfo.msgmni);
 164   ipc_submit_g("msg", "count", "headers", msginfo.msgmap);
 165   ipc_submit_g("msg", "count", "space", msginfo.msgtql);
 166
 167   return 0;
 168 }
 169 /* }}} int ipc_read_msg */
 170
 171 static int ipc_init(void) /* {{{ */
 172 {
 173   pagesize_g = sysconf(_SC_PAGESIZE);
 174   return 0;
 175 }
 176 /* }}} */
 177 /* #endif KERNEL_LINUX */
 178
 179 #elif KERNEL_AIX
 180 static caddr_t ipc_get_info(cid_t cid, int cmd, int version, int stsize,
 181                             int *nmemb) /* {{{ */
 182 {
 183   int size = 0;
 184   caddr_t buff = NULL;
 185
 186   if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
 187     if (errno != ENOSPC) {
 188       WARNING("ipc plugin: get_ipc_info: %s", STRERRNO);
 189       return NULL;
 190     }
 191   }
 192
 193   if (size == 0)
 194     return NULL;
 195
 196   if (size % stsize) {
 197     ERROR("ipc plugin: ipc_get_info: missmatch struct size and buffer size");
 198     return NULL;
 199   }
 200
 201   *nmemb = size / stsize;
 202
 203   buff = malloc(size);
 204   if (buff == NULL) {
 205     ERROR("ipc plugin: ipc_get_info malloc failed.");
 206     return NULL;
 207   }
 208
 209   if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
 210     WARNING("ipc plugin: get_ipc_info: %s", STRERRNO);
 211     free(buff);
 212     return NULL;
 213   }
 214
 215   return buff;
 216 } /* }}} */
 217
 218 static int ipc_read_sem(void) /* {{{ */
 219 {
 220   ipcinfo_sem_t *ipcinfo_sem;
 221   unsigned short sem_nsems = 0;
 222   unsigned short sems = 0;
 223   int n;
 224
 225   ipcinfo_sem = (ipcinfo_sem_t *)ipc_get_info(
 226       0, GET_IPCINFO_SEM_ALL, IPCINFO_SEM_VERSION, sizeof(ipcinfo_sem_t), &n);
 227   if (ipcinfo_sem == NULL)
 228     return -1;
 229
 230   for (int i = 0; i < n; i++) {
 231     sem_nsems += ipcinfo_sem[i].sem_nsems;
 232     sems++;
 233   }
 234   free(ipcinfo_sem);
 235
 236   ipc_submit_g("sem", "count", "arrays", sem_nsems);
 237   ipc_submit_g("sem", "count", "total", sems);
 238
 239   return 0;
 240 } /* }}} int ipc_read_sem */
 241
 242 static int ipc_read_shm(void) /* {{{ */
 243 {
 244   ipcinfo_shm_t *ipcinfo_shm;
 245   ipcinfo_shm_t *pshm;
 246   unsigned int shm_segments = 0;
 247   size64_t shm_bytes = 0;
 248   int i, n;
 249
 250   ipcinfo_shm = (ipcinfo_shm_t *)ipc_get_info(
 251       0, GET_IPCINFO_SHM_ALL, IPCINFO_SHM_VERSION, sizeof(ipcinfo_shm_t), &n);
 252   if (ipcinfo_shm == NULL)
 253     return -1;
 254
 255   for (i = 0, pshm = ipcinfo_shm; i < n; i++, pshm++) {
 256     shm_segments++;
 257     shm_bytes += pshm->shm_segsz;
 258   }
 259   free(ipcinfo_shm);
 260
 261   ipc_submit_g("shm", "segments", NULL, shm_segments);
 262   ipc_submit_g("shm", "bytes", "total", shm_bytes);
 263
 264   return 0;
 265 }
 266 /* }}} int ipc_read_shm */
 267
 268 static int ipc_read_msg(void) /* {{{ */
 269 {
 270   ipcinfo_msg_t *ipcinfo_msg;
 271   uint32_t msg_used_space = 0;
 272   uint32_t msg_alloc_queues = 0;
 273   msgqnum32_t msg_qnum = 0;
 274   int n;
 275
 276   ipcinfo_msg = (ipcinfo_msg_t *)ipc_get_info(
 277       0, GET_IPCINFO_MSG_ALL, IPCINFO_MSG_VERSION, sizeof(ipcinfo_msg_t), &n);
 278   if (ipcinfo_msg == NULL)
 279     return -1;
 280
 281   for (int i = 0; i < n; i++) {
 282     msg_alloc_queues++;
 283     msg_used_space += ipcinfo_msg[i].msg_cbytes;
 284     msg_qnum += ipcinfo_msg[i].msg_qnum;
 285   }
 286   free(ipcinfo_msg);
 287
 288   ipc_submit_g("msg", "count", "queues", msg_alloc_queues);
 289   ipc_submit_g("msg", "count", "headers", msg_qnum);
 290   ipc_submit_g("msg", "count", "space", msg_used_space);
 291
 292   return 0;
 293 }
 294 /* }}} */
 295 #endif /* KERNEL_AIX */
 296
 297 static int ipc_read(void) /* {{{ */
 298 {
 299   int x = 0;
 300   x |= ipc_read_shm();
 301   x |= ipc_read_sem();
 302   x |= ipc_read_msg();
 303
 304   return x;
 305 }
 306 /* }}} */
 307
 308 void module_register(void) /* {{{ */
 309 {
 310 #ifdef KERNEL_LINUX
 311   plugin_register_init("ipc", ipc_init);
 312 #endif
 313   plugin_register_read("ipc", ipc_read);
 314 }
 315 /* }}} */