Merge branch 'collectd-4.5' into collectd-4.6
[collectd.git] / src / processes.c
index 79451d3..559ba97 100644 (file)
@@ -1,8 +1,9 @@
 /**
  * collectd - src/processes.c
- * Copyright (C) 2005  Lyonel Vincent
- * Copyright (C) 2006-2008  Florian Forster (Mach code)
- * Copyright (C) 2008  Oleg King
+ * Copyright (C) 2005       Lyonel Vincent
+ * Copyright (C) 2006-2008  Florian octo Forster
+ * Copyright (C) 2008       Oleg King
+ * Copyright (C) 2009       Sebastian Harl
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -22,6 +23,7 @@
  *   Lyonel Vincent <lyonel at ezix.org>
  *   Florian octo Forster <octo at verplant.org>
  *   Oleg King <king2 at kaluga.ru>
+ *   Sebastian Harl <sh at tokkee.org>
  **/
 
 #include "collectd.h"
 #  endif
 /* #endif KERNEL_LINUX */
 
-#elif HAVE_KVM_H
+#elif HAVE_LIBKVM_GETPROCS
 #  include <kvm.h>
 #  include <sys/user.h>
 #  include <sys/proc.h>
 #  if HAVE_SYS_SYSCTL_H
 #    include <sys/sysctl.h>
 #  endif
-/* #endif HAVE_KVM_H */
+/* #endif HAVE_LIBKVM_GETPROCS */
 
 #else
 # error "No applicable input method."
 # include <regex.h>
 #endif
 
+#ifndef ARG_MAX
+#  define ARG_MAX 4096
+#endif
+
 #define BUFSIZE 256
 
 static const char *config_keys[] =
 {
        "Process",
-       "ProcessMatch",
-       NULL
+       "ProcessMatch"
 };
 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
 
@@ -118,7 +123,9 @@ typedef struct procstat_entry_s
 
        unsigned long num_proc;
        unsigned long num_lwp;
+       unsigned long vmem_size;
        unsigned long vmem_rss;
+       unsigned long stack_size;
 
        unsigned long vmem_minflt;
        unsigned long vmem_majflt;
@@ -143,7 +150,9 @@ typedef struct procstat
 
        unsigned long num_proc;
        unsigned long num_lwp;
+       unsigned long vmem_size;
        unsigned long vmem_rss;
+       unsigned long stack_size;
 
        unsigned long vmem_minflt_counter;
        unsigned long vmem_majflt_counter;
@@ -167,7 +176,11 @@ static mach_msg_type_number_t     pset_list_len;
 
 #elif KERNEL_LINUX
 static long pagesize_g;
-#endif /* KERNEL_LINUX */
+/* #endif KERNEL_LINUX */
+
+#elif HAVE_LIBKVM_GETPROCS
+/* no global variables */
+#endif /* HAVE_LIBKVM_GETPROCS */
 
 /* put name of process from config to list_head_g tree
    list_head_g is a list of 'procstat_t' structs with
@@ -247,13 +260,32 @@ static void ps_list_register (const char *name, const char *regexp)
 /* try to match name against entry, returns 1 if success */
 static int ps_list_match (const char *name, const char *cmdline, procstat_t *ps)
 {
-       if ((ps->re != NULL) && (regexec(ps->re, (strlen(cmdline)!=0)?cmdline:name, 0, NULL, 0) == 0))
-               return (1);
-       if (strcmp (ps->name, name) == 0) {
-               return (1);
+#if HAVE_REGEX_H
+       if (ps->re != NULL)
+       {
+               int status;
+               const char *str;
+
+               str = cmdline;
+               if ((str == NULL) || (str[0] == 0))
+                       str = name;
+
+               assert (str != NULL);
+
+               status = regexec (ps->re, str,
+                               /* nmatch = */ 0,
+                               /* pmatch = */ NULL,
+                               /* eflags = */ 0);
+               if (status == 0)
+                       return (1);
        }
+       else
+#endif
+       if (strcmp (ps->name, name) == 0)
+               return (1);
+
        return (0);
-}
+} /* int ps_list_match */
 
 /* add process entry to 'instances' of process 'name' (or refresh it) */
 static void ps_list_add (const char *name, const char *cmdline, procstat_entry_t *entry)
@@ -266,7 +298,6 @@ static void ps_list_add (const char *name, const char *cmdline, procstat_entry_t
 
        for (ps = list_head_g; ps != NULL; ps = ps->next)
        {
-
                if ((ps_list_match (name, cmdline, ps)) == 0)
                        continue;
 
@@ -293,13 +324,17 @@ static void ps_list_add (const char *name, const char *cmdline, procstat_entry_t
                }
 
                pse->age = 0;
-               pse->num_proc = entry->num_proc;
-               pse->num_lwp  = entry->num_lwp;
-               pse->vmem_rss = entry->vmem_rss;
-
-               ps->num_proc += pse->num_proc;
-               ps->num_lwp  += pse->num_lwp;
-               ps->vmem_rss += pse->vmem_rss;
+               pse->num_proc   = entry->num_proc;
+               pse->num_lwp    = entry->num_lwp;
+               pse->vmem_size  = entry->vmem_size;
+               pse->vmem_rss   = entry->vmem_rss;
+               pse->stack_size = entry->stack_size;
+
+               ps->num_proc   += pse->num_proc;
+               ps->num_lwp    += pse->num_lwp;
+               ps->vmem_size  += pse->vmem_size;
+               ps->vmem_rss   += pse->vmem_rss;
+               ps->stack_size += pse->stack_size;
 
                if ((entry->vmem_minflt_counter == 0)
                                && (entry->vmem_majflt_counter == 0))
@@ -388,7 +423,9 @@ static void ps_list_reset (void)
        {
                ps->num_proc    = 0;
                ps->num_lwp     = 0;
+               ps->vmem_size   = 0;
                ps->vmem_rss    = 0;
+               ps->stack_size  = 0;
 
                pse_prev = NULL;
                pse = ps->instances;
@@ -432,17 +469,23 @@ static int ps_config (const char *key, const char *value)
        }
        else if (strcasecmp (key, "ProcessMatch") == 0)
        {
-               char *new_val;  
+               char *new_val;
                char *fields[3];
                int fields_num;
 
                new_val = strdup (value);
-               if (new_val == NULL)
+               if (new_val == NULL) {
+                       ERROR ("processes plugin: strdup failed when processing "
+                                       "`ProcessMatch %s'.", value);
                        return (1);
+               }
+
                fields_num = strsplit (new_val, fields,
                                STATIC_ARRAY_SIZE (fields));
                if (fields_num != 2)
                {
+                       ERROR ("processes plugin: `ProcessMatch' needs exactly "
+                                       "two string arguments.");
                        sfree (new_val);
                        return (1);
                }
@@ -451,6 +494,8 @@ static int ps_config (const char *key, const char *value)
        }
        else
        {
+               ERROR ("processes plugin: The `%s' configuration option is not "
+                               "understood and will be ignored.", key);
                return (-1);
        }
 
@@ -490,7 +535,11 @@ static int ps_init (void)
        pagesize_g = sysconf(_SC_PAGESIZE);
        DEBUG ("pagesize_g = %li; CONFIG_HZ = %i;",
                        pagesize_g, CONFIG_HZ);
-#endif /* KERNEL_LINUX */
+/* #endif KERNEL_LINUX */
+
+#elif HAVE_LIBKVM_GETPROCS
+/* no initialization */
+#endif /* HAVE_LIBKVM_GETPROCS */
 
        return (0);
 } /* int ps_init */
@@ -505,11 +554,10 @@ static void ps_submit_state (const char *state, double value)
 
        vl.values = values;
        vl.values_len = 1;
-       vl.time = time (NULL);
-       strcpy (vl.host, hostname_g);
-       strcpy (vl.plugin, "processes");
-       strcpy (vl.plugin_instance, "");
-       strcpy (vl.type, "ps_state");
+       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.plugin, "processes", sizeof (vl.plugin));
+       sstrncpy (vl.plugin_instance, "", sizeof (vl.plugin_instance));
+       sstrncpy (vl.type, "ps_state", sizeof (vl.type));
        sstrncpy (vl.type_instance, state, sizeof (vl.type_instance));
 
        plugin_dispatch_values (&vl);
@@ -523,29 +571,38 @@ static void ps_submit_proc_list (procstat_t *ps)
 
        vl.values = values;
        vl.values_len = 2;
-       vl.time = time (NULL);
-       strcpy (vl.host, hostname_g);
-       strcpy (vl.plugin, "processes");
+       sstrncpy (vl.host, hostname_g, sizeof (vl.host));
+       sstrncpy (vl.plugin, "processes", sizeof (vl.plugin));
        sstrncpy (vl.plugin_instance, ps->name, sizeof (vl.plugin_instance));
 
-       strcpy (vl.type, "ps_rss");
+       sstrncpy (vl.type, "ps_vm", sizeof (vl.type));
+       vl.values[0].gauge = ps->vmem_size;
+       vl.values_len = 1;
+       plugin_dispatch_values (&vl);
+
+       sstrncpy (vl.type, "ps_rss", sizeof (vl.type));
        vl.values[0].gauge = ps->vmem_rss;
        vl.values_len = 1;
        plugin_dispatch_values (&vl);
 
-       strcpy (vl.type, "ps_cputime");
+       sstrncpy (vl.type, "ps_stacksize", sizeof (vl.type));
+       vl.values[0].gauge = ps->stack_size;
+       vl.values_len = 1;
+       plugin_dispatch_values (&vl);
+
+       sstrncpy (vl.type, "ps_cputime", sizeof (vl.type));
        vl.values[0].counter = ps->cpu_user_counter;
        vl.values[1].counter = ps->cpu_system_counter;
        vl.values_len = 2;
        plugin_dispatch_values (&vl);
 
-       strcpy (vl.type, "ps_count");
+       sstrncpy (vl.type, "ps_count", sizeof (vl.type));
        vl.values[0].gauge = ps->num_proc;
        vl.values[1].gauge = ps->num_lwp;
        vl.values_len = 2;
        plugin_dispatch_values (&vl);
 
-       strcpy (vl.type, "ps_pagefaults");
+       sstrncpy (vl.type, "ps_pagefaults", sizeof (vl.type));
        vl.values[0].counter = ps->vmem_minflt_counter;
        vl.values[1].counter = ps->vmem_majflt_counter;
        vl.values_len = 2;
@@ -626,7 +683,6 @@ int ps_read_process (int pid, procstat_t *ps, char *state)
 {
        char  filename[64];
        char  buffer[1024];
-       FILE *fh;
 
        char *fields[64];
        char  fields_len;
@@ -639,22 +695,18 @@ int ps_read_process (int pid, procstat_t *ps, char *state)
 
        long long unsigned cpu_user_counter;
        long long unsigned cpu_system_counter;
+       long long unsigned vmem_size;
        long long unsigned vmem_rss;
+       long long unsigned stack_size;
 
        memset (ps, 0, sizeof (procstat_t));
 
        ssnprintf (filename, sizeof (filename), "/proc/%i/stat", pid);
 
-       if ((fh = fopen (filename, "r")) == NULL)
-               return (-1);
-
-       if (fgets (buffer, 1024, fh) == NULL)
-       {
-               fclose (fh);
+       i = read_file_contents (filename, buffer, sizeof(buffer) - 1);
+       if (i <= 0)
                return (-1);
-       }
-
-       fclose (fh);
+       buffer[i] = 0;
 
        fields_len = strsplit (buffer, fields, 64);
        if (fields_len < 24)
@@ -712,10 +764,20 @@ int ps_read_process (int pid, procstat_t *ps, char *state)
 
        cpu_user_counter   = atoll (fields[13]);
        cpu_system_counter = atoll (fields[14]);
-       vmem_rss = atoll (fields[23]);
+       vmem_size          = atoll (fields[22]);
+       vmem_rss           = atoll (fields[23]);
        ps->vmem_minflt_counter = atol (fields[9]);
        ps->vmem_majflt_counter = atol (fields[11]);
-       
+
+       {
+               unsigned long long stack_start = atoll (fields[27]);
+               unsigned long long stack_ptr   = atoll (fields[28]);
+
+               stack_size = (stack_start > stack_ptr)
+                       ? stack_start - stack_ptr
+                       : stack_ptr - stack_start;
+       }
+
        /* Convert jiffies to useconds */
        cpu_user_counter   = cpu_user_counter   * 1000000 / CONFIG_HZ;
        cpu_system_counter = cpu_system_counter * 1000000 / CONFIG_HZ;
@@ -723,11 +785,103 @@ int ps_read_process (int pid, procstat_t *ps, char *state)
 
        ps->cpu_user_counter = (unsigned long) cpu_user_counter;
        ps->cpu_system_counter = (unsigned long) cpu_system_counter;
+       ps->vmem_size = (unsigned long) vmem_size;
        ps->vmem_rss = (unsigned long) vmem_rss;
+       ps->stack_size = (unsigned long) stack_size;
 
        /* success */
        return (0);
 } /* int ps_read_process (...) */
+
+static char *ps_get_cmdline (pid_t pid, char *name, char *buf, size_t buf_len)
+{
+       char  *buf_ptr;
+       size_t len;
+
+       char file[PATH_MAX];
+       int  fd;
+
+       size_t n;
+
+       if ((pid < 1) || (NULL == buf) || (buf_len < 2))
+               return NULL;
+
+       ssnprintf (file, sizeof (file), "/proc/%u/cmdline", pid);
+
+       fd = open (file, O_RDONLY);
+       if (fd < 0) {
+               char errbuf[4096];
+               WARNING ("processes plugin: Failed to open `%s': %s.", file,
+                               sstrerror (errno, errbuf, sizeof (errbuf)));
+               return NULL;
+       }
+
+       buf_ptr = buf;
+       len     = buf_len;
+
+       n = 0;
+
+       while (42) {
+               ssize_t status;
+
+               status = read (fd, (void *)buf_ptr, len);
+
+               if (status < 0) {
+                       char errbuf[4096];
+
+                       if ((EAGAIN == errno) || (EINTR == errno))
+                               continue;
+
+                       WARNING ("processes plugin: Failed to read from `%s': %s.", file,
+                                       sstrerror (errno, errbuf, sizeof (errbuf)));
+                       close (fd);
+                       return NULL;
+               }
+
+               n += status;
+
+               if (status == 0)
+                       break;
+
+               buf_ptr += status;
+               len     -= status;
+
+               if (len <= 0)
+                       break;
+       }
+
+       close (fd);
+
+       if (0 == n) {
+               /* cmdline not available; e.g. kernel thread, zombie */
+               if (NULL == name)
+                       return NULL;
+
+               ssnprintf (buf, buf_len, "[%s]", name);
+               return buf;
+       }
+
+       assert (n <= buf_len);
+
+       if (n == buf_len)
+               --n;
+       buf[n] = '\0';
+
+       --n;
+       /* remove trailing whitespace */
+       while ((n > 0) && (isspace (buf[n]) || ('\0' == buf[n]))) {
+               buf[n] = '\0';
+               --n;
+       }
+
+       /* arguments are separated by '\0' in /proc/<pid>/cmdline */
+       while (n > 0) {
+               if ('\0' == buf[n])
+                       buf[n] = ' ';
+               --n;
+       }
+       return buf;
+} /* char *ps_get_cmdline (...) */
 #endif /* KERNEL_LINUX */
 
 #if HAVE_THREAD_INFO
@@ -838,7 +992,8 @@ static int ps_read (void)
                        {
                                /* search for at least one match */
                                for (ps = list_head_g; ps != NULL; ps = ps->next)
-                                       if (ps_list_match(task_name, NULL, ps) == 1) //!!! cmdline should be here instead of NULL
+                                       /* FIXME: cmdline should be here instead of NULL */
+                                       if (ps_list_match (task_name, NULL, ps) == 1)
                                                break;
                        }
 
@@ -959,7 +1114,7 @@ static int ps_read (void)
                                         * There's only zombie tasks, which are
                                         * handled above. */
                                        default:
-                                               WARNING ("Unknown thread status: %s",
+                                               WARNING ("Unknown thread status: %i",
                                                                thread_data.run_state);
                                                break;
                                } /* switch (thread_data.run_state) */
@@ -998,7 +1153,8 @@ static int ps_read (void)
                        }
 
                        if (ps != NULL)
-                               ps_list_add (task_name, NULL, &pse); //!!! cmdline should be here instead of NULL
+                               /* FIXME: cmdline should be here instead of NULL */
+                               ps_list_add (task_name, NULL, &pse);
                } /* for (task_list) */
 
                if ((status = vm_deallocate (port_task_self,
@@ -1041,6 +1197,8 @@ static int ps_read (void)
        DIR           *proc;
        int            pid;
 
+       char cmdline[ARG_MAX];
+
        int        status;
        procstat_t ps;
        procstat_entry_t pse;
@@ -1077,9 +1235,11 @@ static int ps_read (void)
                pse.id       = pid;
                pse.age      = 0;
 
-               pse.num_proc = ps.num_proc;
-               pse.num_lwp  = ps.num_lwp;
-               pse.vmem_rss = ps.vmem_rss;
+               pse.num_proc   = ps.num_proc;
+               pse.num_lwp    = ps.num_lwp;
+               pse.vmem_size  = ps.vmem_size;
+               pse.vmem_rss   = ps.vmem_rss;
+               pse.stack_size = ps.stack_size;
 
                pse.vmem_minflt = 0;
                pse.vmem_minflt_counter = ps.vmem_minflt_counter;
@@ -1101,7 +1261,9 @@ static int ps_read (void)
                        case 'W': paging++;   break;
                }
 
-               ps_list_add (ps.name, NULL, &pse); //!!! cmdline should be here instead of NULL
+               ps_list_add (ps.name,
+                               ps_get_cmdline (pid, ps.name, cmdline, sizeof (cmdline)),
+                               &pse);
        }
 
        closedir (proc);
@@ -1117,7 +1279,7 @@ static int ps_read (void)
                ps_submit_proc_list (ps_ptr);
 /* #endif KERNEL_LINUX */
 
-#elif HAVE_LIBKVM
+#elif HAVE_LIBKVM_GETPROCS
        int running  = 0;
        int sleeping = 0;
        int zombies  = 0;
@@ -1129,10 +1291,11 @@ static int ps_read (void)
        kvm_t *kd;
        char errbuf[1024];
        char cmdline[ARG_MAX];
+       char *cmdline_ptr;
        struct kinfo_proc *procs;          /* array of processes */
-       char ** argv;
+       char **argv;
        int count;                         /* returns number of processes */
-       int i, j;
+       int i;
 
        procstat_t *ps_ptr;
        procstat_entry_t pse;
@@ -1140,32 +1303,54 @@ static int ps_read (void)
        ps_list_reset ();
 
        /* Open the kvm interface, get a descriptor */
-       if ((kd = kvm_open(NULL, NULL, NULL, 0, errbuf)) == NULL) {
-               ERROR ("Cannot open kvm interface: %s", errbuf);
+       kd = kvm_open (NULL, NULL, NULL, 0, errbuf);
+       if (kd == NULL)
+       {
+               ERROR ("processes plugin: Cannot open kvm interface: %s",
+                               errbuf);
                return (0);
-       }  
-     
+       }
+
        /* Get the list of processes. */
-       if ((procs = kvm_getprocs(kd, KERN_PROC_ALL, 0, &count)) == NULL) {
-               kvm_close(kd);
-               ERROR ("Cannot get kvm processes list: %s", kvm_geterr(kd));
+       procs = kvm_getprocs(kd, KERN_PROC_ALL, 0, &count);
+       if (procs == NULL)
+       {
+               kvm_close (kd);
+               ERROR ("processes plugin: Cannot get kvm processes list: %s",
+                               kvm_geterr(kd));
                return (0);
        }
 
        /* Iterate through the processes in kinfo_proc */
-       for (i=0; i < count; i++) {
-               // retrieve the arguments
-               *cmdline = '\0';
-               argv = kvm_getargv(kd, (const struct kinfo_proc *) &(procs[i]), 0);
-               if (argv) {
-                       j = 0;
-                       while (argv[j] && strlen(cmdline) <= ARG_MAX) {
-                               if (j)
-                                       strncat(cmdline, " ", 1);
-                               strncat(cmdline, argv[j], strlen(argv[j]));
-                               j++;
+       for (i = 0; i < count; i++)
+       {
+               /* retrieve the arguments */
+               cmdline[0] = 0;
+               cmdline_ptr = NULL;
+
+               argv = kvm_getargv (kd, (const struct kinfo_proc *) &(procs[i]), 0);
+               if (argv != NULL)
+               {
+                       int status;
+                       int argc;
+
+                       argc = 0;
+                       while (argv[argc] != NULL)
+                               argc++;
+
+                       status = strjoin (cmdline, sizeof (cmdline),
+                                       argv, argc, " ");
+
+                       if (status < 0)
+                       {
+                               WARNING ("processes plugin: Command line did "
+                                               "not fit into buffer.");
                        }
-               }  
+                       else
+                       {
+                               cmdline_ptr = &cmdline[0];
+                       }
+               }
 
                pse.id       = procs[i].ki_pid;
                pse.age      = 0;
@@ -1173,18 +1358,25 @@ static int ps_read (void)
                pse.num_proc = 1;
                pse.num_lwp  = procs[i].ki_numthreads;
 
+               /* pse.vmem_size = procs[i].ki_size; */
                pse.vmem_rss = procs[i].ki_rssize * getpagesize();
+               /* pse.stack_size = procs[i].ki_ssize * getpagesize(); */
                pse.vmem_minflt = 0;
                pse.vmem_minflt_counter = procs[i].ki_rusage.ru_minflt;
                pse.vmem_majflt = 0;
                pse.vmem_majflt_counter = procs[i].ki_rusage.ru_majflt;
 
                pse.cpu_user = 0;
-               pse.cpu_user_counter = procs[i].ki_rusage.ru_utime.tv_sec*1000 + procs[i].ki_rusage.ru_utime.tv_usec;
+               pse.cpu_user_counter = procs[i].ki_rusage.ru_utime.tv_sec
+                       * 1000
+                       + procs[i].ki_rusage.ru_utime.tv_usec;
                pse.cpu_system = 0;
-               pse.cpu_system_counter = procs[i].ki_rusage.ru_stime.tv_sec*1000 + procs[i].ki_rusage.ru_stime.tv_usec;
+               pse.cpu_system_counter = procs[i].ki_rusage.ru_stime.tv_sec
+                       * 1000
+                       + procs[i].ki_rusage.ru_stime.tv_usec;
 
-               switch (procs[i].ki_stat) {
+               switch (procs[i].ki_stat)
+               {
                        case SSTOP:     stopped++;      break;
                        case SSLEEP:    sleeping++;     break;
                        case SRUN:      running++;      break;
@@ -1194,10 +1386,10 @@ static int ps_read (void)
                        case SZOMB:     zombies++;      break;
                }
 
-               ps_list_add (procs[i].ki_comm, cmdline, &pse);
+               ps_list_add (procs[i].ki_comm, cmdline_ptr, &pse);
        }
 
-       if (kd) kvm_close(kd);
+       kvm_close(kd);
 
        ps_submit_state ("running",  running);
        ps_submit_state ("sleeping", sleeping);
@@ -1209,8 +1401,7 @@ static int ps_read (void)
 
        for (ps_ptr = list_head_g; ps_ptr != NULL; ps_ptr = ps_ptr->next)
                ps_submit_proc_list (ps_ptr);
-
-#endif /* HAVE_LIBKVM */
+#endif /* HAVE_LIBKVM_GETPROCS */
 
        return (0);
 } /* int ps_read */