pluginlaunch.c File Reference

Manages the launching of plugins within processes. More...

#include "pluginlaunch.h"
#include "../misc/heartbeat.h"
#include "../misc/network.h"
#include "../misc/nvt_categories.h"
#include "../misc/plugutils.h"
#include "pluginload.h"
#include "pluginscheduler.h"
#include "plugs_req.h"
#include "processes.h"
#include "sighand.h"
#include "utils.h"
#include <errno.h>
#include <gvm/base/prefs.h>
#include <gvm/util/nvticache.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <strings.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <unistd.h>

Include dependency graph for pluginlaunch.c:

Go to the source code of this file.

Data Structures
struct	running
	Structure to represent a process in the sense of a running NVT. More...

Macros
#define	G_LOG_DOMAIN   "sd main"
	GLib log domain.
#define	MAX_PROCESSES   32
	'Hard' limit of the max. number of concurrent plugins per host.

Functions
static int	max_nvt_timeouts_reached ()
	Check if max_nvt_timeouts is set and if has been reached.
static void	update_running_processes (kb_t main_kb, kb_t kb)
static int	common (GSList *list1, GSList *list2)
static GSList *	required_ports_in_list (const char *oid, GSList *list)
static int	simult_ports (const char *oid, const char *next_oid)
static int	next_free_process (kb_t main_kb, kb_t kb, struct scheduler_plugin *upcoming)
void	pluginlaunch_init (const char *host)
void	pluginlaunch_disable_parallel_checks (void)
void	pluginlaunch_enable_parallel_checks (void)
void	pluginlaunch_stop (void)
static int	plugin_timeout (nvti_t *nvti)
static int	get_available_memory ()
static int	check_memory ()
static int	check_sysload ()
int	plugin_launch (struct scan_globals *globals, struct scheduler_plugin *plugin, struct in6_addr *ip, GSList *vhosts, kb_t kb, kb_t main_kb, nvti_t *nvti, int *error)
	Start a plugin.
void	pluginlaunch_wait (kb_t main_kb, kb_t kb)
	Waits and 'pushes' processes until num_running_processes is 0.
static int	timeout_running_processes (void)
	Return shortest timeout of the running processes.
void	pluginlaunch_wait_for_free_process (kb_t main_kb, kb_t kb)
	Waits and 'pushes' processes until the number of running processes has changed.

Variables
int	global_min_memory
int	global_max_sysload
static struct running	processes [MAX_PROCESSES]
static int	num_running_processes
static int	max_running_processes
static int	old_max_running_processes
static GSList *	non_simult_ports = NULL
const char *	hostname = NULL

Detailed Description

Manages the launching of plugins within processes.

Definition in file pluginlaunch.c.

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "sd main"

GLib log domain.

Definition at line 41 of file pluginlaunch.c.

MAX_PROCESSES

#define MAX_PROCESSES   32

'Hard' limit of the max. number of concurrent plugins per host.

Definition at line 46 of file pluginlaunch.c.

Function Documentation

check_memory()

static int check_memory ( )

static

Definition at line 421 of file pluginlaunch.c.

{
  int available_mem;
 
  if (global_min_memory <= 0)
    return 0;
 
  available_mem = get_available_memory ();
  if (available_mem == 0 || available_mem > global_min_memory)
    return 0;
  return 1;
}

References get_available_memory(), and global_min_memory.

Referenced by pluginlaunch_wait_for_free_process().

Here is the call graph for this function:

Here is the caller graph for this function:

check_sysload()

static int check_sysload ( )

static

Definition at line 435 of file pluginlaunch.c.

{
  double sysload;
 
  if (global_max_sysload <= 0)
    return 0;
  if (getloadavg (&sysload, 1) < 0 || sysload <= global_max_sysload)
    return 0;
  return 1;
}

References global_max_sysload.

Referenced by pluginlaunch_wait_for_free_process().

Here is the caller graph for this function:

common()

static int common ( GSList *  list1, GSList *  list2  )

static

Definition at line 218 of file pluginlaunch.c.

{
  if (!list1 || !list2)
    return 0;
 
  while (list1)
    {
      GSList *tmp = list2;
      while (tmp)
        {
          if (!strcmp (list1->data, tmp->data))
            return 1;
          tmp = tmp->next;
        }
      list1 = list1->next;
    }
  return 0;
}

Referenced by simult_ports().

Here is the caller graph for this function:

get_available_memory()

static int get_available_memory ( )

static

Definition at line 399 of file pluginlaunch.c.

{
  char buf[8192], *hit;
  FILE *fd;
  size_t len;
 
  fd = fopen ("/proc/meminfo", "r");
  len = fread (buf, 1, sizeof (buf) - 1, fd);
  fclose (fd);
  if (len == 0)
    {
      g_warning ("Couldn't read /proc/meminfo");
      return 0;
    }
  hit = strstr (buf, "MemAvailable:");
  if (!hit)
    return 0;
 
  return atoi (hit + 14) / 1000;
}

References len.

Referenced by check_memory().

Here is the caller graph for this function:

max_nvt_timeouts_reached()

static int max_nvt_timeouts_reached ( )

static

Check if max_nvt_timeouts is set and if has been reached.

Returns

1 if reached, 0 if not reached or no set.

Definition at line 76 of file pluginlaunch.c.

{
  static int vts_timeouts_counter = 0;
  int max_vts_timeouts = 0;
  const gchar *max_vts_timeouts_str = NULL;
 
  /* Check if set */
  if ((max_vts_timeouts_str = prefs_get ("max_vts_timeouts")) == NULL)
    {
      g_debug ("%s: max_vts_timeouts not set.", __func__);
      return 0;
    }
 
  /* Check if enabled and valid value */
  max_vts_timeouts = atoi (max_vts_timeouts_str);
  if (max_vts_timeouts <= 0)
    {
      g_debug ("%s: max_vts_timeouts disabled", __func__);
      return 0;
    }
 
  vts_timeouts_counter++;
  /* Check if reached */
  if (vts_timeouts_counter >= max_vts_timeouts)
    return 1;
 
  return 0;
}

Referenced by update_running_processes().

Here is the caller graph for this function:

next_free_process()

static int next_free_process ( kb_t  main_kb, kb_t  kb, struct scheduler_plugin *  upcoming  )

static

If another NVT with same port requirements is running, wait.

Returns

ERR_NO_FREE_SLOT if MAX_PROCESSES are running, the index of the first free "slot" in the processes array otherwise.

Definition at line 292 of file pluginlaunch.c.

{
  int r;
 
  for (r = 0; r < MAX_PROCESSES; r++)
    {
      if (processes[r].pid > 0
          && simult_ports (processes[r].plugin->oid, upcoming->oid))
        {
          while (process_alive (processes[r].pid))
            {
              update_running_processes (main_kb, kb);
              usleep (250000);
            }
        }
    }
  for (r = 0; r < MAX_PROCESSES; r++)
    if (processes[r].pid <= 0)
      return r;
  return ERR_NO_FREE_SLOT;
}

References ERR_NO_FREE_SLOT, main_kb, MAX_PROCESSES, scheduler_plugin::oid, pid, process_alive(), processes, simult_ports(), and update_running_processes().

Referenced by plugin_launch().

Here is the call graph for this function:

Here is the caller graph for this function:

plugin_launch()

int plugin_launch	(	struct scan_globals *	globals,
		struct scheduler_plugin *	plugin,
		struct in6_addr *	ip,
		GSList *	vhosts,
		kb_t	kb,
		kb_t	main_kb,
		nvti_t *	nvti,
		int *	error
	)

Start a plugin.

Check for free slots available in the process table. Set error with ERR_NO_FREE_SLOT if the process table is full. Set error with ERR_CANT_FORK if was not possible to fork() a new child.

Returns

PID of process that is connected to the plugin as returned by plugin classes pl_launch function. Less than 0 means there was a problem, but error param should be checked.

Definition at line 458 of file pluginlaunch.c.

{
  int p;
 
  /* Wait for a free slot */
  pluginlaunch_wait_for_free_process (main_kb, kb);
  p = next_free_process (main_kb, kb, plugin);
  if (p < 0)
    {
      g_warning ("%s. There is currently no free slot available for starting a "
                 "new plugin.",
                 __func__);
      *error = ERR_NO_FREE_SLOT;
      return -1;
    }
 
  processes[p].plugin = plugin;
  processes[p].timeout = plugin_timeout (nvti);
  gettimeofday (&(processes[p].start), NULL);
  processes[p].pid = nasl_plugin_launch (globals, ip, vhosts, kb, plugin->oid);
 
  if (processes[p].pid > 0)
    num_running_processes++;
  else
    {
      processes[p].plugin->running_state = PLUGIN_STATUS_UNRUN;
      *error = ERR_CANT_FORK;
    }
  return processes[p].pid;
}

References ERR_CANT_FORK, ERR_NO_FREE_SLOT, main_kb, nasl_plugin_launch(), next_free_process(), num_running_processes, scheduler_plugin::oid, pid, running::pid, running::plugin, PLUGIN_STATUS_UNRUN, plugin_timeout(), pluginlaunch_wait_for_free_process(), processes, scheduler_plugin::running_state, and running::timeout.

Referenced by launch_plugin().

Here is the call graph for this function:

Here is the caller graph for this function:

plugin_timeout()

static int plugin_timeout ( nvti_t *  nvti )

static

Definition at line 372 of file pluginlaunch.c.

{
  int timeout, tmp;
  gchar *timeout_str;
 
  timeout = 0;
  if ((timeout_str = get_plugin_preference (nvti_oid (nvti), "timeout", 0))
      != NULL)
    timeout = atoi (timeout_str);
 
  if (timeout == 0)
    {
      if (nvti_category (nvti) == ACT_SCANNER)
        {
          tmp = atoi (prefs_get ("scanner_plugins_timeout"));
          timeout = tmp ? tmp : SCANNER_NVT_TIMEOUT;
        }
      else
        {
          tmp = atoi (prefs_get ("plugins_timeout"));
          timeout = tmp ? tmp : NVT_TIMEOUT;
        }
    }
  return timeout;
}

References ACT_SCANNER, and get_plugin_preference().

Referenced by plugin_launch().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginlaunch_disable_parallel_checks()

void pluginlaunch_disable_parallel_checks

(

void

)

Definition at line 340 of file pluginlaunch.c.

{
  max_running_processes = 1;
}

References max_running_processes.

Referenced by get_next_in_range().

Here is the caller graph for this function:

pluginlaunch_enable_parallel_checks()

void pluginlaunch_enable_parallel_checks

(

void

)

Definition at line 346 of file pluginlaunch.c.

{
  max_running_processes = old_max_running_processes;
}

References max_running_processes, and old_max_running_processes.

Referenced by get_next_in_range().

Here is the caller graph for this function:

pluginlaunch_init()

void pluginlaunch_init

(

const char *

host

)

Definition at line 315 of file pluginlaunch.c.

{
  int i;
 
  char **split = g_strsplit (prefs_get ("non_simult_ports"), ", ", 0);
  for (i = 0; split[i]; i++)
    non_simult_ports = g_slist_prepend (non_simult_ports, g_strdup (split[i]));
  g_strfreev (split);
  max_running_processes = get_max_checks_number ();
  old_max_running_processes = max_running_processes;
  hostname = host;
 
  if (max_running_processes >= MAX_PROCESSES)
    {
      g_debug ("max_checks (%d) > MAX_PROCESSES (%d) - modify "
               "openvas/openvas/pluginlaunch.c",
               max_running_processes, MAX_PROCESSES);
      max_running_processes = MAX_PROCESSES - 1;
    }
 
  num_running_processes = 0;
  bzero (&(processes), sizeof (processes));
}

References get_max_checks_number(), hostname, MAX_PROCESSES, max_running_processes, non_simult_ports, num_running_processes, old_max_running_processes, and processes.

Referenced by attack_host().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginlaunch_stop()

void pluginlaunch_stop

(

void

)

Definition at line 352 of file pluginlaunch.c.

{
  int i;
 
  for (i = 0; i < MAX_PROCESSES; i++)
    {
      if (processes[i].pid > 0)
        {
          /* Since the plugin process is a group leader process
           * we can send the signal to -PID process to kill
           * also the plugin's child processes. */
          terminate_process (processes[i].pid * -1);
          num_running_processes--;
          processes[i].plugin->running_state = PLUGIN_STATUS_DONE;
          bzero (&(processes[i]), sizeof (struct running));
        }
    }
}

References MAX_PROCESSES, num_running_processes, pid, running::plugin, PLUGIN_STATUS_DONE, processes, scheduler_plugin::running_state, and terminate_process().

Referenced by attack_host(), launch_plugin(), pluginlaunch_wait_for_free_process(), and scan_stop_cleanup().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginlaunch_wait()

void pluginlaunch_wait	(	kb_t	main_kb,
		kb_t	kb
	)

Waits and 'pushes' processes until num_running_processes is 0.

Definition at line 495 of file pluginlaunch.c.

{
  while (num_running_processes)
    {
      update_running_processes (main_kb, kb);
      if (num_running_processes)
        waitpid (-1, NULL, 0);
    }
}

References main_kb, num_running_processes, and update_running_processes().

Referenced by attack_host().

Here is the call graph for this function:

Here is the caller graph for this function:

pluginlaunch_wait_for_free_process()

void pluginlaunch_wait_for_free_process	(	kb_t	main_kb,
		kb_t	kb
	)

Waits and 'pushes' processes until the number of running processes has changed.

Definition at line 528 of file pluginlaunch.c.

{
  if (!num_running_processes)
    return;
  update_running_processes (main_kb, kb);
  /* Max number of processes are still running, wait for a child to exit or
   * to timeout. */
 
  if (num_running_processes >= max_running_processes)
    g_debug ("%s. Number of running processes >= maximum running processes (%d "
             ">= %d). "
             "Waiting for free slot for processes.",
             __func__, num_running_processes, max_running_processes);
 
  /* Be careful with changing the max_running_process value.
   * The plugin scheduler can change this value for running one plugin at
   * time. */
  while (
    (num_running_processes >= max_running_processes)
    || (num_running_processes > 0 && (check_memory () || check_sysload ())))
    {
      sigset_t mask;
      struct timespec ts = {0, 0};
 
      ts.tv_sec = timeout_running_processes ();
      assert (ts.tv_sec);
      sigemptyset (&mask);
      sigaddset (&mask, SIGCHLD);
      sigaddset (&mask, SIGUSR1);
      /* Wait here for the shortest plugins timeout or for a child which ended.
       * Also, it handles signal SIGUSR1 to stop a scan. Otherwise the signa is
       * ignored, the plugin is never stopped and the scanner keeps waiting. */
      int sig = sigtimedwait (&mask, NULL, &ts);
      if (sig < 0 && errno != EAGAIN)
        g_warning ("%s: %s (%d)", __func__, strerror (errno), errno);
      else if (sig == SIGUSR1)
        {
          /* SIGUSR1 signal is sent during scan stop to all host processes.
             Therefore pluginlaunch_stop() is called here, for the
             special case in which we are waiting for the last plugin, of the
             last host, to finish.
          */
          pluginlaunch_stop ();
        }
      // cleanup ipcc cache
      procs_cleanup_children ();
      update_running_processes (main_kb, kb);
    }
}

References check_memory(), check_sysload(), main_kb, max_running_processes, num_running_processes, pluginlaunch_stop(), procs_cleanup_children(), timeout_running_processes(), and update_running_processes().

Referenced by attack_host(), and plugin_launch().

Here is the call graph for this function:

Here is the caller graph for this function:

required_ports_in_list()

static GSList * required_ports_in_list ( const char *  oid, GSList *  list  )

static

Definition at line 238 of file pluginlaunch.c.

{
  GSList *common_ports = NULL;
  char **array, *ports;
  int i;
 
  if (!oid || !list)
    return 0;
  ports = nvticache_get_required_ports (oid);
  if (!ports)
    return 0;
  array = g_strsplit (ports, ", ", 0);
  g_free (ports);
  if (!array)
    return 0;
 
  for (i = 0; array[i]; i++)
    {
      GSList *tmp = list;
      while (tmp)
        {
          if (!strcmp (tmp->data, array[i]))
            common_ports = g_slist_prepend (common_ports, g_strdup (tmp->data));
          tmp = tmp->next;
        }
    }
 
  g_strfreev (array);
  return common_ports;
}

References oid.

Referenced by simult_ports().

Here is the caller graph for this function:

simult_ports()

static int simult_ports ( const char *  oid, const char *  next_oid  )

static

Definition at line 270 of file pluginlaunch.c.

{
  int ret = 0;
  GSList *common_ports1 = NULL, *common_ports2 = NULL;
 
  common_ports1 = required_ports_in_list (oid, non_simult_ports);
  if (common_ports1)
    common_ports2 = required_ports_in_list (next_oid, non_simult_ports);
  if (common_ports1 && common_ports2 && common (common_ports1, common_ports2))
    ret = 1;
  g_slist_free_full (common_ports1, g_free);
  g_slist_free_full (common_ports2, g_free);
  return ret;
}

References common(), non_simult_ports, oid, and required_ports_in_list().

Referenced by next_free_process().

Here is the call graph for this function:

Here is the caller graph for this function:

timeout_running_processes()

static int timeout_running_processes ( void  )

static

Return shortest timeout of the running processes.

Definition at line 509 of file pluginlaunch.c.

{
  int i, timeout = 0;
 
  for (i = 0; i < MAX_PROCESSES; i++)
    {
      if (processes[i].pid <= 0)
        continue;
      if (!timeout || processes[i].timeout < timeout)
        timeout = processes[i].timeout;
    }
  return timeout;
}

References MAX_PROCESSES, pid, processes, and running::timeout.

Referenced by pluginlaunch_wait_for_free_process().

Here is the caller graph for this function:

update_running_processes()

static void update_running_processes ( kb_t  main_kb, kb_t  kb  )

static

Definition at line 109 of file pluginlaunch.c.

{
  int i;
  struct timeval now;
  int log_whole = prefs_get_bool ("log_whole_attack");
 
  if (num_running_processes == 0)
    return;
 
  gettimeofday (&now, NULL);
  for (i = 0; i < MAX_PROCESSES; i++)
    {
      if (processes[i].pid > 0)
        {
          int is_alive = process_alive (processes[i].pid);
          int ret_terminate = 0;
 
          // If process dead or timed out
          if (!is_alive
              || (processes[i].timeout > 0
                  && ((now.tv_sec - processes[i].start.tv_sec)
                      > processes[i].timeout)))
            {
              char *oid = processes[i].plugin->oid;
 
              if (is_alive) // Alive and timed out
                {
                  char msg[2048];
                  if (log_whole)
                    g_message ("%s (pid %d) is slow to finish - killing it",
                               oid, processes[i].pid);
 
                  g_snprintf (msg, sizeof (msg),
                              "ERRMSG|||%s||| |||general/tcp|||%s|||"
                              "NVT timed out after %d seconds.",
                              hostname, oid ? oid : " ", processes[i].timeout);
                  kb_item_push_str_with_main_kb_check (main_kb,
                                                       "internal/results", msg);
 
                  /* Check for max VTs timeouts */
                  if (max_nvt_timeouts_reached ())
                    {
                      /* Check if host is still alive and send a message
                         if it is dead. */
                      if (check_host_still_alive (kb, hostname) == 0)
                        {
                          g_snprintf (msg, sizeof (msg),
                                      "ERRMSG|||%s||| |||general/tcp||| |||"
                                      "Host has been marked as dead. Too many "
                                      "NVT_TIMEOUTs.",
                                      hostname);
                          kb_item_push_str_with_main_kb_check (
                            main_kb, "internal/results", msg);
                        }
                    }
 
                  ret_terminate = terminate_process (processes[i].pid);
                  if (ret_terminate == 0)
                    {
                      /* Since the plugin process is a group leader process
                       * we can send the signal to -PID process to kill
                       * also the plugin's child processes. */
                      terminate_process (processes[i].pid * -1);
                      num_running_processes--;
                      processes[i].plugin->running_state = PLUGIN_STATUS_DONE;
                      bzero (&(processes[i]), sizeof (processes[i]));
                    }
                }
              else
                {
                  struct timeval old_now = now;
                  int e;
                  if (now.tv_usec < processes[i].start.tv_usec)
                    {
                      processes[i].start.tv_sec++;
                      now.tv_usec += 1000000;
                    }
                  if (log_whole)
                    {
                      char *name = nvticache_get_filename (oid);
                      g_message (
                        "%s (%s) [%d] finished its job in %ld.%.3ld seconds",
                        name, oid, processes[i].pid,
                        (long) (now.tv_sec - processes[i].start.tv_sec),
                        (long) ((now.tv_usec - processes[i].start.tv_usec)
                                / 1000));
                      g_free (name);
                    }
                  now = old_now;
                  do
                    {
                      e = waitpid (processes[i].pid, NULL, 0);
                    }
                  while (e < 0 && errno == EINTR);
 
                  /* Since the plugin process is a group leader process
                   * we can send the signal to -PID process to kill
                   * also the plugin's child processes. */
                  terminate_process (processes[i].pid * -1);
                  num_running_processes--;
                  processes[i].plugin->running_state = PLUGIN_STATUS_DONE;
                  bzero (&(processes[i]), sizeof (processes[i]));
                }
            }
        }
    }
}

References check_host_still_alive(), hostname, kb_item_push_str_with_main_kb_check(), main_kb, max_nvt_timeouts_reached(), MAX_PROCESSES, name, num_running_processes, oid, scheduler_plugin::oid, pid, running::plugin, PLUGIN_STATUS_DONE, process_alive(), processes, scheduler_plugin::running_state, running::start, terminate_process(), running::timeout, and timeval().

Referenced by next_free_process(), pluginlaunch_wait(), and pluginlaunch_wait_for_free_process().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

global_max_sysload

int global_max_sysload

extern

Definition at line 87 of file openvas.c.

Referenced by check_sysload(), and set_globals_from_preferences().

global_min_memory

int global_min_memory

extern

Definition at line 86 of file openvas.c.

Referenced by check_memory(), and set_globals_from_preferences().

hostname

const char* hostname = NULL

Definition at line 68 of file pluginlaunch.c.

Referenced by _http_req(), check_duplicated_vhost(), check_host_still_alive(), get_hostname(), ipc_data_type_from_hostname(), make_table_driven_lsc_info_json_str(), nasl_open_sock_kdc(), nasl_this_host(), nasl_this_host_name(), open_sock_opt_hn(), open_SSL_connection(), open_stream_connection_ext(), plug_add_host_fqdn(), plug_get_host_source(), pluginlaunch_init(), proto_post_wrapped(), run_table_driven_lsc(), socket_negotiate_ssl(), update_running_processes(), and v6_openbpf().

max_running_processes

int max_running_processes

static

Definition at line 65 of file pluginlaunch.c.

Referenced by pluginlaunch_disable_parallel_checks(), pluginlaunch_enable_parallel_checks(), pluginlaunch_init(), and pluginlaunch_wait_for_free_process().

non_simult_ports

GSList* non_simult_ports = NULL

static

Definition at line 67 of file pluginlaunch.c.

Referenced by pluginlaunch_init(), and simult_ports().

num_running_processes

int num_running_processes

static

Definition at line 64 of file pluginlaunch.c.

Referenced by plugin_launch(), pluginlaunch_init(), pluginlaunch_stop(), pluginlaunch_wait(), pluginlaunch_wait_for_free_process(), and update_running_processes().

old_max_running_processes

int old_max_running_processes

static

Definition at line 66 of file pluginlaunch.c.

Referenced by pluginlaunch_enable_parallel_checks(), and pluginlaunch_init().

processes

struct running processes[MAX_PROCESSES]

static

Definition at line 63 of file pluginlaunch.c.

Referenced by next_free_process(), plugin_launch(), pluginlaunch_init(), pluginlaunch_stop(), timeout_running_processes(), and update_running_processes().