/usr/include/singular/singular/misc/auxiliary.h is in libsingular4-dev-common 4.0.3+ds-1.
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 | /*****************************************************************************\
* Computer Algebra System SINGULAR
\*****************************************************************************/
/** @file auxiliary.h
*
* All the auxiliary stuff.
*
* ABSTRACT: we shall put here everything that does not have its own place.
*
* @author Oleksandr Motsak
*
*
**/
/*****************************************************************************/
#ifndef MISC_AUXILIARY_H
#define MISC_AUXILIARY_H
/* please include libpolysconfig.h exclusively via <misc/auxiliary.h> and before any other header */
#include "libpolysconfig.h"
// ----------------- which parts/extensions of Singular to build
#ifndef HAVE_RINGS
#undef HAVE_RINGS
#endif
#ifndef HAVE_PLURAL
#undef HAVE_PLURAL
#endif
#ifndef HAVE_DL
#undef HAVE_DL
#endif
#ifndef HAVE_FACTORY
#undef HAVE_FACTORY
#endif
#ifndef HAVE_NTL
#undef HAVE_NTL
#endif
/* letterplace gb:*/
#ifndef HAVE_SHIFTBBA
#undef HAVE_SHIFTBBA
#endif
#ifndef HAVE_POLYEXTENSIONS
#undef HAVE_POLYEXTENSIONS
#endif
#ifndef DISABLE_GMP_CPP
#undef DISABLE_GMP_CPP
#endif
#ifndef SINGULAR
#undef SINGULAR
#endif
#ifndef NOSTREAMIO
#undef NOSTREAMIO
#endif
/* the following cunstruct is to make it painless to add -DHAVE_NUMSTATS to CPPFLAGS for configure */
#ifndef HAVE_NUMSTATS
/* #define HAVE_NUMSTATS */
#undef HAVE_NUMSTATS
#endif /* HAVE_NUMSTATS */
// ---------------- end of parts/extensions
// ---------------- Singular standard types etc.
/* SI_INTEGER_VARIANT: 1: from longrat.cc
* 2: GMP
* 3: rintegers.cc */
#define SI_INTEGER_VARIANT 2
/* SI_BIGINT_VARIANT: 1: from longrat.cc
* 2: given by SI_INTEGER_VARIANT */
#define SI_BIGINT_VARIANT 1
/* preparation for versio 4.1.0: */
#ifndef SINGULAR_4_1
/* #define SINGULAR_4_1 */
#undef SINGULAR_4_1
#endif /* SINGULAR_4_1 */
#ifndef SIZEOF_LONG
#include <misc/mylimits.h>
#ifndef LONG_BIT
#if ULONG_MAX == 0xffffffffUL
#define LONG_BIT 32
#elif ULONG_MAX == 0xffffffffffffffffULL
#define LONG_BIT 64
#else
#error "Unexpected max for unsigned long"
#endif
#endif
#define SIZEOF_LONG (LONG_BIT/CHAR_BIT)
// another option for SIZEOF_LONG: use omConfig included in <omalloc/omalloc.h>...
#endif
#include <sys/types.h>
#if SIZEOF_LONG == 4
typedef long long int64;
#elif SIZEOF_LONG == 8
typedef long int64;
#else
#error "Unexpected SIZEOF_LONG"
#endif
#ifndef CHAR_BIT
#define CHAR_BIT (8)
#endif /*ifndef CHAR_BIT*/
#ifndef BIT_SIZEOF_LONG
#define BIT_SIZEOF_LONG ((CHAR_BIT)*(SIZEOF_LONG))
#endif /*ifndef BIT_SIZEOF_LONG*/
#if (SIZEOF_LONG == 8)
typedef int BOOLEAN;
/* testet on x86_64, gcc 3.4.6: 2 % */
/* testet on IA64, gcc 3.4.6: 1 % */
#else
/* testet on athlon, gcc 2.95.4: 1 % */
typedef short BOOLEAN;
#endif
#ifndef FALSE
#define FALSE 0
#endif
#ifndef TRUE
#define TRUE 1
#endif
#ifndef NULL
#define NULL (0)
#endif
#ifndef NULLp
#define NULLp ((void*)NULL)
#endif
// #ifdef _TRY
#ifndef ABS
#define ABS(x) ((x)<0?(-(x)):(x))
#endif
// #endif
typedef void* ADDRESS;
#define loop for(;;)
#if defined(__cplusplus)
static inline int si_max(const int a, const int b) { return (a>b) ? a : b; }
static inline int si_min(const int a, const int b) { return (a<b) ? a : b; }
static inline long si_max(const long a, const long b) { return (a>b) ? a : b; }
static inline unsigned long si_max(const unsigned long a, const unsigned long b) { return (a>b) ? a : b; }
static inline long si_min(const long a, const long b) { return (a<b) ? a : b; }
static inline unsigned long si_min(const unsigned long a, const unsigned long b) { return (a<b) ? a : b; }
#else
#define si_max(A,B) ((A) > (B) ? (A) : (B))
#define si_min(A,B) ((A) < (B) ? (A) : (B))
#endif
// ---------------- end of Singular standard types etc.
// ---------------- defines which depend on the settings above
#ifndef HAVE_MULT_MOD
#undef HAVE_MULT_MOD
#endif
#ifndef HAVE_DIV_MOD
#undef HAVE_DIV_MOD
#endif
#ifndef HAVE_GENERIC_ADD
#undef HAVE_GENERIC_ADD
#endif
/*******************************************************************
* DEBUG OPTIONS
* -- only significant for for compiling without -DSING_NDEBUG
* -- you better know what your are doing, if you touch this
******************************************************************/
#ifndef SING_NDEBUG
/* undefine to enable inline */
#define NO_INLINE
/* undefine to disable assume -- should normally be defined for SING_NDEBUG */
#define HAVE_ASSUME
/* undef PDEBUG to disable checks of polys
define PDEBUG to
0 for enabling pTest
1 plus tests in Level 1 poly routines (operations on monomials)
2 plus tests in Level 2 poly routines (operations on single exponents)
-- see also polys.h for more info
NOTE: you can set the value of PDEBUG on a per-file basis, before
including mod2.h, provided ! PDEBUG is defined in mod2.h E.g.:
#define PDEBUG 2
...
makes sure that all poly operations in your file are done with
PDEBUG == 2
To break after an error occurred, set a debugger breakpoint on
dErrorBreak.
*/
#ifndef PDEBUG
#define PDEBUG 0
#endif
/* define MDEBUG to enable memory checks */
//////////////////////////////////////////// #define MDEBUG 0
#ifdef MDEBUG
/* If ! defined(OM_NDEBUG) and (defined(OM_TRACK) or defined(OM_CHECK)
then omDebug routines are used for memory allocation/free:
The omDebug routines are controlled by the values of OM_TRACK, OM_CHECK
and OM_KEEP. There meaning is roughly as follows:
OM_TRACK: strored with address : extra space
0 : no additional info is stored : 0
1 : file:line of location where address was allocated : 1 word
2 : plus backtrace of stack where adress was allocated: 6 words
3 : plus size/bin info and front-, and back padding : 9 words
4 : plus file:line of location where adress was freed : 10 words
5 : plus backtrace of stack where adress was allocated: 15 words
OM_CHECK: checks done
0 : no checks
1 : constant-time checks: i.e. addr checks only
2 : plus linear-time checks and constant related bin check
3 : plus quadratic-time checks and linear-time related bin checks and
constant time all memory checks
4 : and so on
==> for OM_CHECK >= 3 it gets rather slow
OM_KEEP: determines whether addresses are really freed (
0 : addresses are really freed
1 : addresses are only marked as free and not really freed.
OM_CHECK, OM_TRACK, and OM_KEEP can be set on a per-file basis
(as can OM_NDEBUG), e.g.:
#define OM_CHECK 3
#define OM_TRACK 5
#define OM_KEEP 1
#include <omalloc/omalloc.h>
ensures that all memory allocs/free in this file are done with
OM_CHECK==3 and OM_TRACK==5, and that all addresses allocated/freed
in this file are only marked as free and never really freed.
To set OM_CHECK, OM_TRACK and OM_KEEP under dynamic scope, set
om_Opts.MinCheck, om_Opts.MinTrack to the respectiv values and
om_Opts.Keep to the number of addresses which are kept before they are
actually freed. E.g.:
int check=om_Opts.MinCheck, track=om_Opts.MinTrack, keep= m_OPts.Keep;
om_Opts.MinCheck = 3; om_Opts.MinTrack = 5; omOpts.Keep = LONG_MAX;
ExternalRoutine();
om_Opts.MinCheck = check; omOpts.MinTrack = track; omOpts.Keep = keep;
ensures that all calls omDebug routines occuring during the computation of
ExternalRoutine() are done with OM_CHECK==3 and OM_TRACK==5, and
calls to omFree only mark addresses as free and not really free them.
Furthermore, the value of OM_SING_KEEP (resp. om_Opts.Keep) specifies
how many addresses are kept before they are actually freed, independently
of the value of OM_KEEP.
Some tips on possible values of OM_TRACK, OM_CHECK, OM_KEEP:
+ To find out about an address that has been freed twice, first locate the
file(s) where the error occurred, and then at the beginning of these files:
#define OM_CHECK 3
#define OM_TRACK 5
#define OM_KEEP 1
#include <kernel/mod2.h>
#include <omalloc/omalloc.h>
Under dynamic scope, do (e.g., from within the debugger):
om_Opts.MinCheck = 3; om_Opts.MinTrack = 5; omOpts.Keep = LONG_MAX;
+ to find out where "memory corruption" occurred, increase value of
OM_CHECK - the higher this value is, the more consistency checks are
done (However a value > 3 checks the entire memory each time an omalloc
routine is used!)
Some more tips on the usage of omalloc:
+ omAlloc*, omRealloc*, omFree*, omCheck* omDebug* omTest* rotuines
assume that sizes are > 0 and pointers are != NULL
+ omalloc*, omrealloc*, omfree* omcheck*, omdebug* omtest* routines allow
NULL pointers and sizes == 0
+ You can safely use any free/realloc routine in combination with any alloc
routine (including the debug versions): E.g., an address allocated with
omAllocBin can be freed with omfree, or an adress allocated with
om(Debug)Alloc can be freed with omfree, or omFree, or omFreeSize, etc.
However, keep in mind that the efficiency decreases from
Bin over Size to General routines (i.e., omFreeBin is more efficient than
omFreeSize which is more efficient than omFree, likewise with the alloc
routines).
+ if OM_CHECK is undefined or 0, then all omCheck routines do nothing
+ if OM_CHECK and OM_TRACK are both undefined (or 0), or if OM_NDEBUG is
defined, then the "real" alloc/realloc/free macros are used, and all
omTest, omDebug and omCheck routines are undefined
+ to break after an omError occurred within a debugger,
set a breakpoint on dErrorBreak
+ to do checks from within the debugger, or to do checks with explicit
check level, use omTest routines.
*/
/* by default, store alloc info and file/line where addr was freed */
#ifndef OM_TRACK
#define OM_TRACK 4
#endif
/* only do constant-time memory checks */
#ifndef OM_CHECK
#define OM_CHECK 1
#endif
/* Do actually free memory:
(be careful: if this is set, memory is never really freed,
but only marked as free) */
#ifndef OM_KEEP
#define OM_KEEP 0
#endif
/* but only after you have freed 1000 more addresses
(this is actually independent of the value of OM_KEEP and used
to initialize om_Opts.Keep) */
#ifndef OM_SING_KEEP
#define OM_SING_KEEP 1000
#endif
#endif /* MDEBUG */
/* undef KDEBUG for check of data during std computations
*
* define KDEBUG to
* 0 for basic tests
* 1 for tests in kSpoly
* NOTE: You can locally enable tests in kspoly by setting the
* define at the beginning of kspoly.cc
*/
#define KDEBUG 0
/* define LDEBUG checking numbers, undefine otherwise */
#define LDEBUG
/* define RDEBUG checking rings (together with TRACE=9) */
#define RDEBUG
/* define TEST for non time critical tests, undefine otherwise */
#define TEST
/* define YYDEBUG 1 for debugging bison texts, 0 otherwise */
#define YYDEBUG 1
#endif
/* end of debugging option (ifndef SING_NDEBUG) */
#ifdef _DEBUG
# define FORCE_INLINE inline
#else
#ifdef SING_NDEBUG
#if defined(_MSC_VER)
# define FORCE_INLINE __forceinline
#elif defined(__GNUC__) && __GNUC__ > 3
# define FORCE_INLINE inline __attribute__ ((always_inline))
#else
# define FORCE_INLINE inline
#endif
#else
# define FORCE_INLINE inline
#endif
/* SING_NDEBUG */
#endif
/* _DEBUG */
#define DO_PRAGMA(x) _Pragma (#x)
#define TODO(who, msg) DO_PRAGMA(message ("TODO [for " #who "]: " #msg))
#if defined(__GNUC__) && defined(__GNUC_MINOR__)
#define _GNUC_PREREQ(maj, min) ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
#else
#define _GNUC_PREREQ(maj, min) 0
#endif
#if _GNUC_PREREQ(3,3) && defined(__ELF__)
#define FORCE_INTERNAL __attribute__ ((visibility ("internal")))
#else
#define FORCE_INTERNAL
#endif
#if _GNUC_PREREQ(3,3)
#define FORCE_DEPRECATED __attribute__ ((deprecated))
#else
#define FORCE_DEPRECATED
#endif
#ifdef __cplusplus
# define BEGIN_CDECL extern "C" {
# define END_CDECL }
#else
# define BEGIN_CDECL
# define END_CDECL
#endif
#ifdef __cplusplus
// hack to workaround warnings when casting void pointers
// retrieved from dlsym? to function pointers.
// see: http://trac.osgeo.org/qgis/ticket/234, http://www.trilithium.com/johan/2004/12/problem-with-dlsym/
template<typename A, typename B>
inline B cast_A_to_B( A a )
{
union
{
A a;
B b;
} u;
u.a = a;
return u.b;
}
template<typename A>
inline void* cast_A_to_vptr( A a )
{
return cast_A_to_B<A, void*>(a);
}
template<typename A>
inline A cast_vptr_to_A( void * p )
{
return cast_A_to_B<void*, A>(p);
}
#endif
#endif
/* MISC_AUXILIARY_H */
|