message.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <ctype.h>
#include "genC.h"
#include "misc.h"
#include "linear.h"
#include <unistd.h>

Include dependency graph for message.c:

Go to the source code of this file.

Macros
#define	LOG_FILE   "Logfile"
#define	PIPS_THANKS_STRING(arch)
	The # "stringificator" only works in a macro expansion... More...
#define	WARNING_FILE_NAME   "Warnings"
	USER_WARNING issues a warning and don't stop the program (cf. More...

Functions
bool	properties_initialized_p (void)
	FC 2015-07-20: yuk, moved out to prevent an include cycle dependency include "properties.h". More...
bool	get_bool_property (const string)
	FC 2015-07-20: yuk, moved out to prevent an include cycle dependency include "properties.h". More...
char *	get_string_property (const char *)
int	get_int_property (const string)
bool	too_many_property_errors_pending_p (void)
void	set_pips_current_computation (const char *rname, const char *oname)
	message.c More...
string	get_pips_current_pass_name (void)
	Export this piece of information to customize warning functions in passes. More...
string	get_pips_current_module (void)
void	reset_pips_current_computation (void)
void	set_pips_meta_informations (const char *revs, const char *date, const char *comp)
string	default_user_request (const char *fmt, va_list *args)
	USER_REQUEST is a function that should be called to request some data from the user. More...
void	close_log_file (void)
void	open_log_file (const string dir)
void	log_on_file (const char *desc)
static void	pips_user_log_alist (const char *format, va_list *args)
void	pips_user_log_func (const char *format,...)
void	user_log (const char *format,...)
void	pips_thanks (string name, string path)
	display pips thanks on startup, if it on a tty. More...
void	open_warning_file (const char *dir)
void	close_warning_file (void)
void	append_to_warning_file (const char *calling_function_name, const char *format, va_list *args)
	To be used in error handling functions. More...
void	pips_user_warning_alist (const char *function_name, const char *funcfile, const int funcline, const char *format, va_list *args)
void	pips_user_warning_func (const char *calling_function_name, const char *funcfile, const int funcline, const char *format,...)
void	pips_user_warning_func2 (const char *format,...)
	fallback version without a calling function name More...
static void _NORETURN_	pips_internal_error_alist (const char *funcname, const char *funcfile, const int funcline, const char *format, va_list *args)
void _NORETURN_	pips_internal_error_func (const char *funcname, const char *funcfile, const int funcline, const char *fmt,...)
void _NORETURN_	pips_internal_error_func2 (const char *format,...)
static void _NORETURN_	pips_user_error_alist (const char *calling_function_name, const char *funcfile, const int funcline, const char *format, va_list *args)
void _NORETURN_	pips_user_error_func (const char *func_name, const char *funcfile, const int funcline, const char *format,...)
void _NORETURN_	pips_user_error_func2 (const char *format,...)
void _NORETURN_	pips_user_irrecoverable_error_alist (const char *func_name, const char *funcfile, const int funcline, const char *format, va_list *args)
void _NORETURN_	pips_user_irrecoverable_error_func (const char *func_name, const char *funcfile, const int funcline, const char *format,...)
void _NORETURN_	pips_user_irrecoverable_error_func2 (const char *format,...)
bool	function_same_string_p (const char *s1, const char *s2)
static void	append_xml_attribute (string_buffer sb, const string attribute, const string value)
	generate xml: attribute="escaped-stuff" More...
void	open_xml_logfile (const char *filename)
void	close_xml_logfile (void)
static void	append_xml_line_numbers (string_buffer sb, const string attribute, int val1, int val2)
static string	pips_log_xml_tag (pips_log_t tag)
static void	pips_log_xml_pips_level (string_buffer sb, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line)
	append pips-level stuff (function, file, line) to xml file More...
static void	pips_log_xml (const pips_log_t tag, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string description)
	add a full log entry to the xml log file More...
static string	code2status (int code)
static void	pips_stop_xml (pips_log_t tag, int code, const string pips_func, const string pips_file, const int pips_line, const string description)
static void	pips_stop_file (FILE *out, pips_log_t tag, int code, const char *pips_func, const char *pips_file, const int pips_line, const string description)
static void _NORETURN_	pips_stop_desc (pips_log_t tag, int code, const string pips_func, const string pips_file, const int pips_line, const string desc)
static void _NORETURN_	pips_stop_alist (pips_log_t tag, int code, const string pips_func, const string pips_file, const int pips_line, const string format, va_list *args)
void _NORETURN_	pips_stop_func (const char *pips_func, const char *pips_file, const int pips_line, pips_log_t tag, int code, const string format,...)
	expecititely declare "noreturn" functions... More...
void _NORETURN_	pips_stop_func2 (pips_log_t tag, int code, const string format,...)
string	pips_log_tag_name (pips_log_t tag)
static void	pips_log_file (FILE *out, const pips_log_t tag, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string description)
static void	pips_log_display (const pips_log_t tag, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string desc)
	manage "displaying" a log entry, on stderr, in files... More...
static void	pips_log_in_progress (const char *pips_func, const char *pips_file, const int pips_line)
static void	pips_log_done (void)
static void	pips_log_end (pips_log_t tag)
	end of log entry (nothing, exception, abort, exit...) More...
void	pips_log_desc (const pips_log_t tag, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string description)
	log entry with preprocessed format/arguments More...
void	pips_log_alist (const pips_log_t tag, const string pips_pass, const string pips_owner, const string pips_func, const string pips_file, const int pips_line, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string format, va_list *args)
	log entry with unprocessed format/alist arguments More...
void	pips_log_func (const string pips_func, const string pips_file, const int pips_line, const pips_log_t tag, const string pips_pass, const string pips_owner, const string user_func, const string user_file, const int user_line, const int user_line2, const string stmt, const string suggestion, const string format,...)
	direct pips_log call with format and free arguments ("...") More...
void	pips_log_stop (const char *function, const char *file, const int lineno, const pips_log_t tag, const int code, const string format,...)
	quick log and stop, called on timeout this must not invoke malloc as it may still held locks if interrupted this implementation is missing XML escapes... More...
int	safe_vasprintf (char **strp, const char *fmt, va_list args)
int	safe_asprintf (char **strp, const char *fmt,...)

Variables
static string	current_phase = NULL
	CATCH/TRY/UNCATCH/THROW stuff is here. More...
static string	current_module = NULL
static string	pips_revisions = NULL
static string	pips_date = NULL
static string	pips_cc = NULL
string(*	pips_request_handler )(const char *, va_list *)
	default assignment of pips_request_handler is default_user_request. More...
static FILE *	log_file = NULL
	The log file is closed by default. More...
void(*	pips_log_handler )(const char *fmt, va_list *args) = NULL
	USER_LOG is a function that should be called to log the current PIPS request, as soon as it is relevant. More...
static FILE *	warning_file = NULL
static string	warning_file_name = NULL
void(*	pips_warning_handler )(const char *, const char *, va_list *) = NULL
	default assignment of pips_warning_handler is default_user_warning. More...
void(*	pips_error_handler )(const char *, const char *, va_list *) = NULL
	PROMPT_USER schould be implemented. More...
void(*	pips_internal_error_handler )(const char *, const char *,...) = NULL
	PIPS_ERROR is a function that should be called to terminate PIPS execution when data structures are corrupted. More...
static FILE *	xml_logfile = NULL
static string	xml_logfile_name = NULL
static int	pips_log_recursion_count = 0

Macro Definition Documentation

LOG_FILE

#define LOG_FILE   "Logfile"

Definition at line 155 of file message.c.

PIPS_THANKS_STRING

#define PIPS_THANKS_STRING

(

arch

)

Value:

  "%s (ARCH=" arch ")\n  running as %s\n"                               \
  "\n"                                                                  \
  "  (c) 1989-2018 MINES ParisTech\n"                                   \
  "                Centre de recherche en informatique.\n"              \
  "\n"                                                                  \
  "  CRI URL: http://www.cri.mines-paristech.fr/\n"                     \
  "  PIPS URL: http://pips4u.org/\n"                                    \
  "  EMAIL: pips-support at cri dot mines-paristech dot fr\n"           \
  "\n"                                                                  \
  "  This software is provided as is, under the terms of the GPL.\n"    \
  "  It includes and uses software from GNU (gnulib, readline),\n"      \
  "  Berkeley (fsplit), INRIA, IRISA and others (polylib, janus)...\n"  \
  "\n"

The # "stringificator" only works in a macro expansion...

Definition at line 247 of file message.c.

WARNING_FILE_NAME

#define WARNING_FILE_NAME   "Warnings"

USER_WARNING issues a warning and don't stop the program (cf.

user_error for infos.)

Definition at line 281 of file message.c.

Function Documentation

append_to_warning_file()

void append_to_warning_file	(	const char *	calling_function_name,
		const char *	format,
		va_list *	args
	)

To be used in error handling functions.

Parameters

calling_function_name	alling_function_name
format	ormat
args	rgs

Definition at line 306 of file message.c.

{
  if (properties_initialized_p() && get_bool_property("NO_USER_WARNING"))
    return;
 
  pips_log_alist(warning_log,
                 get_pips_current_pass_name(), get_pips_current_module(),
                 (const string) calling_function_name, NULL, -1,
                 NULL, NULL, -1, -1,
                 NULL, NULL, (const string) format, args);
}

References get_bool_property(), get_pips_current_module(), get_pips_current_pass_name(), pips_log_alist(), properties_initialized_p(), and warning_log.

Here is the call graph for this function:

append_xml_attribute()

static void append_xml_attribute ( string_buffer  sb, const string  attribute, const string  value  )

static

generate xml: attribute="escaped-stuff"

Definition at line 595 of file message.c.

{
  string_buffer_append(sb, attribute);
  string_buffer_append(sb, "=\"");
  if (value && *value)
    string_buffer_append_xml_text(sb, value, true);
  string_buffer_append(sb, "\" ");
}

References string_buffer_append(), and string_buffer_append_xml_text().

Referenced by open_xml_logfile(), pips_log_xml(), pips_log_xml_pips_level(), and pips_stop_xml().

Here is the call graph for this function:

Here is the caller graph for this function:

append_xml_line_numbers()

static void append_xml_line_numbers ( string_buffer  sb, const string  attribute, int  val1, int  val2  )

static

Definition at line 641 of file message.c.

{
  if (val1 > 0)
  {
    if (val1 < val2)
      string_buffer_printf(sb, "%s=\"%d-%d\" ", attribute, val1, val2);
    else
      string_buffer_printf(sb, "%s=\"%d\" ", attribute, val1);
  }
  else
    string_buffer_printf(sb, "%s=\"\" ", attribute);
}

References string_buffer_printf().

Referenced by pips_log_xml(), and pips_log_xml_pips_level().

Here is the call graph for this function:

Here is the caller graph for this function:

close_log_file()

void close_log_file

(

void

)

Definition at line 162 of file message.c.

{
   if (log_file != NULL && get_bool_property("USER_LOG_P") )
     if (fclose(log_file) != 0)
       pips_internal_error("Could not close log file");
   log_file = NULL;
}

References get_bool_property(), log_file, and pips_internal_error.

Referenced by check_delete_workspace(), close_workspace(), create_workspace(), gpips_main(), open_log_file(), and wpips_main().

Here is the call graph for this function:

Here is the caller graph for this function:

close_warning_file()

void close_warning_file

(

void

)

Definition at line 293 of file message.c.

{
  if (warning_file)
  {
    safe_fclose(warning_file, warning_file_name);
 
    warning_file = (FILE*) NULL;
    free(warning_file_name);
    warning_file_name = (string) NULL;
  }
}

References free(), safe_fclose(), warning_file, and warning_file_name.

Referenced by check_delete_workspace(), close_workspace(), and create_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

close_xml_logfile()

void close_xml_logfile

(

void

)

Definition at line 631 of file message.c.

{
  if (xml_logfile)
  {
    safe_fclose(xml_logfile, xml_logfile_name);
    xml_logfile = NULL;
    xml_logfile_name = NULL;
  }
}

References safe_fclose(), xml_logfile, and xml_logfile_name.

Here is the call graph for this function:

code2status()

static string code2status ( int  code )

static

Definition at line 759 of file message.c.

{
  switch (code)
  {
  case -1:  return "ABORT";
  case 0:   return "OK";
  case 1:   return "INTERNAL_ERROR";
  case TIMEOUT_CODE: return "TIMEOUT";
  default:  return "USER_ERROR";
  }
}

References TIMEOUT_CODE.

Referenced by pips_log_stop(), pips_stop_file(), and pips_stop_xml().

Here is the caller graph for this function:

default_user_request()

string default_user_request	(	const char *	fmt,
		va_list *	args
	)

USER_REQUEST is a function that should be called to request some data from the user.

It returns the string typed by the user until the return key is typed. USER_REQUEST should be called as:

USER_REQUEST(format [, arg] ... )

where format and arg-list are passed as arguments to vprintf.

Parameters

fmt	mt
args	rgs

Definition at line 124 of file message.c.

{
  va_list acpy;
  va_copy(acpy, *args);
  fprintf(stdout, "\nWaiting for your response: ");
  vfprintf(stdout, fmt, acpy);
  fflush(stdout);
  va_end(acpy);
  return safe_readline(stdin);
}

References fprintf(), and safe_readline().

Here is the call graph for this function:

function_same_string_p()

bool function_same_string_p	(	const char *	s1,
		const char *	s2
	)

Parameters

s1	1
s2	2

Definition at line 560 of file message.c.

{
  return strcmp(s1, s2) == 0;
}

References s1.

get_bool_property()

bool get_bool_property

(

const

string

)

FC 2015-07-20: yuk, moved out to prevent an include cycle dependency include "properties.h".

Definition at line 173 of file gfc2pips-stubs.c.

                                            {
  if ( strcmp( "PRETTYPRINT_LISTS_WITH_SPACES", name ) == 0
      || strcmp( "PRETTYPRINT_REGENERATE_ALTERNATE_RETURNS", name ) == 0
      || strcmp( "PRETTYPRINT_C_CODE", name ) == 0
      || strcmp( "ABORT_ON_USER_ERROR", name ) == 0 ) {
    return true;
  }
  if ( strcmp( "NO_USER_WARNING", name ) == 0 ) {
    return false;
  }
  fprintf( stderr, "***** Property requested : %s ***** ", name );
  STUB_WARNING();
  return 0;
}

Referenced by append_to_warning_file(), close_log_file(), open_log_file(), pips_log_end(), and pips_user_warning_alist().

Here is the caller graph for this function:

get_int_property()

int get_int_property

(

const

string

)

Definition at line 191 of file gfc2pips-stubs.c.

                                          {
  fprintf( stderr, "***** Property requested : %s ***** ", name );
  STUB_ERROR();
}

References fprintf(), and STUB_ERROR.

Referenced by any_loop_to_points_to(), apply_a_rule(), copy_write_statement(), copy_write_statement_with_cumulated_regions(), create_common_parameters_h(), create_k_limited_stub_points_to(), do_kernelize(), do_solve_hardware_constraints_on_nb_proc(), do_solve_hardware_constraints_on_volume(), do_terapix_remove_divide(), freia_spoc_pipeline(), freia_terapix_call(), freia_unroll_while(), generate_opcode(), get_free_slot(), get_optimal_opcode(), get_output_slot(), hbdsc_parallelization(), if_conv_init_statement(), init_computation_intensity_param(), initialization(), internal_print_icfg(), loop_chunk_size_and_strip_mine(), make_eliminate_original_variables(), make_mpi_conversion(), match_expression(), maybe_unroll_while_rwt(), mppa_compile_dag(), mppa_dag_maybe_split_instrs_cmd(), mppa_dag_split(), new_any_loop_to_points_to(), normalize_points_to_graph(), offset_array_reference(), offset_points_to_cell(), pips_log_end(), pragma_build_if_condition(), reductions_rewrite(), reference_add_field_dimension(), replicate_declaration(), sc_delimiter(), simple_simd_unroll_rate(), spire_distributed_unstructured_to_structured(), spire_shared_unstructured_to_structured(), statement_to_postcondition(), statement_to_transformer(), statement_to_transformer_list(), terapix_gram_allocate(), terapix_gram_init(), text_complexity(), unroll(), unstructured_to_flow_sensitive_postconditions(), unstructured_to_transformer(), and whileloop_to_postcondition().

Here is the call graph for this function:

get_pips_current_module()

string get_pips_current_module

(

void

)

Definition at line 82 of file message.c.

{
  return current_module;
}

References current_module.

Referenced by append_to_warning_file(), c_parser_user_warning_alist(), csplit_parser_warning_alist(), pips_internal_error_alist(), pips_log_stop(), pips_stop_file(), pips_stop_xml(), pips_user_error_alist(), pips_user_irrecoverable_error_alist(), pips_user_warning_alist(), semantics_user_warning_alist(), and spear_log_alist().

Here is the caller graph for this function:

get_pips_current_pass_name()

string get_pips_current_pass_name

(

void

)

Export this piece of information to customize warning functions in passes.

Passes are also called "phases" in PIPS jargon.

Definition at line 77 of file message.c.

{
  return current_phase;
}

References current_phase.

Referenced by append_to_warning_file(), c_parser_user_warning_alist(), csplit_parser_warning_alist(), pips_internal_error_alist(), pips_log_stop(), pips_stop_file(), pips_stop_xml(), pips_user_error_alist(), pips_user_irrecoverable_error_alist(), pips_user_warning_alist(), semantics_user_warning_alist(), and spear_log_alist().

Here is the caller graph for this function:

get_string_property()

char* get_string_property

(

const char *

)

log_on_file()

void log_on_file

(

const char *

desc

)

Parameters

desc

esc

Definition at line 190 of file message.c.

{
  pips_log_desc(info_log, NULL, NULL,
                NULL, NULL, -1, NULL, NULL, -1, -1,
                NULL, NULL, (const string) desc);
}

References info_log, and pips_log_desc().

Referenced by gpips_user_error_message(), gpips_user_log(), gpips_user_warning_message(), wpips_user_error_message(), wpips_user_log(), and wpips_user_warning_message().

Here is the call graph for this function:

Here is the caller graph for this function:

open_log_file()

void open_log_file

(

const string

dir

)

Parameters

dir

ir

Definition at line 171 of file message.c.

{
  if (log_file != NULL)
    close_log_file();
 
  if (get_bool_property("USER_LOG_P"))
  {
    string log_file_name = strdup(concatenate(dir, "/", LOG_FILE, NULL));
 
    if ((log_file = fopen(log_file_name, "a")) == NULL) {
            pips_user_error("Cannot open log file in workspace %s. "
                      "Check access rights.");
    }
 
    free(log_file_name);
  }
}

References close_log_file(), concatenate(), free(), get_bool_property(), LOG_FILE, log_file, pips_user_error, and strdup().

Referenced by create_workspace(), and open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

open_warning_file()

void open_warning_file

(

const char *

dir

)

Parameters

dir

ir

Definition at line 286 of file message.c.

{
  assert(warning_file_name == NULL && warning_file == NULL);
  warning_file_name = strdup(concatenate(dir, "/", WARNING_FILE_NAME, 0));
  warning_file = safe_fopen(warning_file_name, "a");
}

References assert, concatenate(), safe_fopen(), strdup(), warning_file, WARNING_FILE_NAME, and warning_file_name.

Referenced by create_workspace(), and open_workspace().

Here is the call graph for this function:

Here is the caller graph for this function:

open_xml_logfile()

void open_xml_logfile

(

const char *

filename

)

Parameters

filename

ilename

Definition at line 607 of file message.c.

{
  xml_logfile_name = (string) filename;
  xml_logfile = safe_fopen(filename, "w");
 
  // put version as an XML comment...
  if (!getenv("PIPS_VALIDATION_IN_PROGRESS"))
  {
    string_buffer sb = string_buffer_make(true);
    string_buffer_append(sb, "<!-- pips informations:\n     ");
    append_xml_attribute(sb, "Architecture", STRINGIFY(SOFT_ARCH));
    string_buffer_append(sb, "\n     ");
    append_xml_attribute(sb, "Revisions", pips_revisions);
    string_buffer_append(sb, "\n     ");
    append_xml_attribute(sb, "Date", pips_date);
    string_buffer_append(sb, "\n     ");
    append_xml_attribute(sb, "Compiler", pips_cc);
    string_buffer_append(sb, "\n-->\n");
    string_buffer_to_file(sb, xml_logfile);
    fflush(xml_logfile);
    string_buffer_free(&sb);
  }
}

References append_xml_attribute(), pips_cc, pips_date, pips_revisions, safe_fopen(), string_buffer_append(), string_buffer_free(), string_buffer_make(), string_buffer_to_file(), STRINGIFY, xml_logfile, and xml_logfile_name.

Referenced by parse_arguments().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_internal_error_alist()

static void _NORETURN_ pips_internal_error_alist ( const char *  funcname, const char *  funcfile, const int  funcline, const char *  format, va_list *  args  )

static

Definition at line 375 of file message.c.

{
  pips_log_alist(internal_error_log,
                 get_pips_current_pass_name(),
                 get_pips_current_module(),
                 (const string) funcname, (const string) funcfile, funcline,
                 NULL, NULL, -1, -1,
                 NULL, NULL, (const string) format, args);
 
  // dead code, stopped from pips_log_desc
  abort();
}

References abort, get_pips_current_module(), get_pips_current_pass_name(), internal_error_log, and pips_log_alist().

Referenced by pips_internal_error_func(), and pips_internal_error_func2().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_internal_error_func()

void pips_internal_error_func	(	const char *	funcname,
		const char *	funcfile,
		const int	funcline,
		const char *	fmt,
			...
	)

Parameters

funcname	uncname
funcfile	uncfile
funcline	uncline
fmt	mt

Definition at line 394 of file message.c.

{
  va_list args;
  va_start(args, fmt);
  pips_internal_error_alist(funcname, funcfile, funcline, fmt, &args);
  va_end(args);
}

References pips_internal_error_alist().

Here is the call graph for this function:

pips_internal_error_func2()

void pips_internal_error_func2	(	const char *	format,
			...
	)

Parameters

format

ormat

Definition at line 408 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_internal_error_alist(pips_unknown_function, "<unknownfile>", 0,
                            format, &args);
  va_end(args);
}

References pips_internal_error_alist(), and pips_unknown_function.

Here is the call graph for this function:

pips_log_alist()

void pips_log_alist	(	const pips_log_t	tag,
		const string	pips_pass,
		const string	pips_owner,
		const string	pips_func,
		const string	pips_file,
		const int	pips_line,
		const string	user_func,
		const string	user_file,
		const int	user_line,
		const int	user_line2,
		const string	stmt,
		const string	suggestion,
		const string	format,
		va_list *	args
	)

log entry with unprocessed format/alist arguments

Parameters

pips_pass	ips_pass
pips_owner	ips_owner
pips_func	ips_func
pips_file	ips_file
pips_line	ips_line
user_func	ser_func
user_file	ser_file
user_line	ser_line
user_line2	ser_line2
stmt	tmt
suggestion	uggestion
format	ormat
args	rgs

Definition at line 1200 of file message.c.

{
  pips_log_in_progress(pips_func, pips_file, pips_line);
 
  // process issue description once and for all
  string description = NULL;
  va_list acpy;
  va_copy(acpy, *args);
  // BUG: if a timeout is raised while being in malloc, this call is deadlocked
  // as a lock is already held and vasprintf needs to allocate... Also, XML
  // output generation also requires malloc later on...
  vasprintf(&description, format, acpy);
  va_end(acpy);
 
  // trim leading newlines/tabs and trailing newlines/tabs/spaces
  string desc = description;
  while (*desc && (*desc == '\n' || *desc == '\t' || *desc == '\r'))
    desc ++;
  int last = strlen(desc) - 1;
  while (last >= 0 &&
         (desc[last] == '\n' || desc[last] == '\t' || desc[last] == ' ' ||
          desc[last] == '\r'))
    desc[last--] = '\0';
 
  // display part
  pips_log_display(tag, pips_pass, pips_owner,
                   pips_func, pips_file, pips_line,
                   user_func, user_file, user_line, user_line2,
                   stmt, suggestion, desc);
 
  // cleanup
  free(description);
 
  // (legacy?) alist level callbacks...
  if (tag == info_log && pips_log_handler)
  {
    va_copy(acpy, *args);
    pips_log_handler(format, &acpy);
    va_end(acpy);
  }
  else if ((tag == warning_log || tag == spear_warning_log) &&
           pips_warning_handler)
  {
    va_copy(acpy, *args);
    pips_warning_handler(pips_func, format, &acpy);
    va_end(acpy);
  }
  else if (tag == user_error_log && pips_error_handler)
  {
    va_copy(acpy, *args);
    pips_error_handler(pips_func, format, &acpy);
    va_end(acpy);
  }
  else if (tag == internal_error_log && pips_internal_error_handler)
  {
    va_copy(acpy, *args);
    pips_internal_error_handler(pips_func, format, &acpy);
    va_end(acpy);
  }
 
  // conclusion (exit, abort, whatever), although it may never be reached...
  pips_log_end(tag);
}

References free(), info_log, internal_error_log, pips_error_handler, pips_internal_error_handler, pips_log_display(), pips_log_end(), pips_log_handler, pips_log_in_progress(), pips_warning_handler, spear_warning_log, user_error_log, user_file, vasprintf(), and warning_log.

Referenced by append_to_warning_file(), c_parser_user_warning_alist(), csplit_parser_warning_alist(), pips_internal_error_alist(), pips_log_func(), pips_user_error_alist(), pips_user_irrecoverable_error_alist(), pips_user_log_alist(), pips_user_warning_alist(), semantics_user_warning_alist(), and spear_log_alist().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_desc()

void pips_log_desc	(	const pips_log_t	tag,
		const string	pips_pass,
		const string	pips_owner,
		const string	pips_func,
		const string	pips_file,
		const int	pips_line,
		const string	user_func,
		const string	user_file,
		const int	user_line,
		const int	user_line2,
		const string	stmt,
		const string	suggestion,
		const string	description
	)

log entry with preprocessed format/arguments

Parameters

pips_pass	ips_pass
pips_owner	ips_owner
pips_func	ips_func
pips_file	ips_file
pips_line	ips_line
user_func	ser_func
user_file	ser_file
user_line	ser_line
user_line2	ser_line2
stmt	tmt
suggestion	uggestion
description	escription

Definition at line 1173 of file message.c.

{
  pips_log_in_progress(pips_func, pips_file, pips_line);
 
  pips_log_display(tag, pips_pass, pips_owner,
                   pips_func, pips_file, pips_line,
                   user_func, user_file, user_line, user_line2,
                   stmt, suggestion, description);
 
  pips_log_end(tag);
}

References pips_log_display(), pips_log_end(), pips_log_in_progress(), and user_file.

Referenced by log_on_file().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_display()

static void pips_log_display ( const pips_log_t  tag, const string  pips_pass, const string  pips_owner, const string  pips_func, const string  pips_file, const int  pips_line, const string  user_func, const string  user_file, const int  user_line, const int  user_line2, const string  stmt, const string  suggestion, const string  desc  )

static

manage "displaying" a log entry, on stderr, in files...

Definition at line 1040 of file message.c.

{
  // always show on stderr
  pips_log_file(stderr, tag,
                pips_pass, pips_owner,
                pips_func, pips_file, pips_line,
                user_func, user_file, user_line, user_line2,
                stmt, suggestion, desc);
 
  // send to logfile if there
  if (log_file && tag == info_log)
    pips_log_file(log_file, tag,
                  pips_pass, pips_owner,
                  pips_func, pips_file, pips_line,
                  user_func, user_file, user_line, user_line2,
                  stmt, suggestion, desc);
 
  // send to WARNINGS?
  if (warning_file && tag >= warning_log)
    pips_log_file(warning_file, tag,
                  pips_pass, pips_owner,
                  pips_func, pips_file, pips_line,
                  user_func, user_file, user_line, user_line2,
                  stmt, suggestion, desc);
 
  // XML output
  if (xml_logfile)
    pips_log_xml(tag,
                 pips_pass, pips_owner,
                 pips_func, pips_file, pips_line,
                 user_func, user_file, user_line, user_line2,
                 stmt, suggestion, desc);
}

References info_log, log_file, pips_log_file(), pips_log_xml(), user_file, warning_file, warning_log, and xml_logfile.

Referenced by pips_log_alist(), and pips_log_desc().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_done()

static void pips_log_done ( void  )

static

Definition at line 1109 of file message.c.

{
  pips_log_recursion_count --;
}

References pips_log_recursion_count.

Referenced by pips_log_end().

Here is the caller graph for this function:

pips_log_end()

static void pips_log_end ( pips_log_t  tag )

static

end of log entry (nothing, exception, abort, exit...)

Definition at line 1116 of file message.c.

{
  pips_log_done();
 
  if (tag <= spear_warning_log)
    return;
 
  // just in case, flush stuff before stopping?
  fflush(stderr);
  fflush(stdout);
  if (xml_logfile) fflush(xml_logfile);
  if (warning_file) fflush(warning_file);
  if (log_file) fflush(log_file);
 
  // ??? get_bool_property("CLOSE_WORKSPACE_AND_QUIT_ON_ERROR")
 
  // handle various stops
  if (tag == internal_error_log)
    pips_stop(tag, -1, "internal error raised");
 
  if (tag == irrecoverable_error_log)
    pips_stop(tag, 1, "irrecoverable error raised");
 
  if (tag == user_error_log || tag == spear_error_log)
  {
    if (properties_initialized_p() &&
        get_bool_property("CLOSE_WORKSPACE_AND_QUIT_ON_ERROR"))
      // the close workspace part only works for tpips user error handler
      pips_stop(tag, 2, "CLOSE_WORKSPACE_AND_QUIT_ON_ERROR");
 
    if (too_many_property_errors_pending_p())
      pips_stop(tag, -1, "too many property errors pending");
 
    if (properties_initialized_p() &&
        get_bool_property("ABORT_ON_USER_ERROR"))
      pips_stop(tag, -1, "ABORT_ON_USER_ERROR");
 
    static int user_error_called = 0;
 
    if (properties_initialized_p() &&
        user_error_called > get_int_property("MAXIMUM_USER_ERROR"))
    {
      pips_stop(user_error_log, 3,
                "over MAXIMUM_USER_ERROR=%d user errors",
                get_int_property("MAXIMUM_USER_ERROR"));
    }
 
    user_error_called++;
 
    // throw according to linear exception stack
    // If it is OK there, we should do a reset_property_error()
    THROW(user_exception_error);
  }
}

References get_bool_property(), get_int_property(), internal_error_log, irrecoverable_error_log, log_file, pips_log_done(), pips_stop, properties_initialized_p(), spear_error_log, spear_warning_log, THROW, too_many_property_errors_pending_p(), user_error_log, user_exception_error, warning_file, and xml_logfile.

Referenced by pips_log_alist(), and pips_log_desc().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_file()

static void pips_log_file ( FILE *  out, const pips_log_t  tag, const string  pips_pass, const string  pips_owner, const string  pips_func, const string  pips_file, const int  pips_line, const string  user_func, const string  user_file, const int  user_line, const int  user_line2, const string  stmt, const string  suggestion, const string  description  )

static

Definition at line 954 of file message.c.

{
  // whether to add a new line after line headers
  bool nl = false;
 
  if (pips_pass) {
    fprintf(out, "%s[%s] ", pips_pass, pips_owner? pips_owner: "?");
  }
 
  if (pips_func && tag >= warning_log)
    fprintf(out, "(%s) ", pips_func);
 
  if (tag >= user_error_log)
    fprintf(out, "[%s] ", pips_log_tag_name(tag));
 
  if (pips_file && tag >= internal_error_log) {
    fprintf(out, "(%s:%d) ", pips_file, pips_line);
    nl = true;
  }
 
  if (user_func && !pips_owner) {
    fprintf(out, "in function %s ", user_func);
    nl = true;
  }
 
  if (user_file)
  {
    fprintf(out, "(\"%s\"", user_file);
    if (user_line >= 0)
    {
      fprintf(out, ":%d", user_line);
      if (user_line < user_line2)
        fprintf(out, "-%d", user_line2);
    }
    fputs(") ", out);
    nl = true;
  }
  else
  {
    if (user_line >= 0)
    {
      fprintf(out, "line %d", user_line);
      if (user_line < user_line2)
        fprintf(out, "-%d", user_line2);
      fputs(" ", out);
      nl = true;
    }
  }
 
  if (nl || stmt) fputc('\n', out);
 
  if (stmt) {
    string s = stmt;
    while (*s && *s == '\n') s++; // skip leading newlines
    fprintf(out, "at statement:\n\n\t%s\n\n", s);
  }
 
  if (description) {
    fputs(description, out);
    fputc('\n', out);
  }
 
  if (suggestion) {
    fputs(suggestion, out);
    fputc('\n', out);
  }
 
  fflush(out);
}

References fprintf(), internal_error_log, out, pips_log_tag_name(), user_error_log, user_file, and warning_log.

Referenced by pips_log_display().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_func()

void pips_log_func	(	const string	pips_func,
		const string	pips_file,
		const int	pips_line,
		const pips_log_t	tag,
		const string	pips_pass,
		const string	pips_owner,
		const string	user_func,
		const string	user_file,
		const int	user_line,
		const int	user_line2,
		const string	stmt,
		const string	suggestion,
		const string	format,
			...
	)

direct pips_log call with format and free arguments ("...")

Parameters

pips_func	ips_func
pips_file	ips_file
pips_line	ips_line
pips_pass	ips_pass
pips_owner	ips_owner
user_func	ser_func
user_file	ser_file
user_line	ser_line
user_line2	ser_line2
stmt	tmt
suggestion	uggestion
format	ormat

Definition at line 1286 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_log_alist(tag,
                 pips_pass, pips_owner,
                 pips_func, pips_file, pips_line,
                 user_func, user_file, user_line, user_line2,
                 stmt, suggestion, format, &args);
  va_end(args);
}

References pips_log_alist(), and user_file.

Here is the call graph for this function:

pips_log_in_progress()

static void pips_log_in_progress ( const char *  pips_func, const char *  pips_file, const int  pips_line  )

static

Definition at line 1089 of file message.c.

{
  // deep recursion detection, should never get there...
  if (pips_log_recursion_count ++ > 3)
  {
    // hmmm... cannot call pips_log!
    fprintf(stderr, "pips_log recursion (%d) from %s (%s:%d)\n",
            pips_log_recursion_count, pips_func, pips_file, pips_line);
    fflush(stderr);
 
    if (pips_log_recursion_count > 10)
      pips_stop_func(pips_func, pips_file, pips_line,
                     internal_error_log, -1,
                     "deep pips_log recursion (%d)", pips_log_recursion_count);
  }
}

References fprintf(), internal_error_log, pips_log_recursion_count, and pips_stop_func().

Referenced by pips_log_alist(), and pips_log_desc().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_stop()

void pips_log_stop	(	const char *	function,
		const char *	file,
		const int	lineno,
		const pips_log_t	tag,
		const int	code,
		const string	format,
			...
	)

quick log and stop, called on timeout this must not invoke malloc as it may still held locks if interrupted this implementation is missing XML escapes...

Parameters

function	unction
file	ile
lineno	ineno
code	ode
format	ormat

Definition at line 1323 of file message.c.

{
  // STDERR
  va_list args;
  va_start(args, format);
  fprintf(stderr, "(%s) [%s] stopping pips on code %d (%s) for ",
          function, pips_log_tag_name(tag), code, code2status(code));
  vfprintf(stderr, format, args);
  va_end(args);
  fputs("\n", stderr);
  fflush(stderr);
 
  // XML
  if (xml_logfile)
  {
    fprintf(xml_logfile,
            "<Exit Code=\"%d\" Status=\"%s\" Source=\"%s\">\n",
            code, code2status(code), pips_log_tag_name(tag));
 
    string
      pass = get_pips_current_pass_name(),
      module = get_pips_current_module();
 
    fprintf(xml_logfile,
            "  <Description AppFunction=\"\" AppFile=\"\" "
            "AppLine=\"\" Statement=\"\" Proposition=\"\" "
            "Pass=\"%s\" Owner=\"%s\" PipsFunction=\"%s\" ",
            pass? pass: "", module? module: "", function);
 
    if (file && getenv("PIPS_VALIDATION_IN_PROGRESS"))
    {
      // just show a short version of the file & hide the line
      string short_file = strstr(file, "/src/");
      fprintf(xml_logfile,
              "PipsFile=\"%s\" PipsLine=\"...\" ",
              short_file? short_file: "...");
    }
    else
    {
      fprintf(xml_logfile, "PipsFile=\"%s\" PipsLine=\"%d\" ", file, lineno);
    }
 
    fprintf(xml_logfile, "Message=\"");
 
    va_start(args, format);
    vfprintf(xml_logfile, format, args);
    va_end(args);
 
    fprintf(xml_logfile, "\" />\n</Exit>\n");
    fflush(xml_logfile);
  }
 
  exit(code);
}

References code2status(), exit, fprintf(), get_pips_current_module(), get_pips_current_pass_name(), module, pips_log_tag_name(), and xml_logfile.

Referenced by pips_timeout_callback().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_tag_name()

string pips_log_tag_name

(

pips_log_t

tag

)

Definition at line 938 of file message.c.

{
  switch (tag)
  {
  case none_log: return "none";
  case info_log: return "information";
  case warning_log: return "warning";
  case spear_warning_log: return "spear warning";
  case spear_error_log: return "spear error";
  case user_error_log: return "user error";
  case internal_error_log: return "internal error";
  case irrecoverable_error_log: return "irrecoverable error";
  default: return "<missing tag name>";
  }
}

References info_log, internal_error_log, irrecoverable_error_log, none_log, spear_error_log, spear_warning_log, user_error_log, and warning_log.

Referenced by pips_log_file(), pips_log_stop(), pips_stop_file(), and pips_stop_xml().

Here is the caller graph for this function:

pips_log_xml()

static void pips_log_xml ( const pips_log_t  tag, const string  pips_pass, const string  pips_owner, const string  pips_func, const string  pips_file, const int  pips_line, const string  user_func, const string  user_file, const int  user_line, const int  user_line2, const string  stmt, const string  suggestion, const string  description  )

static

add a full log entry to the xml log file

Definition at line 701 of file message.c.

{
  // only tag warnings & above...
  if (tag == info_log) return;
 
  assert(xml_logfile != NULL);
 
  // build XML in a string buffer
  string_buffer sb = string_buffer_make(true);
  string field = pips_log_xml_tag(tag);
 
  string_buffer_cat(sb, "<", field, ">\n  <Description ", NULL);
  // user level information
  append_xml_attribute(sb, "AppFunction", user_func);
  append_xml_attribute(sb, "AppFile", user_file);
  append_xml_line_numbers(sb, "AppLine", user_line, user_line2);
 
  pips_log_xml_pips_level(sb, pips_pass, pips_owner,
                          pips_func, pips_file, pips_line);
 
  if (stmt)
  {
    char * s = stmt;
    while (*s && (*s == '\n' || *s == '\t' || *s == ' ')) s++;
    append_xml_attribute(sb, "Statement", s);
  }
  else
    append_xml_attribute(sb, "Statement", NULL);
 
  // remove leading spaces for xml
  string desc = description;
  while (desc && *desc && *desc == ' ') desc++;
 
  append_xml_attribute(sb, "Message", desc);
  append_xml_attribute(sb, "Proposition", suggestion);
  string_buffer_cat(sb, "/>\n</", field, ">\n", NULL);
 
  string_buffer_to_file(sb, xml_logfile);
  string_buffer_free(& sb);
 
  fflush(xml_logfile);
}

References append_xml_attribute(), append_xml_line_numbers(), assert, info_log, pips_log_xml_pips_level(), pips_log_xml_tag(), string_buffer_cat(), string_buffer_free(), string_buffer_make(), string_buffer_to_file(), user_file, and xml_logfile.

Referenced by pips_log_display().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_xml_pips_level()

static void pips_log_xml_pips_level ( string_buffer  sb, const string  pips_pass, const string  pips_owner, const string  pips_func, const string  pips_file, const int  pips_line  )

static

append pips-level stuff (function, file, line) to xml file

Definition at line 673 of file message.c.

{
  // pips level information
  append_xml_attribute(sb, "Pass", pips_pass);
  append_xml_attribute(sb, "Owner", pips_owner);
  append_xml_attribute(sb, "PipsFunction", pips_func);
  if (pips_file && getenv("PIPS_VALIDATION_IN_PROGRESS"))
  {
    // just show a short version of the file & hide the line
    string short_file = strstr(pips_file, "/src/");
    append_xml_attribute(sb, "PipsFile", short_file? short_file: "...");
    append_xml_attribute(sb, "PipsLine", "...");
  }
  else
  {
    append_xml_attribute(sb, "PipsFile", pips_file);
    append_xml_line_numbers(sb, "PipsLine", pips_line, 0);
  }
}

References append_xml_attribute(), and append_xml_line_numbers().

Referenced by pips_log_xml(), and pips_stop_xml().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_log_xml_tag()

static string pips_log_xml_tag ( pips_log_t  tag )

static

Definition at line 657 of file message.c.

{
  switch (tag) {
  case info_log: return "Info";
  case warning_log: return "Warning";
  case spear_warning_log: return "SpearWarning";
  case spear_error_log: return "SpearError";
  case user_error_log: return "UserError";
  case internal_error_log: return "InternalError";
  case irrecoverable_error_log: return "InternalError";
  default: abort();
  }
}

References abort, info_log, internal_error_log, irrecoverable_error_log, spear_error_log, spear_warning_log, user_error_log, and warning_log.

Referenced by pips_log_xml().

Here is the caller graph for this function:

pips_stop_alist()

static void _NORETURN_ pips_stop_alist ( pips_log_t  tag, int  code, const string  pips_func, const string  pips_file, const int  pips_line, const string  format, va_list *  args  )

static

Definition at line 883 of file message.c.

{
  string description;
  va_list acpy;
  va_copy(acpy, *args);
  vasprintf(&description, format, acpy);
  va_end(acpy);
 
  pips_stop_desc(tag, code, pips_func, pips_file, pips_line, description);
 
  free(description);
}

References free(), pips_stop_desc(), and vasprintf().

Referenced by pips_stop_func(), and pips_stop_func2().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_stop_desc()

static void _NORETURN_ pips_stop_desc ( pips_log_t  tag, int  code, const string  pips_func, const string  pips_file, const int  pips_line, const string  desc  )

static

Definition at line 845 of file message.c.

{
  // trace
  pips_stop_file(stderr, tag, code, pips_func, pips_file, pips_line, desc);
 
  if (log_file && tag == info_log)
    pips_stop_file(log_file, tag, code, pips_func, pips_file, pips_line, desc);
 
  if (log_file)
    fclose(log_file);
 
  if (warning_file && tag >= warning_log)
    pips_stop_file(warning_file,
                   tag, code, pips_func, pips_file, pips_line, desc);
 
  if (warning_file)
    fclose(warning_file);
 
  if (xml_logfile)
  {
    pips_stop_xml(tag, code, pips_func, pips_file, pips_line, desc);
    fclose(xml_logfile);
  }
 
  // do the deed
  if (code < 0)
    abort();
  else
    exit(code);
}

References abort, exit, info_log, log_file, pips_stop_file(), pips_stop_xml(), warning_file, warning_log, and xml_logfile.

Referenced by pips_stop_alist().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_stop_file()

static void pips_stop_file ( FILE *  out, pips_log_t  tag, int  code, const char *  pips_func, const char *  pips_file, const int  pips_line, const string  description  )

static

Definition at line 801 of file message.c.

{
  if (code)
  {
    // some error, precise report
    string
      pass = get_pips_current_pass_name(),
      owner = get_pips_current_module();
 
    if (pass)
      fprintf(out, "%s[%s] ", pass, owner? owner: "<unknown");
 
    if (pips_func)
      fprintf(out, "(%s) ", pips_func);
 
    fprintf(out, "[%s] ", pips_log_tag_name(tag));
 
    fprintf(out, "stopping pips on code %d (%s) ", code, code2status(code));
 
    // not good for validation, this might move easily... so only on abort
    if (pips_file && code == -1)
      fprintf(out, "at (\"%s\":%d) ", pips_file, pips_line);
 
    if (description && *description)
    {
      fputs("for ", out);
      fputs(description, out);
    }
    fputs("\n", out);
  }
  else // short output for normal exit(0)
    fprintf(out, "Pips is done: %s\n", description);
 
  fflush(out);
}

References code2status(), fprintf(), get_pips_current_module(), get_pips_current_pass_name(), out, and pips_log_tag_name().

Referenced by pips_stop_desc().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_stop_func()

void pips_stop_func	(	const char *	pips_func,
		const char *	pips_file,
		const int	pips_line,
		pips_log_t	tag,
		int	code,
		const	string,
			...
	)

expecititely declare "noreturn" functions...

because cproto generated headers seem to ignore attributes

Parameters

pips_func	ips_func
pips_file	ips_file
pips_line	ips_line
code	ode
format	ormat

Definition at line 904 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_stop_alist(tag, code,
                  (const string) pips_func, (const string) pips_file, pips_line,
                  format, &args);
  va_end(args);
}

References pips_stop_alist().

Referenced by pips_log_in_progress().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_stop_func2()

void pips_stop_func2	(	pips_log_t	tag,
		int	code,
		const string	format,
			...
	)

Parameters

code	ode
format	ormat

Definition at line 924 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_stop_alist(tag, code, NULL, NULL, -1, format, &args);
  va_end(args);
}

References pips_stop_alist().

Here is the call graph for this function:

pips_stop_xml()

static void pips_stop_xml ( pips_log_t  tag, int  code, const string  pips_func, const string  pips_file, const int  pips_line, const string  description  )

static

Definition at line 771 of file message.c.

{
  assert(xml_logfile != NULL);
 
  string_buffer sb = string_buffer_make(true);
  string_buffer_printf(sb,
                       "<Exit Code=\"%d\" Status=\"%s\" Source=\"%s\">\n",
                       code, code2status(code),
                       code? pips_log_tag_name(tag): "pips");
  string_buffer_append(sb,
                       "  <Description AppFunction=\"\" AppFile=\"\" "
                       "AppLine=\"\" Statement=\"\" Proposition=\"\" ");
  pips_log_xml_pips_level(sb, get_pips_current_pass_name(),
                          get_pips_current_module(),
                          pips_func, pips_file, pips_line);
  append_xml_attribute(sb, "Message", description);
  string_buffer_append(sb, "/>\n</Exit>\n");
 
  string_buffer_to_file(sb, xml_logfile);
  fflush(xml_logfile);
 
  string_buffer_free(&sb);
}

References append_xml_attribute(), assert, code2status(), get_pips_current_module(), get_pips_current_pass_name(), pips_log_tag_name(), pips_log_xml_pips_level(), string_buffer_append(), string_buffer_free(), string_buffer_make(), string_buffer_printf(), string_buffer_to_file(), and xml_logfile.

Referenced by pips_stop_desc().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_thanks()

void pips_thanks	(	string	name,
		string	path
	)

display pips thanks on startup, if it on a tty.

This file contains the main for wpips.

This file contains the main for tpips.

This file contains the main for pips.

This file contains the main for fpips.

Parameters

name	ame
path	ath

Definition at line 265 of file message.c.

{
  if (isatty(fileno(stdout)))
  {
    fprintf(stdout, PIPS_THANKS_STRING(STRINGIFY(SOFT_ARCH)), name, path);
    fflush(stdout);
  }
}

References fprintf(), PIPS_THANKS_STRING, and STRINGIFY.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_user_error_alist()

static void _NORETURN_ pips_user_error_alist ( const char *  calling_function_name, const char *  funcfile, const int  funcline, const char *  format, va_list *  args  )

static

Definition at line 458 of file message.c.

{
  pips_log_alist(
    user_error_log,
    get_pips_current_pass_name(),
    get_pips_current_module(),
    (const string) calling_function_name, (const string) funcfile, funcline,
    NULL, NULL, -1, -1,
    NULL, NULL, (const string) format, args);
 
  // dead code, should not get there...
  abort();
}

References abort, get_pips_current_module(), get_pips_current_pass_name(), pips_log_alist(), and user_error_log.

Referenced by pips_user_error_func(), and pips_user_error_func2().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_user_error_func()

void pips_user_error_func	(	const char *	func_name,
		const char *	funcfile,
		const int	funcline,
		const char *	format,
			...
	)

Parameters

func_name	unc_name
funcfile	uncfile
funcline	uncline
format	ormat

Definition at line 478 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_error_alist(func_name, funcfile, funcline, format, &args);
  va_end(args);
}

References pips_user_error_alist().

Here is the call graph for this function:

pips_user_error_func2()

void pips_user_error_func2	(	const char *	format,
			...
	)

Parameters

format

ormat

Definition at line 492 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_error_alist(pips_unknown_function, NULL, -1, format, &args);
  va_end(args);
}

References pips_unknown_function, and pips_user_error_alist().

Here is the call graph for this function:

pips_user_irrecoverable_error_alist()

void pips_user_irrecoverable_error_alist	(	const char *	func_name,
		const char *	funcfile,
		const int	funcline,
		const char *	format,
		va_list *	args
	)

Parameters

func_name	unc_name
funcfile	uncfile
funcline	uncline
format	ormat
args	rgs

Definition at line 516 of file message.c.

{
  pips_log_alist(irrecoverable_error_log,
                 get_pips_current_pass_name(),
                 get_pips_current_module(),
                 (const string) func_name, (const string) funcfile, funcline,
                 NULL, NULL, -1, -1,
                 NULL, NULL, (const string) format, args);
 
  // dead code, stopped in previous call
  exit(1);
}

References exit, get_pips_current_module(), get_pips_current_pass_name(), irrecoverable_error_log, and pips_log_alist().

Referenced by pips_user_irrecoverable_error_func(), and pips_user_irrecoverable_error_func2().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_user_irrecoverable_error_func()

void pips_user_irrecoverable_error_func	(	const char *	func_name,
		const char *	funcfile,
		const int	funcline,
		const char *	format,
			...
	)

Parameters

func_name	unc_name
funcfile	uncfile
funcline	uncline
format	ormat

Definition at line 535 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_irrecoverable_error_alist(func_name, funcfile, funcline,
                                      format, &args);
  va_end(args);
}

References pips_user_irrecoverable_error_alist().

Here is the call graph for this function:

pips_user_irrecoverable_error_func2()

void pips_user_irrecoverable_error_func2	(	const char *	format,
			...
	)

Parameters

format

ormat

Definition at line 550 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_irrecoverable_error_alist("UNKNOWN...", NULL, -1, format, &args);
  va_end(args);
}

References pips_user_irrecoverable_error_alist().

Here is the call graph for this function:

pips_user_log_alist()

static void pips_user_log_alist ( const char *  format, va_list *  args  )

static

Definition at line 218 of file message.c.

{
  pips_log_alist(info_log, NULL, NULL,
                 NULL, NULL, -1, NULL, NULL, -1, -1,
                 NULL, NULL, (const string) format, args);
}

References info_log, and pips_log_alist().

Referenced by pips_user_log_func(), and user_log().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_user_log_func()

void pips_user_log_func	(	const char *	format,
			...
	)

Parameters

format

ormat

Definition at line 225 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_log_alist(format, &args);
  va_end(args);
}

References pips_user_log_alist().

Here is the call graph for this function:

pips_user_warning_alist()

void pips_user_warning_alist	(	const char *	function_name,
		const char *	funcfile,
		const int	funcline,
		const char *	format,
		va_list *	args
	)

Parameters

function_name	unction_name
funcfile	uncfile
funcline	uncline
format	ormat
args	rgs

Definition at line 328 of file message.c.

{
  if (properties_initialized_p() && get_bool_property("NO_USER_WARNING"))
    return;
 
  pips_log_alist(warning_log,
                 get_pips_current_pass_name(), get_pips_current_module(),
                 (const string) function_name, (const string)funcfile, funcline,
                 NULL, NULL, -1, -1,
                 NULL, NULL, (const string) format, args);
}

References get_bool_property(), get_pips_current_module(), get_pips_current_pass_name(), pips_log_alist(), properties_initialized_p(), and warning_log.

Referenced by pips_user_warning_func(), and pips_user_warning_func2().

Here is the call graph for this function:

Here is the caller graph for this function:

pips_user_warning_func()

void pips_user_warning_func	(	const char *	calling_function_name,
		const char *	funcfile,
		const int	funcline,
		const char *	format,
			...
	)

Parameters

calling_function_name	alling_function_name
funcfile	uncfile
funcline	uncline
format	ormat

Definition at line 346 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_warning_alist(calling_function_name, funcfile, funcline,
                          format, &args);
  va_end(args);
}

References pips_user_warning_alist().

Here is the call graph for this function:

pips_user_warning_func2()

void pips_user_warning_func2	(	const char *	format,
			...
	)

fallback version without a calling function name

Parameters

format

ormat

Definition at line 362 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_warning_alist(pips_unknown_function, NULL, -1, format, &args);
  va_end(args);
}

References pips_unknown_function, and pips_user_warning_alist().

Here is the call graph for this function:

properties_initialized_p()

bool properties_initialized_p

(

void

)

FC 2015-07-20: yuk, moved out to prevent an include cycle dependency include "properties.h".

Definition at line 206 of file gfc2pips-stubs.c.

                                    {
  STUB_WARNING_MSG("unimplemented in gfc2pips !");
  return true;
}

References STUB_WARNING_MSG.

Referenced by append_to_warning_file(), pips_log_end(), pips_user_warning_alist(), and tpips_user_error().

Here is the caller graph for this function:

reset_pips_current_computation()

void reset_pips_current_computation

(

void

)

Definition at line 87 of file message.c.

{
  pips_assert("some current computation", current_module && current_phase);
 
  free(current_module), current_module = NULL;
  free(current_phase), current_phase = NULL;
}

References current_module, current_phase, free(), and pips_assert.

Referenced by create_workspace(), and reset_current_phase_context().

Here is the call graph for this function:

Here is the caller graph for this function:

safe_asprintf()

int safe_asprintf	(	char **	strp,
		const char *	fmt,
			...
	)

Parameters

strp	trp
fmt	mt

Definition at line 1408 of file message.c.

{
  va_list args;
  va_start(args, fmt);
  return safe_vasprintf(strp, fmt, args);
  va_end(args);
}

References safe_vasprintf().

Here is the call graph for this function:

safe_vasprintf()

int safe_vasprintf	(	char **	strp,
		const char *	fmt,
		va_list	args
	)

Parameters

strp	trp
fmt	mt
args	rgs

Definition at line 1398 of file message.c.

{
  va_list acpy;
  va_copy(acpy, args);
  int ret = vasprintf(strp, fmt, acpy);
  pips_assert("vasprintf is ok", ret >= 0);
  va_end(acpy);
  return ret;
}

References pips_assert, ret, and vasprintf().

Referenced by safe_asprintf().

Here is the call graph for this function:

Here is the caller graph for this function:

set_pips_current_computation()

void set_pips_current_computation	(	const char *	rname,
		const char *	oname
	)

message.c

Parameters

rname	name
oname	name

Definition at line 65 of file message.c.

{
  pips_assert("no current computation", !current_module && !current_phase);
 
  current_phase = strdup(rname);
  current_module = strdup(oname);
}

References current_module, current_phase, pips_assert, and strdup().

Referenced by create_workspace(), and set_current_phase_context().

Here is the call graph for this function:

Here is the caller graph for this function:

set_pips_meta_informations()

void set_pips_meta_informations	(	const char *	revs,
		const char *	date,
		const char *	comp
	)

Parameters

revs	evs
date	ate
comp	omp

Definition at line 102 of file message.c.

{
  pips_revisions = (string) revs;
  pips_date = (string) date;
  pips_cc = (string) comp;
}

References pips_cc, pips_date, and pips_revisions.

Referenced by atinit(), gpips_main(), pips_init(), pips_main(), tpips_main(), and wpips_main().

Here is the caller graph for this function:

too_many_property_errors_pending_p()

bool too_many_property_errors_pending_p

(

void

)

Definition at line 203 of file gfc2pips-stubs.c.

                                              {
  STUB_WARNING_MSG("unimplemented in gfc2pips !");
}

References STUB_WARNING_MSG.

Referenced by pips_log_end().

Here is the caller graph for this function:

user_log()

void user_log	(	const char *	format,
			...
	)

Parameters

format

ormat

Definition at line 234 of file message.c.

{
  va_list args;
  va_start(args, format);
  pips_user_log_alist(format, &args);
  va_end(args);
}

References pips_user_log_alist().

Referenced by abc_with_allocation_size(), add_new_compilation_unit(), add_new_module_from_text(), alias_check(), apply_a_rule(), array_bound_check_instrumentation(), array_bound_check_interprocedural(), array_dfg(), atomizer(), bottom_up_abc_base_reference_implied_do(), bottom_up_abc_call(), bottom_up_abc_reference(), check_input_file_syntax(), checkpoint_workspace(), clean_up_sequences_rewrite(), continue_create_workspace_notify(), create_workspace(), db_close_module(), db_save_workspace(), delete_some_resources(), display_alias_check_statistics(), display_alias_propagation_statistics(), display_bottom_up_abc_statistics(), display_clean_up_sequences_statistics(), display_impact_alias_statistics(), display_interprocedural_abc_statistics(), display_top_down_abc_statistics(), display_unspaghettify_statistics(), display_used_before_set_statistics(), do_resource_usage_check(), end_directory_notify(), find_statements_interactively_walker(), formal_array_resizing_bottom_up(), full_unroll(), full_unroll_pragma(), get_view_file(), gpips_display_graph_file_display(), gpips_user_request(), impact_check(), initialize_and_verify_common_variable(), initialize_and_verify_local_variable(), interactive_hyperplane_direction(), interactive_partitioning_matrix(), interprocedural_abc_arrays(), interprocedural_abc_statement_rwt(), lazy_open_module(), LinkInstToCurrentBlock(), logs_off(), loop_chunk_size_and_strip_mine(), main(), make_close_workspace(), make_special_value(), NewStmt(), notify_hpfc_file_view(), open_module(), open_workspace(), open_workspace_notify(), options_select(), parse_arguments(), pips_main(), pips_signal_handler(), print_array_dfg(), print_bdt(), print_code_static_control(), print_plc(), process_user_file(), put_summary(), referencenodeclfilter(), reindexing(), safe_concurrent_apply(), safe_do_something(), safe_set_property(), select_a_module_by_default(), select_rule(), set_env_log_and_free(), single_assign(), static_controlize(), stmt_flt(), strip_mine(), SubstituteAlternateReturns(), text_comp_region(), text_region_no_action(), top_down_abc_array(), tp_system(), unroll(), update_options(), UpdateEntity(), wpips_display_graph_file_display(), wpips_interrupt_pipsmake(), and wpips_user_request().

Here is the call graph for this function:

Variable Documentation

current_module

string current_module = NULL

static

Definition at line 63 of file message.c.

Referenced by get_pips_current_module(), init_host_and_node_entities(), make_sensitivity_information(), reset_pips_current_computation(), and set_pips_current_computation().

current_phase

string current_phase = NULL

static

CATCH/TRY/UNCATCH/THROW stuff is here.

pips meta information from pipsmake are made available here... (current phase and module...)

Definition at line 62 of file message.c.

Referenced by get_pips_current_pass_name(), reset_pips_current_computation(), and set_pips_current_computation().

log_file

FILE* log_file = NULL

static

The log file is closed by default.

Definition at line 159 of file message.c.

Referenced by close_log_file(), open_log_file(), pips_log_display(), pips_log_end(), and pips_stop_desc().

pips_cc

string pips_cc = NULL

static

Definition at line 100 of file message.c.

Referenced by open_xml_logfile(), and set_pips_meta_informations().

pips_date

string pips_date = NULL

static

Definition at line 99 of file message.c.

Referenced by open_xml_logfile(), and set_pips_meta_informations().

pips_error_handler

void(* pips_error_handler) (const char *, const char *, va_list *)	(	const char *	,
		const char *	,
		va_list *
	)		= NULL

PROMPT_USER schould be implemented.

(its a warning with consent of the user) The question is: how schould it be called? USER_ERROR is a function that should be called to terminate the current PIPS request execution or to restore the previous saved stack environment when an error in a Fortran file or elsewhere is detected. USER_ERROR first prints on stderr a description of the error, then tests the property ABORT_ON_USER_ERROR and aborts case true. Else it will restore the last saved stack environment (ie. come back to the last executed setjmp(pips_top_level) ), except for eventuality it has already been called. In this case, it terminates execution with exit. USER_ERROR should be called as:

USER_ERROR(fonction, format [, arg] ... )

where function is a string containing the name of the function calling USER_ERROR, and where format and arg-list are passed as arguments to vprintf.

Modifications:

• user_error() was initially called when a Fortran syntax error was encountered by the parser; execution was stopped; this had to be changed because different kind of errors can occur and because pips is no longer structured using exec(); one has to go back to PIPS top level, in tpips or in wpips; (Francois Irigoin, 19 November 1990)
• user_error() calls (* pips_error_handler) which can either be default_user_error or a user_error function specific to the used top-level. But each user_error function should have the same functionalities. default assignment of pips_error_handler is default_user_error. Some top-level (eg. wpips) may need a special user_error proceedure; they should let pips_error_handler point toward it.

Definition at line 455 of file message.c.

Referenced by atinit(), gpips_main(), pips_log_alist(), tpips_init(), and wpips_main().

pips_internal_error_handler

void(* pips_internal_error_handler) (const char *, const char *,...)	(	const char *	,
		const char *	,
			...
	)		= NULL

PIPS_ERROR is a function that should be called to terminate PIPS execution when data structures are corrupted.

PIPS_ERROR should be called as: PIPS_ERROR(fonction, format [, arg] ... ) where function is a string containing the name of the function calling PIPS_ERROR, and where format and arg-list are passed as arguments to vprintf. PIPS_ERROR terminates execution with abort.

Definition at line 511 of file message.c.

Referenced by pips_log_alist(), and tpips_init().

pips_log_handler

void(* pips_log_handler) (const char *fmt, va_list *args)	(	const char *	fmt,
		va_list *	args
	)		= NULL

USER_LOG is a function that should be called to log the current PIPS request, as soon as it is relevant.

loging will occure if property USER_LOG_P is TRUE. USER_LOG should be called as:

USER_LOG(format [, arg] ... )

where format and arg-list are passed as arguments to vprintf. default assignment of pips_log_handler is default_user_log. Some top-level (eg. wpips) may need a special user_log proceedure; they should let pips_log_handler point toward it.

Every procedure pointed to by pips_log_handler must test the property USER_LOG_P; this is necessary because (* pips_log_handler) may be called anywhere (because VARARGS), whithout verifying it.

Definition at line 216 of file message.c.

Referenced by atinit(), gpips_main(), pips_log_alist(), and wpips_main().

pips_log_recursion_count

int pips_log_recursion_count = 0

static

Definition at line 1087 of file message.c.

Referenced by pips_log_done(), and pips_log_in_progress().

pips_request_handler

string(* pips_request_handler) (const char *, va_list *) ( const char *  , va_list *    )

default

default assignment of pips_request_handler is default_user_request.

Some top-level (eg. wpips) may need a special user_request proceedure; they should let pips_request_handler point toward it.

Definition at line 139 of file message.c.

{
  va_list args;
  va_start(args, a_message_format);
  string str = (* pips_request_handler)(a_message_format, &args);
  va_end(args);
  return str;
}

Referenced by gpips_main(), tpips_init(), and wpips_main().

pips_revisions

string pips_revisions = NULL

static

Definition at line 98 of file message.c.

Referenced by open_xml_logfile(), and set_pips_meta_informations().

pips_warning_handler

void(* pips_warning_handler) (const char *, const char *, va_list *)	(	const char *	,
		const char *	,
		va_list *
	)		= NULL

default assignment of pips_warning_handler is default_user_warning.

Some top-level (eg. wpips) may need a special user_warning proceedure; they should let pips_warning_handler point toward it.

Definition at line 325 of file message.c.

Referenced by gpips_main(), pips_log_alist(), and wpips_main().

warning_file

FILE* warning_file = NULL

static

Definition at line 283 of file message.c.

Referenced by close_warning_file(), open_warning_file(), pips_log_display(), pips_log_end(), and pips_stop_desc().

warning_file_name

string warning_file_name = NULL

static

Definition at line 284 of file message.c.

Referenced by close_warning_file(), and open_warning_file().

xml_logfile

FILE* xml_logfile = NULL

static

Definition at line 567 of file message.c.

Referenced by close_xml_logfile(), open_xml_logfile(), pips_log_display(), pips_log_end(), pips_log_stop(), pips_log_xml(), pips_stop_desc(), and pips_stop_xml().

xml_logfile_name

string xml_logfile_name = NULL

static

Definition at line 568 of file message.c.

Referenced by close_xml_logfile(), and open_xml_logfile().