/usr/include/sc.h is in libp4est-dev 1.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 | /*
This file is part of the SC Library.
The SC Library provides support for parallel scientific applications.
Copyright (C) 2010 The University of Texas System
The SC Library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
The SC Library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with the SC Library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
/** \file sc.h
*
* Support for process management (memory allocation, logging, etc.)
*/
/** \defgroup sc libsc
*
* The SC Library provides support for parallel scientific applications.
*/
#ifndef SC_H
#define SC_H
/* include the sc_config header first */
#include <sc_config.h>
#ifndef _sc_const
#define _sc_const const
#endif
#ifndef _sc_restrict
#define _sc_restrict restrict
#endif
/* use this in case mpi.h includes stdint.h */
#ifndef __STDC_LIMIT_MACROS
#define __STDC_LIMIT_MACROS
#endif
/* include MPI before stdio.h */
#ifdef SC_ENABLE_MPI
#include <mpi.h>
#else
#ifdef MPI_SUCCESS
#error "mpi.h is included. Use --enable-mpi."
#endif
#endif
/* include system headers */
#include <math.h>
#include <ctype.h>
#include <float.h>
#include <libgen.h>
#include <limits.h>
#include <stdarg.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
/* provide extern C defines */
/* the hacks below enable semicolons after the SC_EXTERN_C_ macros */
#ifdef __cplusplus
#define SC_EXTERN_C_BEGIN extern "C" { void sc_extern_c_hack_1 (void)
#define SC_EXTERN_C_END } void sc_extern_c_hack_2 (void)
#else
#define SC_EXTERN_C_BEGIN void sc_extern_c_hack_3 (void)
#define SC_EXTERN_C_END void sc_extern_c_hack_4 (void)
#endif
/* this libsc header is always included */
#include <sc_mpi.h>
SC_EXTERN_C_BEGIN;
/* extern variables */
extern const int sc_log2_lookup_table[256];
extern int sc_package_id;
/* control a trace file by environment variables (see sc_init) */
extern FILE *sc_trace_file;
extern int sc_trace_prio;
/* define math constants if necessary */
#ifndef M_E
#define M_E 2.7182818284590452354 /* e */
#endif
#ifndef M_LOG2E
#define M_LOG2E 1.4426950408889634074 /* log_2 e */
#endif
#ifndef M_LOG10E
#define M_LOG10E 0.43429448190325182765 /* log_10 e */
#endif
#ifndef M_LN2
#define M_LN2 0.69314718055994530942 /* log_e 2 */
#endif
#ifndef M_LN10
#define M_LN10 2.30258509299404568402 /* log_e 10 */
#endif
#ifndef M_PI
#define M_PI 3.14159265358979323846 /* pi */
#endif
#ifndef M_PI_2
#define M_PI_2 1.57079632679489661923 /* pi/2 */
#endif
#ifndef M_PI_4
#define M_PI_4 0.78539816339744830962 /* pi/4 */
#endif
#ifndef M_1_PI
#define M_1_PI 0.31830988618379067154 /* 1/pi */
#endif
#ifndef M_2_PI
#define M_2_PI 0.63661977236758134308 /* 2/pi */
#endif
#ifndef M_2_SQRTPI
#define M_2_SQRTPI 1.12837916709551257390 /* 2/sqrt(pi) */
#endif
#ifndef M_SQRT2
#define M_SQRT2 1.41421356237309504880 /* sqrt(2) */
#endif
#ifndef M_SQRT1_2
#define M_SQRT1_2 0.70710678118654752440 /* 1/sqrt(2) */
#endif
#define SC_EPS 2.220446049250313e-16
#define SC_1000_EPS (1000. * 2.220446049250313e-16)
#if 0
/*@ignore@*/
#define index DONT_USE_NAME_CONFLICT_1 ---
#define rindex DONT_USE_NAME_CONFLICT_2 ---
#define link DONT_USE_NAME_CONFLICT_3 ---
#define NO_DEFINE_DONT_USE_CONFLICT SPLINT_IS_STUPID_ALSO
/*@end@*/
#endif /* 0 */
/* check macros, always enabled */
#define SC_NOOP() ((void) (0))
#define SC_ABORT(s) \
sc_abort_verbose (__FILE__, __LINE__, (s))
#define SC_ABORT_NOT_REACHED() SC_ABORT ("Unreachable code")
#define SC_CHECK_ABORT(q,s) \
((q) ? (void) 0 : SC_ABORT (s))
#define SC_CHECK_MPI(r) SC_CHECK_ABORT ((r) == sc_MPI_SUCCESS, "MPI error")
#define SC_CHECK_ZLIB(r) SC_CHECK_ABORT ((r) == Z_OK, "zlib error")
/*
* C++98 does not allow variadic macros
* 1. Declare a default variadic function for C and C++
* 2. Use macros in C instead of the function
* This loses __FILE__ and __LINE__ in the C++ ..F log functions
*/
void SC_ABORTF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)))
__attribute__ ((noreturn));
void SC_CHECK_ABORTF (int success, const char *fmt, ...)
__attribute__ ((format (printf, 2, 3)));
#ifndef __cplusplus
#define SC_ABORTF(fmt,...) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), __VA_ARGS__)
#define SC_CHECK_ABORTF(q,fmt,...) \
((q) ? (void) 0 : SC_ABORTF (fmt, __VA_ARGS__))
#endif
#define SC_ABORT1(fmt,a) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a))
#define SC_ABORT2(fmt,a,b) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a), (b))
#define SC_ABORT3(fmt,a,b,c) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a), (b), (c))
#define SC_ABORT4(fmt,a,b,c,d) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a), (b), (c), (d))
#define SC_ABORT5(fmt,a,b,c,d,e) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a), (b), (c), (d), (e))
#define SC_ABORT6(fmt,a,b,c,d,e,f) \
sc_abort_verbosef (__FILE__, __LINE__, (fmt), (a), (b), (c), (d), (e), (f))
#define SC_CHECK_ABORT1(q,fmt,a) \
((q) ? (void) 0 : SC_ABORT1 ((fmt), (a)))
#define SC_CHECK_ABORT2(q,fmt,a,b) \
((q) ? (void) 0 : SC_ABORT2 ((fmt), (a), (b)))
#define SC_CHECK_ABORT3(q,fmt,a,b,c) \
((q) ? (void) 0 : SC_ABORT3 ((fmt), (a), (b), (c)))
#define SC_CHECK_ABORT4(q,fmt,a,b,c,d) \
((q) ? (void) 0 : SC_ABORT4 ((fmt), (a), (b), (c), (d)))
#define SC_CHECK_ABORT5(q,fmt,a,b,c,d,e) \
((q) ? (void) 0 : SC_ABORT5 ((fmt), (a), (b), (c), (d), (e)))
#define SC_CHECK_ABORT6(q,fmt,a,b,c,d,e,f) \
((q) ? (void) 0 : SC_ABORT6 ((fmt), (a), (b), (c), (d), (e), (f)))
/* assertions, only enabled in debug mode */
#ifdef SC_DEBUG
#define SC_ASSERT(c) SC_CHECK_ABORT ((c), "Assertion '" #c "'")
#define SC_EXECUTE_ASSERT_FALSE(expression) \
do { int _sc_i = (int) (expression); \
SC_CHECK_ABORT (!_sc_i, "Expected false: '" #expression "'"); \
} while (0)
#define SC_EXECUTE_ASSERT_TRUE(expression) \
do { int _sc_i = (int) (expression); \
SC_CHECK_ABORT (_sc_i, "Expected true: '" #expression "'"); \
} while (0)
#else
#define SC_ASSERT(c) SC_NOOP ()
#define SC_EXECUTE_ASSERT_FALSE(expression) \
do { (void) (expression); } while (0)
#define SC_EXECUTE_ASSERT_TRUE(expression) \
do { (void) (expression); } while (0)
#endif
/* macros for memory allocation, will abort if out of memory */
#define SC_ALLOC(t,n) (t *) sc_malloc (sc_package_id, (n) * sizeof(t))
#define SC_ALLOC_ZERO(t,n) (t *) sc_calloc (sc_package_id, \
(size_t) (n), sizeof(t))
#define SC_REALLOC(p,t,n) (t *) sc_realloc (sc_package_id, \
(p), (n) * sizeof(t))
#define SC_STRDUP(s) sc_strdup (sc_package_id, (s))
#define SC_FREE(p) sc_free (sc_package_id, (p))
/**
* Sets n elements of a memory range to zero.
* Assumes the pointer p is of the correct type.
*/
#define SC_BZERO(p,n) ((void) memset ((p), 0, (n) * sizeof (*(p))))
/* min, max and square helper macros */
#define SC_MIN(a,b) (((a) < (b)) ? (a) : (b))
#define SC_MAX(a,b) (((a) > (b)) ? (a) : (b))
#define SC_SQR(a) ((a) * (a))
/* hopefully fast binary logarithms and binary round up */
#define SC_LOG2_8(x) (sc_log2_lookup_table[(x)])
#define SC_LOG2_16(x) (((x) > 0xff) ? \
(SC_LOG2_8 ((x) >> 8) + 8) : SC_LOG2_8 (x))
#define SC_LOG2_32(x) (((x) > 0xffff) ? \
(SC_LOG2_16 ((x) >> 16)) + 16 : SC_LOG2_16 (x))
#define SC_LOG2_64(x) (((x) > 0xffffffffLL) ? \
(SC_LOG2_32 ((x) >> 32)) + 32 : SC_LOG2_32 (x))
#define SC_ROUNDUP2_32(x) \
(((x) <= 0) ? 0 : (1 << (SC_LOG2_32 ((x) - 1) + 1)))
#define SC_ROUNDUP2_64(x) \
(((x) <= 0) ? 0 : (1LL << (SC_LOG2_64 ((x) - 1LL) + 1)))
/* log categories */
#define SC_LC_GLOBAL 1 /**< log only for master process */
#define SC_LC_NORMAL 2 /**< log for every process */
/** \defgroup logpriorities log priorities
*
* Numbers designating the level of logging output.
*
* Priorities TRACE to VERBOSE are appropriate when all parallel processes
* contribute log messages. INFO and above must not clutter the output of
* large parallel runs. STATISTICS can be used for important measurements.
* PRODUCTION is meant for rudimentary information on the program flow.
* ESSENTIAL can be used for one-time messages, say at program startup.
*
* \ingroup sc
*/
/*@{ \ingroup logpriorities */
/* log priorities */
#define SC_LP_DEFAULT (-1) /**< this selects the SC default threshold */
#define SC_LP_ALWAYS 0 /**< this will log everything */
#define SC_LP_TRACE 1 /**< this will prefix file and line number */
#define SC_LP_DEBUG 2 /**< any information on the internal state */
#define SC_LP_VERBOSE 3 /**< information on conditions, decisions */
#define SC_LP_INFO 4 /**< the main things a function is doing */
#define SC_LP_STATISTICS 5 /**< important for consistency/performance */
#define SC_LP_PRODUCTION 6 /**< a few lines for a major api function */
#define SC_LP_ESSENTIAL 7 /**< this logs a few lines max per program */
#define SC_LP_ERROR 8 /**< this logs errors only */
#define SC_LP_SILENT 9 /**< this never logs anything */
/*@}*/
/** The log priority for the sc package.
*
*/
#ifdef SC_LOG_PRIORITY
#define SC_LP_THRESHOLD SC_LOG_PRIORITY
#else
#ifdef SC_DEBUG
#define SC_LP_THRESHOLD SC_LP_TRACE
#else
#define SC_LP_THRESHOLD SC_LP_INFO
#endif
#endif
/* generic log macros */
#define SC_GEN_LOG(package,category,priority,s) \
((priority) < SC_LP_THRESHOLD ? (void) 0 : \
sc_log (__FILE__, __LINE__, (package), (category), (priority), (s)))
#define SC_GLOBAL_LOG(p,s) SC_GEN_LOG (sc_package_id, SC_LC_GLOBAL, (p), (s))
#define SC_LOG(p,s) SC_GEN_LOG (sc_package_id, SC_LC_NORMAL, (p), (s))
void SC_GEN_LOGF (int package, int category, int priority,
const char *fmt, ...)
__attribute__ ((format (printf, 4, 5)));
void SC_GLOBAL_LOGF (int priority, const char *fmt, ...)
__attribute__ ((format (printf, 2, 3)));
void SC_LOGF (int priority, const char *fmt, ...)
__attribute__ ((format (printf, 2, 3)));
#ifndef __cplusplus
#define SC_GEN_LOGF(package,category,priority,fmt,...) \
((priority) < SC_LP_THRESHOLD ? (void) 0 : \
sc_logf (__FILE__, __LINE__, (package), (category), (priority), \
(fmt), __VA_ARGS__))
#define SC_GLOBAL_LOGF(p,fmt,...) \
SC_GEN_LOGF (sc_package_id, SC_LC_GLOBAL, (p), (fmt), __VA_ARGS__)
#define SC_LOGF(p,fmt,...) \
SC_GEN_LOGF (sc_package_id, SC_LC_NORMAL, (p), (fmt), __VA_ARGS__)
#endif
/* convenience global log macros will only output if identifier <= 0 */
#define SC_GLOBAL_TRACE(s) SC_GLOBAL_LOG (SC_LP_TRACE, (s))
#define SC_GLOBAL_LDEBUG(s) SC_GLOBAL_LOG (SC_LP_DEBUG, (s))
#define SC_GLOBAL_VERBOSE(s) SC_GLOBAL_LOG (SC_LP_VERBOSE, (s))
#define SC_GLOBAL_INFO(s) SC_GLOBAL_LOG (SC_LP_INFO, (s))
#define SC_GLOBAL_STATISTICS(s) SC_GLOBAL_LOG (SC_LP_STATISTICS, (s))
#define SC_GLOBAL_PRODUCTION(s) SC_GLOBAL_LOG (SC_LP_PRODUCTION, (s))
#define SC_GLOBAL_ESSENTIAL(s) SC_GLOBAL_LOG (SC_LP_ESSENTIAL, (s))
#define SC_GLOBAL_LERROR(s) SC_GLOBAL_LOG (SC_LP_ERROR, (s))
void SC_GLOBAL_TRACEF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_LDEBUGF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_VERBOSEF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_INFOF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_STATISTICSF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_PRODUCTIONF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_ESSENTIALF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_GLOBAL_LERRORF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
#ifndef __cplusplus
#define SC_GLOBAL_TRACEF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_TRACE, (fmt), __VA_ARGS__)
#define SC_GLOBAL_LDEBUGF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_DEBUG, (fmt), __VA_ARGS__)
#define SC_GLOBAL_VERBOSEF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_VERBOSE, (fmt), __VA_ARGS__)
#define SC_GLOBAL_INFOF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_INFO, (fmt), __VA_ARGS__)
#define SC_GLOBAL_STATISTICSF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_STATISTICS, (fmt), __VA_ARGS__)
#define SC_GLOBAL_PRODUCTIONF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_PRODUCTION, (fmt), __VA_ARGS__)
#define SC_GLOBAL_ESSENTIALF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_ESSENTIAL, (fmt), __VA_ARGS__)
#define SC_GLOBAL_LERRORF(fmt,...) \
SC_GLOBAL_LOGF (SC_LP_ERROR, (fmt), __VA_ARGS__)
#endif
/* convenience log macros that output regardless of identifier */
#define SC_TRACE(s) SC_LOG (SC_LP_TRACE, (s))
#define SC_LDEBUG(s) SC_LOG (SC_LP_DEBUG, (s))
#define SC_VERBOSE(s) SC_LOG (SC_LP_VERBOSE, (s))
#define SC_INFO(s) SC_LOG (SC_LP_INFO, (s))
#define SC_STATISTICS(s) SC_LOG (SC_LP_STATISTICS, (s))
#define SC_PRODUCTION(s) SC_LOG (SC_LP_PRODUCTION, (s))
#define SC_ESSENTIAL(s) SC_LOG (SC_LP_ESSENTIAL, (s))
#define SC_LERROR(s) SC_LOG (SC_LP_ERROR, (s))
void SC_TRACEF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_LDEBUGF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_VERBOSEF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_INFOF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_STATISTICSF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_PRODUCTIONF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_ESSENTIALF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
void SC_LERRORF (const char *fmt, ...)
__attribute__ ((format (printf, 1, 2)));
#ifndef __cplusplus
#define SC_TRACEF(fmt,...) \
SC_LOGF (SC_LP_TRACE, (fmt), __VA_ARGS__)
#define SC_LDEBUGF(fmt,...) \
SC_LOGF (SC_LP_DEBUG, (fmt), __VA_ARGS__)
#define SC_VERBOSEF(fmt,...) \
SC_LOGF (SC_LP_VERBOSE, (fmt), __VA_ARGS__)
#define SC_INFOF(fmt,...) \
SC_LOGF (SC_LP_INFO, (fmt), __VA_ARGS__)
#define SC_STATISTICSF(fmt,...) \
SC_LOGF (SC_LP_STATISTICS, (fmt), __VA_ARGS__)
#define SC_PRODUCTIONF(fmt,...) \
SC_LOGF (SC_LP_PRODUCTION, (fmt), __VA_ARGS__)
#define SC_ESSENTIALF(fmt,...) \
SC_LOGF (SC_LP_ESSENTIAL, (fmt), __VA_ARGS__)
#define SC_LERRORF(fmt,...) \
SC_LOGF (SC_LP_ERROR, (fmt), __VA_ARGS__)
#endif
/* callback typedefs */
typedef void (*sc_handler_t) (void *data);
typedef void (*sc_log_handler_t) (FILE * log_stream,
const char *filename, int lineno,
int package, int category,
int priority, const char *msg);
/* memory allocation functions, will abort if out of memory */
void *sc_malloc (int package, size_t size);
void *sc_calloc (int package, size_t nmemb, size_t size);
void *sc_realloc (int package, void *ptr, size_t size);
char *sc_strdup (int package, const char *s);
void sc_free (int package, void *ptr);
int sc_memory_status (int package);
void sc_memory_check (int package);
/* comparison functions for various integer sizes */
int sc_int_compare (const void *v1, const void *v2);
int sc_int8_compare (const void *v1, const void *v2);
int sc_int16_compare (const void *v1, const void *v2);
int sc_int32_compare (const void *v1, const void *v2);
int sc_int64_compare (const void *v1, const void *v2);
int sc_double_compare (const void *v1, const void *v2);
/** Controls the default SC log behavior.
* \param [in] log_stream Set stream to use by sc_logf (or NULL for stdout).
* \param [in] log_handler Set default SC log handler (NULL selects builtin).
* \param [in] log_threshold Set default SC log threshold (or SC_LP_DEFAULT).
* May be SC_LP_ALWAYS or SC_LP_SILENT.
*/
void sc_set_log_defaults (FILE * log_stream,
sc_log_handler_t log_handler,
int log_thresold);
/** The central log function to be called by all packages.
* Dispatches the log calls by package and filters by category and priority.
* \param [in] package Must be a registered package id or -1.
* \param [in] category Must be SC_LC_NORMAL or SC_LC_GLOBAL.
* \param [in] priority Must be > SC_LP_ALWAYS and < SC_LP_SILENT.
*/
void sc_log (const char *filename, int lineno,
int package, int category, int priority,
const char *msg);
void sc_logf (const char *filename, int lineno,
int package, int category, int priority,
const char *fmt, ...)
__attribute__ ((format (printf, 6, 7)));
void sc_logv (const char *filename, int lineno,
int package, int category, int priority,
const char *fmt, va_list ap);
/** Add spaces to the start of a package's default log format. */
void sc_log_indent_push_count (int package, int count);
/** Remove spaces from the start of a package's default log format. */
void sc_log_indent_pop_count (int package, int count);
/** Add one space to the start of sc's default log format. */
void sc_log_indent_push (void);
/** Remove one space from the start of a sc's default log format. */
void sc_log_indent_pop (void);
/** Print a stack trace, call the abort handler and then call abort (). */
void sc_abort (void)
__attribute__ ((noreturn));
/** Print a message to stderr and then call sc_abort (). */
void sc_abort_verbose (const char *filename, int lineno,
const char *msg)
__attribute__ ((noreturn));
/** Print a message to stderr and then call sc_abort (). */
void sc_abort_verbosef (const char *filename, int lineno,
const char *fmt, ...)
__attribute__ ((format (printf, 3, 4)))
__attribute__ ((noreturn));
/** Print a message to stderr and then call sc_abort (). */
void sc_abort_verbosev (const char *filename, int lineno,
const char *fmt, va_list ap)
__attribute__ ((noreturn));
/** Collective abort where only root prints a message */
void sc_abort_collective (const char *msg)
__attribute__ ((noreturn));
/** Register a software package with SC.
* This function must only be called before additional threads are created.
* The logging parameters are as in sc_set_log_defaults.
* \return Returns a unique package id.
*/
int sc_package_register (sc_log_handler_t log_handler,
int log_threshold,
const char *name, const char *full);
int sc_package_is_registered (int package_id);
/** Unregister a software package with SC.
* This function must only be called after additional threads are finished.
*/
void sc_package_unregister (int package_id);
/** Print a summary of all packages registered with SC.
* Uses the SC_LP_GLOBAL log category which by default only prints on rank 0.
* \param [in] log_priority Priority passed to sc log functions.
*/
void sc_package_print_summary (int log_priority);
/** Sets the global program identifier (e.g. the MPI rank) and some flags.
* This function is optional.
* This function must only be called before additional threads are created.
* If this function is not called or called with log_handler == NULL,
* the default SC log handler will be used.
* If this function is not called or called with log_threshold == SC_LP_DEFAULT,
* the default SC log threshold will be used.
* The default SC log settings can be changed with sc_set_log_defaults ().
* \param [in] mpicomm MPI communicator, can be sc_MPI_COMM_NULL.
* If sc_MPI_COMM_NULL, the identifier is set to -1.
* Otherwise, sc_MPI_Init must have been called.
* \param [in] catch_signals If true, signals INT SEGV USR2 are be caught.
* \param [in] print_backtrace If true, sc_abort prints a backtrace.
*/
void sc_init (sc_MPI_Comm mpicomm,
int catch_signals, int print_backtrace,
sc_log_handler_t log_handler, int log_threshold);
/** Unregisters all packages, runs the memory check, removes the
* signal handlers and resets sc_identifier and sc_root_*.
* This function is optional.
* This function does not require sc_init to be called first.
*/
void sc_finalize (void);
/** Identify the root process.
* Only meaningful between sc_init and sc_finalize and
* with a communicator that is not sc_MPI_COMM_NULL (otherwise always true).
*
* \return Return true for the root process and false otherwise.
*/
int sc_is_root (void);
SC_EXTERN_C_END;
#endif /* SC_H */
|