ipc.h File Reference

#include <sys/types.h>

Include dependency graph for ipc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ipc_context
struct	ipc_contexts
struct	ipc_exec_context

Typedefs
typedef void(*	ipc_process_func) (struct ipc_context *, void *)

Enumerations
enum	ipc_protocol { IPC_PIPE }
enum	ipc_relation { IPC_MAIN, IPC_CHILD }

Functions
int	ipc_send (struct ipc_context *context, enum ipc_relation to, const char *msg, size_t len)
	sends given msg to the target based on the given context More...
char *	ipc_retrieve (struct ipc_context *context, enum ipc_relation from)
	retrieves data for the relation based on the context More...
int	ipc_destroy (struct ipc_context *context)
	destroys given context More...
int	ipc_close (struct ipc_context *context)
	closes given context More...
struct ipc_context *	ipc_exec_as_process (enum ipc_protocol type, struct ipc_exec_context exec_context)
	runs given functions with the given protocol type. More...
struct ipc_context *	ipc_init (enum ipc_protocol protocol, enum ipc_relation relation)
	initializes a new context. More...
struct ipc_contexts *	ipc_contexts_init (int len)
	initializes ipc_contexts with a given preallocated capacity. More...
struct ipc_contexts *	ipc_add_context (struct ipc_contexts *ctxs, struct ipc_context *ctx)
	adds a given context to contexts More...
int	ipc_destroy_contexts (struct ipc_contexts *ctxs)
	destroys given contexts More...

Typedef Documentation

ipc_process_func

typedef void(* ipc_process_func) (struct ipc_context *, void *)

Definition at line 47 of file ipc.h.

Enumeration Type Documentation

ipc_protocol

enum ipc_protocol

Enumerator
IPC_PIPE

Definition at line 11 of file ipc.h.

{
  IPC_PIPE
};

ipc_relation

enum ipc_relation

Enumerator
IPC_MAIN
IPC_CHILD

Definition at line 16 of file ipc.h.

{
  IPC_MAIN,
  IPC_CHILD
};

Function Documentation

ipc_add_context()

struct ipc_contexts* ipc_add_context	(	struct ipc_contexts *	ctxs,
		struct ipc_context *	ctx
	)

adds a given context to contexts

Parameters

ctxs	the context holder array to be used to add a new ctx
ctx	the context to be added to ctxs

Returns

a pointer to the given ctxs or NULL on failure.

Definition at line 274 of file ipc.c.

{
  if (ctxs == NULL)
    goto exit_error;
  if (ctx == NULL)
    goto exit_error;
  if (ctxs->len == ctxs->cap)
    {
      ctxs->cap = ctxs->cap + IPC_CONTEXTS_CAP_STEP;
      ctxs->ctxs = realloc (ctxs->ctxs, ctxs->cap * sizeof (*ctxs->ctxs));
      if (ctxs->ctxs == NULL)
        {
          // NOTE: the caller must free ctxs->ctxs in this case.
          goto exit_error;
        }
    }
  ctxs->ctxs[ctxs->len] = *ctx;
  ctxs->len += 1;
  return ctxs;
exit_error:
  return NULL;
}

References ipc_contexts::ctxs, and IPC_CONTEXTS_CAP_STEP.

Referenced by reuse_or_add_context().

Here is the caller graph for this function:

ipc_close()

int ipc_close

(

struct ipc_context *

context

)

closes given context

Parameters

context

the ipc_context to be closed

Returns

-1 when context is either NULL or already closed or 0 on success.

Definition at line 116 of file ipc.c.

{
  int rc = -1;
  if (context == NULL || context->closed == 1)
    return rc;
  switch (context->type)
    {
    case IPC_PIPE:
      rc = ipc_pipe_close (context->context);
      context->closed = 1;
    }
  return rc;
}

References ipc_context::closed, ipc_context::context, IPC_PIPE, ipc_pipe_close(), and ipc_context::type.

Referenced by ipc_destroy_contexts(), and procs_cleanup_children().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_contexts_init()

struct ipc_contexts* ipc_contexts_init

(

int

cap

)

initializes ipc_contexts with a given preallocated capacity.

Parameters

cap	to size to be preallocated, if 0 it will not preallocate but allocate on each enw entry.

Returns

a heap initialized contexts or NULL on failure.

Definition at line 248 of file ipc.c.

{
  struct ipc_contexts *ctxs = NULL;
  if ((ctxs = malloc (sizeof (*ctxs))) == NULL)
    goto exit;
  ctxs->len = 0;
  ctxs->cap = cap > 0 ? cap : IPC_CONTEXTS_CAP_STEP;
  if ((ctxs->ctxs = malloc (ctxs->cap * sizeof (*ctxs->ctxs))) == NULL)
    goto free_and_exit;
exit:
  return ctxs;
free_and_exit:
  if (ctxs != NULL)
    free (ctxs);
  return NULL;
}

References ipc_contexts::cap, ipc_contexts::ctxs, free(), IPC_CONTEXTS_CAP_STEP, and malloc().

Referenced by create_ipc_process(), and pre_fn_call().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_destroy()

int ipc_destroy

(

struct ipc_context *

context

)

destroys given context

Parameters

context

the ipc_context to be destroyed.

Returns

0 on success, -1 on context null or failure to destroy

Definition at line 68 of file ipc.c.

{
  int rc = 0;
  if (context == NULL)
    return -1;
  switch (context->type)
    {
    case IPC_PIPE:
      rc = ipc_pipe_destroy (context->context);
      break;
    }
  g_free (context);
  return rc;
}

References ipc_context::context, IPC_PIPE, ipc_pipe_destroy(), and ipc_context::type.

Referenced by ipc_exec_as_process().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_destroy_contexts()

int ipc_destroy_contexts

(

struct ipc_contexts *

ctxs

)

destroys given contexts

Parameters

ctxs	the context holder array to be destroyed.

Returns

0 on success or -1 on failure.

Definition at line 305 of file ipc.c.

{
  int i, rc = 0;
  if (ctxs == NULL)
    return rc;
  for (i = 0; i < ctxs->len; i++)
    {
      if (ipc_close (&ctxs->ctxs[i]) < 0)
        rc = -1;
    }
  free (ctxs->ctxs);
  free (ctxs);
  return rc;
}

References ipc_contexts::ctxs, free(), and ipc_close().

Referenced by clean_procs(), and pre_fn_call().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_exec_as_process()

struct ipc_context* ipc_exec_as_process	(	enum ipc_protocol	type,
		struct ipc_exec_context	exec_ctx
	)

runs given functions with the given protocol type.

Parameters

type	the protocol type to be initialized
exec_ctx	the execution context to be executed.

Returns

a heap initialized context or NULL on failure.

Definition at line 175 of file ipc.c.

{
  struct ipc_context *pctx = NULL, *cctx = NULL;
  pid_t pid;
  if (exec_ctx.func == NULL)
    return NULL;
  switch (type)
    {
    case IPC_PIPE:
      if ((pctx = ipc_init (type, IPC_MAIN)) == NULL)
        {
          return NULL;
        }
    }
 
  gvm_log_lock ();
  pid = fork ();
  gvm_log_unlock ();
  /* fork error */
  if (pid < 0)
    {
      ipc_destroy (pctx);
      return NULL;
    }
  // we are the child process and execute given function
  if (pid == 0)
    {
      if (pctx != NULL)
        cctx = pctx;
      else if ((cctx = ipc_init (type, IPC_CHILD)) == NULL)
        {
          exit (1);
        }
 
      if (exec_ctx.pre_func != NULL)
        (*exec_ctx.pre_func) (cctx, exec_ctx.pre_arg);
      (*exec_ctx.func) (cctx, exec_ctx.func_arg);
      if (exec_ctx.post_func != NULL)
        (*exec_ctx.post_func) (cctx, exec_ctx.pre_arg);
      switch (type)
        {
        case IPC_PIPE:
          ipc_destroy (pctx);
          break;
        }
      exit (0);
    }
 
  if (pctx == NULL)
    {
      if ((pctx = malloc (sizeof (*pctx))) == NULL)
        {
          return NULL;
        }
      pctx->relation = IPC_MAIN;
      pctx->type = type;
      pctx->context = exec_ctx.shared_context;
    }
  // we are the parent process and return the id of the child process for
  // observation
  pctx->pid = pid;
  return pctx;
}

References ipc_context::context, ipc_exec_context::func, ipc_exec_context::func_arg, IPC_CHILD, ipc_destroy(), ipc_init(), IPC_MAIN, IPC_PIPE, malloc(), ipc_context::pid, pid, ipc_exec_context::post_func, ipc_exec_context::pre_arg, ipc_exec_context::pre_func, ipc_context::relation, ipc_exec_context::shared_context, and ipc_context::type.

Referenced by create_ipc_process().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_init()

struct ipc_context* ipc_init	(	enum ipc_protocol	type,
		enum ipc_relation	relation
	)

initializes a new context.

Parameters

type	the protocol type to be initialized
relation	the relation of the context to be initialized when supported by the type.

Returns

a heap initialized context or NULL on failure.

Definition at line 140 of file ipc.c.

{
  struct ipc_context *ctx = NULL;
  void *context = NULL;
  (void) relation;
  if ((ctx = calloc (1, sizeof (*ctx))) == NULL)
    goto exit;
  ctx->type = type;
  switch (type)
    {
    case IPC_PIPE:
      context = ipc_init_pipe ();
      break;
    }
  if (!context)
    goto free_exit;
  ctx->context = context;
  return ctx;
 
free_exit:
  if (ctx != NULL)
    free (ctx);
exit:
  return NULL;
}

References ipc_context::context, free(), ipc_init_pipe(), IPC_PIPE, ipc_context::relation, and ipc_context::type.

Referenced by ipc_exec_as_process().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_retrieve()

char* ipc_retrieve	(	struct ipc_context *	context,
		enum ipc_relation	from
	)

retrieves data for the relation based on the context

Parameters

context	the ipc_context to be used; must be previously initialized via ipc_init.
to	the recieving direction of the message when it is supported by the given ipc_context.

Returns

a heap initialized data or NULL

Definition at line 95 of file ipc.c.

{
  (void) from;
  if (context == NULL)
    return NULL;
  switch (context->type)
    {
    case IPC_PIPE:
      return ipc_pipe_retrieve (context->context);
    };
  return NULL;
}

References ipc_context::context, IPC_PIPE, ipc_pipe_retrieve(), and ipc_context::type.

Referenced by read_ipc().

Here is the call graph for this function:

Here is the caller graph for this function:

ipc_send()

int ipc_send	(	struct ipc_context *	context,
		enum ipc_relation	to,
		const char *	msg,
		size_t	len
	)

sends given msg to the target based on the given context

Parameters

context	the ipc_context to be used; must be previously initialized via ipc_init.
to	the target direction of the message when it is supported by the given ipc_context.
msg	the message to send
len	the length of msg

Returns

bytes written, -2 when the context or msg or context type is unknown, -1 on write error

Definition at line 46 of file ipc.c.

{
  (void) to;
  if (context == NULL || msg == NULL)
    return -2;
  switch (context->type)
    {
    case IPC_PIPE:
      return ipc_pipe_send (context->context, msg, len);
    };
  return -2;
}

References ipc_context::context, IPC_PIPE, ipc_pipe_send(), len, and ipc_context::type.

Referenced by add_hostname(), and send_user_agent_via_ipc().

Here is the call graph for this function:

Here is the caller graph for this function: