pluginload.c File Reference

#include <stdio.h>
#include <openvas/nasl/nasl.h>
#include <openvas/base/nvticache.h>
#include <openvas/misc/openvas_proctitle.h>
#include <openvas/misc/prefs.h>
#include <glib.h>
#include <stdlib.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <sys/shm.h>
#include <string.h>
#include <errno.h>
#include "utils.h"
#include "pluginload.h"
#include "log.h"
#include "processes.h"
#include "sighand.h"

Include dependency graph for pluginload.c:

Go to the source code of this file.

Functions
GSList *	collect_nvts (const char *folder, const char *subdir, GSList *files)
	Collects all NVT files in a directory and recurses into subdirs. More...
int	calculate_eta (struct timeval start_time, int loaded, int total)
void	init_loading_shm (void)
void	destroy_loading_shm (void)
int	current_loading_plugins (void)
int	total_loading_plugins (void)
void	set_current_loading_plugins (int current)
void	set_total_loading_plugins (int total)
int	plugins_init (void)

Function Documentation

calculate_eta()

int calculate_eta	(	struct timeval	start_time,
		int	loaded,
		int	total
	)

Definition at line 110 of file pluginload.c.

{
  struct timeval current_time;
  int elapsed, remaining;

  if (start_time.tv_sec == 0)
    return 0;

  gettimeofday (&current_time, NULL);
  elapsed = current_time.tv_sec - start_time.tv_sec;
  remaining = total - loaded;
  return (remaining * elapsed) / loaded;
}

collect_nvts()

GSList* collect_nvts	(	const char *	folder,
		const char *	subdir,
		GSList *	files
	)

Collects all NVT files in a directory and recurses into subdirs.

Parameters

folder	The main directory from where to descend and collect.
subdir	A subdirectory to consider for the collection: "folder/subdir" is thus the effective directory to descend from. "subdir" can be "" to make "folder" the effective start.
files	A list that is extended with all found files. If it is NULL, a new list is created automatically.

Returns

Parameter "files", extended with all the NVT files found in "folder" and its subdirectories. Not added are directory names. NVT files are identified by the defined filename suffixes.

Definition at line 66 of file pluginload.c.

{
  GDir *dir;
  const gchar *fname;

  if (folder == NULL)
    return files;

  dir = g_dir_open (folder, 0, NULL);
  if (dir == NULL)
    return files;

  fname = g_dir_read_name (dir);
  while (fname)
    {
      char *path;

      path = g_build_filename (folder, fname, NULL);
      if (g_file_test (path, G_FILE_TEST_IS_DIR))
        {
          char *new_folder, *new_subdir;

          new_folder = g_build_filename (folder, fname, NULL);
          new_subdir = g_build_filename (subdir, fname, NULL);

          files = collect_nvts (new_folder, new_subdir, files);

          if (new_folder)
            g_free (new_folder);
          if (new_subdir)
            g_free (new_subdir);
        }
      else if (g_str_has_suffix (fname, ".nasl"))
        files = g_slist_prepend (files,
                                 g_build_filename (subdir, fname, NULL));
      g_free (path);
      fname = g_dir_read_name (dir);
    }

  g_dir_close (dir);
  return files;
}

current_loading_plugins()

int current_loading_plugins

(

void

)

Definition at line 183 of file pluginload.c.

Referenced by comm_loading().

{
  return loading_shm ? loading_shm[0] : 0;
}

Here is the caller graph for this function:

destroy_loading_shm()

void destroy_loading_shm

(

void

)

Definition at line 165 of file pluginload.c.

Referenced by loading_handler_stop().

{
  if (loading_shm)
    {
      shmdt (loading_shm);
      if (shmctl (loading_shmid, IPC_RMID, NULL))
        perror ("shmctl");
      loading_shm = NULL;
      loading_shmid = 0;
    }
}

Here is the caller graph for this function:

init_loading_shm()

void init_loading_shm

(

void

)

Definition at line 132 of file pluginload.c.

{
  int shm_key;

  if (loading_shm)
    return;

  shm_key = rand () + 1;
  /*
   * Create shared memory segment if it doesn't exist.
   * This will be used to communicate current plugins loading progress to other
   * processes.
   * loading_shm[0]: Number of loaded plugins.
   * loading_shm[1]: Total number of plugins.
   */
  loading_shmid = shmget (shm_key, sizeof (int) * 2, IPC_CREAT | 0600);
  if (loading_shmid < 0)
    perror ("shmget");
  loading_shm = shmat (loading_shmid, NULL, 0);
  if (loading_shm == (void *) -1)
    {
      perror ("shmat");
      loading_shm = NULL;
    }
  else
    bzero (loading_shm, sizeof (int) * 2);
}

plugins_init()

int plugins_init

(

void

)

Definition at line 358 of file pluginload.c.

References log_write().

{
  int ret = 0;
  pid_t child_pid;
  const char *plugins_folder = prefs_get ("plugins_folder");

  if (nvticache_init (plugins_folder, prefs_get ("kb_location")))
    {
      log_write ("Failed to initialize nvti cache.");
      return -1;
    }
  include_dirs ();

  child_pid = create_process (plugins_reload_from_dir, (void *) plugins_folder);
  waitpid (child_pid, &ret, 0);
  return ret;
}

Here is the call graph for this function:

set_current_loading_plugins()

void set_current_loading_plugins

(

int

current

)

Definition at line 205 of file pluginload.c.

{
  if (loading_shm)
    loading_shm[0] = current;
}

set_total_loading_plugins()

void set_total_loading_plugins

(

int

total

)

Definition at line 217 of file pluginload.c.

{
  if (loading_shm)
    loading_shm[1] = total;
}

total_loading_plugins()

int total_loading_plugins

(

void

)

Definition at line 194 of file pluginload.c.

Referenced by comm_loading().

{
  return loading_shm ? loading_shm[1] : 0;
}

Here is the caller graph for this function: