core.h File Reference

#include "core/symprefix.h"

Include dependency graph for core.h:

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

Go to the source code of this file.

Macros
#define	__attribute__(x)   /*NOTHING*/
#define	XT_UNUSED(x)   UNUSED_ ## x __attribute__((__unused__))
#define	die(msg)    SymPrefix(abort)(SymPrefix(default_comm), (msg), __FILE__, __LINE__)

Typedefs
typedef int	MPI_Comm
typedef int	MPI_Fint
typedef void(*)(MPI_Comm comm, const char *msg, const char *source, int line) SymPrefi	(abort_func)) ((noreturn))

Enumerations
enum	{ MPI_COMM_WORLD = 4711 , MPI_COMM_NULL = 0 }

Functions
	SymPrefix (abort_func) SymPrefix(abort)
void SymPrefix()	restore_default_abort_handler (void)
MPI_Comm	SymPrefix (default_comm)
void SymPrefix()	abort_default (MPI_Comm comm, const char *msg, const char *source, int line) __attribute__((noreturn))
void SymPrefix()	set_default_comm (MPI_Comm comm)

Detailed Description

--- interface to user-adjustable core routines of scales ppm

Copyright

(C) 2010 Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Author

Thomas Jahns jahns.nosp@m.@dkr.nosp@m.z.de

Definition in file core.h.

Macro Definition Documentation

__attribute__

#define __attribute__

(

x

)

/*NOTHING*/

Examples

test_xmap_all2all_fail.c.

Definition at line 82 of file core.h.

die

#define die

(

msg

)

SymPrefix(abort)(SymPrefix(default_comm), (msg), __FILE__, __LINE__)

Definition at line 131 of file core.h.

XT_UNUSED

#define XT_UNUSED

(

x

)

UNUSED_ ## x __attribute__((__unused__))

Definition at line 84 of file core.h.

Typedef Documentation

(abort_func)

typedef void(*)(MPI_Comm comm, const char *msg, const char *source, int line) SymPrefi (abort_func)) ((noreturn))

functions used as error handler must conform to this interface

Definition at line 90 of file core.h.

MPI_Comm

typedef int MPI_Comm

fall back to int in case no MPI implementation was found

Examples

test_xmap_common_parallel.c.

Definition at line 64 of file core.h.

MPI_Fint

typedef int MPI_Fint

fall back to int in case no MPI implementation was found

Definition at line 68 of file core.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

provide value to use in case no actual communicators exist

Enumerator
MPI_COMM_WORLD
MPI_COMM_NULL

Definition at line 72 of file core.h.

Function Documentation

abort_default()

void SymPrefix() abort_default ( MPI_Comm  comm, const char *  msg, const char *  source, int  line  )

extern

This function prints the message argument and file and line of the error to standard error, and calls either MPI_Abort or abort depending on whether MPI is initialized.

Parameters

comm	MPI communcator object to use on call to MPI_Abort
msg	message text to print
source	string describing source file name
line	line number of caller

Definition at line 116 of file core.c.

restore_default_abort_handler()

void SymPrefix() restore_default_abort_handler

(

void

)

Restore default abort handler.

set_default_comm()

void SymPrefix() set_default_comm ( MPI_Comm  comm )

extern

change default communicator object

SymPrefix() [1/2]

SymPrefix ( abort_func  )

extern

Unless modified, this function pointer will reference PPM_abort_default.

Definition at line 133 of file core.c.

SymPrefix() [2/2]

MPI_Comm SymPrefix ( default_comm  )

extern

communicator object to use by default