This file is indexed.

/usr/include/Yap/opt.macros.h is in yap 6.2.2-6build1.

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
/************************************************************************
**                                                                     **
**                   The YapTab/YapOr/OPTYap systems                   **
**                                                                     **
** YapTab extends the Yap Prolog engine to support sequential tabling  **
** YapOr extends the Yap Prolog engine to support or-parallelism       **
** OPTYap extends the Yap Prolog engine to support or-parallel tabling **
**                                                                     **
**                                                                     **
**      Yap Prolog was developed at University of Porto, Portugal      **
**                                                                     **
************************************************************************/

/************************************************************************
**                          Memory management                          **
************************************************************************/

extern int Yap_page_size;

#ifdef SHM_MEMORY_ALLOC_SCHEME
#include <sys/shm.h>
#define SHMMAX 0x2000000  /* 32 Mbytes: works fine with linux */
/* #define SHMMAX  0x400000 - 4 Mbytes: shmget limit for Mac (?) */
/* #define SHMMAX  0x800000 - 8 Mbytes: shmget limit for Solaris (?) */
#endif /* SHM_MEMORY_ALLOC_SCHEME */

#if SIZEOF_INT_P == 4
#define ALIGN	                   3
#define ALIGNMASK                  0xfffffffc
#elif SIZEOF_INT_P == 8
#define ALIGN	                   7
#define ALIGNMASK                  0xfffffff8
#else
#define ALIGN	                   OOOOPPS!!! Unknown Pointer Sizeof
#define ALIGNMASK                  OOOOPPS!!! Unknown Pointer Sizeof
#endif /* SIZEOF_INT_P */

#define ADJUST_SIZE(SIZE)          ((SIZE + ALIGN) & ALIGNMASK)
#define ADJUST_SIZE_TO_PAGE(SIZE)  ((SIZE) - (SIZE) % Yap_page_size + Yap_page_size)
#define STRUCT_SIZE(STR_TYPE)      ADJUST_SIZE(sizeof(STR_TYPE))
#define PAGE_HEADER(STR)           (pg_hd_ptr)((unsigned long int)STR - (unsigned long int)STR % Yap_page_size)
#define STRUCT_NEXT(STR)           ((STR)->next)

#define UPDATE_STATS(STAT, VALUE)  STAT += VALUE


#ifdef MALLOC_MEMORY_ALLOC_SCHEME
/*************************************************************************************************
**                                  MALLOC_MEMORY_ALLOC_SCHEME                                  **
*************************************************************************************************/
#define ALLOC_BLOCK(STR, SIZE, STR_TYPE)                                                         \
        if ((STR = (STR_TYPE *) malloc(SIZE)) == NULL)                                           \
          Yap_Error(FATAL_ERROR, TermNil, "ALLOC_BLOCK: malloc error")
#define FREE_BLOCK(STR)                                                                          \
        free(STR)
#else
/*************************************************************************************************
**                                 ! MALLOC_MEMORY_ALLOC_SCHEME                                 **
*************************************************************************************************/
#define ALLOC_BLOCK(STR, SIZE, STR_TYPE)                                                         \
        { char *block_ptr;                                                                       \
          if ((block_ptr = Yap_AllocCodeSpace(SIZE + sizeof(CELL))) != NULL)                     \
            *block_ptr = 'y';                                                                    \
          else if ((block_ptr = (char *) malloc(SIZE + sizeof(CELL))) != NULL)                   \
            *block_ptr = 'm';                                                                    \
          else                                                                                   \
            Yap_Error(FATAL_ERROR, TermNil, "ALLOC_BLOCK: malloc error");                        \
          block_ptr += sizeof(CELL);                                                             \
          STR = (STR_TYPE *) block_ptr;                                                          \
        }
#define FREE_BLOCK(STR)                                                                          \
        { char *block_ptr = (char *)(STR) - sizeof(CELL);                                        \
          if (block_ptr[0] == 'y')                                                               \
            Yap_FreeCodeSpace(block_ptr);                                                        \
          else                                                                                   \
            free(block_ptr);                                                                     \
        }
#endif /*****************************************************************************************/


#if defined(MALLOC_MEMORY_ALLOC_SCHEME) || defined(YAP_MEMORY_ALLOC_SCHEME)
/*************************************************************************************************
**                    MALLOC_MEMORY_ALLOC_SCHEME || YAP_MEMORY_ALLOC_SCHEME                     **
*************************************************************************************************/
#define ALLOC_STRUCT(STR, STR_PAGES, STR_TYPE)                                                   \
        UPDATE_STATS(Pg_str_in_use(STR_PAGES), 1);                                               \
        ALLOC_BLOCK(STR, sizeof(STR_TYPE), STR_TYPE)
#define ALLOC_NEXT_FREE_STRUCT(STR, STR_PAGES, STR_TYPE)                                         \
        ALLOC_STRUCT(STR, STR_PAGES, STR_TYPE)
#define FREE_STRUCT(STR, STR_PAGES, STR_TYPE)                                                    \
        UPDATE_STATS(Pg_str_in_use(STR_PAGES), -1);                                              \
        FREE_BLOCK(STR)
#elif SHM_MEMORY_ALLOC_SCHEME
#ifdef LIMIT_TABLING
/*************************************************************************************************
**                          SHM_MEMORY_ALLOC_SCHEME && LIMIT_TABLING                            **
*************************************************************************************************/
#define INIT_PAGE(PG_HD, STR_PAGES, STR_TYPE)                                                    \
        { int i;                                                                                 \
          STR_TYPE *aux_str;                                                                     \
          PgHd_str_in_use(PG_HD) = 0;                                                            \
          PgHd_previous(PG_HD) = NULL;                                                           \
          aux_str = (STR_TYPE *) (PG_HD + 1);                                                    \
          PgHd_free_str(PG_HD) = (void *) aux_str;                                               \
          for (i = 1; i < Pg_str_per_pg(STR_PAGES); i++) {                                       \
            STRUCT_NEXT(aux_str) = aux_str + 1;                                                  \
            aux_str++;                                                                           \
          }                                                                                      \
          STRUCT_NEXT(aux_str) = NULL;                                                           \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          if ((PgHd_next(PG_HD) = Pg_free_pg(STR_PAGES)) != NULL)                                \
            PgHd_previous(PgHd_next(PG_HD)) = PG_HD;                                             \
          Pg_free_pg(STR_PAGES) = PG_HD;                                                         \
          UPDATE_STATS(Pg_pg_alloc(STR_PAGES), 1);                                               \
        }

#define ALLOC_PAGE(PG_HD)                                                                        \
        { int i, shmid;                                                                          \
          pg_hd_ptr aux_pg_hd;                                                                   \
          if ((shmid = shmget(IPC_PRIVATE, SHMMAX, SHM_R|SHM_W)) == -1)                          \
            Yap_Error(FATAL_ERROR, TermNil, "shmget error (ALLOC_PAGE)");                        \
          if ((PG_HD = (pg_hd_ptr) shmat(shmid, NULL, 0)) == (void *) -1)                        \
            Yap_Error(FATAL_ERROR, TermNil, "shmat error (ALLOC_PAGE)");                         \
          if (shmctl(shmid, IPC_RMID, 0) != 0)                                                   \
            Yap_Error(FATAL_ERROR, TermNil, "shmctl error (ALLOC_PAGE)");                        \
          aux_pg_hd = (pg_hd_ptr)(((void *)PG_HD) + Yap_page_size);                              \
          Pg_free_pg(GLOBAL_PAGES_void) = aux_pg_hd;                                             \
          for (i = 2; i < SHMMAX / Yap_page_size; i++) {                                         \
            PgHd_next(aux_pg_hd) = (pg_hd_ptr)(((void *)aux_pg_hd) + Yap_page_size);             \
            aux_pg_hd = PgHd_next(aux_pg_hd);                                                    \
          }                                                                                      \
          PgHd_next(aux_pg_hd) = NULL;                                                           \
          UPDATE_STATS(Pg_pg_alloc(GLOBAL_PAGES_void), SHMMAX / Yap_page_size);                  \
        }

#define RECOVER_UNUSED_SPACE(STR_PAGES)                                                          \
        { sg_fr_ptr sg_fr = GLOBAL_check_sg_fr;                                                  \
          do {                                                                                   \
            if (sg_fr)                                                                           \
              sg_fr = SgFr_next(sg_fr);                                                          \
            else                                                                                 \
              sg_fr = GLOBAL_first_sg_fr;                                                        \
            if (sg_fr == NULL)                                                                   \
              Yap_Error(FATAL_ERROR, TermNil, "no space left (RECOVER_UNUSED_SPACE)");           \
              /* see function 'InteractSIGINT' in file 'sysbits.c' */                            \
              /* Yap_Error(PURE_ABORT, TermNil, "");               */                            \
              /* restore_absmi_regs(&Yap_standard_regs);           */                            \
              /* siglongjmp (Yap_RestartEnv, 1);                   */                            \
            if (SgFr_first_answer(sg_fr) &&                                                      \
                SgFr_first_answer(sg_fr) != SgFr_answer_trie(sg_fr)) {                           \
              SgFr_state(sg_fr) = ready;                                                         \
	      free_answer_hash_chain(SgFr_hash_chain(sg_fr));                                    \
	      SgFr_hash_chain(sg_fr) = NULL;                                                     \
	      SgFr_first_answer(sg_fr) = NULL;                                                   \
              SgFr_last_answer(sg_fr) = NULL;                                                    \
              free_answer_trie(TrNode_child(SgFr_answer_trie(sg_fr)),                            \
                               TRAVERSE_MODE_NORMAL, TRAVERSE_POSITION_FIRST);                   \
              TrNode_child(SgFr_answer_trie(sg_fr)) = NULL;                                      \
	    }                                                                                    \
          } while (Pg_free_pg(GLOBAL_PAGES_void) == Pg_free_pg(STR_PAGES));                      \
          GLOBAL_check_sg_fr = sg_fr;                                                            \
        }

#define ALLOC_STRUCT(STR, STR_PAGES, STR_TYPE)                                                   \
        { pg_hd_ptr pg_hd;                                                                       \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          pg_hd = Pg_free_pg(STR_PAGES);                                                         \
          while (pg_hd == NULL) {                                                                \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
            LOCK(Pg_lock(GLOBAL_PAGES_void));                                                    \
            if (Pg_free_pg(GLOBAL_PAGES_void)) {                                                 \
              pg_hd = Pg_free_pg(GLOBAL_PAGES_void);                                             \
              Pg_free_pg(GLOBAL_PAGES_void) = PgHd_next(pg_hd);                                  \
              UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), 1);                                 \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              INIT_PAGE(pg_hd, STR_PAGES, STR_TYPE);                                             \
            } else if (GLOBAL_MAX_PAGES != Pg_pg_alloc(GLOBAL_PAGES_void)) {                     \
              ALLOC_PAGE(pg_hd);                                                                 \
              UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), 1);                                 \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              INIT_PAGE(pg_hd, STR_PAGES, STR_TYPE);                                             \
            } else {                                                                             \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              RECOVER_UNUSED_SPACE(STR_PAGES);                                                   \
              LOCK(Pg_lock(STR_PAGES));                                                          \
              pg_hd = Pg_free_pg(STR_PAGES);                                                     \
            }                                                                                    \
          }                                                                                      \
          PgHd_str_in_use(pg_hd)++;                                                              \
          STR = (STR_TYPE *) PgHd_free_str(pg_hd);                                               \
          if ((PgHd_free_str(pg_hd) = (void *) STRUCT_NEXT(STR)) == NULL)                        \
            if ((Pg_free_pg(STR_PAGES) = PgHd_next(pg_hd)) != NULL)                              \
              PgHd_previous(PgHd_next(pg_hd)) = NULL;                                            \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), 1);                                             \
          UNLOCK(Pg_lock(STR_PAGES));                                                            \
	}

#define ALLOC_NEXT_FREE_STRUCT(STR, STR_PAGES, STR_TYPE)                                         \
        if ((STR = LOCAL_next_free_ans_node) == NULL) {                                          \
          pg_hd_ptr pg_hd;                                                                       \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          pg_hd = Pg_free_pg(STR_PAGES);                                                         \
          while (pg_hd == NULL) {                                                                \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
            LOCK(Pg_lock(GLOBAL_PAGES_void));                                                    \
            if (Pg_free_pg(GLOBAL_PAGES_void)) {                                                 \
              pg_hd = Pg_free_pg(GLOBAL_PAGES_void);                                             \
              Pg_free_pg(GLOBAL_PAGES_void) = PgHd_next(pg_hd);                                  \
              UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), 1);                                 \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              INIT_PAGE(pg_hd, STR_PAGES, STR_TYPE);                                             \
            } else if (GLOBAL_MAX_PAGES != Pg_pg_alloc(GLOBAL_PAGES_void)) {                     \
              ALLOC_PAGE(pg_hd);                                                                 \
              UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), 1);                                 \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              INIT_PAGE(pg_hd, STR_PAGES, STR_TYPE);                                             \
            } else {                                                                             \
              UNLOCK(Pg_lock(GLOBAL_PAGES_void));                                                \
              RECOVER_UNUSED_SPACE(STR_PAGES);                                                   \
              LOCK(Pg_lock(STR_PAGES));                                                          \
              pg_hd = Pg_free_pg(STR_PAGES);                                                     \
            }                                                                                    \
          }                                                                                      \
          PgHd_str_in_use(pg_hd) = Pg_str_per_pg(STR_PAGES);                                     \
          STR = (STR_TYPE *) PgHd_free_str(pg_hd);                                               \
          PgHd_free_str(pg_hd) = NULL;                                                           \
          Pg_free_pg(STR_PAGES) = PgHd_next(pg_hd);                                              \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), -PgHd_str_in_use(pg_hd));                       \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), Pg_str_per_pg(STR_PAGES));                      \
          UNLOCK(Pg_lock(STR_PAGES));                                                            \
	}                                                                                        \
        LOCAL_next_free_ans_node = STRUCT_NEXT(STR)
#else
/*************************************************************************************************
**                          SHM_MEMORY_ALLOC_SCHEME && !LIMIT_TABLING                           **
*************************************************************************************************/
#define ALLOC_PAGE(PG_HD)                                                                        \
        LOCK(Pg_lock(GLOBAL_PAGES_void));                                                        \
        if (Pg_free_pg(GLOBAL_PAGES_void) == NULL) {                                             \
          int i, shmid;                                                                          \
          pg_hd_ptr pg_hd, aux_pg_hd;                                                            \
          if ((shmid = shmget(IPC_PRIVATE, SHMMAX, SHM_R|SHM_W)) == -1)                          \
            Yap_Error(FATAL_ERROR, TermNil, "shmget error (ALLOC_PAGE)");                        \
          if ((pg_hd = (pg_hd_ptr) shmat(shmid, NULL, 0)) == (void *) -1)                        \
            Yap_Error(FATAL_ERROR, TermNil, "shmat error (ALLOC_PAGE)");                         \
          if (shmctl(shmid, IPC_RMID, 0) != 0)                                                   \
            Yap_Error(FATAL_ERROR, TermNil, "shmctl error (ALLOC_PAGE)");                        \
          Pg_free_pg(GLOBAL_PAGES_void) = pg_hd;                                                 \
          for (i = 1; i < SHMMAX / Yap_page_size; i++) {                                         \
            aux_pg_hd = (pg_hd_ptr)(((void *)pg_hd) + Yap_page_size);                            \
            PgHd_next(pg_hd) = aux_pg_hd;                                                        \
            pg_hd = aux_pg_hd;                                                                   \
          }                                                                                      \
          PgHd_next(pg_hd) = NULL;                                                               \
          UPDATE_STATS(Pg_pg_alloc(GLOBAL_PAGES_void), SHMMAX / Yap_page_size);                  \
        }                                                                                        \
        UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), 1);                                       \
        PG_HD = Pg_free_pg(GLOBAL_PAGES_void);                                                   \
        Pg_free_pg(GLOBAL_PAGES_void) = PgHd_next(PG_HD);                                        \
        UNLOCK(Pg_lock(GLOBAL_PAGES_void))

#define ALLOC_STRUCT(STR, STR_PAGES, STR_TYPE)                                                   \
        { pg_hd_ptr pg_hd;                                                                       \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), 1);                                             \
          if (Pg_free_pg(STR_PAGES)) {                                                           \
            pg_hd = Pg_free_pg(STR_PAGES);                                                       \
            PgHd_str_in_use(pg_hd)++;                                                            \
            STR = (STR_TYPE *) PgHd_free_str(pg_hd);                                             \
            if ((PgHd_free_str(pg_hd) = (void *) STRUCT_NEXT(STR)) == NULL)                      \
              if ((Pg_free_pg(STR_PAGES) = PgHd_next(pg_hd)) != NULL)                            \
                PgHd_previous(PgHd_next(pg_hd)) = NULL;                                          \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
          } else {                                                                               \
            int i;                                                                               \
            UPDATE_STATS(Pg_pg_alloc(STR_PAGES), 1);                                             \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
            ALLOC_PAGE(pg_hd);                                                                   \
            PgHd_str_in_use(pg_hd) = 1;                                                          \
            PgHd_previous(pg_hd) = NULL;                                                         \
            STR = (STR_TYPE *) (pg_hd + 1);                                                      \
            PgHd_free_str(pg_hd) = (void *) ++STR;                                               \
            for (i = Pg_str_per_pg(STR_PAGES); i != 2; i--) {                                    \
              STRUCT_NEXT(STR) = STR + 1;                                                        \
              STR++;                                                                             \
            }                                                                                    \
            STRUCT_NEXT(STR) = NULL;                                                             \
            STR = (STR_TYPE *) (pg_hd + 1);                                                      \
            LOCK(Pg_lock(STR_PAGES));                                                            \
            if ((PgHd_next(pg_hd) = Pg_free_pg(STR_PAGES)) != NULL)                              \
              PgHd_previous(PgHd_next(pg_hd)) = pg_hd;                                           \
            Pg_free_pg(STR_PAGES) = pg_hd;                                                       \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
          }                                                                                      \
	}

#define ALLOC_NEXT_FREE_STRUCT(STR, STR_PAGES, STR_TYPE)                                         \
        if ((STR = LOCAL_next_free_ans_node) == NULL) {                                          \
          pg_hd_ptr pg_hd;                                                                       \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), Pg_str_per_pg(STR_PAGES));                      \
          if (Pg_free_pg(STR_PAGES)) {                                                           \
            pg_hd = Pg_free_pg(STR_PAGES);                                                       \
            UPDATE_STATS(Pg_str_in_use(STR_PAGES), -PgHd_str_in_use(pg_hd));                     \
            PgHd_str_in_use(pg_hd) = Pg_str_per_pg(STR_PAGES);                                   \
            STR = (STR_TYPE *) PgHd_free_str(pg_hd);                                             \
            PgHd_free_str(pg_hd) = NULL;                                                         \
            Pg_free_pg(STR_PAGES) = PgHd_next(pg_hd);                                            \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
          } else {                                                                               \
            int i;                                                                               \
            UPDATE_STATS(Pg_pg_alloc(STR_PAGES), 1);                                             \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
            ALLOC_PAGE(pg_hd);                                                                   \
            PgHd_str_in_use(pg_hd) = Pg_str_per_pg(STR_PAGES);                                   \
            PgHd_free_str(pg_hd) = NULL;                                                         \
            PgHd_previous(pg_hd) = NULL;                                                         \
            PgHd_next(pg_hd) = NULL;                                                             \
            STR = (STR_TYPE *) (pg_hd + 1);                                                      \
            for (i = Pg_str_per_pg(STR_PAGES); i != 1; i--) {                                    \
              STRUCT_NEXT(STR) = STR + 1;                                                        \
              STR++;                                                                             \
            }                                                                                    \
            STRUCT_NEXT(STR) = NULL;                                                             \
            STR = (STR_TYPE *) (pg_hd + 1);                                                      \
          }                                                                                      \
	}                                                                                        \
        LOCAL_next_free_ans_node = STRUCT_NEXT(STR)
#endif /* LIMIT_TABLING */
/*************************************************************************************************
**                                   SHM_MEMORY_ALLOC_SCHEME                                    **
*************************************************************************************************/
#define FREE_PAGE(PG_HD)                                                                         \
        LOCK(Pg_lock(GLOBAL_PAGES_void));                                                        \
        UPDATE_STATS(Pg_str_in_use(GLOBAL_PAGES_void), -1);                                      \
        PgHd_next(PG_HD) = Pg_free_pg(GLOBAL_PAGES_void);                                        \
        Pg_free_pg(GLOBAL_PAGES_void) = PG_HD;                                                   \
        UNLOCK(Pg_lock(GLOBAL_PAGES_void))

#define FREE_STRUCT(STR, STR_PAGES, STR_TYPE)                                                    \
        { pg_hd_ptr pg_hd;                                                                       \
          pg_hd = PAGE_HEADER(STR);                                                              \
          LOCK(Pg_lock(STR_PAGES));                                                              \
          UPDATE_STATS(Pg_str_in_use(STR_PAGES), -1);                                            \
          if (--PgHd_str_in_use(pg_hd) == 0) {                                                   \
            UPDATE_STATS(Pg_pg_alloc(STR_PAGES), -1);                                            \
            if (PgHd_previous(pg_hd)) {                                                          \
              if ((PgHd_next(PgHd_previous(pg_hd)) = PgHd_next(pg_hd)) != NULL)                  \
                PgHd_previous(PgHd_next(pg_hd)) = PgHd_previous(pg_hd);                          \
	    } else {                                                                             \
              if ((Pg_free_pg(STR_PAGES) = PgHd_next(pg_hd)) != NULL)                            \
                PgHd_previous(PgHd_next(pg_hd)) = NULL;                                          \
	    }                                                                                    \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
            FREE_PAGE(pg_hd);                                                                    \
	  } else {                                                                               \
            if ((STRUCT_NEXT(STR) = (STR_TYPE *) PgHd_free_str(pg_hd)) == NULL) {                \
              PgHd_previous(pg_hd) = NULL;                                                       \
              if ((PgHd_next(pg_hd) = Pg_free_pg(STR_PAGES)) != NULL)                            \
                PgHd_previous(PgHd_next(pg_hd)) = pg_hd;                                         \
              Pg_free_pg(STR_PAGES) = pg_hd;                                                     \
            }                                                                                    \
            PgHd_free_str(pg_hd) = (void *) STR;                                                 \
            UNLOCK(Pg_lock(STR_PAGES));                                                          \
          }                                                                                      \
        }
#endif /*****************************************************************************************/

#define ALLOC_HASH_BUCKETS(BUCKET_PTR, NUM_BUCKETS)                                              \
        { int i; void **bucket_ptr;                                                              \
          ALLOC_BLOCK(bucket_ptr, NUM_BUCKETS * sizeof(void *), void *);	                 \
          BUCKET_PTR = (void *) bucket_ptr;                                                      \
          for (i = NUM_BUCKETS; i != 0; i--)                                                     \
            *bucket_ptr++ = NULL;                                                                \
        }
#define FREE_HASH_BUCKETS(BUCKET_PTR)  FREE_BLOCK(BUCKET_PTR)

#define ALLOC_OR_FRAME(STR)            ALLOC_STRUCT(STR, GLOBAL_PAGES_or_fr, struct or_frame)
#define FREE_OR_FRAME(STR)             FREE_STRUCT(STR, GLOBAL_PAGES_or_fr, struct or_frame)

#define ALLOC_QG_SOLUTION_FRAME(STR)   ALLOC_STRUCT(STR, GLOBAL_PAGES_qg_sol_fr, struct query_goal_solution_frame)
#define FREE_QG_SOLUTION_FRAME(STR)    FREE_STRUCT(STR, GLOBAL_PAGES_qg_sol_fr, struct query_goal_solution_frame)

#define ALLOC_QG_ANSWER_FRAME(STR)     ALLOC_STRUCT(STR, GLOBAL_PAGES_qg_ans_fr, struct query_goal_answer_frame)
#define FREE_QG_ANSWER_FRAME(STR)      FREE_STRUCT(STR, GLOBAL_PAGES_qg_ans_fr, struct query_goal_answer_frame)

#define ALLOC_TG_SOLUTION_FRAME(STR)   ALLOC_STRUCT(STR, GLOBAL_PAGES_tg_sol_fr, struct table_subgoal_solution_frame)
#define FREE_TG_SOLUTION_FRAME(STR)    FREE_STRUCT(STR, GLOBAL_PAGES_tg_sol_fr, struct table_subgoal_solution_frame)

#define ALLOC_TG_ANSWER_FRAME(STR)     ALLOC_STRUCT(STR, GLOBAL_PAGES_tg_ans_fr, struct table_subgoal_answer_frame)
#define FREE_TG_ANSWER_FRAME(STR)      FREE_STRUCT(STR, GLOBAL_PAGES_tg_ans_fr, struct table_subgoal_answer_frame)

#define ALLOC_TABLE_ENTRY(STR)         ALLOC_STRUCT(STR, GLOBAL_PAGES_tab_ent, struct table_entry)
#define FREE_TABLE_ENTRY(STR)          FREE_STRUCT(STR, GLOBAL_PAGES_tab_ent, struct table_entry)

#define ALLOC_SUBGOAL_FRAME(STR)       ALLOC_STRUCT(STR, GLOBAL_PAGES_sg_fr, struct subgoal_frame)
#define FREE_SUBGOAL_FRAME(STR)        FREE_STRUCT(STR, GLOBAL_PAGES_sg_fr, struct subgoal_frame)

#define ALLOC_DEPENDENCY_FRAME(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_dep_fr, struct dependency_frame)
#define FREE_DEPENDENCY_FRAME(STR)     FREE_STRUCT(STR, GLOBAL_PAGES_dep_fr, struct dependency_frame)

#define ALLOC_SUSPENSION_FRAME(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_susp_fr, struct suspension_frame)
#define FREE_SUSPENSION_FRAME(STR)     FREE_BLOCK(SuspFr_global_start(STR));                         \
                                       FREE_STRUCT(STR, GLOBAL_PAGES_susp_fr, struct suspension_frame)

#define ALLOC_GLOBAL_TRIE_NODE(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_gt_node, struct global_trie_node)
#define FREE_GLOBAL_TRIE_NODE(STR)     FREE_STRUCT(STR, GLOBAL_PAGES_gt_node, struct global_trie_node)

#define ALLOC_SUBGOAL_TRIE_NODE(STR)   ALLOC_STRUCT(STR, GLOBAL_PAGES_sg_node, struct subgoal_trie_node)
#define FREE_SUBGOAL_TRIE_NODE(STR)    FREE_STRUCT(STR, GLOBAL_PAGES_sg_node, struct subgoal_trie_node)

#ifdef YAPOR
#define ALLOC_ANSWER_TRIE_NODE(STR)    ALLOC_NEXT_FREE_STRUCT(STR, GLOBAL_PAGES_ans_node, struct answer_trie_node)
#else /* TABLING */
#define ALLOC_ANSWER_TRIE_NODE(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_ans_node, struct answer_trie_node)
#endif /* YAPOR - TABLING */
#define FREE_ANSWER_TRIE_NODE(STR)     FREE_STRUCT(STR, GLOBAL_PAGES_ans_node, struct answer_trie_node)

#define ALLOC_GLOBAL_TRIE_HASH(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_gt_hash, struct global_trie_hash)
#define FREE_GLOBAL_TRIE_HASH(STR)     FREE_STRUCT(STR, GLOBAL_PAGES_gt_hash, struct global_trie_hash)

#define ALLOC_SUBGOAL_TRIE_HASH(STR)   ALLOC_STRUCT(STR, GLOBAL_PAGES_sg_hash, struct subgoal_trie_hash)
#define FREE_SUBGOAL_TRIE_HASH(STR)    FREE_STRUCT(STR, GLOBAL_PAGES_sg_hash, struct subgoal_trie_hash)

#define ALLOC_ANSWER_TRIE_HASH(STR)    ALLOC_STRUCT(STR, GLOBAL_PAGES_ans_hash, struct answer_trie_hash)
#define FREE_ANSWER_TRIE_HASH(STR)     FREE_STRUCT(STR, GLOBAL_PAGES_ans_hash, struct answer_trie_hash)



/************************************************************************
**                         Bitmap manipulation                         **
************************************************************************/

#define BITMAP_empty(b)		       ((b) == 0)
#define BITMAP_member(b,n)	       (((b) & (1<<(n))) != 0)
#define BITMAP_alone(b,n)	       ((b) == (1<<(n)))
#define BITMAP_subset(b1,b2)	       (((b1) & (b2)) == b2)
#define BITMAP_same(b1,b2)             ((b1) == (b2))
#define BITMAP_clear(b)	               ((b) = 0)
#define BITMAP_and(b1,b2)              ((b1) &= (b2))
#define BITMAP_minus(b1,b2)            ((b1) &= ~(b2))
#define BITMAP_insert(b,n)	       ((b) |= (1<<(n)))
#define BITMAP_delete(b,n)	       ((b) &= (~(1<<(n))))
#define BITMAP_copy(b1,b2)	       ((b1) = (b2))
#define BITMAP_intersection(b1,b2,b3)  ((b1) = ((b2) & (b3)))
#define BITMAP_difference(b1,b2,b3)    ((b1) = ((b2) & (~(b3))))



/************************************************************************
**                            Debug macros                             **
************************************************************************/

#define INFORMATION_MESSAGE(MESSAGE,ARGS...)                            \
        fprintf(stderr, "[ " MESSAGE " ]\n", ##ARGS)

#ifdef YAPOR
#define ERROR_MESSAGE(MESSAGE)                                          \
        Yap_Error(INTERNAL_ERROR, TermNil, "W%d - " MESSAGE, worker_id)
#else
#define ERROR_MESSAGE(MESSAGE)                                          \
        Yap_Error(INTERNAL_ERROR, TermNil, MESSAGE)
#endif /* YAPOR */

#ifdef DEBUG_TABLING
#define TABLING_ERROR_CHECKING(PROCEDURE,TEST)                          \
        if (TEST) ERROR_MESSAGE(#PROCEDURE ": " #TEST)
#else
#define TABLING_ERROR_CHECKING(PROCEDURE,TEST)
#endif /* DEBUG_TABLING */

#ifdef DEBUG_YAPOR
#define YAPOR_ERROR_CHECKING(PROCEDURE,TEST)                            \
        if (TEST) ERROR_MESSAGE(#PROCEDURE ": " #TEST)
#else
#define YAPOR_ERROR_CHECKING(PROCEDURE,TEST)
#endif /* DEBUG_YAPOR */

#ifdef DEBUG_OPTYAP
#define OPTYAP_ERROR_CHECKING(PROCEDURE,TEST)                           \
        if (TEST) ERROR_MESSAGE(#PROCEDURE ": " #TEST)
#else
#define OPTYAP_ERROR_CHECKING(PROCEDURE,TEST)
#endif /* DEBUG_OPTYAP */