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 **/
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 */
29 #include "collectd.h"
31 #include "common.h"
32 #include "plugin.h"
34 #if KERNEL_LINUX
35 /* _GNU_SOURCE is needed for struct shm_info.used_ids on musl libc */
36 #define _GNU_SOURCE
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>
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
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
66 #ifndef SEM_STAT
67 #define SEM_STAT 18
68 #define SEM_INFO 19
69 #endif
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
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_t values[1];
99 value_list_t vl = VALUE_LIST_INIT;
101 values[0].gauge = value;
103 vl.values = values;
104 vl.values_len = 1;
105 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
106 sstrncpy(vl.plugin, "ipc", sizeof(vl.plugin));
107 sstrncpy(vl.plugin_instance, plugin_instance, sizeof(vl.plugin_instance));
108 sstrncpy(vl.type, type, sizeof(vl.type));
109 if (type_instance != NULL)
110 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
112 plugin_dispatch_values(&vl);
113 } /* }}} */
115 #if KERNEL_LINUX
116 static int ipc_read_sem(void) /* {{{ */
117 {
118 struct seminfo seminfo;
119 union semun arg;
120 int status;
122 arg.array = (void *)&seminfo;
124 status = semctl(/* id = */ 0, /* num = */ 0, SEM_INFO, arg);
125 if (status == -1) {
126 char errbuf[1024];
127 ERROR("ipc plugin: semctl(2) failed: %s. "
128 "Maybe the kernel is not configured for semaphores?",
129 sstrerror(errno, errbuf, sizeof(errbuf)));
130 return (-1);
131 }
133 ipc_submit_g("sem", "count", "arrays", seminfo.semusz);
134 ipc_submit_g("sem", "count", "total", seminfo.semaem);
136 return (0);
137 } /* }}} int ipc_read_sem */
139 static int ipc_read_shm(void) /* {{{ */
140 {
141 struct shm_info shm_info;
142 int status;
144 status = shmctl(/* id = */ 0, SHM_INFO, (void *)&shm_info);
145 if (status == -1) {
146 char errbuf[1024];
147 ERROR("ipc plugin: shmctl(2) failed: %s. "
148 "Maybe the kernel is not configured for shared memory?",
149 sstrerror(errno, errbuf, sizeof(errbuf)));
150 return (-1);
151 }
153 ipc_submit_g("shm", "segments", NULL, shm_info.used_ids);
154 ipc_submit_g("shm", "bytes", "total", shm_info.shm_tot * pagesize_g);
155 ipc_submit_g("shm", "bytes", "rss", shm_info.shm_rss * pagesize_g);
156 ipc_submit_g("shm", "bytes", "swapped", shm_info.shm_swp * pagesize_g);
157 return (0);
158 }
159 /* }}} int ipc_read_shm */
161 static int ipc_read_msg(void) /* {{{ */
162 {
163 struct msginfo msginfo;
165 if (msgctl(0, MSG_INFO, (struct msqid_ds *)(void *)&msginfo) < 0) {
166 ERROR("Kernel is not configured for message queues");
167 return (-1);
168 }
169 ipc_submit_g("msg", "count", "queues", msginfo.msgmni);
170 ipc_submit_g("msg", "count", "headers", msginfo.msgmap);
171 ipc_submit_g("msg", "count", "space", msginfo.msgtql);
173 return (0);
174 }
175 /* }}} int ipc_read_msg */
177 static int ipc_init(void) /* {{{ */
178 {
179 pagesize_g = sysconf(_SC_PAGESIZE);
180 return (0);
181 }
182 /* }}} */
183 /* #endif KERNEL_LINUX */
185 #elif KERNEL_AIX
186 static caddr_t ipc_get_info(cid_t cid, int cmd, int version, int stsize,
187 int *nmemb) /* {{{ */
188 {
189 int size = 0;
190 caddr_t buff = NULL;
192 if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
193 if (errno != ENOSPC) {
194 char errbuf[1024];
195 WARNING("ipc plugin: get_ipc_info: %s",
196 sstrerror(errno, errbuf, sizeof(errbuf)));
197 return (NULL);
198 }
199 }
201 if (size == 0)
202 return NULL;
204 if (size % stsize) {
205 ERROR("ipc plugin: ipc_get_info: missmatch struct size and buffer size");
206 return (NULL);
207 }
209 *nmemb = size / stsize;
211 buff = malloc(size);
212 if (buff == NULL) {
213 ERROR("ipc plugin: ipc_get_info malloc failed.");
214 return (NULL);
215 }
217 if (get_ipc_info(cid, cmd, version, buff, &size) < 0) {
218 char errbuf[1024];
219 WARNING("ipc plugin: get_ipc_info: %s",
220 sstrerror(errno, errbuf, sizeof(errbuf)));
221 free(buff);
222 return (NULL);
223 }
225 return buff;
226 } /* }}} */
228 static int ipc_read_sem(void) /* {{{ */
229 {
230 ipcinfo_sem_t *ipcinfo_sem;
231 unsigned short sem_nsems = 0;
232 unsigned short sems = 0;
233 int n;
235 ipcinfo_sem = (ipcinfo_sem_t *)ipc_get_info(
236 0, GET_IPCINFO_SEM_ALL, IPCINFO_SEM_VERSION, sizeof(ipcinfo_sem_t), &n);
237 if (ipcinfo_sem == NULL)
238 return -1;
240 for (int i = 0; i < n; i++) {
241 sem_nsems += ipcinfo_sem[i].sem_nsems;
242 sems++;
243 }
244 free(ipcinfo_sem);
246 ipc_submit_g("sem", "count", "arrays", sem_nsems);
247 ipc_submit_g("sem", "count", "total", sems);
249 return (0);
250 } /* }}} int ipc_read_sem */
252 static int ipc_read_shm(void) /* {{{ */
253 {
254 ipcinfo_shm_t *ipcinfo_shm;
255 ipcinfo_shm_t *pshm;
256 unsigned int shm_segments = 0;
257 size64_t shm_bytes = 0;
258 int n;
260 ipcinfo_shm = (ipcinfo_shm_t *)ipc_get_info(
261 0, GET_IPCINFO_SHM_ALL, IPCINFO_SHM_VERSION, sizeof(ipcinfo_shm_t), &n);
262 if (ipcinfo_shm == NULL)
263 return -1;
265 for (int i = 0, pshm = ipcinfo_shm; i < n; i++, pshm++) {
266 shm_segments++;
267 shm_bytes += pshm->shm_segsz;
268 }
269 free(ipcinfo_shm);
271 ipc_submit_g("shm", "segments", NULL, shm_segments);
272 ipc_submit_g("shm", "bytes", "total", shm_bytes);
274 return (0);
275 }
276 /* }}} int ipc_read_shm */
278 static int ipc_read_msg(void) /* {{{ */
279 {
280 ipcinfo_msg_t *ipcinfo_msg;
281 uint32_t msg_used_space = 0;
282 uint32_t msg_alloc_queues = 0;
283 msgqnum32_t msg_qnum = 0;
284 int n;
286 ipcinfo_msg = (ipcinfo_msg_t *)ipc_get_info(
287 0, GET_IPCINFO_MSG_ALL, IPCINFO_MSG_VERSION, sizeof(ipcinfo_msg_t), &n);
288 if (ipcinfo_msg == NULL)
289 return -1;
291 for (int i = 0; i < n; i++) {
292 msg_alloc_queues++;
293 msg_used_space += ipcinfo_msg[i].msg_cbytes;
294 msg_qnum += ipcinfo_msg[i].msg_qnum;
295 }
296 free(ipcinfo_msg);
298 ipc_submit_g("msg", "count", "queues", msg_alloc_queues);
299 ipc_submit_g("msg", "count", "headers", msg_qnum);
300 ipc_submit_g("msg", "count", "space", msg_used_space);
302 return (0);
303 }
304 /* }}} */
305 #endif /* KERNEL_AIX */
307 static int ipc_read(void) /* {{{ */
308 {
309 int x = 0;
310 x |= ipc_read_shm();
311 x |= ipc_read_sem();
312 x |= ipc_read_msg();
314 return (x);
315 }
316 /* }}} */
318 void module_register(void) /* {{{ */
319 {
320 #ifdef KERNEL_LINUX
321 plugin_register_init("ipc", ipc_init);
322 #endif
323 plugin_register_read("ipc", ipc_read);
324 }
325 /* }}} */
327 /* vim: set sw=2 sts=2 et fdm=marker : */