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
  
/* -*- c -*- 
|| This file is part of Pike. For copyright information see COPYRIGHT. 
|| Pike is distributed under GPL, LGPL and MPL. See the file COPYING 
|| for more information. 
*/ 
 
#include "global.h" 
#include "module.h" 
#include "pike_error.h" 
#include "interpret.h" 
#include "pike_embed.h" 
#include "module_support.h" 
#include "builtin_functions.h" 
#include "mapping.h" 
#include "multiset.h" 
#include "gc.h" 
 
DECLARATIONS 
 
/*! @module Debug 
 */ 
 
/*! @decl int(0..) map_all_objects(function(object:void) cb) 
 *! 
 *! Call cb for all objects that currently exist. The callback will 
 *! not be called with destructed objects as it's argument. 
 *! 
 *! Objects might be missed if @[cb] creates new objects or destroys 
 *! old ones. 
 *! 
 *! This function is only intended to be used for debug purposes. 
 *! 
 *! @returns 
 *!   The total number of objects 
 *! 
 *! @seealso 
 *!   @[next_object()] 
 */ 
PIKEFUN int(0..) map_all_objects(function(object:void) cb) 
{ 
    struct object *o = first_object; 
    INT32 total = 0; 
 
    while( o ) 
    { 
        struct object *next = o->next; 
        if( o->prog ) 
        { 
            ref_push_object( o ); 
            safe_apply_svalue( Pike_sp-2, 1, 1 ); 
            pop_stack(); 
        } 
        total++; 
        o = next; 
    } 
    RETURN total; 
} 
 
/*! @decl int refs(string|array|mapping|multiset|function|object|program o) 
 *! 
 *!   Return the number of references @[o] has. 
 *! 
 *!   It is mainly meant for debugging the Pike runtime, but can also be 
 *!   used to control memory usage. 
 *! 
 *! @note 
 *!   Note that the number of references will always be at least one since 
 *!   the value is located on the stack when this function is executed. 
 *! 
 *! @seealso 
 *!   @[next()], @[prev()] 
 */ 
PIKEFUN int refs(string|array|mapping|multiset|function|object|program o) 
{ 
  RETURN o->u.refs[0]; 
} 
 
/*! @decl object next_object(object o) 
 *! @decl object next_object() 
 *! 
 *!   Returns the next object from the list of all objects. 
 *! 
 *!   All objects are stored in a linked list. 
 *! 
 *! @returns 
 *!   If no arguments have been given @[next_object()] will return the first 
 *!   object from the list. 
 *! 
 *!   If @[o] has been specified the object after @[o] on the list will be 
 *!   returned. 
 *! 
 *! @note 
 *!   This function is not recomended to use. 
 *! 
 *! @seealso 
 *!   @[destruct()] 
 */ 
PIKEFUN object next_object(void|object o) 
{ 
  if (!o) 
    o = first_object; 
  else 
    o = Pike_sp[-args].u.object->next; 
 
  while(o && !o->prog) o=o->next; 
 
  pop_n_elems(args); 
  if(o) 
    ref_push_object(o); 
  else 
    push_int(0); 
} 
 
/*! @decl mixed next(mixed x) 
 *! 
 *!   Find the next object/array/mapping/multiset/program or string. 
 *! 
 *!   All objects, arrays, mappings, multisets, programs and strings are 
 *!   stored in linked lists inside Pike. This function returns the next 
 *!   item on the corresponding list. It is mainly meant for debugging 
 *!   the Pike runtime, but can also be used to control memory usage. 
 *! 
 *! @seealso 
 *!   @[next_object()], @[prev()] 
 */ 
PIKEFUN mixed next(mixed x) 
rawtype tOr6(tFunc(tStr,tStr), 
             tFunc(tObj,tObj), 
             tFunc(tMapping,tMapping), 
             tFunc(tMultiset,tMultiset), 
             tFunc(tPrg(tObj),tPrg(tObj)), 
             tFunc(tArray,tArray)); 
{ 
  struct svalue tmp = *x; 
  switch(TYPEOF(tmp)) 
  { 
  case T_OBJECT: 
    tmp.u.object=tmp.u.object->next; 
    while(tmp.u.object && !tmp.u.object->prog) 
      tmp.u.object=tmp.u.object->next; 
    break; 
  case T_ARRAY:   tmp.u.array=tmp.u.array->next; break; 
  case T_MAPPING: tmp.u.mapping=tmp.u.mapping->next; break; 
  case T_MULTISET:tmp.u.multiset=tmp.u.multiset->next; break; 
  case T_PROGRAM: tmp.u.program=tmp.u.program->next; break; 
  case T_STRING:  tmp.u.string=next_pike_string(tmp.u.string); break; 
  default: 
    SIMPLE_BAD_ARG_ERROR("next", 1, 
                         "object|array|mapping|multiset|program|string"); 
  } 
 
  if(tmp.u.refs) 
    assign_svalue(Pike_sp-1, &tmp); 
  else 
  { 
    pop_stack(); 
    push_int(0); 
  } 
} 
 
/*! @decl mixed prev(mixed x) 
 *! 
 *!   Find the previous object/array/mapping/multiset or program. 
 *! 
 *!   All objects, arrays, mappings, multisets and programs are 
 *!   stored in linked lists inside Pike. This function returns the previous 
 *!   item on the corresponding list. It is mainly meant for debugging 
 *!   the Pike runtime, but can also be used to control memory usage. 
 *! 
 *! @note 
 *!   Unlike @[next()] this function does not work on strings. 
 *! 
 *! @seealso 
 *!   @[next_object()], @[next()] 
 */ 
PIKEFUN mixed prev(mixed x) 
rawtype tOr5(tFunc(tObj,tObj), 
             tFunc(tMapping,tMapping), 
             tFunc(tMultiset,tMultiset), 
             tFunc(tPrg(tObj),tPrg(tObj)), 
             tFunc(tArray,tArray)); 
{ 
  struct svalue tmp = *x; 
  switch(TYPEOF(tmp)) 
  { 
  case T_OBJECT: 
    tmp.u.object=tmp.u.object->prev; 
    while(tmp.u.object && !tmp.u.object->prog) 
      tmp.u.object=tmp.u.object->prev; 
    break; 
  case T_ARRAY:   tmp.u.array=tmp.u.array->prev; break; 
  case T_MAPPING: tmp.u.mapping=tmp.u.mapping->prev; break; 
  case T_MULTISET:tmp.u.multiset=tmp.u.multiset->prev; break; 
  case T_PROGRAM: tmp.u.program=tmp.u.program->prev; break; 
  default: 
    SIMPLE_BAD_ARG_ERROR("prev", 1, "object|array|mapping|multiset|program"); 
  } 
  if(tmp.u.refs) 
    assign_svalue(Pike_sp-1, &tmp); 
  else 
  { 
    pop_stack(); 
    push_int(0); 
  } 
} 
 
#ifdef PIKE_DEBUG 
/* This function is for debugging *ONLY* 
 * do not document please. /Hubbe 
 */ 
PIKEFUN int leak(array|mapping|multiset|object|function|program|string|type val) 
  export; 
{ 
  INT32 i; 
 
  if(!REFCOUNTED_TYPE(TYPEOF(*val))) 
    SIMPLE_BAD_ARG_ERROR("leak", 1, 
                         "array|mapping|multiset|object|" 
                         "function|program|string|type"); 
 
  add_ref(val->u.dummy); 
  i = val->u.refs[0]; 
  RETURN i; 
} 
 
/*! @decl int(0..) debug(int(0..) level) 
 *! 
 *!   Set the run-time debug level. 
 *! 
 *! @returns 
 *!   The old debug level will be returned. 
 *! 
 *! @note 
 *!   This function is only available if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN int(0..) debug(int(0..) d) 
  export; 
{ 
  pop_n_elems(args); 
  push_int(d_flag); 
  d_flag = d; 
} 
 
/*! @decl int(0..) optimizer_debug(int(0..) level) 
 *! 
 *!   Set the optimizer debug level. 
 *! 
 *! @returns 
 *!   The old optimizer debug level will be returned. 
 *! 
 *! @note 
 *!   This function is only available if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN int(0..) optimizer_debug(int(0..) l) 
  export; 
{ 
  pop_n_elems(args); 
  push_int(l_flag); 
  l_flag = l; 
} 
 
/*! @decl int(0..) assembler_debug(int(0..) level) 
 *! 
 *!   Set the assembler debug level. 
 *! 
 *! @returns 
 *!   The old assembler debug level will be returned. 
 *! 
 *! @note 
 *!   This function is only available if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN int(0..) assembler_debug(int(0..) l) 
  export; 
{ 
  pop_n_elems(args); 
  push_int(a_flag); 
  a_flag = l; 
} 
 
/*! @decl void dump_program_tables(program p, int(0..)|void indent) 
 *! 
 *! Dumps the internal tables for the program @[p] on stderr. 
 *! 
 *! @param p 
 *!   Program to dump. 
 *! 
 *! @param indent 
 *!   Number of spaces to indent the output. 
 */ 
PIKEFUN void dump_program_tables(program p, int(0..)|void indent) 
{ 
  dump_program_tables(p, indent?indent->u.integer:0); 
  pop_n_elems(args); 
} 
 
/*! @decl mixed locate_references(string|array|mapping| @ 
 *!                              multiset|function|object| @ 
 *!                              program|type o) 
 *! @belongs Debug 
 *! 
 *!   This function is mostly intended for debugging. It will search through 
 *!   all data structures in Pike looking for @[o] and print the 
 *!   locations on stderr. @[o] can be anything but @expr{int@} or 
 *!   @expr{float@}. 
 *! 
 *! @note 
 *!   This function only exists if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN mixed locate_references(mixed o) 
  rawtype tFunc(tSetvar(1,tMix),tVar(1)); 
{ 
  locate_references(o); 
} 
 
/*! @decl mixed describe(mixed x) 
 *! @belongs Debug 
 *! 
 *!   Prints out a description of the thing @[x] to standard error. 
 *!   The description contains various internal info associated with 
 *!   @[x]. 
 *! 
 *! @note 
 *!   This function only exists if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN mixed describe(mixed x) 
  rawtype tFunc(tSetvar(1,tMix),tVar(1)); 
{ 
  debug_describe_svalue(debug_malloc_pass(&Pike_sp[-1])); 
} 
 
#ifdef YYDEBUG 
 
/*! @decl int(0..) compiler_trace(int(0..) level) 
 *! 
 *!   Set the compiler trace level. 
 *! 
 *! @returns 
 *!   The old compiler trace level will be returned. 
 *! 
 *! @note 
 *!   This function is only available if the Pike runtime has been compiled 
 *!   with RTL debug. 
 */ 
PIKEFUN int(0..) compiler_trace(int(0..) yyd) 
  export; 
{ 
  extern int yydebug; 
  pop_n_elems(args); 
  push_int(yydebug); 
  yydebug = yyd; 
} 
 
#endif /* YYDEBUG */ 
 
#if defined(PIKE_PORTABLE_BYTECODE) 
 
/*! @decl void disassemble(function fun) 
 *! 
 *!   Disassemble a Pike function to @[Stdio.stderr]. 
 *! 
 *! @note 
 *!   This function is only available if the Pike runtime 
 *!   has been compiled with debug enabled. 
 */ 
PIKEFUN void disassemble(function fun) 
{ 
  if ((TYPEOF(*fun) != T_FUNCTION) || 
      (SUBTYPEOF(*fun) == FUNCTION_BUILTIN)) { 
    fprintf(stderr, 
            "Disassembly only supported for functions implemented in Pike.\n"); 
  } else if (!fun->u.object->prog) { 
    fprintf(stderr, "Function in destructed object.\n"); 
  } else { 
    int f = SUBTYPEOF(*fun); 
    struct reference *ptr = PTR_FROM_INT(fun->u.object->prog, f); 
    struct program *p = PROG_FROM_PTR(fun->u.object->prog, ptr); 
    struct identifier *id = p->identifiers + ptr->identifier_offset; 
    if (id->func.offset >= 0) { 
      struct pike_string *tripples = 
        p->strings[read_program_data(p->program + id->func.offset, -1)]; 
      switch(tripples->size_shift) { 
#define CASE(SHIFT)                                     \ 
        case SHIFT:                                     \ 
          {                                             \ 
            PIKE_CONCAT(p_wchar, SHIFT) *str =          \ 
              PIKE_CONCAT(STR, SHIFT)(tripples);        \ 
            int i=0;                                    \ 
            while(i < tripples->len) {                  \ 
              fprintf(stderr, "@@@ %d: %s, %d, %d\n",   \ 
                      i/3,                              \ 
                      instrs[*str - F_OFFSET].          \ 
                      name,                             \ 
                      str[1], str[2]);                  \ 
              str += 3;                                 \ 
              i += 3;                                   \ 
            }                                           \ 
          }                                             \ 
          break 
        CASE(0); 
        CASE(1); 
        CASE(2); 
#undef CASE 
      } 
    } else { 
      fprintf(stderr, "Prototype.\n"); 
    } 
  } 
  pop_n_elems(args); 
  push_int(0); 
} 
 
#endif /*  PIKE_PORTABLE_BYTECODE */ 
 
#endif /* PIKE_DEBUG */ 
 
#ifdef DEBUG_MALLOC 
 
/*! @decl void reset_dmalloc() 
 *! 
 *! @note 
 *!   Only available when compiled with dmalloc. 
 */ 
PIKEFUN void reset_dmalloc() 
{ 
  reset_debug_malloc(); 
} 
 
extern char * dynamic_location(const char *file, INT_TYPE line); 
extern char * dmalloc_default_location; 
 
/*! @decl void dmalloc_set_name() 
 *! 
 *! @note 
 *!   Only available when compiled with dmalloc. 
 */ 
PIKEFUN void dmalloc_set_name() 
{ 
  dmalloc_default_location=0; 
} 
 
/*! @decl void dmalloc_set_name(string filename, int(1..) linenumber) 
 *! 
 *! @note 
 *!   Only available when compiled with dmalloc. 
 */ 
PIKEFUN void dmalloc_set_name(string filename, int(1..) linenumber) 
{ 
  dmalloc_default_location = dynamic_location(filename->str, linenumber); 
} 
 
extern void list_open_fds(void); 
 
/*! @decl void list_open_fds() 
 *! 
 *! @note 
 *!   Only available when compiled with dmalloc. 
 */ 
PIKEFUN void list_open_fds() 
{ 
  list_open_fds(); 
} 
 
/*! @decl void dump_dmalloc_locations(string|array|mapping| @ 
 *!                                   multiset|function|object| @ 
 *!                                   program|type o) 
 *! 
 *! @note 
 *!   Only available when compiled with dmalloc. 
 */ 
PIKEFUN void dump_dmalloc_locations(string|array|mapping|multiset|function|object|program|type o) 
{ 
  debug_malloc_dump_references (o->u.refs, 2, 1, 0); 
} 
#endif /* DEBUG_MALLOC */ 
 
/*! @endmodule 
 */ 
 
PIKE_MODULE_INIT 
{ 
  INIT; 
#ifdef PIKE_DEBUG 
  ADD_INT_CONSTANT("HAVE_DEBUG", 1, 0); 
#endif 
}