2 * collectd - src/intel_rdt.c
4 * Copyright(c) 2016-2019 Intel Corporation. All rights reserved.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 * Serhiy Pshyk <serhiyx.pshyk@intel.com>
26 * Starzyk, Mateusz <mateuszx.starzyk@intel.com>
27 * Wojciech Andralojc <wojciechx.andralojc@intel.com>
28 * Michał Aleksiński <michalx.aleksinski@intel.com>
32 #include "utils/common/common.h"
33 #include "utils/config_cores/config_cores.h"
34 #include "utils/proc_pids/proc_pids.h"
37 #define RDT_PLUGIN "intel_rdt"
39 /* libpqos v2.0 or newer is required for process monitoring*/
41 #if defined(PQOS_VERSION) && PQOS_VERSION >= 20000
45 #define RDT_PLUGIN "intel_rdt"
47 #define RDT_MAX_SOCKETS 8
48 #define RDT_MAX_SOCKET_CORES 64
49 #define RDT_MAX_CORES (RDT_MAX_SOCKET_CORES * RDT_MAX_SOCKETS)
53 * Process name inside comm file is limited to 16 chars.
54 * More info here: http://man7.org/linux/man-pages/man5/proc.5.html
56 #define RDT_MAX_NAMES_GROUPS 64
57 #define RDT_PROC_PATH "/proc"
66 struct rdt_name_group_s {
70 proc_pids_t **proc_pids;
71 size_t monitored_pids_count;
72 enum pqos_mon_event events;
74 typedef struct rdt_name_group_s rdt_name_group_t;
78 core_groups_list_t cores;
79 enum pqos_mon_event events[RDT_MAX_CORES];
80 struct pqos_mon_data *pcgroups[RDT_MAX_CORES];
82 rdt_name_group_t ngroups[RDT_MAX_NAMES_GROUPS];
83 struct pqos_mon_data *pngroups[RDT_MAX_NAMES_GROUPS];
85 proc_pids_t **proc_pids;
88 const struct pqos_cpuinfo *pqos_cpu;
89 const struct pqos_cap *pqos_cap;
90 const struct pqos_capability *cap_mon;
92 typedef struct rdt_ctx_s rdt_ctx_t;
94 static rdt_ctx_t *g_rdt;
96 static rdt_config_status g_state = UNKNOWN;
98 static int g_interface = -1;
100 static void rdt_submit_derive(const char *cgroup, const char *type,
101 const char *type_instance, derive_t value) {
102 value_list_t vl = VALUE_LIST_INIT;
104 vl.values = &(value_t){.derive = value};
107 sstrncpy(vl.plugin, RDT_PLUGIN, sizeof(vl.plugin));
108 snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s", cgroup);
109 sstrncpy(vl.type, type, sizeof(vl.type));
111 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
113 plugin_dispatch_values(&vl);
116 static void rdt_submit_gauge(const char *cgroup, const char *type,
117 const char *type_instance, gauge_t value) {
118 value_list_t vl = VALUE_LIST_INIT;
120 vl.values = &(value_t){.gauge = value};
123 sstrncpy(vl.plugin, RDT_PLUGIN, sizeof(vl.plugin));
124 snprintf(vl.plugin_instance, sizeof(vl.plugin_instance), "%s", cgroup);
125 sstrncpy(vl.type, type, sizeof(vl.type));
127 sstrncpy(vl.type_instance, type_instance, sizeof(vl.type_instance));
129 plugin_dispatch_values(&vl);
133 static void rdt_dump_cgroups(void) {
134 char cores[RDT_MAX_CORES * 4];
139 DEBUG(RDT_PLUGIN ": Core Groups Dump");
140 DEBUG(RDT_PLUGIN ": groups count: %" PRIsz, g_rdt->cores.num_cgroups);
142 for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
143 core_group_t *cgroup = g_rdt->cores.cgroups + i;
145 memset(cores, 0, sizeof(cores));
146 for (size_t j = 0; j < cgroup->num_cores; j++) {
147 snprintf(cores + strlen(cores), sizeof(cores) - strlen(cores) - 1, " %d",
151 DEBUG(RDT_PLUGIN ": group[%zu]:", i);
152 DEBUG(RDT_PLUGIN ": description: %s", cgroup->desc);
153 DEBUG(RDT_PLUGIN ": cores: %s", cores);
154 DEBUG(RDT_PLUGIN ": events: 0x%X", g_rdt->events[i]);
161 static void rdt_dump_ngroups(void) {
163 char names[DATA_MAX_NAME_LEN];
168 DEBUG(RDT_PLUGIN ": Process Names Groups Dump");
169 DEBUG(RDT_PLUGIN ": groups count: %" PRIsz, g_rdt->num_ngroups);
171 for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
172 memset(names, 0, sizeof(names));
173 for (size_t j = 0; j < g_rdt->ngroups[i].num_names; j++)
174 snprintf(names + strlen(names), sizeof(names) - strlen(names) - 1, " %s",
175 g_rdt->ngroups[i].names[j]);
177 DEBUG(RDT_PLUGIN ": group[%d]:", (int)i);
178 DEBUG(RDT_PLUGIN ": description: %s", g_rdt->ngroups[i].desc);
179 DEBUG(RDT_PLUGIN ": process names:%s", names);
180 DEBUG(RDT_PLUGIN ": events: 0x%X", g_rdt->ngroups[i].events);
185 #endif /* LIBPQOS2 */
187 static inline double bytes_to_kb(const double bytes) { return bytes / 1024.0; }
189 static inline double bytes_to_mb(const double bytes) {
190 return bytes / (1024.0 * 1024.0);
193 static void rdt_dump_cores_data(void) {
195 * CORE - monitored group of cores
196 * RMID - Resource Monitoring ID associated with the monitored group
197 * This is not available for monitoring with resource control
198 * LLC - last level cache occupancy
199 * MBL - local memory bandwidth
200 * MBR - remote memory bandwidth
203 if (g_interface == PQOS_INTER_OS_RESCTRL_MON) {
204 DEBUG(RDT_PLUGIN ": CORE LLC[KB] MBL[MB] MBR[MB]");
206 DEBUG(RDT_PLUGIN ": CORE RMID LLC[KB] MBL[MB] MBR[MB]");
209 DEBUG(RDT_PLUGIN ": CORE RMID LLC[KB] MBL[MB] MBR[MB]");
210 #endif /* LIBPQOS2 */
212 for (int i = 0; i < g_rdt->cores.num_cgroups; i++) {
213 const struct pqos_event_values *pv = &g_rdt->pcgroups[i]->values;
215 double llc = bytes_to_kb(pv->llc);
216 double mbr = bytes_to_mb(pv->mbm_remote_delta);
217 double mbl = bytes_to_mb(pv->mbm_local_delta);
219 if (g_interface == PQOS_INTER_OS_RESCTRL_MON) {
220 DEBUG(RDT_PLUGIN ": [%s] %10.1f %10.1f %10.1f",
221 g_rdt->cores.cgroups[i].desc, llc, mbl, mbr);
223 DEBUG(RDT_PLUGIN ": [%s] %8u %10.1f %10.1f %10.1f",
224 g_rdt->cores.cgroups[i].desc, g_rdt->pcgroups[i]->poll_ctx[0].rmid,
228 DEBUG(RDT_PLUGIN ": [%s] %8u %10.1f %10.1f %10.1f",
229 g_rdt->cores.cgroups[i].desc, g_rdt->pcgroups[i]->poll_ctx[0].rmid,
231 #endif /* LIBPQOS2 */
236 static void rdt_dump_pids_data(void) {
238 * NAME - monitored group of processes
239 * PIDs - list of PID numbers in the NAME group
240 * LLC - last level cache occupancy
241 * MBL - local memory bandwidth
242 * MBR - remote memory bandwidth
245 DEBUG(RDT_PLUGIN ": NAME PIDs");
246 char pids[DATA_MAX_NAME_LEN];
247 for (size_t i = 0; i < g_rdt->num_ngroups; ++i) {
248 memset(pids, 0, sizeof(pids));
249 for (size_t j = 0; j < g_rdt->ngroups[i].num_names; ++j) {
250 pids_list_t *list = g_rdt->ngroups[i].proc_pids[j].curr;
251 for (size_t k = 0; k < list->size; k++)
252 snprintf(pids + strlen(pids), sizeof(pids) - strlen(pids) - 1, " %u",
255 DEBUG(RDT_PLUGIN ": [%s] %s", g_rdt->ngroups[i].desc, pids);
258 DEBUG(RDT_PLUGIN ": NAME LLC[KB] MBL[MB] MBR[MB]");
259 for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
261 const struct pqos_event_values *pv = &g_rdt->pngroups[i]->values;
263 double llc = bytes_to_kb(pv->llc);
264 double mbr = bytes_to_mb(pv->mbm_remote_delta);
265 double mbl = bytes_to_mb(pv->mbm_local_delta);
267 DEBUG(RDT_PLUGIN ": [%s] %10.1f %10.1f %10.1f", g_rdt->ngroups[i].desc,
271 #endif /* LIBPQOS2 */
272 #endif /* COLLECT_DEBUG */
275 static int isdupstr(const char *names[], const size_t size, const char *name) {
276 for (size_t i = 0; i < size; i++)
277 if (strncmp(names[i], name, (size_t)MAX_PROC_NAME_LEN) == 0)
288 * Converts string representing list of strings into array of strings.
290 * name,name1,name2,name3
293 * `str_list' String representing list of strings.
294 * `names' Array to put extracted strings into.
295 * `names_num' Variable to put number of extracted strings.
298 * Number of elements placed into names.
300 static int strlisttoarray(char *str_list, char ***names, size_t *names_num) {
301 char *saveptr = NULL;
303 if (str_list == NULL || names == NULL)
306 if (strstr(str_list, ",,")) {
307 /* strtok ignores empty words between separators.
308 * This condition handles that by rejecting strings
309 * with consecutive seprators */
310 ERROR(RDT_PLUGIN ": Empty process name");
315 char *token = strtok_r(str_list, ",", &saveptr);
321 while (isspace(*token))
327 if ((isdupstr((const char **)*names, *names_num, token))) {
328 ERROR(RDT_PLUGIN ": Duplicated process name \'%s\' in group \'%s\'",
332 if (0 != strarray_add(names, names_num, token)) {
333 ERROR(RDT_PLUGIN ": Error allocating process name string");
347 * Function to compare names in two name groups.
350 * `ng_a' Pointer to name group a.
351 * `ng_b' Pointer to name group b.
354 * 1 if both groups contain the same names
355 * 0 if none of their names match
356 * -1 if some but not all names match
358 static int ngroup_cmp(const rdt_name_group_t *ng_a,
359 const rdt_name_group_t *ng_b) {
362 assert(ng_a != NULL);
363 assert(ng_b != NULL);
365 const size_t sz_a = (unsigned)ng_a->num_names;
366 const size_t sz_b = (unsigned)ng_b->num_names;
367 const char **tab_a = (const char **)ng_a->names;
368 const char **tab_b = (const char **)ng_b->names;
370 for (size_t i = 0; i < sz_a; i++) {
371 for (size_t j = 0; j < sz_b; j++)
372 if (strncmp(tab_a[i], tab_b[j], (size_t)MAX_PROC_NAME_LEN) == 0)
375 /* if no names are the same */
378 /* if group contains same names */
379 if (sz_a == sz_b && sz_b == (size_t)found)
381 /* if not all names are the same */
390 * Function to set the descriptions and names for each process names group.
391 * Takes a config option containing list of strings that are used to set
392 * process group values.
395 * `item' Config option containing process names groups.
396 * `groups' Table of process name groups to set values in.
397 * `max_groups' Maximum number of process name groups allowed.
400 * On success, the number of name groups set up. On error, appropriate
401 * negative error value.
403 static int oconfig_to_ngroups(const oconfig_item_t *item,
404 rdt_name_group_t *groups,
405 const size_t max_groups) {
408 assert(groups != NULL);
409 assert(max_groups > 0);
410 assert(item != NULL);
412 for (int j = 0; j < item->values_num; j++) {
414 char value[DATA_MAX_NAME_LEN];
416 if ((item->values[j].value.string == NULL) ||
417 (strlen(item->values[j].value.string) == 0)) {
418 ERROR(RDT_PLUGIN ": Error - empty group");
422 sstrncpy(value, item->values[j].value.string, sizeof(value));
424 ret = strlisttoarray(value, &groups[index].names, &groups[index].num_names);
425 if (ret != 0 || groups[index].num_names == 0) {
426 ERROR(RDT_PLUGIN ": Error parsing process names group (%s)",
427 item->values[j].value.string);
431 /* set group description info */
432 groups[index].desc = sstrdup(item->values[j].value.string);
433 if (groups[index].desc == NULL) {
434 ERROR(RDT_PLUGIN ": Error allocating name group description");
438 groups[index].proc_pids = NULL;
439 groups[index].monitored_pids_count = 0;
443 if (index >= (const int)max_groups) {
444 WARNING(RDT_PLUGIN ": Too many process names groups configured");
457 * Function to deallocate memory allocated for name groups.
460 * `rdt' Pointer to rdt context
462 static void rdt_free_ngroups(rdt_ctx_t *rdt) {
463 for (int i = 0; i < RDT_MAX_NAMES_GROUPS; i++) {
464 if (rdt->ngroups[i].desc)
465 DEBUG(RDT_PLUGIN ": Freeing pids \'%s\' group\'s data...",
466 rdt->ngroups[i].desc);
467 sfree(rdt->ngroups[i].desc);
468 strarray_free(rdt->ngroups[i].names, rdt->ngroups[i].num_names);
470 if (rdt->ngroups[i].proc_pids)
471 proc_pids_free(rdt->ngroups[i].proc_pids, rdt->ngroups[i].num_names);
473 rdt->ngroups[i].num_names = 0;
474 sfree(rdt->pngroups[i]);
477 sfree(rdt->proc_pids);
485 * Reads name groups configuration.
488 * `rdt` Pointer to rdt context
489 * `item' Config option containing process names groups.
492 * 0 on success. Negative number on error.
494 static int rdt_config_ngroups(rdt_ctx_t *rdt, const oconfig_item_t *item) {
496 enum pqos_mon_event events = 0;
499 DEBUG(RDT_PLUGIN ": ngroups_config: Invalid argument.");
503 DEBUG(RDT_PLUGIN ": Process names groups [%d]:", item->values_num);
504 for (int j = 0; j < item->values_num; j++) {
505 if (item->values[j].type != OCONFIG_TYPE_STRING) {
507 ": given process names group value is not a string [idx=%d]",
511 DEBUG(RDT_PLUGIN ": [%d]: %s", j, item->values[j].value.string);
514 n = oconfig_to_ngroups(item, rdt->ngroups, RDT_MAX_NAMES_GROUPS);
516 rdt_free_ngroups(rdt);
517 ERROR(RDT_PLUGIN ": Error parsing process name groups configuration.");
521 /* validate configured process name values */
522 for (int group_idx = 0; group_idx < n; group_idx++) {
523 DEBUG(RDT_PLUGIN ": checking group [%d]: %s", group_idx,
524 rdt->ngroups[group_idx].desc);
525 for (size_t name_idx = 0; name_idx < rdt->ngroups[group_idx].num_names;
527 DEBUG(RDT_PLUGIN ": checking process name [%zu]: %s", name_idx,
528 rdt->ngroups[group_idx].names[name_idx]);
529 if (!proc_pids_is_name_valid(rdt->ngroups[group_idx].names[name_idx])) {
530 ERROR(RDT_PLUGIN ": Process name group '%s' contains invalid name '%s'",
531 rdt->ngroups[group_idx].desc,
532 rdt->ngroups[group_idx].names[name_idx]);
533 rdt_free_ngroups(rdt);
540 ERROR(RDT_PLUGIN ": Empty process name groups configured.");
544 /* Get all available events on this platform */
545 for (unsigned i = 0; i < rdt->cap_mon->u.mon->num_events; i++)
546 events |= rdt->cap_mon->u.mon->events[i].type;
548 events &= ~(PQOS_PERF_EVENT_LLC_MISS);
550 DEBUG(RDT_PLUGIN ": Available events to monitor: %#x", events);
552 rdt->num_ngroups = n;
553 for (int i = 0; i < n; i++) {
554 for (int j = 0; j < i; j++) {
555 int found = ngroup_cmp(&rdt->ngroups[j], &rdt->ngroups[i]);
557 rdt_free_ngroups(rdt);
559 ": Cannot monitor same process name in different groups.");
564 rdt->ngroups[i].events = events;
565 rdt->pngroups[i] = calloc(1, sizeof(*rdt->pngroups[i]));
566 if (rdt->pngroups[i] == NULL) {
567 rdt_free_ngroups(rdt);
569 ": Failed to allocate memory for process name monitoring data.");
582 * Refresh pids monitored by name group.
585 * `ngroup` Pointer to name group.
586 * `group_mon_data' PQoS monitoring context.
589 * 0 on success. Negative number on error.
591 static int rdt_refresh_ngroup(rdt_name_group_t *ngroup,
592 struct pqos_mon_data *group_mon_data) {
599 if (NULL == ngroup->proc_pids) {
601 ": rdt_refresh_ngroup: \'%s\' uninitialized process pids array.",
607 DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' process names group.",
610 proc_pids_t **proc_pids = ngroup->proc_pids;
611 pids_list_t added_pids;
612 pids_list_t removed_pids;
614 memset(&added_pids, 0, sizeof(added_pids));
615 memset(&removed_pids, 0, sizeof(removed_pids));
617 for (size_t i = 0; i < ngroup->num_names; ++i) {
618 int diff_result = pids_list_diff(proc_pids[i], &added_pids, &removed_pids);
619 if (0 != diff_result) {
621 ": rdt_refresh_ngroup: \'%s\'. Error [%d] during PID diff.",
622 ngroup->desc, diff_result);
628 DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' process names group, added: "
630 ngroup->desc, (unsigned)added_pids.size, (unsigned)removed_pids.size);
632 if (added_pids.size > 0) {
634 /* no pids are monitored for this group yet: start monitoring */
635 if (0 == ngroup->monitored_pids_count) {
638 pqos_mon_start_pids(added_pids.size, added_pids.pids, ngroup->events,
639 (void *)ngroup->desc, group_mon_data);
640 if (PQOS_RETVAL_OK == start_result) {
641 ngroup->monitored_pids_count = added_pids.size;
643 ERROR(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\'. Error [%d] while "
644 "STARTING pids monitoring",
645 ngroup->desc, start_result);
647 goto pqos_error_recovery;
653 pqos_mon_add_pids(added_pids.size, added_pids.pids, group_mon_data);
654 if (PQOS_RETVAL_OK == add_result)
655 ngroup->monitored_pids_count += added_pids.size;
658 ": rdt_refresh_ngroup: \'%s\'. Error [%d] while ADDING pids.",
659 ngroup->desc, add_result);
661 goto pqos_error_recovery;
666 if (removed_pids.size > 0) {
668 /* all pids are removed: stop monitoring */
669 if (removed_pids.size == ngroup->monitored_pids_count) {
670 /* all pids for this group are lost: stop monitoring */
671 int stop_result = pqos_mon_stop(group_mon_data);
672 if (PQOS_RETVAL_OK != stop_result) {
673 ERROR(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\'. Error [%d] while "
674 "STOPPING monitoring",
675 ngroup->desc, stop_result);
677 goto pqos_error_recovery;
679 ngroup->monitored_pids_count = 0;
681 int remove_result = pqos_mon_remove_pids(
682 removed_pids.size, removed_pids.pids, group_mon_data);
683 if (PQOS_RETVAL_OK == remove_result) {
684 ngroup->monitored_pids_count -= removed_pids.size;
687 ": rdt_refresh_ngroup: \'%s\'. Error [%d] while REMOVING pids.",
688 ngroup->desc, remove_result);
690 goto pqos_error_recovery;
699 * Resources might be temporary unavailable.
702 * Collectd will halt the reading thread for this
703 * plugin if it returns an error.
704 * Consecutive errors will be increasing the read period
705 * up to 1 day interval.
706 * On pqos error stop monitoring current group
707 * and reset the proc_pids array
708 * monitoring will be restarted on next collectd read cycle
710 DEBUG(RDT_PLUGIN ": rdt_refresh_ngroup: \'%s\' group RESET after error.",
712 pqos_mon_stop(group_mon_data);
713 for (size_t i = 0; i < ngroup->num_names; ++i)
714 if (ngroup->proc_pids[i]->curr)
715 ngroup->proc_pids[i]->curr->size = 0;
717 ngroup->monitored_pids_count = 0;
720 pids_list_clear(&added_pids);
721 pids_list_clear(&removed_pids);
731 * Poll monitoring statistics for name groups
734 * 0 on success. Negative number on error.
736 static int read_pids_data() {
738 if (0 == g_rdt->num_ngroups) {
739 DEBUG(RDT_PLUGIN ": read_pids_data: not configured - PIDs read skipped");
743 DEBUG(RDT_PLUGIN ": read_pids_data: Scanning active groups");
744 struct pqos_mon_data *active_groups[RDT_MAX_NAMES_GROUPS] = {0};
745 size_t active_group_idx = 0;
746 for (size_t pngroups_idx = 0;
747 pngroups_idx < STATIC_ARRAY_SIZE(g_rdt->pngroups); ++pngroups_idx)
748 if (0 != g_rdt->ngroups[pngroups_idx].monitored_pids_count)
749 active_groups[active_group_idx++] = g_rdt->pngroups[pngroups_idx];
753 if (0 == active_group_idx) {
754 DEBUG(RDT_PLUGIN ": read_pids_data: no active groups - PIDs read skipped");
758 DEBUG(RDT_PLUGIN ": read_pids_data: PIDs data polling");
760 int poll_result = pqos_mon_poll(active_groups, active_group_idx);
761 if (poll_result != PQOS_RETVAL_OK) {
762 ERROR(RDT_PLUGIN ": read_pids_data: Failed to poll monitoring data for "
769 for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
770 enum pqos_mon_event mbm_events =
771 (PQOS_MON_EVENT_LMEM_BW | PQOS_MON_EVENT_TMEM_BW |
772 PQOS_MON_EVENT_RMEM_BW);
774 if (g_rdt->pngroups[i] == NULL ||
775 g_rdt->ngroups[i].monitored_pids_count == 0)
778 const struct pqos_event_values *pv = &g_rdt->pngroups[i]->values;
780 /* Submit only monitored events data */
782 if (g_rdt->ngroups[i].events & PQOS_MON_EVENT_L3_OCCUP)
783 rdt_submit_gauge(g_rdt->ngroups[i].desc, "bytes", "llc", pv->llc);
785 if (g_rdt->ngroups[i].events & PQOS_PERF_EVENT_IPC)
786 rdt_submit_gauge(g_rdt->ngroups[i].desc, "ipc", NULL, pv->ipc);
788 if (g_rdt->ngroups[i].events & mbm_events) {
789 rdt_submit_derive(g_rdt->ngroups[i].desc, "memory_bandwidth", "local",
790 pv->mbm_local_delta);
791 rdt_submit_derive(g_rdt->ngroups[i].desc, "memory_bandwidth", "remote",
792 pv->mbm_remote_delta);
797 rdt_dump_pids_data();
798 #endif /* COLLECT_DEBUG */
801 ret = proc_pids_update(RDT_PROC_PATH, g_rdt->proc_pids, g_rdt->num_proc_pids);
803 ERROR(RDT_PLUGIN ": Initial update of proc pids failed");
807 for (size_t i = 0; i < g_rdt->num_ngroups; i++) {
809 rdt_refresh_ngroup(&(g_rdt->ngroups[i]), g_rdt->pngroups[i]);
811 if (0 != refresh_result) {
812 ERROR(RDT_PLUGIN ": read_pids_data: NGroup %zu refresh failed. Error: %d",
815 /* refresh error will be escalated only if there were no
818 ret = refresh_result;
829 * rdt_init_pids_monitoring
832 * Initialize pids monitoring for all name groups
834 static void rdt_init_pids_monitoring() {
835 for (size_t group_idx = 0; group_idx < g_rdt->num_ngroups; group_idx++) {
837 * Each group must have not-null proc_pids array.
838 * Initial refresh is not mandatory for proper
839 * PIDs statistics detection.
841 rdt_name_group_t *ng = &g_rdt->ngroups[group_idx];
843 proc_pids_init((const char **)ng->names, ng->num_names, &ng->proc_pids);
844 if (0 != init_result) {
846 ": Initialization of proc_pids for group %zu failed. Error: %d",
847 group_idx, init_result);
851 /* update global proc_pids table */
852 proc_pids_t **proc_pids = realloc(g_rdt->proc_pids,
853 (g_rdt->num_proc_pids + ng->num_names) *
854 sizeof(*g_rdt->proc_pids));
855 if (NULL == proc_pids) {
856 ERROR(RDT_PLUGIN ": Alloc error\n");
860 for (size_t i = 0; i < ng->num_names; i++)
861 proc_pids[g_rdt->num_proc_pids + i] = ng->proc_pids[i];
863 g_rdt->proc_pids = proc_pids;
864 g_rdt->num_proc_pids += ng->num_names;
868 proc_pids_update(RDT_PROC_PATH, g_rdt->proc_pids, g_rdt->num_proc_pids);
869 if (0 != update_result)
870 ERROR(RDT_PLUGIN ": Initial update of proc pids failed");
872 for (size_t group_idx = 0; group_idx < g_rdt->num_ngroups; group_idx++) {
873 int refresh_result = rdt_refresh_ngroup(&(g_rdt->ngroups[group_idx]),
874 g_rdt->pngroups[group_idx]);
875 if (0 != refresh_result)
876 ERROR(RDT_PLUGIN ": Initial refresh of group %zu failed. Error: %d",
877 group_idx, refresh_result);
880 #endif /* LIBPQOS2 */
886 * Function to deallocate memory allocated for core groups.
888 static void rdt_free_cgroups(void) {
889 config_cores_cleanup(&g_rdt->cores);
890 for (int i = 0; i < RDT_MAX_CORES; i++) {
891 sfree(g_rdt->pcgroups[i]);
895 static int rdt_default_cgroups(void) {
896 unsigned num_cores = g_rdt->pqos_cpu->num_cores;
898 g_rdt->cores.cgroups = calloc(num_cores, sizeof(*(g_rdt->cores.cgroups)));
899 if (g_rdt->cores.cgroups == NULL) {
900 ERROR(RDT_PLUGIN ": Error allocating core groups array");
903 g_rdt->cores.num_cgroups = num_cores;
905 /* configure each core in separate group */
906 for (unsigned i = 0; i < num_cores; i++) {
907 core_group_t *cgroup = g_rdt->cores.cgroups + i;
908 char desc[DATA_MAX_NAME_LEN];
910 /* set core group info */
911 cgroup->cores = calloc(1, sizeof(*cgroup->cores));
912 if (cgroup->cores == NULL) {
913 ERROR(RDT_PLUGIN ": Error allocating cores array");
917 cgroup->num_cores = 1;
918 cgroup->cores[0] = i;
920 snprintf(desc, sizeof(desc), "%d", g_rdt->pqos_cpu->cores[i].lcore);
921 cgroup->desc = strdup(desc);
922 if (cgroup->desc == NULL) {
923 ERROR(RDT_PLUGIN ": Error allocating core group description");
932 static int rdt_is_core_id_valid(unsigned int core_id) {
934 for (unsigned int i = 0; i < g_rdt->pqos_cpu->num_cores; i++)
935 if (core_id == g_rdt->pqos_cpu->cores[i].lcore)
941 static int rdt_config_cgroups(oconfig_item_t *item) {
943 enum pqos_mon_event events = 0;
945 if (config_cores_parse(item, &g_rdt->cores) < 0) {
947 ERROR(RDT_PLUGIN ": Error parsing core groups configuration.");
950 n = g_rdt->cores.num_cgroups;
952 /* validate configured core id values */
953 for (size_t group_idx = 0; group_idx < n; group_idx++) {
954 core_group_t *cgroup = g_rdt->cores.cgroups + group_idx;
955 for (size_t core_idx = 0; core_idx < cgroup->num_cores; core_idx++) {
956 if (!rdt_is_core_id_valid(cgroup->cores[core_idx])) {
957 ERROR(RDT_PLUGIN ": Core group '%s' contains invalid core id '%u'",
958 cgroup->desc, cgroup->cores[core_idx]);
966 /* create default core groups if "Cores" config option is empty */
967 int ret = rdt_default_cgroups();
970 ERROR(RDT_PLUGIN ": Error creating default core groups configuration.");
975 ": No core groups configured. Default core groups created.");
978 /* Get all available events on this platform */
979 for (unsigned int i = 0; i < g_rdt->cap_mon->u.mon->num_events; i++)
980 events |= g_rdt->cap_mon->u.mon->events[i].type;
982 events &= ~(PQOS_PERF_EVENT_LLC_MISS);
984 DEBUG(RDT_PLUGIN ": Number of cores in the system: %u",
985 g_rdt->pqos_cpu->num_cores);
986 DEBUG(RDT_PLUGIN ": Available events to monitor: %#x", events);
988 g_rdt->cores.num_cgroups = n;
989 for (int i = 0; i < n; i++) {
990 for (int j = 0; j < i; j++) {
992 found = config_cores_cmp_cgroups(&g_rdt->cores.cgroups[j],
993 &g_rdt->cores.cgroups[i]);
996 ERROR(RDT_PLUGIN ": Cannot monitor same cores in different groups.");
1001 g_rdt->events[i] = events;
1002 g_rdt->pcgroups[i] = calloc(1, sizeof(*g_rdt->pcgroups[i]));
1003 if (g_rdt->pcgroups[i] == NULL) {
1005 ERROR(RDT_PLUGIN ": Failed to allocate memory for monitoring data.");
1013 static void rdt_pqos_log(void *context, const size_t size, const char *msg) {
1014 DEBUG(RDT_PLUGIN ": %s", msg);
1017 static int rdt_preinit(void) {
1020 if (g_rdt != NULL) {
1021 /* already initialized if config callback was called before init callback */
1025 g_rdt = calloc(1, sizeof(*g_rdt));
1026 if (g_rdt == NULL) {
1027 ERROR(RDT_PLUGIN ": Failed to allocate memory for rdt context.");
1031 struct pqos_config pqos = {.fd_log = -1,
1032 .callback_log = rdt_pqos_log,
1033 .context_log = NULL,
1036 .interface = PQOS_INTER_OS_RESCTRL_MON};
1037 DEBUG(RDT_PLUGIN ": Initializing PQoS with RESCTRL interface");
1039 .interface = PQOS_INTER_MSR};
1040 DEBUG(RDT_PLUGIN ": Initializing PQoS with MSR interface");
1043 ret = pqos_init(&pqos);
1044 DEBUG(RDT_PLUGIN ": PQoS initialization result: [%d]", ret);
1047 if (ret == PQOS_RETVAL_INTER) {
1048 pqos.interface = PQOS_INTER_MSR;
1049 DEBUG(RDT_PLUGIN ": Initializing PQoS with MSR interface");
1050 ret = pqos_init(&pqos);
1051 DEBUG(RDT_PLUGIN ": PQoS initialization result: [%d]", ret);
1055 if (ret != PQOS_RETVAL_OK) {
1056 ERROR(RDT_PLUGIN ": Error initializing PQoS library!");
1057 goto rdt_preinit_error1;
1060 g_interface = pqos.interface;
1062 ret = pqos_cap_get(&g_rdt->pqos_cap, &g_rdt->pqos_cpu);
1063 if (ret != PQOS_RETVAL_OK) {
1064 ERROR(RDT_PLUGIN ": Error retrieving PQoS capabilities.");
1065 goto rdt_preinit_error2;
1068 ret = pqos_cap_get_type(g_rdt->pqos_cap, PQOS_CAP_TYPE_MON, &g_rdt->cap_mon);
1069 if (ret == PQOS_RETVAL_PARAM) {
1070 ERROR(RDT_PLUGIN ": Error retrieving monitoring capabilities.");
1071 goto rdt_preinit_error2;
1074 if (g_rdt->cap_mon == NULL) {
1077 ": Monitoring capability not detected. Nothing to do for the plugin.");
1078 goto rdt_preinit_error2;
1081 /* Reset pqos monitoring groups registers */
1095 static int rdt_config(oconfig_item_t *ci) {
1096 if (rdt_preinit() != 0) {
1097 g_state = CONFIGURATION_ERROR;
1098 /* if we return -1 at this point collectd
1099 reports a failure in configuration and
1105 for (int i = 0; i < ci->children_num; i++) {
1106 oconfig_item_t *child = ci->children + i;
1108 if (strncasecmp("Cores", child->key, (size_t)strlen("Cores")) == 0) {
1109 if (rdt_config_cgroups(child) != 0) {
1110 g_state = CONFIGURATION_ERROR;
1111 /* if we return -1 at this point collectd
1112 reports a failure in configuration and
1120 #endif /* COLLECT_DEBUG */
1121 } else if (strncasecmp("Processes", child->key,
1122 (size_t)strlen("Processes")) == 0) {
1124 if (g_interface != PQOS_INTER_OS_RESCTRL_MON) {
1125 ERROR(RDT_PLUGIN ": Configuration parameter \"%s\" not supported. "
1126 "Resctrl monitoring is needed for PIDs monitoring.",
1128 g_state = CONFIGURATION_ERROR;
1129 /* if we return -1 at this point collectd
1130 reports a failure in configuration and
1136 if (rdt_config_ngroups(g_rdt, child) != 0) {
1137 g_state = CONFIGURATION_ERROR;
1138 /* if we return -1 at this point collectd
1139 reports a failure in configuration and
1147 #endif /* COLLECT_DEBUG */
1148 #else /* !LIBPQOS2 */
1149 ERROR(RDT_PLUGIN ": Configuration parameter \"%s\" not supported, please "
1150 "recompile collectd with libpqos version 2.0 or newer.",
1152 #endif /* LIBPQOS2 */
1154 ERROR(RDT_PLUGIN ": Unknown configuration parameter \"%s\".", child->key);
1161 static int read_cores_data() {
1163 if (0 == g_rdt->cores.num_cgroups) {
1164 DEBUG(RDT_PLUGIN ": read_cores_data: not configured - Cores read skipped");
1167 DEBUG(RDT_PLUGIN ": read_cores_data: Cores data poll");
1170 pqos_mon_poll(&g_rdt->pcgroups[0], (unsigned)g_rdt->cores.num_cgroups);
1171 if (ret != PQOS_RETVAL_OK) {
1172 ERROR(RDT_PLUGIN ": read_cores_data: Failed to poll monitoring data for "
1173 "cores. Error [%d].",
1178 for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1179 core_group_t *cgroup = g_rdt->cores.cgroups + i;
1180 enum pqos_mon_event mbm_events =
1181 (PQOS_MON_EVENT_LMEM_BW | PQOS_MON_EVENT_TMEM_BW |
1182 PQOS_MON_EVENT_RMEM_BW);
1184 const struct pqos_event_values *pv = &g_rdt->pcgroups[i]->values;
1186 /* Submit only monitored events data */
1188 if (g_rdt->events[i] & PQOS_MON_EVENT_L3_OCCUP)
1189 rdt_submit_gauge(cgroup->desc, "bytes", "llc", pv->llc);
1191 if (g_rdt->events[i] & PQOS_PERF_EVENT_IPC)
1192 rdt_submit_gauge(cgroup->desc, "ipc", NULL, pv->ipc);
1194 if (g_rdt->events[i] & mbm_events) {
1195 rdt_submit_derive(cgroup->desc, "memory_bandwidth", "local",
1196 pv->mbm_local_delta);
1197 rdt_submit_derive(cgroup->desc, "memory_bandwidth", "remote",
1198 pv->mbm_remote_delta);
1203 rdt_dump_cores_data();
1204 #endif /* COLLECT_DEBUG */
1209 static int rdt_read(__attribute__((unused)) user_data_t *ud) {
1211 if (g_rdt == NULL) {
1212 ERROR(RDT_PLUGIN ": rdt_read: plugin not initialized.");
1216 int cores_read_result = read_cores_data();
1219 int pids_read_result = read_pids_data();
1220 #endif /* LIBPQOS2 */
1222 if (0 != cores_read_result)
1223 return cores_read_result;
1226 if (0 != pids_read_result)
1227 return pids_read_result;
1228 #endif /* LIBPQOS2 */
1233 static void rdt_init_cores_monitoring() {
1234 for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1235 core_group_t *cg = g_rdt->cores.cgroups + i;
1237 int mon_start_result =
1238 pqos_mon_start(cg->num_cores, cg->cores, g_rdt->events[i],
1239 (void *)cg->desc, g_rdt->pcgroups[i]);
1241 if (mon_start_result != PQOS_RETVAL_OK)
1243 ": Error starting cores monitoring group %s (pqos status=%d)",
1244 cg->desc, mon_start_result);
1248 static int rdt_init(void) {
1250 if (g_state == CONFIGURATION_ERROR)
1253 int rdt_preinint_result = rdt_preinit();
1254 if (rdt_preinint_result != 0)
1255 return rdt_preinint_result;
1257 rdt_init_cores_monitoring();
1259 rdt_init_pids_monitoring();
1260 #endif /* LIBPQOS2 */
1265 static int rdt_shutdown(void) {
1268 DEBUG(RDT_PLUGIN ": rdt_shutdown.");
1273 /* Stop monitoring cores */
1274 for (size_t i = 0; i < g_rdt->cores.num_cgroups; i++) {
1275 pqos_mon_stop(g_rdt->pcgroups[i]);
1278 /* Stop pids monitoring */
1280 for (size_t i = 0; i < g_rdt->num_ngroups; i++)
1281 pqos_mon_stop(g_rdt->pngroups[i]);
1285 if (ret != PQOS_RETVAL_OK)
1286 ERROR(RDT_PLUGIN ": Error shutting down PQoS library.");
1289 rdt_free_ngroups(g_rdt);
1290 #endif /* LIBPQOS2 */
1296 void module_register(void) {
1297 plugin_register_init(RDT_PLUGIN, rdt_init);
1298 plugin_register_complex_config(RDT_PLUGIN, rdt_config);
1299 plugin_register_complex_read(NULL, RDT_PLUGIN, rdt_read, 0, NULL);
1300 plugin_register_shutdown(RDT_PLUGIN, rdt_shutdown);