errors.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "boolean.h"
#include "arithmetique.h"
#include <time.h>
#include <signal.h>
#include <unistd.h>
#include "linear_assert.h"

Include dependency graph for errors.c:

Go to the source code of this file.

Data Structures
struct	linear_exception_holder
	A structure for the exception stack. More...
struct	timeout_t
	hold a timeout prescription More...

Macros
#define	MAX_STACKED_CONTEXTS   64
	exception stack. More...
#define	exception_debug_message(type)
#define	exception_debug_trace(type)
#define	same_string_p(s1, s2)   (strcmp((s1),(s2))==0)
#define	throw_exception   linear_throw_exception
#define	TIMEOUT_MAX_STACK_SIZE   10

Functions
char const *	__attribute__ ((weak))
	This can be overrided in the PolyLib. More...
void	linear_reset_error_counters (void)
	reset linear counters More...
unsigned int	linear_error_count (void)
	return number of linear errors may be used as a test after a reset to know whether new errors occured. More...
void	linear_get_error_counts (unsigned int *poe, unsigned int *pse, unsigned int *pme)
	return various errors counts through unsigned int pointer overflow, simplex & misc (aka others) NULL pointers are ignored More...
static void	linear_record_exception (const linear_exception_t exception)
void	__attribute__ ((weak, noreturn))
	throws an exception of a given type by searching for the specified 'what' in the current exception stack. More...
bool	linear_with_gmp (void)
	whether linear can use gmp (i.e. More...
bool	linear_require_gmp (void)
	whether linear is asked to use gmp if possible (env variable) More...
bool	linear_use_gmp (void)
	whether linear is to use gmp More...
void	set_timeout_callback (timeout_callback_f callback)
static void	__attribute__ ((noreturn))
void	push_timeout (const unsigned int delay, const char *funcname, const char *filename, const int lineno)
static int	env2int (const char *env)
bool	push_timeout_env (const char *env, const char *funcname, const char *filename, const int lineno)
void	pop_timeout (__attribute__((unused)) const char *funcname, __attribute__((unused)) const char *filename, __attribute__((unused)) const int lineno)
void	pop_timeout_env (const char *env, const char *funcname, const char *filename, const int lineno)

Variables
static int	timeout_index = 0
int	linear_assertion_result = -1
	errors.c More...
static unsigned int	overflow_error_count = 0
static unsigned int	simplex_error_count = 0
static unsigned int	misc_error_count = 0
static bool	linear_exception_debug_mode = false
	whether to run in debug mode (that is to trace catch/uncatch/throw) More...
static unsigned int	linear_exception_verbose = 1 | 2 | 16
static linear_exception_holder	exception_stack [MAX_STACKED_CONTEXTS]
static int	exception_index = 0
static exception_callback_t	push_callback = NULL
	callbacks... More...
static exception_callback_t	pop_callback = NULL
static bool	warned_if_inconsistent_gmp = false
static timeout_callback_f	timeout_callback = NULL
	a stack of timeouts is kept. More...
static timeout_t	timeouts [TIMEOUT_MAX_STACK_SIZE]

Macro Definition Documentation

exception_debug_message

#define exception_debug_message

(

type

)

Value:

  fprintf(stderr, "%s[%s:%d %s (%d)/%d]\n",               \
            type, file, line, function, what, exception_index)

Definition at line 207 of file errors.c.

exception_debug_trace

#define exception_debug_trace

(

type

)

Value:

  if (linear_exception_debug_mode)    \
    exception_debug_message(type);

Definition at line 211 of file errors.c.

MAX_STACKED_CONTEXTS

#define MAX_STACKED_CONTEXTS   64

exception stack.

maximum extension.

• current index (next available bucket)

Definition at line 148 of file errors.c.

same_string_p

#define same_string_p	(		s1,
			s2
	)		(strcmp((s1),(s2))==0)

Definition at line 265 of file errors.c.

throw_exception

#define throw_exception   linear_throw_exception

Definition at line 415 of file errors.c.

TIMEOUT_MAX_STACK_SIZE

#define TIMEOUT_MAX_STACK_SIZE   10

Definition at line 507 of file errors.c.

Function Documentation

__attribute__() [1/3]

static void __attribute__ ( (noreturn)  )

static

Definition at line 512 of file errors.c.

{
  int toidx = timeout_index - 1;
 
  assert(sig == SIGALRM);
  assert(toidx >= 0);
 
  // always say something... even if redundant with callback
  fprintf(stderr, "timeout[%d] after %ds from %s (\"%s\":%d)\n", toidx,
          timeouts[toidx].delay,
          timeouts[toidx].funcname,
          timeouts[toidx].filename,
          timeouts[toidx].lineno);
  fflush(stderr);
 
  // note: the timeout may not return
  if (timeout_callback != NULL)
    (*timeout_callback)(timeouts[toidx].delay,
                        timeouts[toidx].funcname,
                        timeouts[toidx].filename,
                        timeouts[toidx].lineno);
 
  // may try to go on, although it is probably not a good idea
  POP_TIMEOUT();
  THROW(timeout_error);
}

References assert, timeout_t::delay, timeout_t::filename, fprintf(), timeout_t::funcname, timeout_t::lineno, POP_TIMEOUT, THROW, timeout_callback, timeout_error, timeout_index, and timeouts.

Here is the call graph for this function:

__attribute__() [2/3]

char const* __attribute__

(

(weak)

)

This can be overrided in the PolyLib.

This can be overridden in the PolyLib.

pop a what exception.

push a what exception on stack.

dump stack

total number of exceptions thrown, for statistics.

keep track of last thrown exception for RETHROW()

And seems to be according to gdb who cannot find the corresponding source code.

This can be overrided in the PolyLib

check for any mismatch! This can be overrided in the PolyLib

Definition at line 47 of file errors.c.

{
  if (exception==overflow_error)
    return "overflow_error exception";
  if (exception==simplex_arithmetic_error)
    return "simplex_arithmetic_error exception";
  if (exception==user_exception_error)
    return "user_exception_error exception";
  if (exception==parser_exception_error)
    return "parser_exception_error exception";
  if (exception==timeout_error)
    return "timeout_error exception";
  if (exception==any_exception_error)
    return "all exceptions mask";
 
  return "unknown or mixed exception";
}

References any_exception_error, overflow_error, parser_exception_error, simplex_arithmetic_error, timeout_error, and user_exception_error.

__attribute__() [3/3]

void __attribute__

(

(weak, noreturn)

)

throws an exception of a given type by searching for the specified 'what' in the current exception stack.

This can be overridden in the PolyLib

Definition at line 337 of file errors.c.

{
  int i;
 
  exception_debug_trace("THROW");
 
  the_last_just_thrown_exception = what; // for rethrow
  linear_record_exception(what);
 
  for (i=exception_index-1; i>=0; i--)
  {
    if (pop_callback)
      // call pop callback with push parameters
      pop_callback(exception_stack[i].file,
                   exception_stack[i].function,
                   exception_stack[i].line);
 
    if (exception_stack[i].what & what)
    {
      exception_index = i;
      linear_number_of_exception_thrown++;
 
      if (linear_exception_debug_mode)
        fprintf(stderr, "---->[%s:%d %s (%d)/%d]\n",
                exception_stack[i].file,
                exception_stack[i].line,
                exception_stack[i].function,
                exception_stack[i].what,
                i);
 
      // trace some exceptions...
      if (linear_exception_verbose & what)
        fprintf(stderr, "exception %d/%d: %s(%s:%d) -> %s(%s:%d)\n",
                what, exception_stack[i].what,
                function, file, line,
                exception_stack[i].function,
                exception_stack[i].file,
                exception_stack[i].line);
 
      // pop timeouts
      while (timeout_index > exception_stack[i].timeout)
        POP_TIMEOUT();
 
      longjmp(exception_stack[i].where, 0);
    }
  }
 
  // internal error, THROW without matching CATCH
  exception_debug_message("throw");
  fprintf(stderr,
          "exception not found in stack:\n"
          "an exception was THROWN without a matching CATCH\n");
  dump_exception_stack();
 
  // timeout triggers an exception which may be intentionnaly not caught
  if (what == timeout_error)
    exit(203);
  else
    abort();
}

References abort, dump_exception_stack(), exception_debug_message, exception_debug_trace, exception_index, exception_stack, exit, fprintf(), line, linear_exception_debug_mode, linear_exception_verbose, linear_number_of_exception_thrown, linear_record_exception(), pop_callback, POP_TIMEOUT, the_last_just_thrown_exception, timeout_error, and timeout_index.

Here is the call graph for this function:

env2int()

static int env2int ( const char *  env )

static

Definition at line 563 of file errors.c.

{
  char * val = getenv(env);
  if (val != NULL)
  {
    int i = atoi(val);
    if (i >= 0)
      return i;
  }
  return -1;
}

References env.

Referenced by pop_timeout_env(), and push_timeout_env().

Here is the caller graph for this function:

linear_error_count()

unsigned int linear_error_count

(

void

)

return number of linear errors may be used as a test after a reset to know whether new errors occured.

Definition at line 85 of file errors.c.

{
  return overflow_error_count + simplex_error_count + misc_error_count;
}

References misc_error_count, overflow_error_count, and simplex_error_count.

Referenced by catch_user_error().

Here is the caller graph for this function:

linear_get_error_counts()

void linear_get_error_counts	(	unsigned int *	poe,
		unsigned int *	pse,
		unsigned int *	pme
	)

return various errors counts through unsigned int pointer overflow, simplex & misc (aka others) NULL pointers are ignored

Parameters

poe	oe
pse	se
pme	me

Definition at line 94 of file errors.c.

{
  if (poe) *poe = overflow_error_count;
  if (pse) *pse = simplex_error_count;
  if (pme) *pme = misc_error_count;
}

References misc_error_count, overflow_error_count, and simplex_error_count.

Referenced by catch_user_error().

Here is the caller graph for this function:

linear_record_exception()

static void linear_record_exception ( const linear_exception_t  exception )

static

Definition at line 102 of file errors.c.

{
  if (exception==overflow_error)
    overflow_error_count ++;
  else if (exception==simplex_arithmetic_error)
    simplex_error_count ++;
  else if (exception==user_exception_error ||
           exception==parser_exception_error ||
           exception==timeout_error)
    misc_error_count ++;
}

References misc_error_count, overflow_error, overflow_error_count, parser_exception_error, simplex_arithmetic_error, simplex_error_count, timeout_error, and user_exception_error.

Referenced by __attribute__().

Here is the caller graph for this function:

linear_require_gmp()

bool linear_require_gmp

(

void

)

whether linear is asked to use gmp if possible (env variable)

Definition at line 446 of file errors.c.

{
        char* env = getenv("LINEAR_USE_GMP");
        return env && atoi(env) != 0;
}

References env.

Referenced by catch_user_error(), and linear_use_gmp().

Here is the caller graph for this function:

linear_reset_error_counters()

void linear_reset_error_counters

(

void

)

reset linear counters

Definition at line 75 of file errors.c.

{
  overflow_error_count = 0;
  simplex_error_count = 0;
  misc_error_count = 0;
}

References misc_error_count, overflow_error_count, and simplex_error_count.

Referenced by catch_user_error().

Here is the caller graph for this function:

linear_use_gmp()

bool linear_use_gmp

(

void

)

whether linear is to use gmp

Definition at line 454 of file errors.c.

{
  bool
    with_gmp = linear_with_gmp(),
    req_gmp = linear_require_gmp();
 
  if (req_gmp && !with_gmp && !warned_if_inconsistent_gmp)
  {
    fprintf(stderr, "linear was compiled without GMP support\n");
    warned_if_inconsistent_gmp = true;
  }
 
  return with_gmp && req_gmp;
}

References fprintf(), linear_require_gmp(), linear_with_gmp(), and warned_if_inconsistent_gmp.

Referenced by internal_sc_feasibility(), sc_convex_hull(), sc_to_sg_chernikova(), and sg_to_sc_chernikova().

Here is the call graph for this function:

Here is the caller graph for this function:

linear_with_gmp()

bool linear_with_gmp

(

void

)

whether linear can use gmp (i.e.

compiled in)

Definition at line 435 of file errors.c.

{
#ifdef HAVE_GMP_H
  return true;
#else
  return false;
#endif // HAVE_GMP_H
}

Referenced by catch_user_error(), and linear_use_gmp().

Here is the caller graph for this function:

pop_timeout()

void pop_timeout	(	__attribute__((unused)) const char *	funcname,
		__attribute__((unused)) const char *	filename,
		__attribute__((unused)) const int	lineno
	)

Definition at line 591 of file errors.c.

{
  time_t now = time(NULL);
 
  assert(timeout_index > 0);
 
  // cleanup
  alarm(0);
  signal(SIGALRM, SIG_DFL);
 
  timeout_index--;
 
  // reset to previous delay
  if (timeout_index > 0)
  {
    int delay = timeouts[timeout_index - 1].end - now;
 
    if (delay <= 0)
      timeout_handler(SIGALRM);
 
    signal(SIGALRM, timeout_handler);
    alarm(delay);
  }
}

References assert, timeout_t::end, timeout_index, and timeouts.

Referenced by pop_timeout_env().

Here is the caller graph for this function:

pop_timeout_env()

void pop_timeout_env	(	const char *	env,
		const char *	funcname,
		const char *	filename,
		const int	lineno
	)

Parameters

env	nv
funcname	uncname
filename	ilename
lineno	ineno

Definition at line 619 of file errors.c.

{
  int delay = env2int(env);
  if (delay > 0)
    pop_timeout(funcname, filename, lineno);
}

References env, env2int(), and pop_timeout().

Here is the call graph for this function:

push_timeout()

void push_timeout	(	const unsigned int	delay,
		const char *	funcname,
		const char *	filename,
		const int	lineno
	)

Parameters

delay	elay
funcname	uncname
filename	ilename
lineno	ineno

Definition at line 539 of file errors.c.

{
  time_t now = time(NULL);
 
  assert(timeout_index < TIMEOUT_MAX_STACK_SIZE);
 
  timeouts[timeout_index].start = now;
  timeouts[timeout_index].delay = delay;
  timeouts[timeout_index].env = NULL;
  timeouts[timeout_index].end = timeouts[timeout_index].start + delay;
  timeouts[timeout_index].funcname = funcname;
  timeouts[timeout_index].filename = filename;
  timeouts[timeout_index].lineno = lineno;
 
  timeout_index++;
 
  signal(SIGALRM, timeout_handler);
  alarm(delay);
}

References assert, timeout_t::delay, timeout_t::end, timeout_t::env, timeout_t::filename, timeout_t::funcname, timeout_t::lineno, timeout_t::start, timeout_index, TIMEOUT_MAX_STACK_SIZE, and timeouts.

Referenced by push_timeout_env().

Here is the caller graph for this function:

push_timeout_env()

bool push_timeout_env	(	const char *	env,
		const char *	funcname,
		const char *	filename,
		const int	lineno
	)

Parameters

env	nv
funcname	uncname
filename	ilename
lineno	ineno

Definition at line 575 of file errors.c.

{
  int delay = env2int(env);
  if (delay > 0)
  {
    push_timeout(delay, funcname, filename, lineno);
    timeouts[timeout_index-1].env = env;
    return true;
  }
  return false;
}

References timeout_t::env, env, env2int(), push_timeout(), timeout_index, and timeouts.

Here is the call graph for this function:

set_timeout_callback()

void set_timeout_callback

(

timeout_callback_f

callback

)

Parameters

callback

allback

Definition at line 485 of file errors.c.

{
  timeout_callback = callback;
}

References callback, and timeout_callback.

Referenced by set_pips_timeout(), and set_pips_timeout_from_env().

Here is the caller graph for this function:

Variable Documentation

exception_index

int exception_index = 0

static

Definition at line 150 of file errors.c.

Referenced by __attribute__().

exception_stack

linear_exception_holder exception_stack[MAX_STACKED_CONTEXTS]

static

Definition at line 149 of file errors.c.

Referenced by __attribute__().

linear_assertion_result

int linear_assertion_result = -1

errors.c

Definition at line 43 of file errors.c.

linear_exception_debug_mode

bool linear_exception_debug_mode = false

static

whether to run in debug mode (that is to trace catch/uncatch/throw)

Definition at line 121 of file errors.c.

Referenced by __attribute__().

linear_exception_verbose

unsigned int linear_exception_verbose = 1 | 2 | 16

static

Definition at line 122 of file errors.c.

Referenced by __attribute__().

misc_error_count

unsigned int misc_error_count = 0

static

Definition at line 71 of file errors.c.

Referenced by linear_error_count(), linear_get_error_counts(), linear_record_exception(), and linear_reset_error_counters().

overflow_error_count

unsigned int overflow_error_count = 0

static

Definition at line 69 of file errors.c.

Referenced by linear_error_count(), linear_get_error_counts(), linear_record_exception(), and linear_reset_error_counters().

pop_callback

exception_callback_t pop_callback = NULL

static

Definition at line 155 of file errors.c.

Referenced by __attribute__().

push_callback

exception_callback_t push_callback = NULL

static

callbacks...

Definition at line 154 of file errors.c.

simplex_error_count

unsigned int simplex_error_count = 0

static

Definition at line 70 of file errors.c.

Referenced by linear_error_count(), linear_get_error_counts(), linear_record_exception(), and linear_reset_error_counters().

timeout_callback

timeout_callback_f timeout_callback = NULL

static

a stack of timeouts is kept.

this may make sense to deal with local timeouts within linear but still keeping a global outside timeout for pips. on timeouts, the corresponding exception is raised... what to do about it is unclear... probably the idea is to stop more or less cleanly.

Definition at line 483 of file errors.c.

Referenced by __attribute__(), and set_timeout_callback().

timeout_index

static int timeout_index = 0

static

Definition at line 40 of file errors.c.

Referenced by __attribute__(), pop_timeout(), push_timeout(), and push_timeout_env().

timeouts

timeout_t timeouts[TIMEOUT_MAX_STACK_SIZE]

static

Definition at line 509 of file errors.c.

Referenced by __attribute__(), pop_timeout(), push_timeout(), and push_timeout_env().

warned_if_inconsistent_gmp

bool warned_if_inconsistent_gmp = false

static

Definition at line 431 of file errors.c.

Referenced by linear_use_gmp().