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
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
/******************************************************************************
 *                                        *
 *                             N O T I C E                    *
 *                                        *
 *                Copyright Abandoned, 1987, Fred Fish            *
 *                                        *
 *                                        *
 *  This previously copyrighted work has been placed into the  public     *
 *  domain  by  the  author  and  may be freely used for any purpose,     *
 *  private or commercial.                            *
 *                                        *
 *  Because of the number of inquiries I was receiving about the  use     *
 *  of this product in commercially developed works I have decided to     *
 *  simply make it public domain to further its unrestricted use.   I     *
 *  specifically  would  be  most happy to see this material become a     *
 *  part of the standard Unix distributions by AT&T and the  Berkeley     *
 *  Computer  Science  Research Group, and a standard part of the GNU     *
 *  system from the Free Software Foundation.                 *
 *                                        *
 *  I would appreciate it, as a courtesy, if this notice is  left  in     *
 *  all copies and derivative works.  Thank you.                  *
 *                                        *
 *  The author makes no warranty of any kind  with  respect  to  this     *
 *  product  and  explicitly disclaims any implied warranties of mer-     *
 *  chantability or fitness for any particular purpose.           *
 *                                        *
 ******************************************************************************
 */


/*
 *  FILE
 *
 *  dbug.c   runtime support routines for dbug package
 *
 *  SCCS
 *
 *  @(#)dbug.c  1.19 9/5/87
 *
 *  DESCRIPTION
 *
 *  These are the runtime support routines for the dbug package.
 *  The dbug package has two main components; the user include
 *  file containing various macro definitions, and the runtime
 *  support routines which are called from the macro expansions.
 *
 *  Externally visible functions in the runtime support module
 *  use the naming convention pattern "_db_xx...xx_", thus
 *  they are unlikely to collide with user defined function names.
 *
 *  AUTHOR(S)
 *
 *  Fred Fish       (base code)
 *  (Currently at Motorola Computer Division, Tempe, Az.)
 *  hao!noao!mcdsun!fnf
 *  (602) 438-3614
 *
 *  Binayak Banerjee    (profiling enhancements)
 *  seismo!bpa!sjuvax!bbanerje
 */


#include <stdio.h>
#ifdef amiga
#define AMIGA
#endif

#ifdef AMIGA
#define HZ (50)         /* Probably in some header somewhere */
#endif

/*
 *  Manifest constants that should not require any changes.
 */

#define FALSE       0   /* Boolean FALSE */
#define TRUE        1   /* Boolean TRUE */
#define EOS     '\000'  /* End Of String marker */

/*
 *  Manifest constants which may be "tuned" if desired.
 */

#define PRINTBUF    1024    /* Print buffer size */
#define INDENT      4   /* Indentation per trace level */
#define MAXDEPTH    200 /* Maximum trace depth default */

/*
 *  The following flags are used to determine which
 *  capabilities the user has enabled with the state
 *  push macro.
 */

#define TRACE_ON    000001  /* Trace enabled */
#define DEBUG_ON    000002  /* Debug enabled */
#define FILE_ON     000004  /* File name print enabled */
#define LINE_ON     000010  /* Line number print enabled */
#define DEPTH_ON    000020  /* Function nest level print enabled */
#define PROCESS_ON  000040  /* Process name print enabled */
#define NUMBER_ON   000100  /* Number each line of output */
#define PROFILE_ON  000200  /* Print out profiling code */

#define TRACING (stack -> flags & TRACE_ON)
#define DEBUGGING (stack -> flags & DEBUG_ON)
#define PROFILING (stack -> flags & PROFILE_ON)
#define STREQ(a,b) (strcmp(a,b) == 0)

/*
 *  Typedefs to make things more obvious.
 */

#define VOID void       /* Can't use typedef for most compilers */
typedef int BOOLEAN;

/*
 *  Make it easy to change storage classes if necessary.
 */

#define LOCAL static        /* Names not needed by outside world */
#define IMPORT extern       /* Names defined externally */
#define EXPORT          /* Allocated here, available globally */
#define AUTO auto       /* Names to be allocated on stack */
#define REGISTER register   /* Names to be placed in registers */

/*
 *  The following define is for the variable arguments kluge, see
 *  the comments in _db_doprnt_().
 *
 *  Also note that the longer this list, the less prone to failing
 *  on long argument lists, but the more stuff that must be moved
 *  around for each call to the runtime support routines.  The
 *  length may really be critical if the machine convention is
 *  to pass arguments in registers.
 *
 *  Note that the default define allows up to 16 integral arguments,
 *  or 8 floating point arguments (doubles), on most machines.
 *
 *  Someday this may be replaced with true varargs support, when
 *  ANSI C has had time to take root.
 */

#define ARGLIST a0,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,a13,a14,a15

/*
 * The default file for profiling.  Could also add another flag
 * (G?) which allowed the user to specify this.
 */

#define PROF_FILE   "dbugmon.out"

/*
 *  Variables which are available externally but should only
 *  be accessed via the macro package facilities.
 */

EXPORT FILE *_db_fp_ = (FILE *)0;   /* Output stream, default is set to
                     * stderr later */
EXPORT FILE *_db_pfp_ = (FILE *)0;  /* Profile stream, 'dbugmon.out' */
EXPORT char *_db_process_ = "dbug"; /* Pointer to process name; argv[0] */
EXPORT BOOLEAN _db_on_ = FALSE;     /* TRUE if debugging currently on */
EXPORT BOOLEAN _db_pon_ = FALSE;    /* TRUE if debugging currently on */

/*
 *  Externally supplied functions.
 */

/*
 *  The user may specify a list of functions to trace or
 *  debug.  These lists are kept in a linear linked list,
 *  a very simple implementation.
 */

struct link {
    char *string;       /* Pointer to link's contents */
    struct link *next_link; /* Pointer to the next link */
};


/*
 *  Debugging states can be pushed or popped off of a
 *  stack which is implemented as a linked list.  Note
 *  that the head of the list is the current state and the
 *  stack is pushed by adding a new state to the head of the
 *  list or popped by removing the first link.
 */

struct state {
    int flags;              /* Current state flags */
    int maxdepth;           /* Current maximum trace depth */
    unsigned int delay;         /* Delay after each output line */
    int level;              /* Current function nesting level */
    FILE *out_file;         /* Current output stream */
    FILE *prof_file;            /* Current profiling stream */
    struct link *functions;     /* List of functions */
    struct link *p_functions;       /* List of profiled functions */
    struct link *keywords;      /* List of debug keywords */
    struct link *processes;     /* List of process names */
    struct state *next_state;       /* Next state in the list */
};

LOCAL struct state *stack = NULL;   /* Linked list of stacked states */

/*
 *  Local variables not seen by user.
 */

LOCAL int lineno = 0;       /* Current debugger output line number */
LOCAL char *func = "?func"; /* Name of current user function */
LOCAL char *file = "?file"; /* Name of current user file */
LOCAL BOOLEAN init_done = FALSE;/* Set to TRUE when initialization done */

/*#if unix || AMIGA || M_I86*/
LOCAL int jmplevel;     /* Remember nesting level at setjmp () */
LOCAL char *jmpfunc;        /* Remember current function for setjmp */
LOCAL char *jmpfile;        /* Remember current file for setjmp */
/*#endif*/

LOCAL struct link *ListParse ();/* Parse a debug command string */
LOCAL char *StrDup ();      /* Make a fresh copy of a string */
LOCAL VOID OpenFile ();     /* Open debug output stream */
LOCAL VOID OpenProfile ();  /* Open profile output stream */
LOCAL VOID CloseFile ();    /* Close debug output stream */
LOCAL VOID PushState ();    /* Push current debug state */
LOCAL VOID ChangeOwner ();  /* Change file owner and group */
LOCAL BOOLEAN DoTrace ();   /* Test for tracing enabled */
LOCAL BOOLEAN Writable ();  /* Test to see if file is writable */
LOCAL unsigned long Clock ();   /* Return current user time (ms) */
LOCAL char *DbugMalloc ();  /* Allocate memory for runtime support */
LOCAL char *BaseName ();    /* Remove leading pathname components */
LOCAL VOID DoPrefix ();     /* Print debugger line prefix */
LOCAL VOID FreeList ();     /* Free memory from linked list */
LOCAL VOID Indent ();       /* Indent line to specified indent */
LOCAL int DelayArg (int value); /* Convert D flag argument */
LOCAL BOOLEAN DoProfile (); /* Check if profiling is enabled */

                /* Supplied in Sys V runtime environ */
LOCAL char *strtok ();      /* Break string into tokens */
LOCAL char *strrchr ();     /* Find last occurrence of char */

/*
 *  The following local variables are used to hold the state information
 *  between the call to _db_pargs_() and _db_doprnt_(), during
 *  expansion of the DBUG_PRINT macro.  This is the only macro
 *  that currently uses these variables.  The DBUG_PRINT macro
 *  and the new _db_doprnt_() routine replace the older DBUG_N macros
 *  and their corresponding runtime support routine _db_printf_().
 *
 *  These variables are currently used only by _db_pargs_() and
 *  _db_doprnt_().
 */

LOCAL int u_line = 0;       /* User source code line number */
LOCAL char *u_keyword = "?";    /* Keyword for current macro */

/*
 *  Miscellaneous printf format strings.
 */

#define ERR_MISSING_RETURN "%s: missing DBUG_RETURN or DBUG_VOID_RETURN macro in function \"%s\"\n"
#define ERR_OPEN "%s: can't open debug output stream \"%s\": "
#define ERR_CLOSE "%s: can't close debug file: "
#define ERR_ABORT "%s: debugger aborting because %s\n"
#define ERR_CHOWN "%s: can't change owner/group of \"%s\": "
#define ERR_PRINTF "%s: obsolete object file for '%s', please recompile!\n"

/*
 *  Macros and defines for testing file accessibility under UNIX.
 */

#ifdef unix
#  define A_EXISTS  00      /* Test for file existance */
#  define A_EXECUTE 01      /* Test for execute permission */
#  define A_WRITE   02      /* Test for write access */
#  define A_READ    03      /* Test for read access */
#  define EXISTS(pathname) (access (pathname, A_EXISTS) == 0)
#  define WRITABLE(pathname) (access (pathname, A_WRITE) == 0)
#else
#  define EXISTS(pathname) (FALSE)  /* Assume no existance */
#endif

/*
 *  Translate some calls among different systems.
 */

#ifdef unix
# define XDelay sleep
IMPORT unsigned int sleep ();   /* Pause for given number of seconds */
#endif

#ifdef AMIGA
IMPORT int XDelay ();       /* Pause for given number of ticks */
#endif


/*
 *  FUNCTION
 *
 *  _db_push_    push current debugger state and set up new one
 *
 *  SYNOPSIS
 *
 *  VOID _db_push_ (control)
 *  char *control;
 *
 *  DESCRIPTION
 *
 *  Given pointer to a debug control string in "control", pushes
 *  the current debug state, parses the control string, and sets
 *  up a new debug state.
 *
 *  The only attribute of the new state inherited from the previous
 *  state is the current function nesting level.  This can be
 *  overridden by using the "r" flag in the control string.
 *
 *  The debug control string is a sequence of colon separated fields
 *  as follows:
 *
 *      <field_1>:<field_2>:...:<field_N>
 *
 *  Each field consists of a mandatory flag character followed by
 *  an optional "," and comma separated list of modifiers:
 *
 *      flag[,modifier,modifier,...,modifier]
 *
 *  The currently recognized flag characters are:
 *
 *      d   Enable output from DBUG_<N> macros for
 *          for the current state.  May be followed
 *          by a list of keywords which selects output
 *          only for the DBUG macros with that keyword.
 *          A null list of keywords implies output for
 *          all macros.
 *
 *      D   Delay after each debugger output line.
 *          The argument is the number of tenths of seconds
 *          to delay, subject to machine capabilities.
 *          I.E.  -#D,20 is delay two seconds.
 *
 *      f   Limit debugging and/or tracing, and profiling to the
 *          list of named functions.  Note that a null list will
 *          disable all functions.  The appropriate "d" or "t"
 *          flags must still be given, this flag only limits their
 *          actions if they are enabled.
 *
 *      F   Identify the source file name for each
 *          line of debug or trace output.
 *
 *      g   Enable profiling.  Create a file called 'dbugmon.out'
 *          containing information that can be used to profile
 *          the program.  May be followed by a list of keywords
 *          that select profiling only for the functions in that
 *          list.  A null list implies that all functions are
 *          considered.
 *
 *      L   Identify the source file line number for
 *          each line of debug or trace output.
 *
 *      n   Print the current function nesting depth for
 *          each line of debug or trace output.
 *
 *      N   Number each line of dbug output.
 *
 *      p   Limit debugger actions to specified processes.
 *          A process must be identified with the
 *          DBUG_PROCESS macro and match one in the list
 *          for debugger actions to occur.
 *
 *      P   Print the current process name for each
 *          line of debug or trace output.
 *
 *      r   When pushing a new state, do not inherit
 *          the previous state's function nesting level.
 *          Useful when the output is to start at the
 *          left margin.
 *
 *      t   Enable function call/exit trace lines.
 *          May be followed by a list (containing only
 *          one modifier) giving a numeric maximum
 *          trace level, beyond which no output will
 *          occur for either debugging or tracing
 *          macros.  The default is a compile time
 *          option.
 *
 *  Some examples of debug control strings which might appear
 *  on a shell command line (the "-#" is typically used to
 *  introduce a control string to an application program) are:
 *
 *      -#d:t
 *      -#d:f,main,subr1:F:L:t,20
 *      -#d,input,output,files:n
 *
 *  For convenience, any leading "-#" is stripped off.
 *
 */


VOID _db_push_ (control)
char *control;
{
    REGISTER char *scan;
    REGISTER struct link *temp;

    if (!_db_fp_)
    _db_fp_ = stderr;   /* Output stream, default stderr */

    if (control && *control == '-') {
    if (*++control == '#') {
        control++;
    }
    }
    control = StrDup (control);
    PushState ();
    scan = strtok (control, ":");
    for (; scan != NULL; scan = strtok ((char *)NULL, ":")) {
    switch (*scan++) {
        case 'd':
        _db_on_ = TRUE;
        stack -> flags |= DEBUG_ON;
        if (*scan++ == ',') {
            stack -> keywords = ListParse (scan);
        }
            break;
        case 'D':
        stack -> delay = 0;
        if (*scan++ == ',') {
            temp = ListParse (scan);
            stack -> delay = DelayArg (atoi (temp -> string));
            FreeList (temp);
        }
        break;
        case 'f':
        if (*scan++ == ',') {
            stack -> functions = ListParse (scan);
        }
        break;
        case 'F':
        stack -> flags |= FILE_ON;
        break;
        case 'g':
        _db_pon_ = TRUE;
        OpenProfile(PROF_FILE);
        stack -> flags |= PROFILE_ON;
        if (*scan++ == ',') {
            stack -> p_functions = ListParse (scan);
        }
        break;
        case 'L':
        stack -> flags |= LINE_ON;
        break;
        case 'n':
        stack -> flags |= DEPTH_ON;
        break;
        case 'N':
        stack -> flags |= NUMBER_ON;
        break;
        case 'o':
        if (*scan++ == ',') {
            temp = ListParse (scan);
            OpenFile (temp -> string);
            FreeList (temp);
        } else {
            OpenFile ("-");
        }
        break;
        case 'p':
        if (*scan++ == ',') {
            stack -> processes = ListParse (scan);
        }
        break;
        case 'P':
        stack -> flags |= PROCESS_ON;
        break;
        case 'r':
        stack -> level = 0;
        break;
        case 't':
        stack -> flags |= TRACE_ON;
        if (*scan++ == ',') {
            temp = ListParse (scan);
            stack -> maxdepth = atoi (temp -> string);
            FreeList (temp);
        }
        break;
    }
    }
    free (control);
}



/*
 *  FUNCTION
 *
 *  _db_pop_    pop the debug stack
 *
 *  DESCRIPTION
 *
 *  Pops the debug stack, returning the debug state to its
 *  condition prior to the most recent _db_push_ invocation.
 *  Note that the pop will fail if it would remove the last
 *  valid state from the stack.  This prevents user errors
 *  in the push/pop sequence from screwing up the debugger.
 *  Maybe there should be some kind of warning printed if the
 *  user tries to pop too many states.
 *
 */

VOID _db_pop_ ()
{
    REGISTER struct state *discard;

    discard = stack;
    if (discard != NULL && discard -> next_state != NULL) {
    stack = discard -> next_state;
    _db_fp_ = stack -> out_file;
    _db_pfp_ = stack -> prof_file;
    if (discard -> keywords != NULL) {
        FreeList (discard -> keywords);
    }
    if (discard -> functions != NULL) {
        FreeList (discard -> functions);
    }
    if (discard -> processes != NULL) {
        FreeList (discard -> processes);
    }
    if (discard -> p_functions != NULL) {
        FreeList (discard -> p_functions);
    }
    CloseFile (discard -> out_file);
    CloseFile (discard -> prof_file);
    free ((char *) discard);
    }
}


/*
 *  FUNCTION
 *
 *  _db_enter_    process entry point to user function
 *
 *  SYNOPSIS
 *
 *  VOID _db_enter_ (_func_, _file_, _line_, _sfunc_, _sfile_, _slevel_)
 *  char *_func_;       points to current function name
 *  char *_file_;       points to current file name
 *  int _line_;     called from source line number
 *  char **_sfunc_;     save previous _func_
 *  char **_sfile_;     save previous _file_
 *  int *_slevel_;      save previous nesting level
 *
 *  DESCRIPTION
 *
 *  Called at the beginning of each user function to tell
 *  the debugger that a new function has been entered.
 *  Note that the pointers to the previous user function
 *  name and previous user file name are stored on the
 *  caller's stack (this is why the ENTER macro must be
 *  the first "executable" code in a function, since it
 *  allocates these storage locations).  The previous nesting
 *  level is also stored on the callers stack for internal
 *  self consistency checks.
 *
 *  Also prints a trace line if tracing is enabled and
 *  increments the current function nesting depth.
 *
 *  Note that this mechanism allows the debugger to know
 *  what the current user function is at all times, without
 *  maintaining an internal stack for the function names.
 *
 */

VOID _db_enter_ (_func_, _file_, _line_, _sfunc_, _sfile_, _slevel_)
char *_func_;
char *_file_;
int _line_;
char **_sfunc_;
char **_sfile_;
int *_slevel_;
{
    if (!init_done) {
    _db_push_ ("");
    }
    *_sfunc_ = func;
    *_sfile_ = file;
    func = _func_;
    file = BaseName (_file_);
    stack -> level++;
    *_slevel_ = stack -> level;
    if (DoProfile ()) {
    (VOID) fprintf (_db_pfp_, "%s\tE\t%ld\n",func, Clock());
    (VOID) fflush (_db_pfp_);
    }
    if (DoTrace ()) {
    DoPrefix (_line_);
    Indent (stack -> level);
    (VOID) fprintf (_db_fp_, ">%s\n", func);
    (VOID) fflush (_db_fp_);
    (VOID) XDelay (stack -> delay);
    }
}


/*
 *  FUNCTION
 *
 *  _db_return_    process exit from user function
 *
 *  SYNOPSIS
 *
 *  VOID _db_return_ (_line_, _sfunc_, _sfile_, _slevel_)
 *  int _line_;     current source line number
 *  char **_sfunc_;     where previous _func_ is to be retrieved
 *  char **_sfile_;     where previous _file_ is to be retrieved
 *  int *_slevel_;      where previous level was stashed
 *
 *  DESCRIPTION
 *
 *  Called just before user function executes an explicit or implicit
 *  return.  Prints a trace line if trace is enabled, decrements
 *  the current nesting level, and restores the current function and
 *  file names from the defunct function's stack.
 *
 */

VOID _db_return_ (_line_, _sfunc_, _sfile_, _slevel_)
int _line_;
char **_sfunc_;
char **_sfile_;
int *_slevel_;
{
    if (!init_done) {
    _db_push_ ("");
    }
    if (stack -> level != *_slevel_ && (TRACING || DEBUGGING || PROFILING)) {
    (VOID) fprintf (_db_fp_, ERR_MISSING_RETURN, _db_process_, func);
        (VOID) XDelay (stack -> delay);
    } else if (DoProfile ()) {
    (VOID) fprintf (_db_pfp_, "%s\tX\t%ld\n", func, Clock());
        (VOID) XDelay (stack -> delay);
    } else if (DoTrace ()) {
    DoPrefix (_line_);
    Indent (stack -> level);
    (VOID) fprintf (_db_fp_, "<%s\n", func);
        (VOID) XDelay (stack -> delay);
    }
    (VOID) fflush (_db_fp_);
    stack -> level = *_slevel_ - 1;
    func = *_sfunc_;
    file = *_sfile_;
}


/*
 *  FUNCTION
 *
 *  _db_pargs_    log arguments for subsequent use by _db_doprnt_()
 *
 *  SYNOPSIS
 *
 *  VOID _db_pargs_ (_line_, keyword)
 *  int _line_;
 *  char *keyword;
 *
 *  DESCRIPTION
 *
 *  The new universal printing macro DBUG_PRINT, which replaces
 *  all forms of the DBUG_N macros, needs two calls to runtime
 *  support routines.  The first, this function, remembers arguments
 *  that are used by the subsequent call to _db_doprnt_().
*
 */

VOID _db_pargs_ (_line_, keyword)
int _line_;
char *keyword;
{
    u_line = _line_;
    u_keyword = keyword;
}


/*
 *  FUNCTION
 *
 *  _db_doprnt_    handle print of debug lines
 *
 *  SYNOPSIS
 *
 *  VOID _db_doprnt_ (format, ARGLIST)
 *  char *format;
 *  long ARGLIST;
 *
 *  DESCRIPTION
 *
 *  When invoked via one of the DBUG macros, tests the current keyword
 *  set by calling _db_pargs_() to see if that macro has been selected
 *  for processing via the debugger control string, and if so, handles
 *  printing of the arguments via the format string.  The line number
 *  of the DBUG macro in the source is found in u_line.
 *
 *  Note that the format string SHOULD NOT include a terminating
 *  newline, this is supplied automatically.
 *
 *  NOTES
 *
 *  This runtime support routine replaces the older _db_printf_()
 *  routine which is temporarily kept around for compatibility.
 *
 *  The rather ugly argument declaration is to handle some
 *  magic with respect to the number of arguments passed
 *  via the DBUG macros.  The current maximum is 3 arguments
 *  (not including the keyword and format strings).
 *
 *  The new <varargs.h> facility is not yet common enough to
 *  convert to it quite yet...
 *
 */

/*VARARGS1*/
VOID _db_doprnt_ (format, ARGLIST)<--- syntax error
char *format;
long ARGLIST;
{
    if (_db_keyword_ (u_keyword)) {
    DoPrefix (u_line);
    if (TRACING) {
        Indent (stack -> level + 1);
    } else {
        (VOID) fprintf (_db_fp_, "%s: ", func);
    }
    (VOID) fprintf (_db_fp_, "%s: ", u_keyword);
    (VOID) fprintf (_db_fp_, format, ARGLIST);
    (VOID) fprintf (_db_fp_, "\n");
    (VOID) fflush (_db_fp_);
    (VOID) XDelay (stack -> delay);
    }
}

/*
 *  The following routine is kept around temporarily for compatibility
 *  with older objects that were compiled with the DBUG_N macro form
 *  of the print routine.  It will print a warning message on first
 *  usage.  It will go away in subsequent releases...
 */

/*VARARGS3*/
VOID _db_printf_ (_line_, keyword, format, ARGLIST)
int _line_;
char *keyword,  *format;
long ARGLIST;
{
    static BOOLEAN firsttime = TRUE;

    if (firsttime) {
    (VOID) fprintf (stderr, ERR_PRINTF, _db_process_, file);
    firsttime = FALSE;
    }
    _db_pargs_ (_line_, keyword);
    _db_doprnt_ (format, ARGLIST);
}


/*
 *  FUNCTION
 *
 *  ListParse    parse list of modifiers in debug control string
 *
 *  SYNOPSIS
 *
 *  LOCAL struct link *ListParse (ctlp)
 *  char *ctlp;
 *
 *  DESCRIPTION
 *
 *  Given pointer to a comma separated list of strings in "cltp",
 *  parses the list, building a list and returning a pointer to it.
 *  The original comma separated list is destroyed in the process of
 *  building the linked list, thus it had better be a duplicate
 *  if it is important.
 *
 *  Note that since each link is added at the head of the list,
 *  the final list will be in "reverse order", which is not
 *  significant for our usage here.
 *
 */

LOCAL struct link *ListParse (ctlp)
char *ctlp;
{
    REGISTER char *start;
    REGISTER struct link *new;
    REGISTER struct link *head;

    head = NULL;
    while (*ctlp != EOS) {
    start = ctlp;
    while (*ctlp != EOS && *ctlp != ',') {
        ctlp++;
    }
    if (*ctlp == ',') {
        *ctlp++ = EOS;
    }
    new = (struct link *) DbugMalloc (sizeof (struct link));
    new -> string = StrDup (start);
    new -> next_link = head;
    head = new;
    }
    return (head);
}


/*
 *  FUNCTION
 *
 *  InList    test a given string for member of a given list
 *
 *  SYNOPSIS
 *
 *  LOCAL BOOLEAN InList (linkp, cp)
 *  struct link *linkp;
 *  char *cp;
 *
 *  DESCRIPTION
 *
 *  Tests the string pointed to by "cp" to determine if it is in
 *  the list pointed to by "linkp".  Linkp points to the first
 *  link in the list.  If linkp is NULL then the string is treated
 *  as if it is in the list (I.E all strings are in the null list).
 *  This may seem rather strange at first but leads to the desired
 *  operation if no list is given.  The net effect is that all
 *  strings will be accepted when there is no list, and when there
 *  is a list, only those strings in the list will be accepted.
 *
 */

LOCAL BOOLEAN InList (linkp, cp)
struct link *linkp;
char *cp;
{
    REGISTER struct link *scan;
    REGISTER BOOLEAN accept;

    if (linkp == NULL) {
    accept = TRUE;
    } else {
    accept = FALSE;
    for (scan = linkp; scan != NULL; scan = scan -> next_link) {
        if (STREQ (scan -> string, cp)) {
        accept = TRUE;
        break;
        }
    }
    }
    return (accept);
}


/*
 *  FUNCTION
 *
 *  PushState    push current state onto stack and set up new one
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID PushState ()
 *
 *  DESCRIPTION
 *
 *  Pushes the current state on the state stack, and initializes
 *  a new state.  The only parameter inherited from the previous
 *  state is the function nesting level.  This action can be
 *  inhibited if desired, via the "r" flag.
 *
 *  The state stack is a linked list of states, with the new
 *  state added at the head.  This allows the stack to grow
 *  to the limits of memory if necessary.
 *
 */

LOCAL VOID PushState ()
{
    REGISTER struct state *new;

    new = (struct state *) DbugMalloc (sizeof (struct state));
    new -> flags = 0;
    new -> delay = 0;
    new -> maxdepth = MAXDEPTH;
    if (stack != NULL) {
    new -> level = stack -> level;
    } else {
    new -> level = 0;
    }
    new -> out_file = stderr;
    new -> functions = NULL;
    new -> p_functions = NULL;
    new -> keywords = NULL;
    new -> processes = NULL;
    new -> next_state = stack;
    stack = new;
    init_done = TRUE;
}


/*
 *  FUNCTION
 *
 *  DoTrace    check to see if tracing is current enabled
 *
 *  SYNOPSIS
 *
 *  LOCAL BOOLEAN DoTrace ()
 *
 *  DESCRIPTION
 *
 *  Checks to see if tracing is enabled based on whether the
 *  user has specified tracing, the maximum trace depth has
 *  not yet been reached, the current function is selected,
 *  and the current process is selected.  Returns TRUE if
 *  tracing is enabled, FALSE otherwise.
 *
 */

LOCAL BOOLEAN DoTrace ()
{
    REGISTER BOOLEAN trace;

    trace = FALSE;
    if (TRACING) {
    if (stack -> level <= stack -> maxdepth) {
        if (InList (stack -> functions, func)) {
        if (InList (stack -> processes, _db_process_)) {
            trace = TRUE;
        }
        }
    }
    }
    return (trace);
}


/*
 *  FUNCTION
 *
 *  DoProfile    check to see if profiling is current enabled
 *
 *  SYNOPSIS
 *
 *  LOCAL BOOLEAN DoProfile ()
 *
 *  DESCRIPTION
 *
 *  Checks to see if profiling is enabled based on whether the
 *  user has specified profiling, the maximum trace depth has
 *  not yet been reached, the current function is selected,
 *  and the current process is selected.  Returns TRUE if
 *  profiling is enabled, FALSE otherwise.
 *
 */

LOCAL BOOLEAN DoProfile ()
{
    REGISTER BOOLEAN profile;

    profile = FALSE;
    if (PROFILING) {
    if (stack -> level <= stack -> maxdepth) {
        if (InList (stack -> p_functions, func)) {
        if (InList (stack -> processes, _db_process_)) {
            profile = TRUE;
        }
        }
    }
    }
    return (profile);
}


/*
 *  FUNCTION
 *
 *  _db_keyword_    test keyword for member of keyword list
 *
 *  SYNOPSIS
 *
 *  BOOLEAN _db_keyword_ (keyword)
 *  char *keyword;
 *
 *  DESCRIPTION
 *
 *  Test a keyword to determine if it is in the currently active
 *  keyword list.  As with the function list, a keyword is accepted
 *  if the list is null, otherwise it must match one of the list
 *  members.  When debugging is not on, no keywords are accepted.
 *  After the maximum trace level is exceeded, no keywords are
 *  accepted (this behavior subject to change).  Additionally,
 *  the current function and process must be accepted based on
 *  their respective lists.
 *
 *  Returns TRUE if keyword accepted, FALSE otherwise.
 *
 */

BOOLEAN _db_keyword_ (keyword)
char *keyword;
{
    REGISTER BOOLEAN accept;

    if (!init_done) {
    _db_push_ ("");
    }
    accept = FALSE;
    if (DEBUGGING) {
    if (stack -> level <= stack -> maxdepth) {
        if (InList (stack -> functions, func)) {
        if (InList (stack -> keywords, keyword)) {
            if (InList (stack -> processes, _db_process_)) {
            accept = TRUE;
            }
        }
        }
    }
    }
    return (accept);
}


/*
 *  FUNCTION
 *
 *  Indent    indent a line to the given indentation level
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID Indent (indent)
 *  int indent;
 *
 *  DESCRIPTION
 *
 *  Indent a line to the given level.  Note that this is
 *  a simple minded but portable implementation.
 *  There are better ways.
 *
 *  Also, the indent must be scaled by the compile time option
 *  of character positions per nesting level.
 *
 */

LOCAL VOID Indent (indent)
int indent;
{
    REGISTER int count;
    AUTO char buffer[PRINTBUF];

    indent *= INDENT;
    for (count = 0; (count < (indent - INDENT)) && (count < (PRINTBUF - 1)); count++) {
    if ((count % INDENT) == 0) {
        buffer[count] = '|';
    } else {
        buffer[count] = ' ';
    }
    }
    buffer[count] = EOS;
    (VOID) fprintf (_db_fp_, buffer);
    (VOID) fflush (_db_fp_);
}


/*
 *  FUNCTION
 *
 *  FreeList    free all memory associated with a linked list
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID FreeList (linkp)
 *  struct link *linkp;
 *
 *  DESCRIPTION
 *
 *  Given pointer to the head of a linked list, frees all
 *  memory held by the list and the members of the list.
 *
 */

LOCAL VOID FreeList (linkp)
struct link *linkp;
{
    REGISTER struct link *old;

    while (linkp != NULL) {
    old = linkp;
    linkp = linkp -> next_link;
    if (old -> string != NULL) {
        free (old -> string);
    }
    free ((char *) old);
    }
}


/*
 *  FUNCTION
 *
 *  StrDup   make a duplicate of a string in new memory
 *
 *  SYNOPSIS
 *
 *  LOCAL char *StrDup (string)
 *  char *string;
 *
 *  DESCRIPTION
 *
 *  Given pointer to a string, allocates sufficient memory to make
 *  a duplicate copy, and copies the string to the newly allocated
 *  memory.  Failure to allocated sufficient memory is immediately
 *  fatal.
 *
 */


LOCAL char *StrDup (string)
char *string;
{
    REGISTER char *new;

    new = DbugMalloc (strlen (string) + 1);
    (VOID) strcpy (new, string);
    return (new);
}


/*
 *  FUNCTION
 *
 *  DoPrefix    print debugger line prefix prior to indentation
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID DoPrefix (_line_)
 *  int _line_;
 *
 *  DESCRIPTION
 *
 *  Print prefix common to all debugger output lines, prior to
 *  doing indentation if necessary.  Print such information as
 *  current process name, current source file name and line number,
 *  and current function nesting depth.
 *
 */


LOCAL VOID DoPrefix (_line_)
int _line_;
{
    lineno++;
    if (stack -> flags & NUMBER_ON) {
    (VOID) fprintf (_db_fp_, "%5d: ", lineno);
    }
    if (stack -> flags & PROCESS_ON) {
    (VOID) fprintf (_db_fp_, "%s: ", _db_process_);
    }
    if (stack -> flags & FILE_ON) {
    (VOID) fprintf (_db_fp_, "%14s: ", file);
    }
    if (stack -> flags & LINE_ON) {
    (VOID) fprintf (_db_fp_, "%5d: ", _line_);
    }
    if (stack -> flags & DEPTH_ON) {
    (VOID) fprintf (_db_fp_, "%4d: ", stack -> level);
    }
    (VOID) fflush (_db_fp_);
}


/*
 *  FUNCTION
 *
 *  OpenFile    open new output stream for debugger output
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID OpenFile (name)
 *  char *name;
 *
 *  DESCRIPTION
 *
 *  Given name of a new file (or "-" for stdout) opens the file
 *  and sets the output stream to the new file.
 *
 */

LOCAL VOID OpenFile (name)
char *name;
{
    REGISTER FILE *fp;
    REGISTER BOOLEAN newfile;

    if (name != NULL) {
    if (strcmp (name, "-") == 0) {
        _db_fp_ = stdout;
        stack -> out_file = _db_fp_;
    } else {
        if (!Writable (name)) {
        (VOID) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
        perror ("");
        (VOID) fflush (_db_fp_);
        (VOID) XDelay (stack -> delay);
        } else {
        if (EXISTS (name)) {
            newfile = FALSE;
        } else {
            newfile = TRUE;
        }
        fp = fopen (name, "a");
        if (fp == NULL) {
             (VOID) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
            perror ("");
            (VOID) fflush (_db_fp_);
            (VOID) XDelay (stack -> delay);
        } else {
            _db_fp_ = fp;
            stack -> out_file = fp;
            if (newfile) {
            ChangeOwner (name);
            }
        }
        }
    }
    }
}


/*
 *  FUNCTION
 *
 *  OpenProfile    open new output stream for profiler output
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID OpenProfile (name)
 *  char *name;
 *
 *  DESCRIPTION
 *
 *  Given name of a new file, opens the file
 *  and sets the profiler output stream to the new file.
 *
 *  It is currently unclear whether the prefered behavior is
 *  to truncate any existing file, or simply append to it.
 *  The latter behavior would be desirable for collecting
 *  accumulated runtime history over a number of separate
 *  runs.  It might take some changes to the analyzer program
 *  though, and the notes that Binayak sent with the profiling
 *  diffs indicated that append was the normal mode, but this
 *  does not appear to agree with the actual code. I haven't
 *  investigated at this time [fnf; 24-Jul-87].
 */

LOCAL VOID OpenProfile (name)
char *name;
{
    REGISTER FILE *fp;
    REGISTER BOOLEAN newfile;

    if (name != NULL) {
    if (!Writable (name)) {
        (VOID) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
        perror ("");
        (VOID) fflush (_db_fp_);
        (VOID) XDelay (stack -> delay);
    } else {
        if (EXISTS (name)) {
        newfile = FALSE;
        } else {
        newfile = TRUE;
        }
        fp = fopen (name, "w");
        if (fp == NULL) {
        (VOID) fprintf (_db_fp_, ERR_OPEN, _db_process_, name);
        perror ("");
        (VOID) fflush (_db_fp_);
        (VOID) XDelay (stack -> delay);
        } else {
        _db_pfp_ = fp;
        stack -> prof_file = fp;
        if (newfile) {
            ChangeOwner (name);
        }
        }
    }
    }
}


/*
 *  FUNCTION
 *
 *  CloseFile    close the debug output stream
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID CloseFile (fp)
 *  FILE *fp;
 *
 *  DESCRIPTION
 *
 *  Closes the debug output stream unless it is standard output
 *  or standard error.
 *
 */

LOCAL VOID CloseFile (fp)
FILE *fp;
{
    if (fp != stderr && fp != stdout) {
    if (fclose (fp) == EOF) {
        (VOID) fprintf (stderr, ERR_CLOSE, _db_process_);
        perror ("");
        (VOID) fflush (stderr);
        (VOID) XDelay (stack -> delay);
    }
    }
}


/*
 *  FUNCTION
 *
 *  DbugExit    print error message and exit
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID DbugExit (why)
 *  char *why;
 *
 *  DESCRIPTION
 *
 *  Prints error message using current process name, the reason for
 *  aborting (typically out of memory), and exits with status 1.
 *  This should probably be changed to use a status code
 *  defined in the user's debugger include file.
 *
 */

LOCAL VOID DbugExit (why)
char *why;
{
    (VOID) fprintf (stderr, ERR_ABORT, _db_process_, why);
    (VOID) fflush (stderr);
    (VOID) XDelay (stack -> delay);
    exit (1);
}


/*
 *  FUNCTION
 *
 *  DbugMalloc    allocate memory for debugger runtime support
 *
 *  SYNOPSIS
 *
 *  LOCAL char *DbugMalloc (size)
 *  int size;
 *
 *  DESCRIPTION
 *
 *  Allocate more memory for debugger runtime support functions.
 *  Failure to to allocate the requested number of bytes is
 *  immediately fatal to the current process.  This may be
 *  rather unfriendly behavior.  It might be better to simply
 *  print a warning message, freeze the current debugger state,
 *  and continue execution.
 *
 */

LOCAL char *DbugMalloc (size)
int size;
{
    register char *new;

    new = malloc ( size );
    if (new == NULL) {
    DbugExit ("out of memory");
    }
    return (new);
}


/*
 *  This function may be eliminated when strtok is available
 *  in the runtime environment (missing from BSD4.1).
 */

LOCAL char *strtok (s1, s2)
char *s1, *s2;
{
    static char *end = NULL;
    REGISTER char *rtnval;

    rtnval = NULL;
    if (s2 != NULL) {
    if (s1 != NULL) {
        end = s1;
        rtnval = strtok ((char *) NULL, s2);
    } else if (end != NULL) {
        if (*end != EOS) {
        rtnval = end;
        while (*end != *s2 && *end != EOS) {end++;}
        if (*end != EOS) {
            *end++ = EOS;
        }
        }
    }
    }
    return (rtnval);
}


/*
 *  FUNCTION
 *
 *  BaseName    strip leading pathname components from name
 *
 *  SYNOPSIS
 *
 *  LOCAL char *BaseName (pathname)
 *  char *pathname;
 *
 *  DESCRIPTION
 *
 *  Given pointer to a complete pathname, locates the base file
 *  name at the end of the pathname and returns a pointer to
 *  it.
 *
 */

LOCAL char *BaseName (pathname)
char *pathname;
{
    register char *base;

    base = strrchr (pathname, '/');
    if (base++ == NULL) {
    base = pathname;
    }
    return (base);
}


/*
 *  FUNCTION
 *
 *  Writable    test to see if a pathname is writable/creatable
 *
 *  SYNOPSIS
 *
 *  LOCAL BOOLEAN Writable (pathname)
 *  char *pathname;
 *
 *  DESCRIPTION
 *
 *  Because the debugger might be linked in with a program that
 *  runs with the set-uid-bit (suid) set, we have to be careful
 *  about opening a user named file for debug output.  This consists
 *  of checking the file for write access with the real user id,
 *  or checking the directory where the file will be created.
 *
 *  Returns TRUE if the user would normally be allowed write or
 *  create access to the named file.  Returns FALSE otherwise.
 *
 */

LOCAL BOOLEAN Writable (pathname)
char *pathname;
{
    REGISTER BOOLEAN granted;
#ifdef unix
    REGISTER char *lastslash;
#endif

#ifndef unix
    granted = TRUE;
#else
    granted = FALSE;
    if (EXISTS (pathname)) {
    if (WRITABLE (pathname)) {
        granted = TRUE;
    }
    } else {
    lastslash = strrchr (pathname, '/');
    if (lastslash != NULL) {
        *lastslash = EOS;
    } else {
        pathname = ".";
    }
    if (WRITABLE (pathname)) {
        granted = TRUE;
    }
    if (lastslash != NULL) {
        *lastslash = '/';
    }
    }
#endif
    return (granted);
}


/*
 *  This function may be eliminated when strrchr is available
 *  in the runtime environment (missing from BSD4.1).
 *  Alternately, you can use rindex() on BSD systems.
 */

LOCAL char *strrchr (s, c)
char *s;
char c;
{
    REGISTER char *scan;

    for (scan = s; *scan != EOS; scan++) {;}
    while (scan > s && *--scan != c) {;}
    if (*scan != c) {
    scan = NULL;
    }
    return (scan);
}


/*
 *  FUNCTION
 *
 *  ChangeOwner    change owner to real user for suid programs
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID ChangeOwner (pathname)
 *
 *  DESCRIPTION
 *
 *  For unix systems, change the owner of the newly created debug
 *  file to the real owner.  This is strictly for the benefit of
 *  programs that are running with the set-user-id bit set.
 *
 *  Note that at this point, the fact that pathname represents
 *  a newly created file has already been established.  If the
 *  program that the debugger is linked to is not running with
 *  the suid bit set, then this operation is redundant (but
 *  harmless).
 *
 */

LOCAL VOID ChangeOwner (pathname)
char *pathname;
{
#ifdef unix
    if (chown (pathname, getuid (), getgid ()) == -1) {
    (VOID) fprintf (stderr, ERR_CHOWN, _db_process_, pathname);
    perror ("");
    (VOID) fflush (stderr);
    (VOID) XDelay (stack -> delay);
    }
#endif
}


/*
 *  FUNCTION
 *
 *  _db_setjmp_    save debugger environment
 *
 *  SYNOPSIS
 *
 *  VOID _db_setjmp_ ()
 *
 *  DESCRIPTION
 *
 *  Invoked as part of the user's DBUG_SETJMP macro to save
 *  the debugger environment in parallel with saving the user's
 *  environment.
 *
 */

VOID _db_setjmp_ ()
{
   jmplevel = stack -> level;
   jmpfunc = func;
   jmpfile = file;
}


/*
 *  FUNCTION
 *
 *  _db_longjmp_    restore previously saved debugger environment
 *
 *  SYNOPSIS
 *
 *  VOID _db_longjmp_ ()
 *
 *  DESCRIPTION
 *
 *  Invoked as part of the user's DBUG_LONGJMP macro to restore
 *  the debugger environment in parallel with restoring the user's
 *  previously saved environment.
 *
 */

VOID _db_longjmp_ ()
{
    stack -> level = jmplevel;
    if (jmpfunc) {
    func = jmpfunc;
    }
    if (jmpfile) {
    file = jmpfile;
    }
}


/*
 *  FUNCTION
 *
 *  DelayArg   convert D flag argument to appropriate value
 *
 *  SYNOPSIS
 *
 *  LOCAL int DelayArg (value)
 *  int value;
 *
 *  DESCRIPTION
 *
 *  Converts delay argument, given in tenths of a second, to the
 *  appropriate numerical argument used by the system to delay
 *  that that many tenths of a second.  For example, on the
 *  AMIGA, there is a system call "Delay()" which takes an
 *  argument in ticks (50 per second).  On unix, the sleep
 *  command takes seconds.  Thus a value of "10", for one
 *  second of delay, gets converted to 50 on the amiga, and 1
 *  on unix.  Other systems will need to use a timing loop.
 *
 */

LOCAL int DelayArg (value)
int value;
{
    int delayarg = 0;

#ifdef unix
    delayarg = value / 10;      /* Delay is in seconds for sleep () */
#endif
#ifdef AMIGA
    delayarg = (HZ * value) / 10;   /* Delay in ticks for XDelay () */
#endif
    return (delayarg);
}


/*
 *  A dummy delay stub for systems that do not support delays.
 *  With a little work, this can be turned into a timing loop.
 */

#ifndef unix
#ifndef AMIGA
XDelay ()
{
}
#endif
#endif


/*
 *  FUNCTION
 *
 *  perror    perror simulation for systems that don't have it
 *
 *  SYNOPSIS
 *
 *  LOCAL VOID perror (s)
 *  char *s;
 *
 *  DESCRIPTION
 *
 *  Perror produces a message on the standard error stream which
 *  provides more information about the library or system error
 *  just encountered.  The argument string s is printed, followed
 *  by a ':', a blank, and then a message and a newline.
 *
 *  An undocumented feature of the unix perror is that if the string
 *  's' is a null string (NOT a NULL pointer!), then the ':' and
 *  blank are not printed.
 *
 *  This version just complains about an "unknown system error".
 *
 */

#if !unix && !(AMIGA || LATTICE || __TURBOC__ )
LOCAL VOID perror (s)
#if __STDC__
const char *s;
#else
char *s;
#endif
{
    if (s && *s != EOS) {
    (VOID) fprintf (stderr, "%s: ", s);
    }
    (VOID) fprintf (stderr, "<unknown system error>\n");
}
#endif  /* !unix && !(AMIGA && LATTICE) */

/*
 * Here we need the definitions of the clock routine.  Add your
 * own for whatever system that you have.
 */

#if unix

# include <sys/param.h>
# if !defined(Solaris) && (BSD4_3 || sun)

/*
 * Definition of the Clock() routine for 4.3 BSD.
 */

#include <sys/time.h>
#include <sys/resource.h>


/*
 * Returns the user time in milliseconds used by this process so
 * far.
 */

LOCAL unsigned long Clock ()
{
    struct rusage ru;

    (VOID) getrusage (RUSAGE_SELF, &ru);
    return ((ru.ru_utime.tv_sec * 1000) + (ru.ru_utime.tv_usec / 1000));
}

#else

LOCAL unsigned long Clock ()
{
    return (0);
}

# endif

#else

#if AMIGA

struct DateStamp {      /* Yes, this is a hack, but doing it right */
    long ds_Days;       /* is incredibly ugly without splitting this */
    long ds_Minute;     /* off into a separate file */
    long ds_Tick;
};

static int first_clock = TRUE;
static struct DateStamp begin;
static struct DateStamp elapsed;

LOCAL unsigned long Clock ()
{
    register struct DateStamp *now;
    register unsigned long millisec = 0;
    extern VOID *AllocMem ();

    now = (struct DateStamp *) AllocMem ((long) sizeof (struct DateStamp), 0L);
    if (now != NULL) {
    if (first_clock == TRUE) {
        first_clock = FALSE;
        (VOID) DateStamp (now);
        begin = *now;
    }
    (VOID) DateStamp (now);
    millisec = 24 * 3600 * (1000 / HZ) * (now -> ds_Days - begin.ds_Days);
    millisec += 60 * (1000 / HZ) * (now -> ds_Minute - begin.ds_Minute);
    millisec += (1000 / HZ) * (now -> ds_Tick - begin.ds_Tick);
    (VOID) FreeMem (now, (long) sizeof (struct DateStamp));
    }
    return (millisec);
}

#else

LOCAL unsigned long Clock ()
{
    return (0);
}

#endif  /* AMIGA */

#endif  /* unix */

#ifdef AMIGA
XDelay(x)
int x;
{
    if (x) Delay(x);    /* fix Delay bug in AmigaDOS */
}
#endif