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>
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.
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.
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
21 * Andres J. Diaz <ajdiaz@connectical.com>
22 * Manuel L. Sanmartin <manuel.luis@gmail>
25 /* Many of this code is based on busybox ipc implementation, which is:
26 * (C) Rodney Radford <rradford@mindspring.com> and distributed under GPLv2.
35 /* _GNU_SOURCE is needed for struct shm_info.used_ids on musl libc */
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() */
45 #include <sys/types.h>
47 /* For older kernels the same holds for the defines below */
58 ulong shm_tot; /* total allocated shm */
59 ulong shm_rss; /* total resident shm */
60 ulong shm_swp; /* total swapped shm */
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> */
77 /* according to X/OPEN we have to define it ourselves */
81 unsigned short *array;
82 struct seminfo *__buf;
85 static long pagesize_g;
86 /* #endif KERNEL_LINUX */
88 #include <sys/ipc_info.h>
89 /* #endif KERNEL_AIX */
91 #error "No applicable input method."
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) /* {{{ */
98 value_list_t vl = VALUE_LIST_INIT;
100 vl.values = &(value_t){.gauge = value};
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));
108 plugin_dispatch_values(&vl);
112 static int ipc_read_sem(void) /* {{{ */
114 struct seminfo seminfo;
118 arg.array = (void *)&seminfo;
120 status = semctl(/* id = */ 0, /* num = */ 0, SEM_INFO, arg);
122 ERROR("ipc plugin: semctl(2) failed: %s. "
123 "Maybe the kernel is not configured for semaphores?",
128 ipc_submit_g("sem", "count", "arrays", seminfo.semusz);
129 ipc_submit_g("sem", "count", "total", seminfo.semaem);
132 } /* }}} int ipc_read_sem */
134 static int ipc_read_shm(void) /* {{{ */
136 struct shm_info shm_info;
139 status = shmctl(/* id = */ 0, SHM_INFO, (void *)&shm_info);
141 ERROR("ipc plugin: shmctl(2) failed: %s. "
142 "Maybe the kernel is not configured for shared memory?",
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);
153 /* }}} int ipc_read_shm */
155 static int ipc_read_msg(void) /* {{{ */
157 struct msginfo msginfo;
159 if (msgctl(0, MSG_INFO, (struct msqid_ds *)(void *)&msginfo) < 0) {
160 ERROR("Kernel is not configured for message queues");
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);
169 /* }}} int ipc_read_msg */
171 static int ipc_init(void) /* {{{ */
173 pagesize_g = sysconf(_SC_PAGESIZE);
177 /* #endif KERNEL_LINUX */
180 static caddr_t ipc_get_info(cid_t cid, int cmd, int version, int stsize,
181 int *nmemb) /* {{{ */
186 if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
187 if (errno != ENOSPC) {
188 WARNING("ipc plugin: get_ipc_info: %s", STRERRNO);
197 ERROR("ipc plugin: ipc_get_info: missmatch struct size and buffer size");
201 *nmemb = size / stsize;
205 ERROR("ipc plugin: ipc_get_info malloc failed.");
209 if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
210 WARNING("ipc plugin: get_ipc_info: %s", STRERRNO);
218 static int ipc_read_sem(void) /* {{{ */
220 ipcinfo_sem_t *ipcinfo_sem;
221 unsigned short sem_nsems = 0;
222 unsigned short sems = 0;
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)
230 for (int i = 0; i < n; i++) {
231 sem_nsems += ipcinfo_sem[i].sem_nsems;
236 ipc_submit_g("sem", "count", "arrays", sem_nsems);
237 ipc_submit_g("sem", "count", "total", sems);
240 } /* }}} int ipc_read_sem */
242 static int ipc_read_shm(void) /* {{{ */
244 ipcinfo_shm_t *ipcinfo_shm;
246 unsigned int shm_segments = 0;
247 size64_t shm_bytes = 0;
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)
255 for (i = 0, pshm = ipcinfo_shm; i < n; i++, pshm++) {
257 shm_bytes += pshm->shm_segsz;
261 ipc_submit_g("shm", "segments", NULL, shm_segments);
262 ipc_submit_g("shm", "bytes", "total", shm_bytes);
266 /* }}} int ipc_read_shm */
268 static int ipc_read_msg(void) /* {{{ */
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;
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)
281 for (int i = 0; i < n; i++) {
283 msg_used_space += ipcinfo_msg[i].msg_cbytes;
284 msg_qnum += ipcinfo_msg[i].msg_qnum;
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);
295 #endif /* KERNEL_AIX */
297 static int ipc_read(void) /* {{{ */
308 void module_register(void) /* {{{ */
311 plugin_register_init("ipc", ipc_init);
313 plugin_register_read("ipc", ipc_read);