intel_rdt: update unit-tests for process monitoring
[collectd.git] / src / intel_rdt.c
1 /**
2  * collectd - src/intel_rdt.c
3  *
4  * Copyright(c) 2016-2018 Intel Corporation. All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  *
24  * Authors:
25  *   Serhiy Pshyk <serhiyx.pshyk@intel.com>
26  *   Starzyk, Mateusz <mateuszx.starzyk@intel.com>
27  *   Wojciech Andralojc <wojciechx.andralojc@intel.com>
28  **/
29
30 #include "collectd.h"
31 #include "utils/common/common.h"
32 #include "utils/config_cores/config_cores.h"
33 #include <pqos.h>
34
35 #define RDT_PLUGIN "intel_rdt"
36
37 /* libpqos v2.0 or newer is required for process monitoring*/
38 #undef LIBPQOS2
39 #if defined(PQOS_VERSION) && PQOS_VERSION >= 20000
40 #define LIBPQOS2
41 #endif
42
43 #define RDT_PLUGIN "intel_rdt"
44
45 #define RDT_MAX_SOCKETS 8
46 #define RDT_MAX_SOCKET_CORES 64
47 #define RDT_MAX_CORES (RDT_MAX_SOCKET_CORES * RDT_MAX_SOCKETS)
48
49 #ifdef LIBPQOS2
50 /*
51  * Process name inside comm file is limited to 16 chars.
52  * More info here: http://man7.org/linux/man-pages/man5/proc.5.html
53  */
54 #define RDT_MAX_NAME_LEN 16
55 #define RDT_MAX_NAMES_GROUPS 64
56
57 #define RDT_PROC_PATH "/proc"
58 #endif /* LIBPQOS2 */
59
60 typedef enum {
61   UNKNOWN = 0,
62   CONFIGURATION_ERROR,
63 } rdt_config_status;
64
65 #ifdef LIBPQOS2
66 /* Helper typedef for process name array
67  * Extra 1 char is added for string null termination.
68  */
69 typedef char proc_comm_t[RDT_MAX_NAME_LEN + 1];
70
71 /* Linked one-way list of pids. */
72 typedef struct pids_list_s {
73   pid_t pid;
74   struct pids_list_s *next;
75 } pids_list_t;
76
77 /* Holds process name and list of pids assigned to that name */
78 typedef struct proc_pids_s {
79   proc_comm_t proccess_name;
80   pids_list_t *pids;
81 } proc_pids_t;
82
83 struct rdt_name_group_s {
84   char *desc;
85   size_t num_names;
86   char **names;
87   proc_pids_t *proc_pids_array;
88   size_t monitored_pids_count;
89   enum pqos_mon_event events;
90 };
91 typedef struct rdt_name_group_s rdt_name_group_t;
92 #endif /* LIBPQOS2 */
93
94 struct rdt_ctx_s {
95   core_groups_list_t cores;
96   enum pqos_mon_event events[RDT_MAX_CORES];
97   struct pqos_mon_data *pcgroups[RDT_MAX_CORES];
98 #ifdef LIBPQOS2
99   rdt_name_group_t ngroups[RDT_MAX_NAMES_GROUPS];
100   struct pqos_mon_data *pngroups[RDT_MAX_NAMES_GROUPS];
101   size_t num_ngroups;
102 #endif /* LIBPQOS2 */
103   const struct pqos_cpuinfo *pqos_cpu;
104   const struct pqos_cap *pqos_cap;
105   const struct pqos_capability *cap_mon;
106 };
107 typedef struct rdt_ctx_s rdt_ctx_t;
108
109 static rdt_ctx_t *g_rdt;
110
111 static rdt_config_status g_state = UNKNOWN;
112
113 static int g_interface = -1;
114
115 #ifdef LIBPQOS2
116 static int isdupstr(const char *names[], const size_t size, const char *name) {
117   for (size_t i = 0; i < size; i++)
118     if (strncmp(names[i], name, (size_t)RDT_MAX_NAME_LEN) == 0)
119       return 1;
120
121   return 0;
122 }
123
124 /*
125  * NAME
126  *   strlisttoarray
127  *
128  * DESCRIPTION
129  *   Converts string representing list of strings into array of strings.
130  *   Allowed format is:
131  *     name,name1,name2,name3
132  *
133  * PARAMETERS
134  *   `str_list'  String representing list of strings.
135  *   `names'     Array to put extracted strings into.
136  *   `names_num' Variable to put number of extracted strings.
137  *
138  * RETURN VALUE
139  *    Number of elements placed into names.
140  */
141 static int strlisttoarray(char *str_list, char ***names, size_t *names_num) {
142   char *saveptr = NULL;
143
144   if (str_list == NULL || names == NULL)
145     return -EINVAL;
146
147   if (strstr(str_list, ",,")) {
148     /* strtok ignores empty words between separators.
149      * This condition handles that by rejecting strings
150      * with consecutive seprators */
151     ERROR(RDT_PLUGIN ": Empty process name");
152     return -EINVAL;
153   }
154
155   for (;;) {
156     char *token = strtok_r(str_list, ",", &saveptr);
157     if (token == NULL)
158       break;
159
160     str_list = NULL;
161
162     while (isspace(*token))
163       token++;
164
165     if (*token == '\0')
166       continue;
167
168     if ((isdupstr((const char **)*names, *names_num, token))) {
169       ERROR(RDT_PLUGIN ": Duplicated process name \'%s\' in group \'%s\'",
170             token, str_list);
171       return -EINVAL;
172     } else {
173       if (0 != strarray_add(names, names_num, token)) {
174         ERROR(RDT_PLUGIN ": Error allocating process name string");
175         return -ENOMEM;
176       }
177     }
178   }
179
180   return 0;
181 }
182
183 /*
184  * NAME
185  *   ngroup_cmp
186  *
187  * DESCRIPTION
188  *   Function to compare names in two name groups.
189  *
190  * PARAMETERS
191  *   `ng_a'      Pointer to name group a.
192  *   `ng_b'      Pointer to name group b.
193  *
194  * RETURN VALUE
195  *    1 if both groups contain the same names
196  *    0 if none of their names match
197  *    -1 if some but not all names match
198  */
199 static int ngroup_cmp(const rdt_name_group_t *ng_a,
200                       const rdt_name_group_t *ng_b) {
201   unsigned found = 0;
202
203   assert(ng_a != NULL);
204   assert(ng_b != NULL);
205
206   const size_t sz_a = (unsigned)ng_a->num_names;
207   const size_t sz_b = (unsigned)ng_b->num_names;
208   const char **tab_a = (const char **)ng_a->names;
209   const char **tab_b = (const char **)ng_b->names;
210
211   for (size_t i = 0; i < sz_a; i++) {
212     for (size_t j = 0; j < sz_b; j++)
213       if (strncmp(tab_a[i], tab_b[j], (size_t)RDT_MAX_NAME_LEN) == 0)
214         found++;
215   }
216   /* if no names are the same */
217   if (!found)
218     return 0;
219   /* if group contains same names */
220   if (sz_a == sz_b && sz_b == (size_t)found)
221     return 1;
222   /* if not all names are the same */
223   return -1;
224 }
225
226 /*
227  * NAME
228  *   oconfig_to_ngroups
229  *
230  * DESCRIPTION
231  *   Function to set the descriptions and names for each process names group.
232  *   Takes a config option containing list of strings that are used to set
233  *   process group values.
234  *
235  * PARAMETERS
236  *   `item'        Config option containing process names groups.
237  *   `groups'      Table of process name groups to set values in.
238  *   `max_groups'  Maximum number of process name groups allowed.
239  *
240  * RETURN VALUE
241  *   On success, the number of name groups set up. On error, appropriate
242  *   negative error value.
243  */
244 static int oconfig_to_ngroups(const oconfig_item_t *item,
245                               rdt_name_group_t *groups,
246                               const size_t max_groups) {
247   int index = 0;
248
249   assert(groups != NULL);
250   assert(max_groups > 0);
251   assert(item != NULL);
252
253   for (int j = 0; j < item->values_num; j++) {
254     int ret;
255     char value[DATA_MAX_NAME_LEN];
256
257     if ((item->values[j].value.string == NULL) ||
258         (strlen(item->values[j].value.string) == 0)) {
259       ERROR(RDT_PLUGIN ": Error - empty group");
260       return -EINVAL;
261     }
262
263     sstrncpy(value, item->values[j].value.string, sizeof(value));
264
265     ret = strlisttoarray(value, &groups[index].names, &groups[index].num_names);
266     if (ret != 0 || groups[index].num_names == 0) {
267       ERROR(RDT_PLUGIN ": Error parsing process names group (%s)",
268             item->values[j].value.string);
269       return -EINVAL;
270     }
271
272     /* set group description info */
273     groups[index].desc = sstrdup(item->values[j].value.string);
274     if (groups[index].desc == NULL) {
275       ERROR(RDT_PLUGIN ": Error allocating name group description");
276       return -ENOMEM;
277     }
278
279     groups[index].proc_pids_array = NULL;
280     groups[index].monitored_pids_count = 0;
281
282     index++;
283
284     if (index >= (const int)max_groups) {
285       WARNING(RDT_PLUGIN ": Too many process names groups configured");
286       return index;
287     }
288   }
289
290   return index;
291 }
292 #endif /* LIBPQOS2 */
293
294 #if COLLECT_DEBUG
295 static void rdt_dump_cgroups(void) {
296   char cores[RDT_MAX_CORES * 4];
297
298   if (g_rdt == NULL)
299     return;
300
301   DEBUG(RDT_PLUGIN ": Core Groups Dump");
302   DEBUG(RDT_PLUGIN ":  groups count: %" PRIsz, g_rdt->cores.num_cgroups);
303
304   for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
305     core_group_t *cgroup = g_rdt->cores.cgroups + i;
306
307     memset(cores, 0, sizeof(cores));
308     for (size_t j = 0; j < cgroup->num_cores; j++) {
309       snprintf(cores + strlen(cores), sizeof(cores) - strlen(cores) - 1, " %d",
310                cgroup->cores[j]);
311     }
312
313     DEBUG(RDT_PLUGIN ":  group[%zu]:", i);
314     DEBUG(RDT_PLUGIN ":    description: %s", cgroup->desc);
315     DEBUG(RDT_PLUGIN ":    cores: %s", cores);
316     DEBUG(RDT_PLUGIN ":    events: 0x%X", g_rdt->events[i]);
317   }
318
319   return;
320 }
321
322 #ifdef LIBPQOS2
323 static void rdt_dump_ngroups(void) {
324
325   char names[DATA_MAX_NAME_LEN];
326
327   if (g_rdt == NULL)
328     return;
329
330   DEBUG(RDT_PLUGIN ": Process Names Groups Dump");
331   DEBUG(RDT_PLUGIN ":  groups count: %" PRIsz, g_rdt->num_ngroups);
332
333   for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
334     memset(names, 0, sizeof(names));
335     for (size_t j = 0; j < g_rdt->ngroups[i].num_names; j++)
336       snprintf(names + strlen(names), sizeof(names) - strlen(names) - 1, " %s",
337                g_rdt->ngroups[i].names[j]);
338
339     DEBUG(RDT_PLUGIN ":  group[%d]:", (int)i);
340     DEBUG(RDT_PLUGIN ":    description: %s", g_rdt->ngroups[i].desc);
341     DEBUG(RDT_PLUGIN ":    process names:%s", names);
342     DEBUG(RDT_PLUGIN ":    events: 0x%X", g_rdt->ngroups[i].events);
343   }
344
345   return;
346 }
347 #endif /* LIBPQOS2 */
348
349 static inline double bytes_to_kb(const double bytes) { return bytes / 1024.0; }
350
351 static inline double bytes_to_mb(const double bytes) {
352   return bytes / (1024.0 * 1024.0);
353 }
354
355 static void rdt_dump_cores_data(void) {
356 /*
357  * CORE - monitored group of cores
358  * RMID - Resource Monitoring ID associated with the monitored group
359  *        This is not available for monitoring with resource control
360  * LLC - last level cache occupancy
361  * MBL - local memory bandwidth
362  * MBR - remote memory bandwidth
363  */
364 #ifdef LIBPQOS2
365   if (g_interface == PQOS_INTER_OS_RESCTRL_MON) {
366     DEBUG(RDT_PLUGIN ":  CORE     LLC[KB]   MBL[MB]    MBR[MB]");
367   } else {
368     DEBUG(RDT_PLUGIN ":  CORE     RMID    LLC[KB]   MBL[MB]    MBR[MB]");
369   }
370 #else
371   DEBUG(RDT_PLUGIN ":  CORE     RMID    LLC[KB]   MBL[MB]    MBR[MB]");
372 #endif /* LIBPQOS2 */
373
374   for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
375     const struct pqos_event_values *pv = &g_rdt->pcgroups[i]->values;
376
377     double llc = bytes_to_kb(pv->llc);
378     double mbr = bytes_to_mb(pv->mbm_remote_delta);
379     double mbl = bytes_to_mb(pv->mbm_local_delta);
380 #ifdef LIBPQOS2
381     if (g_interface == PQOS_INTER_OS_RESCTRL_MON) {
382       DEBUG(RDT_PLUGIN ": [%s] %10.1f %10.1f %10.1f",
383             g_rdt->cores.cgroups[i].desc, llc, mbl, mbr);
384     } else {
385       DEBUG(RDT_PLUGIN ": [%s] %8u %10.1f %10.1f %10.1f",
386             g_rdt->cores.cgroups[i].desc, g_rdt->pcgroups[i]->poll_ctx[0].rmid,
387             llc, mbl, mbr);
388     }
389 #else
390     DEBUG(RDT_PLUGIN ": [%s] %8u %10.1f %10.1f %10.1f",
391           g_rdt->cores.cgroups[i].desc, g_rdt->pcgroups[i]->poll_ctx[0].rmid,
392           llc, mbl, mbr);
393 #endif /* LIBPQOS2 */
394   }
395 }
396
397 #ifdef LIBPQOS2
398 static void rdt_dump_pids_data(void) {
399   /*
400    * NAME - monitored group of processes
401    * PIDs - list of PID numbers in the NAME group
402    * LLC - last level cache occupancy
403    * MBL - local memory bandwidth
404    * MBR - remote memory bandwidth
405    */
406
407   DEBUG(RDT_PLUGIN ":  NAME     PIDs");
408   char pids[DATA_MAX_NAME_LEN];
409   for (size_t i = 0; i < g_rdt->num_ngroups; ++i) {
410     memset(pids, 0, sizeof(pids));
411     for (size_t j = 0; j < g_rdt->ngroups[i].num_names; ++j) {
412       pids_list_t *list = g_rdt->ngroups[i].proc_pids_array[j].pids;
413       while (list != NULL) {
414         snprintf(pids + strlen(pids), sizeof(pids) - strlen(pids) - 1, " %u",
415                  list->pid);
416         list = list->next;
417       }
418     }
419     DEBUG(RDT_PLUGIN ":  [%s] %s", g_rdt->ngroups[i].desc, pids);
420   }
421
422   DEBUG(RDT_PLUGIN ":  NAME    LLC[KB]   MBL[MB]    MBR[MB]");
423   for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
424
425     const struct pqos_event_values *pv = &g_rdt->pngroups[i]->values;
426
427     double llc = bytes_to_kb(pv->llc);
428     double mbr = bytes_to_mb(pv->mbm_remote_delta);
429     double mbl = bytes_to_mb(pv->mbm_local_delta);
430
431     DEBUG(RDT_PLUGIN ":  [%s] %10.1f %10.1f %10.1f", g_rdt->ngroups[i].desc,
432           llc, mbl, mbr);
433   }
434 }
435 #endif /* LIBPQOS2 */
436 #endif /* COLLECT_DEBUG */
437
438 static void rdt_free_cgroups(void) {
439   config_cores_cleanup(&g_rdt->cores);
440   for (int i = 0; i < RDT_MAX_CORES; i++) {
441     sfree(g_rdt->pcgroups[i]);
442   }
443 }
444
445 #ifdef LIBPQOS2
446 static int pids_list_free(pids_list_t *list) {
447   assert(list);
448
449   pids_list_t *current = list;
450   while (current != NULL) {
451     pids_list_t *previous = current;
452     current = current->next;
453     sfree(previous);
454   }
455   return 0;
456 }
457
458 static void rdt_free_ngroups(rdt_ctx_t *rdt) {
459   for (int i = 0; i < RDT_MAX_NAMES_GROUPS; i++) {
460     if (rdt->ngroups[i].desc)
461       DEBUG(RDT_PLUGIN ": Freeing pids \'%s\' group\'s data...",
462             rdt->ngroups[i].desc);
463     sfree(rdt->ngroups[i].desc);
464
465     strarray_free(rdt->ngroups[i].names, rdt->ngroups[i].num_names);
466
467     if (rdt->ngroups[i].proc_pids_array) {
468       for (size_t j = 0; j < rdt->ngroups[i].num_names; ++j) {
469         if (NULL == rdt->ngroups[i].proc_pids_array[j].pids)
470           continue;
471         pids_list_free(rdt->ngroups[i].proc_pids_array[j].pids);
472       }
473
474       sfree(rdt->ngroups[i].proc_pids_array);
475     }
476
477     rdt->ngroups[i].num_names = 0;
478     sfree(rdt->pngroups[i]);
479   }
480 }
481 #endif /* LIBPQOS2 */
482
483 static int rdt_default_cgroups(void) {
484   unsigned num_cores = g_rdt->pqos_cpu->num_cores;
485
486   g_rdt->cores.cgroups = calloc(num_cores, sizeof(*g_rdt->cores.cgroups));
487   if (g_rdt->cores.cgroups == NULL) {
488     ERROR(RDT_PLUGIN ": Error allocating core groups array");
489     return -ENOMEM;
490   }
491   g_rdt->cores.num_cgroups = num_cores;
492
493   /* configure each core in separate group */
494   for (unsigned i = 0; i < num_cores; i++) {
495     core_group_t *cgroup = g_rdt->cores.cgroups + i;
496     char desc[DATA_MAX_NAME_LEN];
497
498     /* set core group info */
499     cgroup->cores = calloc(1, sizeof(*cgroup->cores));
500     if (cgroup->cores == NULL) {
501       ERROR(RDT_PLUGIN ": Error allocating cores array");
502       rdt_free_cgroups();
503       return -ENOMEM;
504     }
505     cgroup->num_cores = 1;
506     cgroup->cores[0] = i;
507
508     snprintf(desc, sizeof(desc), "%d", g_rdt->pqos_cpu->cores[i].lcore);
509     cgroup->desc = strdup(desc);
510     if (cgroup->desc == NULL) {
511       ERROR(RDT_PLUGIN ": Error allocating core group description");
512       rdt_free_cgroups();
513       return -ENOMEM;
514     }
515   }
516
517   return num_cores;
518 }
519
520 static int rdt_is_core_id_valid(unsigned int core_id) {
521
522   for (unsigned int i = 0; i < g_rdt->pqos_cpu->num_cores; i++)
523     if (core_id == g_rdt->pqos_cpu->cores[i].lcore)
524       return 1;
525
526   return 0;
527 }
528
529 #ifdef LIBPQOS2
530 static int rdt_is_proc_name_valid(const char *name) {
531
532   if (name != NULL) {
533     unsigned len = strlen(name);
534     if (len > 0 && len <= RDT_MAX_NAME_LEN)
535       return 1;
536     else {
537       DEBUG(RDT_PLUGIN
538             ": Process name \'%s\' is too long. Max supported len is %d chars.",
539             name, RDT_MAX_NAME_LEN);
540     }
541   }
542
543   return 0;
544 }
545 #endif /* LIBPQOS2 */
546
547 static int rdt_config_cgroups(oconfig_item_t *item) {
548   size_t n = 0;
549   enum pqos_mon_event events = 0;
550
551   if (config_cores_parse(item, &g_rdt->cores) < 0) {
552     rdt_free_cgroups();
553     ERROR(RDT_PLUGIN ": Error parsing core groups configuration.");
554     return -EINVAL;
555   }
556   n = g_rdt->cores.num_cgroups;
557
558   /* validate configured core id values */
559   for (size_t group_idx = 0; group_idx < n; group_idx++) {
560     core_group_t *cgroup = g_rdt->cores.cgroups + group_idx;
561     for (size_t core_idx = 0; core_idx < cgroup->num_cores; core_idx++) {
562       if (!rdt_is_core_id_valid(cgroup->cores[core_idx])) {
563         ERROR(RDT_PLUGIN ": Core group '%s' contains invalid core id '%u'",
564               cgroup->desc, cgroup->cores[core_idx]);
565         rdt_free_cgroups();
566         return -EINVAL;
567       }
568     }
569   }
570
571   if (n == 0) {
572     /* create default core groups if "Cores" config option is empty */
573     int ret = rdt_default_cgroups();
574     if (ret < 0) {
575       rdt_free_cgroups();
576       ERROR(RDT_PLUGIN ": Error creating default core groups configuration.");
577       return ret;
578     }
579     n = (size_t)ret;
580     INFO(RDT_PLUGIN
581          ": No core groups configured. Default core groups created.");
582   }
583
584   /* Get all available events on this platform */
585   for (unsigned int i = 0; i < g_rdt->cap_mon->u.mon->num_events; i++)
586     events |= g_rdt->cap_mon->u.mon->events[i].type;
587
588   events &= ~(PQOS_PERF_EVENT_LLC_MISS);
589
590   DEBUG(RDT_PLUGIN ": Number of cores in the system: %u",
591         g_rdt->pqos_cpu->num_cores);
592   DEBUG(RDT_PLUGIN ": Available events to monitor: %#x", events);
593
594   g_rdt->cores.num_cgroups = n;
595   for (int i = 0; i < n; i++) {
596     for (int j = 0; j < i; j++) {
597       int found = 0;
598       found = config_cores_cmp_cgroups(&g_rdt->cores.cgroups[j],
599                                        &g_rdt->cores.cgroups[i]);
600       if (found != 0) {
601         rdt_free_cgroups();
602         ERROR(RDT_PLUGIN ": Cannot monitor same cores in different groups.");
603         return -EINVAL;
604       }
605     }
606
607     g_rdt->events[i] = events;
608     g_rdt->pcgroups[i] = calloc(1, sizeof(*g_rdt->pcgroups[i]));
609     if (g_rdt->pcgroups[i] == NULL) {
610       rdt_free_cgroups();
611       ERROR(RDT_PLUGIN ": Failed to allocate memory for monitoring data.");
612       return -ENOMEM;
613     }
614   }
615
616   return 0;
617 }
618
619 #ifdef LIBPQOS2
620 static int rdt_config_ngroups(rdt_ctx_t *rdt, const oconfig_item_t *item) {
621   int n = 0;
622   enum pqos_mon_event events = 0;
623
624   if (item == NULL) {
625     DEBUG(RDT_PLUGIN ": ngroups_config: Invalid argument.");
626     return -EINVAL;
627   }
628
629   DEBUG(RDT_PLUGIN ": Process names groups [%d]:", item->values_num);
630   for (int j = 0; j < item->values_num; j++) {
631     if (item->values[j].type != OCONFIG_TYPE_STRING) {
632       ERROR(RDT_PLUGIN
633             ": given process names group value is not a string [idx=%d]",
634             j);
635       return -EINVAL;
636     }
637     DEBUG(RDT_PLUGIN ":  [%d]: %s", j, item->values[j].value.string);
638   }
639
640   n = oconfig_to_ngroups(item, rdt->ngroups, RDT_MAX_NAMES_GROUPS);
641   if (n < 0) {
642     rdt_free_ngroups(rdt);
643     ERROR(RDT_PLUGIN ": Error parsing process name groups configuration.");
644     return -EINVAL;
645   }
646
647   /* validate configured process name values */
648   for (int group_idx = 0; group_idx < n; group_idx++) {
649     DEBUG(RDT_PLUGIN ":  checking group [%d]: %s", group_idx,
650           rdt->ngroups[group_idx].desc);
651     for (size_t name_idx = 0; name_idx < rdt->ngroups[group_idx].num_names;
652          name_idx++) {
653       DEBUG(RDT_PLUGIN ":    checking process name [%zu]: %s", name_idx,
654             rdt->ngroups[group_idx].names[name_idx]);
655       if (!rdt_is_proc_name_valid(rdt->ngroups[group_idx].names[name_idx])) {
656         ERROR(RDT_PLUGIN ": Process name group '%s' contains invalid name '%s'",
657               rdt->ngroups[group_idx].desc,
658               rdt->ngroups[group_idx].names[name_idx]);
659         rdt_free_ngroups(rdt);
660         return -EINVAL;
661       }
662     }
663   }
664
665   if (n == 0) {
666     ERROR(RDT_PLUGIN ": Empty process name groups configured.");
667     return -EINVAL;
668   }
669
670   /* Get all available events on this platform */
671   for (unsigned i = 0; i < rdt->cap_mon->u.mon->num_events; i++)
672     events |= rdt->cap_mon->u.mon->events[i].type;
673
674   events &= ~(PQOS_PERF_EVENT_LLC_MISS);
675
676   DEBUG(RDT_PLUGIN ": Available events to monitor: %#x", events);
677
678   rdt->num_ngroups = n;
679   for (int i = 0; i < n; i++) {
680     for (int j = 0; j < i; j++) {
681       int found = ngroup_cmp(&rdt->ngroups[j], &rdt->ngroups[i]);
682       if (found != 0) {
683         rdt_free_ngroups(rdt);
684         ERROR(RDT_PLUGIN
685               ": Cannot monitor same process name in different groups.");
686         return -EINVAL;
687       }
688     }
689
690     rdt->ngroups[i].events = events;
691     rdt->pngroups[i] = calloc(1, sizeof(*rdt->pngroups[i]));
692     if (rdt->pngroups[i] == NULL) {
693       rdt_free_ngroups(rdt);
694       ERROR(RDT_PLUGIN
695             ": Failed to allocate memory for process name monitoring data.");
696       return -ENOMEM;
697     }
698   }
699
700   return 0;
701 }
702
703 /*
704  * NAME
705  *   pids_list_add_pid
706  *
707  * DESCRIPTION
708  *   Adds pid at the end of the pids list.
709  *   Allocates memory for new pid element, it is up to user to free it.
710  *
711  * PARAMETERS
712  *   `list'     Head of target pids_list.
713  *   `pid'      Pid to be added.
714  *
715  * RETURN VALUE
716  *   On success, returns 0.
717  *   -1 on memory allocation error.
718  */
719 static int pids_list_add_pid(pids_list_t **list, const pid_t pid) {
720   assert(list);
721
722   pids_list_t *new_element = calloc(1, sizeof(*new_element));
723
724   if (new_element == NULL) {
725     ERROR(RDT_PLUGIN ": Alloc error\n");
726     return -1;
727   }
728   new_element->pid = pid;
729   new_element->next = NULL;
730
731   pids_list_t **current = list;
732   while (*current != NULL) {
733     current = &((*current)->next);
734   }
735   *current = new_element;
736   return 0;
737 }
738
739 /*
740  * NAME
741  *   pids_list_contains_pid
742  *
743  * DESCRIPTION
744  *   Tests if pids list contains specific pid.
745  *
746  * PARAMETERS
747  *   `list'     Head of pids_list.
748  *   `pid'      Pid to be searched for.
749  *
750  * RETURN VALUE
751  *   If PID found in list, returns 1,
752  *   Otherwise returns 0.
753  */
754 static int pids_list_contains_pid(pids_list_t *list, const pid_t pid) {
755   assert(list);
756
757   pids_list_t *current = list;
758   while (current != NULL) {
759     if (current->pid == pid)
760       return 1;
761     current = current->next;
762   }
763   return 0;
764 }
765
766 /*
767  * NAME
768  *   pids_list_add_pids_list
769  *
770  * DESCRIPTION
771  *   Adds pids list at the end of the pids list.
772  *   Allocates memory for new pid elements, it is up to user to free it.
773  *   Increases dst_num by a number of added PIDs.
774  *
775  * PARAMETERS
776  *   `dst'      Head of target PIDs list.
777  *   `src'      Head of source PIDs list.
778  *   `dst_num'  Variable to be increased by a number of appended PIDs.
779  *
780  * RETURN VALUE
781  *   On success, returns 0.
782  *   -1 on memory allocation error.
783  */
784 static int pids_list_add_pids_list(pids_list_t **dst, pids_list_t *src,
785                                    size_t *dst_num) {
786   assert(dst);
787   assert(src);
788   assert(dst_num);
789
790   pids_list_t *current = src;
791   int ret;
792
793   while (current != NULL) {
794     ret = pids_list_add_pid(dst, current->pid);
795     if (0 != ret)
796       return ret;
797
798     ++(*dst_num);
799     current = current->next;
800   }
801
802   return 0;
803 }
804
805 /*
806  * NAME
807  *   read_proc_name
808  *
809  * DESCRIPTION
810  *   Reads process name from given pid directory.
811  *   Strips new-line character (\n).
812  *
813  * PARAMETERS
814  *   `procfs_path` Path to systems proc directory (e.g. /proc)
815  *   `pid_entry'   Dirent for PID directory
816  *   `name'        Output buffer for process name, recommended proc_comm.
817  *   `out_size'    Output buffer size, recommended sizeof(proc_comm)
818  *
819  * RETURN VALUE
820  *   On success, the number of read bytes (includes stripped \n).
821  *   -1 on file open error
822  */
823 static int read_proc_name(const char *procfs_path,
824                           const struct dirent *pid_entry, char *name,
825                           const size_t out_size) {
826   assert(procfs_path);
827   assert(pid_entry);
828   assert(name);
829   assert(out_size);
830   memset(name, 0, out_size);
831
832   const char *comm_file_name = "comm";
833
834   char *path = ssnprintf_alloc("%s/%s/%s", procfs_path, pid_entry->d_name,
835                                comm_file_name);
836
837   FILE *f = fopen(path, "r");
838   if (f == NULL) {
839     ERROR(RDT_PLUGIN ": Failed to open comm file, error: %d\n", errno);
840     sfree(path);
841     return -1;
842   }
843   size_t read_length = fread(name, sizeof(char), out_size, f);
844   fclose(f);
845   sfree(path);
846   /* strip new line ending */
847   char *newline = strchr(name, '\n');
848   if (newline) {
849     *newline = '\0';
850   }
851
852   return read_length;
853 }
854
855 /*
856  * NAME
857  *   get_pid_number
858  *
859  * DESCRIPTION
860  *   Gets pid number for given /proc/pid directory entry or
861  *   returns error if input directory does not hold PID information.
862  *
863  * PARAMETERS
864  *   `entry'    Dirent for PID directory
865  *   `pid'      PID number to be filled
866  *
867  * RETURN VALUE
868  *   0 on success. -1 on error.
869  */
870 static int get_pid_number(struct dirent *entry, pid_t *pid) {
871   char *tmp_end; /* used for strtoul error check*/
872
873   if (pid == NULL || entry == NULL)
874     return -1;
875
876   if (entry->d_type != DT_DIR)
877     return -1;
878
879   /* trying to get pid number from directory name*/
880   *pid = strtoul(entry->d_name, &tmp_end, 10);
881   if (*tmp_end != '\0') {
882     return -1; /* conversion failed, not proc-pid */
883   }
884   /* all checks passed, marking as success */
885   return 0;
886 }
887
888 /*
889  * NAME
890  *   pids_list_to_array
891  *
892  * DESCRIPTION
893  *   Copies element from list to array. Assumes the space for the array is
894  *   allocated.
895  *
896  * PARAMETERS
897  *   `array'      First element of target array
898  *   `list'       Head of the list
899  *   `array_length' Length (element count) of the target array
900  */
901 static void pids_list_to_array(pid_t *array, pids_list_t *list,
902                                const size_t array_length) {
903
904   assert(list);
905   assert(array);
906   assert(array_length > 0);
907
908   size_t current = 0;
909
910   while (list != NULL && current < array_length) {
911     array[current] = list->pid;
912     list = list->next;
913     ++current;
914   }
915 }
916
917 /*
918  * NAME
919  *   initialize_proc_pids
920  *
921  * DESCRIPTION
922  *   Helper function to properly initialize array of proc_pids.
923  *   Allocates memory for proc_pids structs.
924  *
925  * PARAMETERS
926  *   `procs_names_array'      Array of null-terminated strings with
927  *                            process' names to be copied to new array
928  *   `procs_names_array_size' procs_names_array element count
929  *   `proc_pids_array'        Address of pointer, under which new
930  *                            array of proc_pids will be allocated.
931  *                            Must be NULL.
932  * RETURN VALUE
933  *   0 on success. Negative number on error:
934  *   -1: allocation error
935  */
936 static int initialize_proc_pids(const char **procs_names_array,
937                                 const size_t procs_names_array_size,
938                                 proc_pids_t **proc_pids_array) {
939
940   assert(proc_pids_array);
941   assert(NULL == *proc_pids_array);
942
943   /* Copy procs names to output array. Initialize pids list with NULL value. */
944   *proc_pids_array = calloc(procs_names_array_size, sizeof(**proc_pids_array));
945
946   if (NULL == *proc_pids_array)
947     return -1;
948
949   for (size_t i = 0; i < procs_names_array_size; ++i) {
950     sstrncpy((*proc_pids_array)[i].proccess_name, procs_names_array[i],
951              STATIC_ARRAY_SIZE((*proc_pids_array)[i].proccess_name));
952     (*proc_pids_array)[i].pids = NULL;
953   }
954
955   return 0;
956 }
957
958 /*
959  * NAME
960  *   fetch_pids_for_procs
961  *
962  * DESCRIPTION
963  *   Finds PIDs matching given process's names.
964  *   Searches all PID directories in /proc fs and
965  *   allocates memory for proc_pids structs, it is up to user to free it.
966  *   Output array will have same element count as input array.
967  *
968  * PARAMETERS
969  *   `procfs_path'            Path to systems proc directory (e.g. /proc)
970  *   `procs_names_array'      Array of null-terminated strings with
971  *                            process' names to be copied to new array
972  *   `procs_names_array_size' procs_names_array element count
973  *   `proc_pids_array'        Address of pointer, under which new
974  *                            array of proc_pids will be allocated.
975  *                            Must be NULL.
976  *
977  * RETURN VALUE
978  *   0 on success. -1 on error.
979  */
980 static int fetch_pids_for_procs(const char *procfs_path,
981                                 const char **procs_names_array,
982                                 const size_t procs_names_array_size,
983                                 proc_pids_t **proc_pids_array) {
984   assert(procfs_path);
985   assert(procs_names_array);
986   assert(procs_names_array_size);
987
988   DIR *proc_dir = opendir(procfs_path);
989   if (proc_dir == NULL) {
990     ERROR(RDT_PLUGIN ": Could not open %s directory, error: %d", procfs_path,
991           errno);
992     return -1;
993   }
994
995   int init_result = initialize_proc_pids(
996       procs_names_array, procs_names_array_size, proc_pids_array);
997   if (0 != init_result)
998     return -1;
999
1000   /* Go through procfs and find PIDS and their comms */
1001   struct dirent *entry;
1002   while ((entry = readdir(proc_dir)) != NULL) {
1003
1004     pid_t pid;
1005     int pid_conversion = get_pid_number(entry, &pid);
1006     if (pid_conversion < 0)
1007       continue;
1008
1009     proc_comm_t comm;
1010     int read_result =
1011         read_proc_name(procfs_path, entry, comm, sizeof(proc_comm_t));
1012     if (read_result <= 0) {
1013       ERROR(RDT_PLUGIN ": Comm file skipped. Read result: %d", read_result);
1014       continue;
1015     }
1016
1017     /* Try to find comm in input procs array (proc_pids_array has same names) */
1018     for (size_t i = 0; i < procs_names_array_size; ++i) {
1019       if (0 == strncmp(comm, (*proc_pids_array)[i].proccess_name,
1020                        STATIC_ARRAY_SIZE(comm)))
1021         pids_list_add_pid(&((*proc_pids_array)[i].pids), pid);
1022     }
1023   }
1024
1025   int close_result = closedir(proc_dir);
1026   if (0 != close_result) {
1027     ERROR(RDT_PLUGIN ": failed to close %s directory, error: %d", procfs_path,
1028           errno);
1029     sfree(*proc_pids_array);
1030     return -1;
1031   }
1032   return 0;
1033 }
1034 #endif /* LIBPQOS2 */
1035
1036 static void rdt_pqos_log(void *context, const size_t size, const char *msg) {
1037   DEBUG(RDT_PLUGIN ": %s", msg);
1038 }
1039
1040 static int rdt_preinit(void) {
1041   int ret;
1042
1043   if (g_rdt != NULL) {
1044     /* already initialized if config callback was called before init callback */
1045     return 0;
1046   }
1047
1048   g_rdt = calloc(1, sizeof(*g_rdt));
1049   if (g_rdt == NULL) {
1050     ERROR(RDT_PLUGIN ": Failed to allocate memory for rdt context.");
1051     return -ENOMEM;
1052   }
1053
1054   struct pqos_config pqos = {.fd_log = -1,
1055                              .callback_log = rdt_pqos_log,
1056                              .context_log = NULL,
1057                              .verbose = 0,
1058 #ifdef LIBPQOS2
1059                              .interface = PQOS_INTER_OS_RESCTRL_MON};
1060   DEBUG(RDT_PLUGIN ": Initializing PQoS with RESCTRL interface");
1061 #else
1062                              .interface = PQOS_INTER_MSR};
1063   DEBUG(RDT_PLUGIN ": Initializing PQoS with MSR interface");
1064 #endif
1065
1066   ret = pqos_init(&pqos);
1067   DEBUG(RDT_PLUGIN ": PQoS initialization result: [%d]", ret);
1068
1069 #ifdef LIBPQOS2
1070   if (ret == PQOS_RETVAL_INTER) {
1071     pqos.interface = PQOS_INTER_MSR;
1072     DEBUG(RDT_PLUGIN ": Initializing PQoS with MSR interface");
1073     ret = pqos_init(&pqos);
1074     DEBUG(RDT_PLUGIN ": PQoS initialization result: [%d]", ret);
1075   }
1076 #endif
1077
1078   if (ret != PQOS_RETVAL_OK) {
1079     ERROR(RDT_PLUGIN ": Error initializing PQoS library!");
1080     goto rdt_preinit_error1;
1081   }
1082
1083   g_interface = pqos.interface;
1084
1085   ret = pqos_cap_get(&g_rdt->pqos_cap, &g_rdt->pqos_cpu);
1086   if (ret != PQOS_RETVAL_OK) {
1087     ERROR(RDT_PLUGIN ": Error retrieving PQoS capabilities.");
1088     goto rdt_preinit_error2;
1089   }
1090
1091   ret = pqos_cap_get_type(g_rdt->pqos_cap, PQOS_CAP_TYPE_MON, &g_rdt->cap_mon);
1092   if (ret == PQOS_RETVAL_PARAM) {
1093     ERROR(RDT_PLUGIN ": Error retrieving monitoring capabilities.");
1094     goto rdt_preinit_error2;
1095   }
1096
1097   if (g_rdt->cap_mon == NULL) {
1098     ERROR(
1099         RDT_PLUGIN
1100         ": Monitoring capability not detected. Nothing to do for the plugin.");
1101     goto rdt_preinit_error2;
1102   }
1103
1104   /* Reset pqos monitoring groups registers */
1105   pqos_mon_reset();
1106
1107   return 0;
1108
1109 rdt_preinit_error2:
1110   pqos_fini();
1111
1112 rdt_preinit_error1:
1113   sfree(g_rdt);
1114
1115   return -1;
1116 }
1117
1118 static int rdt_config(oconfig_item_t *ci) {
1119   if (rdt_preinit() != 0) {
1120     g_state = CONFIGURATION_ERROR;
1121     /* if we return -1 at this point collectd
1122       reports a failure in configuration and
1123       aborts
1124     */
1125     return (0);
1126   }
1127
1128   for (int i = 0; i < ci->children_num; i++) {
1129     oconfig_item_t *child = ci->children + i;
1130
1131     if (strncasecmp("Cores", child->key, (size_t)strlen("Cores")) == 0) {
1132       if (rdt_config_cgroups(child) != 0) {
1133         g_state = CONFIGURATION_ERROR;
1134         /* if we return -1 at this point collectd
1135            reports a failure in configuration and
1136            aborts
1137          */
1138         return (0);
1139       }
1140
1141 #if COLLECT_DEBUG
1142       rdt_dump_cgroups();
1143 #endif /* COLLECT_DEBUG */
1144     } else if (strncasecmp("Processes", child->key,
1145                            (size_t)strlen("Processes")) == 0) {
1146 #ifdef LIBPQOS2
1147       if (g_interface != PQOS_INTER_OS_RESCTRL_MON) {
1148         ERROR(RDT_PLUGIN ": Configuration parameter \"%s\" not supported. "
1149                          "Resctrl monitoring is needed for PIDs monitoring.",
1150               child->key);
1151         g_state = CONFIGURATION_ERROR;
1152         /* if we return -1 at this point collectd
1153            reports a failure in configuration and
1154            aborts
1155          */
1156         return 0;
1157       }
1158
1159       if (rdt_config_ngroups(g_rdt, child) != 0) {
1160         g_state = CONFIGURATION_ERROR;
1161         /* if we return -1 at this point collectd
1162            reports a failure in configuration and
1163            aborts
1164          */
1165         return 0;
1166       }
1167
1168 #if COLLECT_DEBUG
1169       rdt_dump_ngroups();
1170 #endif /* COLLECT_DEBUG */
1171 #else  /* !LIBPQOS2 */
1172       ERROR(RDT_PLUGIN ": Configuration parameter \"%s\" not supported, please "
1173                        "recompile collectd with libpqos version 2.0 or newer.",
1174             child->key);
1175 #endif /* LIBPQOS2 */
1176     } else {
1177       ERROR(RDT_PLUGIN ": Unknown configuration parameter \"%s\".", child->key);
1178     }
1179   }
1180
1181   return 0;
1182 }
1183
1184 static void rdt_submit_derive(const char *cgroup, const char *type,
1185                               const char *type_instance, derive_t value) {
1186   value_list_t vl = VALUE_LIST_INIT;
1187
1188   vl.values = &(value_t){.derive = value};
1189   vl.values_len = 1;
1190
1191   sstrncpy(vl.plugin, RDT_PLUGIN, sizeof(vl.plugin));
1192   snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s", cgroup);
1193   sstrncpy(vl.type, type, sizeof(vl.type));
1194   if (type_instance)
1195     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
1196
1197   plugin_dispatch_values(&vl);
1198 }
1199
1200 static void rdt_submit_gauge(const char *cgroup, const char *type,
1201                              const char *type_instance, gauge_t value) {
1202   value_list_t vl = VALUE_LIST_INIT;
1203
1204   vl.values = &(value_t){.gauge = value};
1205   vl.values_len = 1;
1206
1207   sstrncpy(vl.plugin, RDT_PLUGIN, sizeof(vl.plugin));
1208   snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s", cgroup);
1209   sstrncpy(vl.type, type, sizeof(vl.type));
1210   if (type_instance)
1211     sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
1212
1213   plugin_dispatch_values(&vl);
1214 }
1215
1216 #ifdef LIBPQOS2
1217 static int rdt_pid_list_diff(pids_list_t *prev, pids_list_t *curr,
1218                              pids_list_t **added, size_t *added_num,
1219                              pids_list_t **removed, size_t *removed_num) {
1220   assert(prev || curr);
1221   assert(added);
1222   assert(removed);
1223
1224   if (NULL == prev) {
1225     /* append all PIDs from curr to added*/
1226     return pids_list_add_pids_list(added, curr, added_num);
1227   } else if (NULL == curr) {
1228     /* append all PIDs from prev to removed*/
1229     return pids_list_add_pids_list(removed, prev, removed_num);
1230   }
1231
1232   pids_list_t *item = prev;
1233   while (item != NULL) {
1234     if (0 == pids_list_contains_pid(curr, item->pid)) {
1235       pids_list_add_pid(removed, item->pid);
1236       ++(*removed_num);
1237     }
1238     item = item->next;
1239   }
1240
1241   item = curr;
1242   while (item != NULL) {
1243     if (0 == pids_list_contains_pid(prev, item->pid)) {
1244       pids_list_add_pid(added, item->pid);
1245       ++(*added_num);
1246     }
1247     item = item->next;
1248   }
1249
1250   return 0;
1251 }
1252
1253 static int rdt_refresh_ngroup(rdt_name_group_t *ngroup,
1254                               struct pqos_mon_data *group_mon_data) {
1255
1256   int result = 0;
1257
1258   if (NULL == ngroup)
1259     return -1;
1260
1261   if (NULL == ngroup->proc_pids_array) {
1262     ERROR(RDT_PLUGIN
1263           ": rdt_refresh_ngroup: \'%s\' uninitialized process pids array.",
1264           ngroup->desc);
1265
1266     return -1;
1267   }
1268
1269   DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' process names group.",
1270         ngroup->desc);
1271
1272   proc_pids_t *proc_pids_array_prev = ngroup->proc_pids_array;
1273   proc_pids_t *proc_pids_array_curr = NULL;
1274
1275   int fetch_result =
1276       fetch_pids_for_procs(RDT_PROC_PATH, (const char **)ngroup->names,
1277                            ngroup->num_names, &proc_pids_array_curr);
1278
1279   if (0 != fetch_result) {
1280     ERROR(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' failed to fetch PIDs.",
1281           ngroup->desc);
1282     return fetch_result;
1283   }
1284
1285   pids_list_t *new_pids = NULL;
1286   size_t new_pids_count = 0;
1287
1288   pids_list_t *lost_pids = NULL;
1289   size_t lost_pids_count = 0;
1290
1291   for (size_t i = 0; i < ngroup->num_names; ++i) {
1292     if (NULL == proc_pids_array_prev[i].pids &&
1293         NULL == proc_pids_array_curr[i].pids)
1294       continue;
1295     int diff_result = rdt_pid_list_diff(
1296         proc_pids_array_prev[i].pids, proc_pids_array_curr[i].pids, &new_pids,
1297         &new_pids_count, &lost_pids, &lost_pids_count);
1298     if (0 != diff_result) {
1299       ERROR(RDT_PLUGIN
1300             ": rdt_refresh_ngroup: \'%s\'. Error [%d] during PID diff.",
1301             ngroup->desc, diff_result);
1302       result = -1;
1303       goto cleanup;
1304     }
1305   }
1306
1307   DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' process names group, added: "
1308                    "%u, removed: %u.",
1309         ngroup->desc, (unsigned)new_pids_count, (unsigned)lost_pids_count);
1310
1311   if (new_pids_count != 0 || lost_pids_count != 0) {
1312
1313     if (new_pids) {
1314       pid_t new_pids_array[new_pids_count];
1315       pids_list_to_array(new_pids_array, new_pids,
1316                          STATIC_ARRAY_SIZE(new_pids_array));
1317
1318       /* no pids are monitored for this group yet: start monitoring */
1319       if (0 == ngroup->monitored_pids_count) {
1320
1321         int start_result =
1322             pqos_mon_start_pids(new_pids_count, new_pids_array, ngroup->events,
1323                                 (void *)ngroup->desc, group_mon_data);
1324         if (PQOS_RETVAL_OK == start_result) {
1325           ngroup->monitored_pids_count = new_pids_count;
1326         } else {
1327           ERROR(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\'. Error [%d] while "
1328                            "STARTING pids monitoring",
1329                 ngroup->desc, start_result);
1330           result = -1;
1331           goto pqos_error_recovery;
1332         }
1333
1334       } else {
1335
1336         int add_result =
1337             pqos_mon_add_pids(new_pids_count, new_pids_array, group_mon_data);
1338         if (PQOS_RETVAL_OK == add_result)
1339           ngroup->monitored_pids_count += new_pids_count;
1340         else {
1341           ERROR(RDT_PLUGIN
1342                 ": rdt_refresh_ngroup: \'%s\'. Error [%d] while ADDING pids.",
1343                 ngroup->desc, add_result);
1344           result = -1;
1345           goto pqos_error_recovery;
1346         }
1347       }
1348     }
1349
1350     if (lost_pids) {
1351       pid_t lost_pids_array[lost_pids_count];
1352       pids_list_to_array(lost_pids_array, lost_pids,
1353                          STATIC_ARRAY_SIZE(lost_pids_array));
1354
1355       if (lost_pids_count == ngroup->monitored_pids_count) {
1356         /* all pids for this group are lost: stop monitoring */
1357         int stop_result = pqos_mon_stop(group_mon_data);
1358         if (PQOS_RETVAL_OK != stop_result) {
1359           ERROR(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\'. Error [%d] while "
1360                            "STOPPING monitoring",
1361                 ngroup->desc, stop_result);
1362           result = -1;
1363           goto pqos_error_recovery;
1364         }
1365         ngroup->monitored_pids_count = 0;
1366       } else {
1367         assert(lost_pids_count < ngroup->monitored_pids_count);
1368         int remove_result = pqos_mon_remove_pids(
1369             lost_pids_count, lost_pids_array, group_mon_data);
1370         if (PQOS_RETVAL_OK == remove_result) {
1371           ngroup->monitored_pids_count -= lost_pids_count;
1372         } else {
1373           ERROR(RDT_PLUGIN
1374                 ": rdt_refresh_ngroup: \'%s\'. Error [%d] while REMOVING pids.",
1375                 ngroup->desc, remove_result);
1376           result = -1;
1377           goto pqos_error_recovery;
1378         }
1379       }
1380     }
1381
1382     ngroup->proc_pids_array = proc_pids_array_curr;
1383   }
1384
1385   goto cleanup;
1386
1387 pqos_error_recovery:
1388   /* Why?
1389    * Resources might be temporary unavailable.
1390    *
1391    * How?
1392    * Collectd will halt the reading thread for this
1393    * plugin if it returns an error.
1394    * Consecutive errors will be increasing the read period
1395    * up to 1 day interval.
1396    * On pqos error stop monitoring current group
1397    * and reset the proc_pids array
1398    * monitoring will be restarted on next collectd read cycle
1399    */
1400   DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' group RESET after error.",
1401         ngroup->desc);
1402   pqos_mon_stop(group_mon_data);
1403   for (size_t i = 0; i < ngroup->num_names; ++i) {
1404     if (ngroup->proc_pids_array[i].pids)
1405       pids_list_free(ngroup->proc_pids_array[i].pids);
1406   }
1407   sfree(ngroup->proc_pids_array);
1408
1409   initialize_proc_pids((const char **)ngroup->names, ngroup->num_names,
1410                        &ngroup->proc_pids_array);
1411   ngroup->monitored_pids_count = 0;
1412
1413 cleanup:
1414   if (ngroup->proc_pids_array == proc_pids_array_curr) {
1415     assert(proc_pids_array_curr);
1416     /* new list was successfully saved, free the old one */
1417     for (size_t i = 0; i < ngroup->num_names; ++i)
1418       if (proc_pids_array_prev[i].pids)
1419         pids_list_free(proc_pids_array_prev[i].pids);
1420
1421     sfree(proc_pids_array_prev);
1422
1423   } else {
1424     /* new list was not saved. Free the new list, keep the old one*/
1425     for (size_t i = 0; i < ngroup->num_names; ++i)
1426       if (proc_pids_array_curr[i].pids)
1427         pids_list_free(proc_pids_array_curr[i].pids);
1428
1429     sfree(proc_pids_array_curr);
1430   }
1431
1432   if (new_pids)
1433     pids_list_free(new_pids);
1434
1435   if (lost_pids)
1436     pids_list_free(lost_pids);
1437
1438   return result;
1439 }
1440
1441 static int read_pids_data() {
1442
1443   if (0 == g_rdt->num_ngroups) {
1444     DEBUG(RDT_PLUGIN ": read_pids_data: not configured - PIDs read skipped");
1445     return 0;
1446   }
1447
1448   DEBUG(RDT_PLUGIN ": read_pids_data: Scanning active groups");
1449   struct pqos_mon_data *active_groups[RDT_MAX_NAMES_GROUPS] = {0};
1450   size_t active_group_idx = 0;
1451   for (size_t pngroups_idx = 0;
1452        pngroups_idx < STATIC_ARRAY_SIZE(g_rdt->pngroups); ++pngroups_idx)
1453     if (0 != g_rdt->ngroups[pngroups_idx].monitored_pids_count)
1454       active_groups[active_group_idx++] = g_rdt->pngroups[pngroups_idx];
1455
1456   int ret = 0;
1457
1458   if (0 == active_group_idx) {
1459     DEBUG(RDT_PLUGIN ": read_pids_data: no active groups - PIDs read skipped");
1460     goto groups_refresh;
1461   }
1462
1463   DEBUG(RDT_PLUGIN ": read_pids_data: PIDs data polling");
1464
1465   int poll_result = pqos_mon_poll(active_groups, active_group_idx);
1466   if (poll_result != PQOS_RETVAL_OK) {
1467     ERROR(RDT_PLUGIN ": read_pids_data: Failed to poll monitoring data for "
1468                      "pids. Error [%d].",
1469           poll_result);
1470     ret = -poll_result;
1471     goto groups_refresh;
1472   }
1473
1474   for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
1475     enum pqos_mon_event mbm_events =
1476         (PQOS_MON_EVENT_LMEM_BW | PQOS_MON_EVENT_TMEM_BW |
1477          PQOS_MON_EVENT_RMEM_BW);
1478
1479     if (g_rdt->pngroups[i] == NULL ||
1480         g_rdt->ngroups[i].monitored_pids_count == 0)
1481       continue;
1482
1483     const struct pqos_event_values *pv = &g_rdt->pngroups[i]->values;
1484
1485     /* Submit only monitored events data */
1486
1487     if (g_rdt->ngroups[i].events & PQOS_MON_EVENT_L3_OCCUP)
1488       rdt_submit_gauge(g_rdt->ngroups[i].desc, "bytes", "llc", pv->llc);
1489
1490     if (g_rdt->ngroups[i].events & PQOS_PERF_EVENT_IPC)
1491       rdt_submit_gauge(g_rdt->ngroups[i].desc, "ipc", NULL, pv->ipc);
1492
1493     if (g_rdt->ngroups[i].events & mbm_events) {
1494       rdt_submit_derive(g_rdt->ngroups[i].desc, "memory_bandwidth", "local",
1495                         pv->mbm_local_delta);
1496       rdt_submit_derive(g_rdt->ngroups[i].desc, "memory_bandwidth", "remote",
1497                         pv->mbm_remote_delta);
1498     }
1499   }
1500
1501 #if COLLECT_DEBUG
1502   rdt_dump_pids_data();
1503 #endif /* COLLECT_DEBUG */
1504
1505 groups_refresh:
1506   for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
1507     int refresh_result =
1508         rdt_refresh_ngroup(&(g_rdt->ngroups[i]), g_rdt->pngroups[i]);
1509
1510     if (0 != refresh_result) {
1511       ERROR(RDT_PLUGIN ": read_pids_data: NGroup %zu refresh failed. Error: %d",
1512             i, refresh_result);
1513       if (0 == ret) {
1514         /* refresh error will be escalated only if there were no
1515          * errors before.
1516          */
1517         ret = refresh_result;
1518       }
1519     }
1520   }
1521
1522   assert(ret <= 0);
1523   return ret;
1524 }
1525
1526 static void rdt_init_pids_monitoring() {
1527   for (size_t group_idx = 0; group_idx < g_rdt->num_ngroups; group_idx++) {
1528     /*
1529      * Each group must have not-null proc_pids array.
1530      * Initial refresh is not mandatory for proper
1531      * PIDs statistics detection.
1532      */
1533     rdt_name_group_t *ng = &g_rdt->ngroups[group_idx];
1534     int init_result = initialize_proc_pids((const char **)ng->names,
1535                                            ng->num_names, &ng->proc_pids_array);
1536     if (0 != init_result) {
1537       ERROR(RDT_PLUGIN
1538             ": Initialization of proc_pids for group %zu failed. Error: %d",
1539             group_idx, init_result);
1540       continue;
1541     }
1542
1543     int refresh_result = rdt_refresh_ngroup(&(g_rdt->ngroups[group_idx]),
1544                                             g_rdt->pngroups[group_idx]);
1545     if (0 != refresh_result)
1546       ERROR(RDT_PLUGIN ": Initial refresh of group %zu failed. Error: %d",
1547             group_idx, refresh_result);
1548   }
1549 }
1550 #endif /* LIBPQOS2 */
1551
1552 static int read_cores_data() {
1553
1554   if (0 == g_rdt->cores.num_cgroups) {
1555     DEBUG(RDT_PLUGIN ": read_cores_data: not configured - Cores read skipped");
1556     return 0;
1557   }
1558   DEBUG(RDT_PLUGIN ": read_cores_data: Cores data poll");
1559
1560   int ret =
1561       pqos_mon_poll(&g_rdt->pcgroups[0], (unsigned)g_rdt->cores.num_cgroups);
1562   if (ret != PQOS_RETVAL_OK) {
1563     ERROR(RDT_PLUGIN ": read_cores_data: Failed to poll monitoring data for "
1564                      "cores. Error [%d].",
1565           ret);
1566     return -1;
1567   }
1568
1569   for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1570     core_group_t *cgroup = g_rdt->cores.cgroups + i;
1571     enum pqos_mon_event mbm_events =
1572         (PQOS_MON_EVENT_LMEM_BW | PQOS_MON_EVENT_TMEM_BW |
1573          PQOS_MON_EVENT_RMEM_BW);
1574
1575     const struct pqos_event_values *pv = &g_rdt->pcgroups[i]->values;
1576
1577     /* Submit only monitored events data */
1578
1579     if (g_rdt->events[i] & PQOS_MON_EVENT_L3_OCCUP)
1580       rdt_submit_gauge(cgroup->desc, "bytes", "llc", pv->llc);
1581
1582     if (g_rdt->events[i] & PQOS_PERF_EVENT_IPC)
1583       rdt_submit_gauge(cgroup->desc, "ipc", NULL, pv->ipc);
1584
1585     if (g_rdt->events[i] & mbm_events) {
1586       rdt_submit_derive(cgroup->desc, "memory_bandwidth", "local",
1587                         pv->mbm_local_delta);
1588       rdt_submit_derive(cgroup->desc, "memory_bandwidth", "remote",
1589                         pv->mbm_remote_delta);
1590     }
1591   }
1592
1593 #if COLLECT_DEBUG
1594   rdt_dump_cores_data();
1595 #endif /* COLLECT_DEBUG */
1596
1597   return 0;
1598 }
1599
1600 static int rdt_read(__attribute__((unused)) user_data_t *ud) {
1601
1602   if (g_rdt == NULL) {
1603     ERROR(RDT_PLUGIN ": rdt_read: plugin not initialized.");
1604     return -EINVAL;
1605   }
1606
1607   int cores_read_result = read_cores_data();
1608
1609 #ifdef LIBPQOS2
1610   int pids_read_result = read_pids_data();
1611 #endif /* LIBPQOS2 */
1612
1613   if (0 != cores_read_result)
1614     return cores_read_result;
1615
1616 #ifdef LIBPQOS2
1617   if (0 != pids_read_result)
1618     return pids_read_result;
1619 #endif /* LIBPQOS2 */
1620
1621   return 0;
1622 }
1623
1624 static void rdt_init_cores_monitoring() {
1625   for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1626     core_group_t *cg = g_rdt->cores.cgroups + i;
1627
1628     int mon_start_result =
1629         pqos_mon_start(cg->num_cores, cg->cores, g_rdt->events[i],
1630                        (void *)cg->desc, g_rdt->pcgroups[i]);
1631
1632     if (mon_start_result != PQOS_RETVAL_OK)
1633       ERROR(RDT_PLUGIN
1634             ": Error starting cores monitoring group %s (pqos status=%d)",
1635             cg->desc, mon_start_result);
1636   }
1637 }
1638
1639 static int rdt_init(void) {
1640
1641   if (g_state == CONFIGURATION_ERROR)
1642     return -1;
1643
1644   int rdt_preinint_result = rdt_preinit();
1645   if (rdt_preinint_result != 0)
1646     return rdt_preinint_result;
1647
1648   rdt_init_cores_monitoring();
1649 #ifdef LIBPQOS2
1650   rdt_init_pids_monitoring();
1651 #endif /* LIBPQOS2 */
1652
1653   return 0;
1654 }
1655
1656 static int rdt_shutdown(void) {
1657   int ret;
1658
1659   DEBUG(RDT_PLUGIN ": rdt_shutdown.");
1660
1661   if (g_rdt == NULL)
1662     return 0;
1663
1664   /* Stop monitoring cores */
1665   for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1666     pqos_mon_stop(g_rdt->pcgroups[i]);
1667   }
1668
1669 /* Stop pids monitoring */
1670 #ifdef LIBPQOS2
1671   for (size_t i = 0; i < g_rdt->num_ngroups; i++)
1672     pqos_mon_stop(g_rdt->pngroups[i]);
1673 #endif
1674
1675   ret = pqos_fini();
1676   if (ret != PQOS_RETVAL_OK)
1677     ERROR(RDT_PLUGIN ": Error shutting down PQoS library.");
1678
1679   rdt_free_cgroups();
1680 #ifdef LIBPQOS2
1681   rdt_free_ngroups(g_rdt);
1682 #endif /* LIBPQOS2 */
1683   sfree(g_rdt);
1684
1685   return 0;
1686 }
1687
1688 void module_register(void) {
1689   plugin_register_init(RDT_PLUGIN, rdt_init);
1690   plugin_register_complex_config(RDT_PLUGIN, rdt_config);
1691   plugin_register_complex_read(NULL, RDT_PLUGIN, rdt_read, 0, NULL);
1692   plugin_register_shutdown(RDT_PLUGIN, rdt_shutdown);
1693 }