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 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
|
// *************************************************************************
// gdbcontroller.cpp - description
// -------------------
// begin : Sun Aug 8 1999
// copyright : (C) 1999 by John Birch
// email : jbb@kdevelop.org
// **************************************************************************
//
// **************************************************************************
// * *
// * This program is free software; you can redistribute it and/or modify *
// * it under the terms of the GNU General Public License as published by *
// * the Free Software Foundation; either version 2 of the License, or *
// * (at your option) any later version. *
// * *
// **************************************************************************
#include "gdbcontroller.h"
#include "breakpoint.h"
#include "gdbcommand.h"
#include "stty.h"
#include "domutil.h"
#include "settings.h"
#include "mi/miparser.h"
#include <kapplication.h>
#include <kconfig.h>
#include <kdebug.h>
#include <kglobal.h>
#include <klocale.h>
#include <kmessagebox.h>
#include <kprocess.h>
#include <kwin.h>
#include <qdatetime.h>
#include <qfileinfo.h>
#include <qregexp.h>
#include <qstring.h>
#include <qdir.h>
#include <qvaluevector.h>
#include <qeventloop.h>
#include <iostream>
#include <ctype.h>
#include <stdlib.h>
#include <assert.h>
#include <typeinfo>
using namespace std;
// **************************************************************************
//
// Does all the communication between gdb and the kdevelop's debugger code.
// Significatant classes being used here are
//
// GDBParser - parses the "variable" data using the vartree and varitems
// VarTree - where the variable data will end up
// FrameStack - tracks the program frames and allows the user to switch between
// and therefore view the calling funtions and their data
// Breakpoint - Where and what to do with breakpoints.
// STTY - the tty that the _application_ will run on.
//
// Significant variables
// state_ - be very careful setting this. The controller is totally
// dependent on this reflecting the correct state. For instance,
// if the app is busy but we don't think so, then we lose control
// of the app. The only way to get out of these situations is to
// delete (stop) the controller.
// currentFrame_
// - Holds the frame number where and locals/variable information will
// go to
//
// Certain commands need to be "wrapped", so that the output gdb produces is
// of the form "\032data_id gdb output \032data_id"
// Then a very simple parse can extract this gdb output and hand it off
// to its' respective parser.
// To do this we set the prompt to be \032data_id before the command and then
// reset to \032i to indicate the "idle".
//
// Note that the following does not work because in certain situations
// gdb can get an error in performing the command and therefore will not
// output the final echo. Hence the data will be thrown away.
// (certain "info locals" will generate this error.
//
// queueCmd(new GDBCommand(QString().sprintf("define printlocal\n"
// "echo \32%c\ninfo locals\necho \32%c\n"
// "end",
// LOCALS, LOCALS)));
// (although replacing echo with "set prompt" appropriately could work Hmmmm.)
//
// Shared libraries and breakpoints
// ================================
// Shared libraries and breakpoints have a problem that has a reasonable solution.
// The problem is that gdb will not accept breakpoints in source that is in a
// shared library that has _not_ _yet_ been opened but will be opened via a
// dlopen.
//
// The solution is to get gdb to tell us when a shared library has been opened.
// This means that when the user sets a breakpoint, we flag this breakpoint as
// pending, try to set the breakpoint and if gdb says it succeeded then flag it
// as active. If gdb is not successful then we leave the breakpoint as pending.
//
// This is known as "lazy breakpoints"
//
// If the user has selected a file that is really outside the program and tried to
// set a breakpoint then this breakpoint will always be pending. I can't do
// anything about that, because it _might_ be in a shared library. If not they
// are either fools or just misguided...
//
// Now that the breakpoint is pending, we need gdb to tell us when a shared
// library has been loaded. We use "set stop-on 1". This breaks on _any_
// library event, and we just try to set the pending breakpoints. Once we're
// done, we then "continue"
//
// Now here's the problem with all this. If the user "step"s over code that
// contains a library dlopen then it'll just keep running, because we receive a
// break and hence end up doing a continue. In this situation, I do _not_
// do a continue but leave it stopped with the status line reflecting the
// stopped state. The frame stack is in the dl routine that caused the stop.
//
// There isn't any way around this, but I could allievate the problem somewhat
// by only doing a "set stop-on 1" when we have pending breakpoints.
//
// **************************************************************************
namespace GDBDebugger
{
// This is here so we can check for startup /shutdown problems
int debug_controllerExists = false;
GDBController::GDBController(QDomDocument &projectDom)
: DbgController(),
currentFrame_(0),
viewedThread_(-1),
holdingZone_(),
currentCmd_(0),
tty_(0),
badCore_(QString()),
state_(s_dbgNotStarted|s_appNotStarted),
programHasExited_(false),
dom(projectDom),
config_breakOnLoadingLibrary_(true),
config_forceBPSet_(true),
config_displayStaticMembers_(false),
config_asmDemangle_(true),
config_dbgTerminal_(false),
config_gdbPath_(),
config_outputRadix_(10),
state_reload_needed(false),
stateReloadInProgress_(false)
{
configure();
cmdList_.setAutoDelete(true);
Q_ASSERT(! debug_controllerExists);
debug_controllerExists = true;
}
// **************************************************************************
// Deleting the controller involves shutting down gdb nicely.
// When were attached to a process, we must first detach so that the process
// can continue running as it was before being attached. gdb is quite slow to
// detach from a process, so we must process events within here to get a "clean"
// shutdown.
GDBController::~GDBController()
{
debug_controllerExists = false;
}
// **************************************************************************
void GDBController::configure()
{
// A a configure.gdb script will prevent these from uncontrolled growth...
config_configGdbScript_ = DomUtil::readEntry(dom, "/kdevdebugger/general/configGdbScript").latin1();
config_runShellScript_ = DomUtil::readEntry(dom, "/kdevdebugger/general/runShellScript").latin1();
config_runGdbScript_ = DomUtil::readEntry(dom, "/kdevdebugger/general/runGdbScript").latin1();
// add macros for reading QStrings? or in configGdbScript?
config_forceBPSet_ = DomUtil::readBoolEntry(dom, "/kdevdebugger/general/allowforcedbpset", true);
config_dbgTerminal_ = DomUtil::readBoolEntry(dom, "/kdevdebugger/general/separatetty", false);
config_gdbPath_ = DomUtil::readEntry(dom, "/kdevdebugger/general/gdbpath");
bool old_displayStatic = config_displayStaticMembers_;
config_displayStaticMembers_ = DomUtil::readBoolEntry(dom, "/kdevdebugger/display/staticmembers",false);
bool old_asmDemangle = config_asmDemangle_;
config_asmDemangle_ = DomUtil::readBoolEntry(dom, "/kdevdebugger/display/demanglenames",true);
bool old_breakOnLoadingLibrary_ = config_breakOnLoadingLibrary_;
config_breakOnLoadingLibrary_ = DomUtil::readBoolEntry(dom, "/kdevdebugger/general/breakonloadinglibs",true);
// FIXME: should move this into debugger part or variable widget.
int old_outputRadix = config_outputRadix_;
#if 0
config_outputRadix_ = DomUtil::readIntEntry(dom, "/kdevdebugger/display/outputradix", 10);
varTree_->setRadix(config_outputRadix_);
#endif
if (( old_displayStatic != config_displayStaticMembers_ ||
old_asmDemangle != config_asmDemangle_ ||
old_breakOnLoadingLibrary_ != config_breakOnLoadingLibrary_ ||
old_outputRadix != config_outputRadix_) &&
dbgProcess_)
{
bool restart = false;
if (stateIsOn(s_dbgBusy))
{
pauseApp();
restart = true;
}
if (old_displayStatic != config_displayStaticMembers_)
{
if (config_displayStaticMembers_)
queueCmd(new GDBCommand("set print static-members on"));
else
queueCmd(new GDBCommand("set print static-members off"));
}
if (old_asmDemangle != config_asmDemangle_)
{
if (config_asmDemangle_)
queueCmd(new GDBCommand("set print asm-demangle on"));
else
queueCmd(new GDBCommand("set print asm-demangle off"));
}
// Disabled for MI port.
if (old_outputRadix != config_outputRadix_)
{
queueCmd(new GDBCommand(QCString().sprintf("set output-radix %d",
config_outputRadix_)));
// FIXME: should do this in variable widget anyway.
// After changing output radix, need to refresh variables view.
raiseEvent(program_state_changed);
}
if (!config_configGdbScript_.isEmpty())
queueCmd(new GDBCommand("source " + config_configGdbScript_));
if (restart)
queueCmd(new GDBCommand("-exec-continue"));
}
}
// **************************************************************************
void GDBController::addCommand(GDBCommand* cmd)
{
queueCmd(cmd);
}
void GDBController::addCommand(const QString& str)
{
queueCmd(new GDBCommand(str));
}
void GDBController::addCommandToFront(GDBCommand* cmd)
{
queueCmd(cmd, queue_at_front);
}
void GDBController::addCommandBeforeRun(GDBCommand* cmd)
{
queueCmd(cmd, queue_before_run);
}
int GDBController::currentThread() const
{
return viewedThread_;
}
int GDBController::currentFrame() const
{
return currentFrame_;
}
// Fairly obvious that we'll add whatever command you give me to a queue
// If you tell me to, I'll put it at the head of the queue so it'll run ASAP
// Not quite so obvious though is that if we are going to run again. then any
// information requests become redundent and must be removed.
// We also try and run whatever command happens to be at the head of
// the queue.
void GDBController::queueCmd(GDBCommand *cmd, enum queue_where queue_where)
{
if (stateIsOn(s_dbgNotStarted))
{
KMessageBox::information(
0,
i18n("<b>Gdb command sent when debugger is not running</b><br>"
"The command was:<br> %1").arg(cmd->initialString()),
i18n("Internal error"), "gdb_error");
return;
}
if (stateReloadInProgress_)
stateReloadingCommands_.insert(cmd);
if (queue_where == queue_at_front)
cmdList_.insert(0, cmd);
else if (queue_where == queue_at_end)
cmdList_.append (cmd);
else if (queue_where == queue_before_run)
{
unsigned i;
for (i = 0; i < cmdList_.count(); ++i)
if (cmdList_.at(i)->isRun())
break;
cmdList_.insert(i, cmd);
}
kdDebug(9012) << "QUEUE: " << cmd->initialString()
<< (stateReloadInProgress_ ? " (state reloading)\n" : "\n");
setStateOn(s_dbgBusy);
emit dbgStatus("", state_);
raiseEvent(debugger_busy);
executeCmd();
}
// **************************************************************************
// If the appliction can accept a command and we've got one waiting
// then send it.
// Commands can be just request for data (or change gdbs state in someway)
// or they can be "run" commands. If a command is sent to gdb our internal
// state will get updated.
void GDBController::executeCmd()
{
if (stateIsOn(s_dbgNotStarted|s_waitForWrite|s_shuttingDown) || !dbgProcess_)
{
return;
}
if (!currentCmd_)
{
if (cmdList_.isEmpty())
return;
currentCmd_ = cmdList_.take(0);
}
else
{
return;
}
QString commandText = currentCmd_->cmdToSend();
bool bad_command = false;
QString message;
unsigned length = commandText.length();
// No i18n for message since it's mainly for debugging.
if (length == 0)
{
// The command might decide it's no longer necessary to send
// it.
if (SentinelCommand* sc = dynamic_cast<SentinelCommand*>(currentCmd_))
{
kdDebug(9012) << "SEND: sentinel command, not sending\n";
sc->invokeHandler();
}
else
{
kdDebug(9012) << "SEND: command " << currentCmd_->initialString()
<< " changed its mind, not sending\n";
}
destroyCurrentCommand();
executeCmd();
commandDone();
return;
}
else
{
if (commandText[length-1] != '\n')
{
bad_command = true;
message = "Debugger command does not end with newline";
}
}
if (bad_command)
{
KMessageBox::information(0, i18n("<b>Invalid debugger command</b><br>")
+ message,
i18n("Invalid debugger command"), "gdb_error");
return;
}
kdDebug(9012) << "SEND: " << commandText;
dbgProcess_->writeStdin(commandText.local8Bit(),
commandText.length());
setStateOn(s_waitForWrite);
QString prettyCmd = currentCmd_->cmdToSend();
prettyCmd.replace( QRegExp("set prompt \032.\n"), "" );
prettyCmd = "(gdb) " + prettyCmd;
if (currentCmd_->isUserCommand())
emit gdbUserCommandStdout( prettyCmd.latin1() );
else
emit gdbInternalCommandStdout( prettyCmd.latin1() );
emit dbgStatus ("", state_);
}
// **************************************************************************
void GDBController::destroyCmds()
{
if (currentCmd_)
{
destroyCurrentCommand();
}
while (!cmdList_.isEmpty())
delete cmdList_.take(0);
}
// Pausing an app removes any pending run commands so that the app doesn't
// start again. If we want to be silent then we remove any pending info
// commands as well.
void GDBController::pauseApp()
{
setStateOn(s_explicitBreakInto);
/* FIXME: need to decide if we really
need this, and the consistenly mark
info commands as such.
int i = cmdList_.count();
while (i)
{
i--;
DbgCommand *cmd = cmdList_.at(i);
if (cmd->isAnInfoCmd())
delete cmdList_.take(i);
}
*/
if (dbgProcess_)
dbgProcess_->kill(SIGINT);
}
void GDBController::actOnProgramPauseMI(const GDBMI::ResultRecord& r)
{
// Is this stop on shared library load? Gdb smartly does not
// print any 'reason' field in this case.
bool shared_library_load = false;
if (currentCmd_)
{
const QValueVector<QString>& lines = currentCmd_->allStreamOutput();
for(unsigned int i = 0; i < lines.count(); ++i)
{
if (lines[i].startsWith("Stopped due to shared library event"))
{
shared_library_load = true;
break;
}
}
}
if (shared_library_load)
{
raiseEvent(shared_library_loaded);
queueCmd(new GDBCommand("-exec-continue"));
return;
}
if (!r.hasField("reason"))
{
// FIXME: throw an exception, and add the gdb reply in the
// caller. Show message box in the caller, not here.
// FIXME: remove this 'bla-bla-bla'.
KMessageBox::detailedSorry(
0,
i18n("<b>Invalid gdb reply</b>"
"<p>The 'stopped' packet does not include the 'reason' field'."),
i18n("The gdb reply is: bla-bla-bla"),
i18n("Invalid gdb reply"));
return;
}
QString reason = r["reason"].literal();
if (reason == "exited-normally" || reason == "exited")
{
programNoApp("Exited normally", false);
programHasExited_ = true;
state_reload_needed = false;
return;
}
if (reason == "exited-signalled")
{
programNoApp(i18n("Exited on signal %1")
.arg(r["signal-name"].literal()), false);
// FIXME: figure out why this variable is needed.
programHasExited_ = true;
state_reload_needed = false;
return;
}
if (reason == "watchpoint-scope")
{
QString number = r["wpnum"].literal();
// FIXME: shuld remove this watchpoint
// But first, we should consider if removing all
// watchpoinst on program exit is the right thing to
// do.
queueCmd(new GDBCommand("-exec-continue"));
state_reload_needed = false;
return;
}
if (reason == "signal-received")
{
QString name = r["signal-name"].literal();
QString user_name = r["signal-meaning"].literal();
// SIGINT is a "break into running program".
// We do this when the user set/mod/clears a breakpoint but the
// application is running.
// And the user does this to stop the program also.
bool suppress_reporting = false;
if (name == "SIGINT" && stateIsOn(s_explicitBreakInto))
{
suppress_reporting = true;
// TODO: check that we do something reasonable on
// implicit break into program (for setting breakpoints,
// or whatever).
setStateOff(s_explicitBreakInto);
emit dbgStatus("Application interrupted", state_);
// Will show the source line in the code
// handling non-special stop kinds, below.
}
if (!suppress_reporting)
{
// Whenever we have a signal raised then tell the user, but don't
// end the program as we want to allow the user to look at why the
// program has a signal that's caused the prog to stop.
// Continuing from SIG FPE/SEGV will cause a "Cannot ..." and
// that'll end the program.
KMessageBox::information(0,
i18n("Program received signal %1 (%2)")
.arg(name).arg(user_name),
i18n("Received signal"));
}
}
if (reason == "breakpoint-hit")
{
int id = r["bkptno"].literal().toInt();
emit breakpointHit(id);
}
}
void GDBController::reloadProgramState()
{
const GDBMI::ResultRecord& r = *last_stop_result;
// In gdb 6.3, the *stopped reply does not include full
// name of the source file. Need to send extra command.
// Don't send it unless there was 'line' field in last *stopped response.
// The command has a bug that makes it always returns some file/line,
// even if we're not in one.
//
// FIXME: For gdb 6.4, should not send extra commands.
// That's for later, so that I verify that this three-command
// approach works fine.
if (r.hasField("frame") && r["frame"].hasField("line"))
queueCmd(new GDBCommand(
"-file-list-exec-source-file",
this,
&GDBController::handleMiFileListExecSourceFile));
else
{
maybeAnnounceWatchpointHit();
}
emit dbgStatus ("", state_);
// We're always at frame zero when the program stops
// and we must reset the active flag
if (r.hasField("thread-id"))
viewedThread_ = r["thread-id"].literal().toInt();
else
viewedThread_ = -1;
currentFrame_ = 0;
raiseEvent(program_state_changed);
state_reload_needed = false;
}
// **************************************************************************
// There is no app anymore. This can be caused by program exiting
// an invalid program specified or ...
// gdb is still running though, but only the run command (may) make sense
// all other commands are disabled.
void GDBController::programNoApp(const QString &msg, bool msgBox)
{
setState(s_appNotStarted|s_programExited|(state_&s_shuttingDown));
destroyCmds();
// We're always at frame zero when the program stops
// and we must reset the active flag
viewedThread_ = -1;
currentFrame_ = 0;
// The application has existed, but it's possible that
// some of application output is still in the pipe. We use
// different pipes to communicate with gdb and to get application
// output, so "exited" message from gdb might have arrived before
// last application output. Get this last bit.
// Note: this method can be called when we open an invalid
// core file. In that case, tty_ won't be set.
if (tty_)
tty_->readRemaining();
// Tty is no longer usable, delete it. Without this, QSocketNotifier
// will continiously bomd STTY with signals, so we need to either disable
// QSocketNotifier, or delete STTY. The latter is simpler, since we can't
// reuse it for future debug sessions anyway.
delete tty_;
tty_ = 0;
raiseEvent(program_exited);
if (msgBox)
KMessageBox::information(0, i18n("gdb message:\n")+msg,"Warning", "gdb_error");
emit dbgStatus (msg, state_);
/* Also show message in gdb window, so that users who
prefer to look at gdb window know what's up. */
emit gdbUserCommandStdout(msg.ascii());
}
void GDBController::parseCliLine(const QString& line)
{
if (line.startsWith("The program no longer exists")
|| line.startsWith("Program exited")
|| line.startsWith("Program terminated"))
{
programNoApp(line, false);
return;
}
#if 0
if (strncmp(buf, "No symbol", 9) == 0 || // watch point failed
strncmp(buf, "Single", 6) == 0 || // Single stepping
strncmp(buf, "No source file named", 20) == 0 || // breakpoint not set
strncmp(buf, "[Switching to Thread", 20) == 0 || //
strncmp(buf, "[Thread debugging using", 23) == 0 ||
strncmp(buf, "Current language:", 17) == 0 ||
strncmp(buf, "Error while mapping shared library sections:", 44) == 0 ||
strncmp(buf, "Error while reading shared library symbols:", 43) == 0 ||
*buf == ':' )
{
// We don't change state, because this falls out when a run command
// starts rather than when a run command stops.
// Or.... it falls out with other messages that _are_ handled.
return;
}
#endif
#if 0
/// @todo - Only do this at start up
if (
strstr(buf, "not in executable format:") ||
strstr(buf, "No such file or directory.") || // does this fall out?
strstr(buf, i18n("No such file or directory.").local8Bit())|| // from system via gdb
strstr(buf, "is not a core dump:") ||
strncmp(buf, "ptrace: No such process.", 24)==0 ||
strncmp(buf, "ptrace: Operation not permitted.", 32)==0 ||
strncmp(buf, "No executable file specified.", 29)==0)
{
programNoApp(QString(buf), true);
kdDebug(9012) << "Bad file <" << buf << ">" << endl;
return;
}
#endif
}
void GDBController::handleMiFileListExecSourceFile(const GDBMI::ResultRecord& r)
{
if (r.reason != "done")
{
return;
// FIXME: throw an exception here. Move reporting
// to the caller, who knows the gdb output.
#if 0
KMessageBox::information(
0,
i18n("Invalid gdb reply\n"
"Command was: %1\n"
"Response is: %2\n"
"Invalid response kind: \"%3\"")
.arg(currentCmd_->rawDbgCommand())
.arg(buf)
.arg(r.reason),
i18n("Invalid gdb reply"), "gdb_error");
#endif
}
QString fullname = "";
if (r.hasField("fullname"))
fullname = r["fullname"].literal();
showStepInSource(fullname,
r["line"].literal().toInt(),
(*last_stop_result)["frame"]["addr"].literal());
/* Watchpoint hit is announced only after we've highlighted
the current line. */
maybeAnnounceWatchpointHit();
last_stop_result.reset();
}
void GDBController::maybeAnnounceWatchpointHit()
{
/* For some cases, for example catchpoints,
gdb does not report any reason at all. */
if ((*last_stop_result).hasField("reason"))
{
QString last_stop_reason = (*last_stop_result)["reason"].literal();
if (last_stop_reason == "watchpoint-trigger")
{
emit watchpointHit((*last_stop_result)["wpt"]["number"]
.literal().toInt(),
(*last_stop_result)["value"]["old"].literal(),
(*last_stop_result)["value"]["new"].literal());
}
else if (last_stop_reason == "read-watchpoint-trigger")
{
emit dbgStatus ("Read watchpoint triggered", state_);
}
}
}
void GDBController::handleMiFrameSwitch(const GDBMI::ResultRecord& r)
{
raiseEvent(thread_or_frame_changed);
const GDBMI::Value& frame = r["frame"];
QString file;
if (frame.hasField("fullname"))
file = frame["fullname"].literal();
else if (frame.hasField("file"))
file = frame["file"].literal();
int line = -1;
if (frame.hasField("line"))
line = frame["line"].literal().toInt();
showStepInSource(file,
line,
frame["addr"].literal());
}
// **************************************************************************
// SLOTS
// *****
// For most of these slots data can only be sent to gdb when it
// isn't busy and it is running.
// **************************************************************************
bool GDBController::start(const QString& shell, const DomUtil::PairList& run_envvars, const QString& run_directory, const QString &application, const QString& run_arguments)
{
kdDebug(9012) << "Starting debugger controller\n";
badCore_ = QString();
Q_ASSERT (!dbgProcess_ && !tty_);
dbgProcess_ = new KProcess;
connect( dbgProcess_, SIGNAL(receivedStdout(KProcess *, char *, int)),
this, SLOT(slotDbgStdout(KProcess *, char *, int)) );
connect( dbgProcess_, SIGNAL(receivedStderr(KProcess *, char *, int)),
this, SLOT(slotDbgStderr(KProcess *, char *, int)) );
connect( dbgProcess_, SIGNAL(wroteStdin(KProcess *)),
this, SLOT(slotDbgWroteStdin(KProcess *)) );
connect( dbgProcess_, SIGNAL(processExited(KProcess*)),
this, SLOT(slotDbgProcessExited(KProcess*)) );
application_ = application;
QString gdb = "gdb";
// Prepend path to gdb, if needed. Using QDir,
// path can either end with slash, or not.
if (!config_gdbPath_.isEmpty())
{
gdb = config_gdbPath_;
}
if (!shell.isEmpty())
{
*dbgProcess_ << "/bin/sh" << "-c" << shell + " " + gdb +
+ " " + application + " --interpreter=mi2 -quiet";
emit gdbUserCommandStdout(
QString( "/bin/sh -c " + shell + " " + gdb
+ " " + application
+ " --interpreter=mi2 -quiet\n" ).latin1());
}
else
{
*dbgProcess_ << gdb << application
<< "-interpreter=mi2" << "-quiet";
emit gdbUserCommandStdout(
QString( gdb + " " + application +
" --interpreter=mi2 -quiet\n" ).latin1());
}
if (!dbgProcess_->start( KProcess::NotifyOnExit,
KProcess::Communication(KProcess::All)))
{
KMessageBox::information(
0,
i18n("<b>Could not start debugger.</b>"
"<p>Could not run '%1'. "
"Make sure that the path name is specified correctly."
).arg(dbgProcess_->args()[0]),
i18n("Could not start debugger"), "gdb_error");
return false;
}
setStateOff(s_dbgNotStarted);
emit dbgStatus ("", state_);
saw_gdb_prompt_ = false;
// Initialise gdb. At this stage gdb is sitting wondering what to do,
// and to whom. Organise a few things, then set up the tty for the application,
// and the application itself
// The following two are not necessary in MI, and the first one
// just breaks MI completely.
// queueCmd(new GDBCommand("set edit off", NOTRUNCMD, NOTINFOCMD, 0));
// queueCmd(new GDBCommand("set confirm off", NOTRUNCMD, NOTINFOCMD));
if (config_displayStaticMembers_)
queueCmd(new GDBCommand("set print static-members on"));
else
queueCmd(new GDBCommand("set print static-members off"));
// This makes gdb pump a variable out on one line.
queueCmd(new GDBCommand("set width 0"));
queueCmd(new GDBCommand("set height 0"));
queueCmd(new GDBCommand("handle SIG32 pass nostop noprint"));
queueCmd(new GDBCommand("handle SIG41 pass nostop noprint"));
queueCmd(new GDBCommand("handle SIG42 pass nostop noprint"));
queueCmd(new GDBCommand("handle SIG43 pass nostop noprint"));
// Print some nicer names in disassembly output. Although for an assembler
// person this may actually be wrong and the mangled name could be better.
if (config_asmDemangle_)
queueCmd(new GDBCommand("set print asm-demangle on"));
else
queueCmd(new GDBCommand("set print asm-demangle off"));
// make sure output radix is always set to users view.
queueCmd(new GDBCommand(QCString().sprintf("set output-radix %d", config_outputRadix_)));
// Change the "Working directory" to the correct one
QCString tmp( "cd " + QFile::encodeName( run_directory ));
queueCmd(new GDBCommand(tmp));
// Set the run arguments
if (!run_arguments.isEmpty())
queueCmd(
new GDBCommand(QCString("set args ") + run_arguments.local8Bit()));
// Get the run environment variables pairs into the environstr string
// in the form of: "ENV_VARIABLE=ENV_VALUE" and send to gdb using the
// "set enviroment" command
// Note that we quote the variable value due to the possibility of
// embedded spaces
QString environstr;
DomUtil::PairList::ConstIterator it;
for (it = run_envvars.begin(); it != run_envvars.end(); ++it)
{
environstr = "set environment ";
environstr += (*it).first;
environstr += "=";
environstr += (*it).second;
queueCmd(new GDBCommand(environstr.latin1()));
}
queueCmd(new GDBCommand(
"-list-features", this,
&GDBController::handleListFeatures, true /* handles error */));
queueCmd(new SentinelCommand(this, &GDBController::startDone));
// Now gdb has been started and the application has been loaded,
// BUT the app hasn't been started yet! A run command is about to be issued
// by whoever is controlling us. Or we might be asked to load a core, or
// attach to a running process.
return true;
}
void GDBController::startDone()
{
// Needed so that breakpoint widget has a chance to insert breakpoints.
// FIXME: a bit hacky, as we're really not ready for new commands.
setStateOn(s_dbgBusy);
raiseEvent(debugger_ready);
raiseEvent(connected_to_program);
}
void GDBController::handleListFeatures(const GDBMI::ResultRecord& r)
{
mi_pending_breakpoints_ = false;
if (r.reason == "done")
{
const GDBMI::Value& features = r["features"];
for (unsigned i = 0; i < features.size(); ++i)
if (features[i].literal() == "pending-breakpoints")
{
mi_pending_breakpoints_ = true;
}
}
if (!mi_pending_breakpoints_)
{
// This version of GDB does not support pending breakpoints in MI,
// so use a workaround.
// The below command makes GDB notify us about shared library
// events, and on each stop we'll try to set breakpoint again.
addCommandToFront(new GDBCommand("set stop-on-solib-events 1"));
}
}
// **************************************************************************
void GDBController::slotStopDebugger()
{
kdDebug(9012) << "GDBController::slotStopDebugger() called" << endl;
if (stateIsOn(s_shuttingDown) || !dbgProcess_)
return;
setStateOn(s_shuttingDown);
kdDebug(9012) << "GDBController::slotStopDebugger() executing" << endl;
QTime start;
QTime now;
// Get gdb's attention if it's busy. We need gdb to be at the
// command line so we can stop it.
if (stateIsOn(s_dbgBusy))
{
kdDebug(9012) << "gdb busy on shutdown - stopping gdb (SIGINT)" << endl;
dbgProcess_->kill(SIGINT);
start = QTime::currentTime();
while (-1)
{
kapp->eventLoop()->processEvents( QEventLoop::ExcludeUserInput, 20 );
now = QTime::currentTime();
if (!stateIsOn(s_dbgBusy) || start.msecsTo( now ) > 2000)
break;
}
}
// If the app is attached then we release it here. This doesn't stop
// the app running.
if (stateIsOn(s_attached))
{
const char *detach="detach\n";
if (!dbgProcess_->writeStdin(detach, strlen(detach)))
kdDebug(9012) << "failed to write 'detach' to gdb" << endl;
emit gdbUserCommandStdout("(gdb) detach\n");
start = QTime::currentTime();
while (-1)
{
kapp->eventLoop()->processEvents( QEventLoop::ExcludeUserInput, 20 );
now = QTime::currentTime();
if (!stateIsOn(s_attached) || start.msecsTo( now ) > 2000)
break;
}
}
// Now try to stop gdb running.
const char *quit="quit\n";
if (!dbgProcess_->writeStdin(quit, strlen(quit)))
kdDebug(9012) << "failed to write 'quit' to gdb" << endl;
emit gdbUserCommandStdout("(gdb) quit");
start = QTime::currentTime();
while (-1)
{
kapp->eventLoop()->processEvents( QEventLoop::ExcludeUserInput, 20 );
now = QTime::currentTime();
if (stateIsOn(s_programExited) || start.msecsTo( now ) > 2000)
break;
}
// We cannot wait forever.
if (!stateIsOn(s_programExited))
{
kdDebug(9012) << "gdb not shutdown - killing" << endl;
dbgProcess_->kill(SIGKILL);
}
destroyCmds();
delete dbgProcess_; dbgProcess_ = 0;
delete tty_; tty_ = 0;
// The gdb output buffer might contain start marker of some
// previously issued command that crashed gdb (so there's no end marker)
// If we don't clear this, then after restart, we'll be trying to search
// for the end marker of the command issued in previous gdb session,
// and never succeed.
gdbOutput_ = "";
setState(s_dbgNotStarted | s_appNotStarted);
emit dbgStatus (i18n("Debugger stopped"), state_);
raiseEvent(debugger_exited);
}
// **************************************************************************
void GDBController::slotCoreFile(const QString &coreFile)
{
setStateOff(s_programExited|s_appNotStarted);
setStateOn(s_core);
queueCmd(new GDBCommand(QCString("core ") + coreFile.latin1()));
raiseEvent(connected_to_program);
raiseEvent(program_state_changed);
}
// **************************************************************************
void GDBController::slotAttachTo(int pid)
{
setStateOff(s_appNotStarted|s_programExited);
setStateOn(s_attached);
// Currently, we always start debugger with a name of binary,
// we might be connecting to a different binary completely,
// so cancel all symbol tables gdb has.
// We can't omit application name from gdb invocation
// because for libtool binaries, we have no way to guess
// real binary name.
queueCmd(new GDBCommand(QString("file")));
// The MI interface does not implements -target-attach yet,
// and we don't recognize whatever gibberish 'attach' pours out, so...
queueCmd(new GDBCommand(
QCString().sprintf("attach %d", pid)));
raiseEvent(connected_to_program);
// ...emit a separate MI command to step one instruction more. We'll
// notice the '*stopped' response from it and proceed as usual.
queueCmd(new GDBCommand("-exec-step-instruction"));
}
// **************************************************************************
void GDBController::slotRun()
{
if (stateIsOn(s_dbgNotStarted|s_shuttingDown))
return;
if (stateIsOn(s_appNotStarted)) {
delete tty_;
tty_ = new STTY(config_dbgTerminal_, Settings::terminalEmulatorName( *kapp->config() ));
if (!config_dbgTerminal_)
{
connect( tty_, SIGNAL(OutOutput(const char*)), SIGNAL(ttyStdout(const char*)) );
connect( tty_, SIGNAL(ErrOutput(const char*)), SIGNAL(ttyStderr(const char*)) );
}
QString tty(tty_->getSlave());
if (tty.isEmpty())
{
KMessageBox::information(0, i18n("GDB cannot use the tty* or pty* devices.\n"
"Check the settings on /dev/tty* and /dev/pty*\n"
"As root you may need to \"chmod ug+rw\" tty* and pty* devices "
"and/or add the user to the tty group using "
"\"usermod -G tty username\"."), "Warning", "gdb_error");
delete tty_;
tty_ = 0;
return;
}
queueCmd(new GDBCommand(QCString("tty ")+tty.latin1()));
if (!config_runShellScript_.isEmpty()) {
// Special for remote debug...
QCString tty(tty_->getSlave().latin1());
QCString options = QCString(">") + tty + QCString(" 2>&1 <") + tty;
KProcess *proc = new KProcess;
*proc << "sh" << "-c";
*proc << config_runShellScript_ +
" " + application_.latin1() + options;
proc->start(KProcess::DontCare);
}
if (!config_runGdbScript_.isEmpty()) {// gdb script at run is requested
// Race notice: wait for the remote gdbserver/executable
// - but that might be an issue for this script to handle...
// Future: the shell script should be able to pass info (like pid)
// to the gdb script...
queueCmd(new GDBCommand("source " + config_runGdbScript_));
// Note: script could contain "run" or "continue"
}
else {
QFileInfo app(application_);
if (!app.exists())
{
KMessageBox::error(
0,
i18n("<b>Application does not exist</b>"
"<p>The application you're trying to debug,<br>"
" %1\n"
"<br>does not exist. Check that you've specified "
"the right application in the debugger configuration."
).arg(app.fileName()),
i18n("Application does not exist"));
// FIXME: after this, KDevelop will still show that debugger
// is running, because DebuggerPart::slotStopDebugger won't be
// called, and core()->running(this, false) won't be called too.
slotStopDebugger();
return;
}
if (!app.isExecutable())
{
KMessageBox::error(
0,
i18n("<b>Could not run application '%1'.</b>"
"<p>The application does not have the executable bit set. "
"Try rebuilding the project, or change permissions "
"manually."
).arg(app.fileName()),
i18n("Could not run application"));
slotStopDebugger();
}
else
{
GDBCommand *cmd = new GDBCommand("-exec-run");
cmd->setRun(true);
queueCmd(cmd);
}
}
}
else {
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-continue"));
}
setStateOff(s_appNotStarted|s_programExited);
}
void GDBController::slotKill()
{
if (stateIsOn(s_dbgNotStarted|s_shuttingDown))
return;
if (stateIsOn(s_dbgBusy))
{
pauseApp();
}
queueCmd(new GDBCommand("kill"));
setStateOn(s_appNotStarted);
}
// **************************************************************************
void GDBController::slotRunUntil(const QString &fileName, int lineNum)
{
if (stateIsOn(s_dbgBusy|s_dbgNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
if (fileName.isEmpty())
queueCmd(new GDBCommand(
QCString().sprintf("-exec-until %d", lineNum)));
else
queueCmd(new GDBCommand(
QCString().
sprintf("-exec-until %s:%d", fileName.latin1(), lineNum)));
}
// **************************************************************************
void GDBController::slotJumpTo(const QString &fileName, int lineNum)
{
if (stateIsOn(s_dbgBusy|s_dbgNotStarted|s_shuttingDown))
return;
if (!fileName.isEmpty()) {
queueCmd(new GDBCommand(QCString().sprintf("tbreak %s:%d", fileName.latin1(), lineNum)));
queueCmd(new GDBCommand(QCString().sprintf("jump %s:%d", fileName.latin1(), lineNum)));
}
}
// **************************************************************************
void GDBController::slotStepInto()
{
if (stateIsOn(s_dbgBusy|s_appNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-step"));
}
// **************************************************************************
void GDBController::slotStepIntoIns()
{
if (stateIsOn(s_dbgBusy|s_appNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-step-instruction"));
}
// **************************************************************************
void GDBController::slotStepOver()
{
if (stateIsOn(s_dbgBusy|s_appNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-next"));
}
// **************************************************************************
void GDBController::slotStepOverIns()
{
if (stateIsOn(s_dbgBusy|s_appNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-next-instruction"));
}
// **************************************************************************
void GDBController::slotStepOutOff()
{
if (stateIsOn(s_dbgBusy|s_appNotStarted|s_shuttingDown))
return;
removeStateReloadingCommands();
queueCmd(new GDBCommand("-exec-finish"));
}
// **************************************************************************
// Only interrupt a running program.
void GDBController::slotBreakInto()
{
pauseApp();
}
// **************************************************************************
void GDBController::selectFrame(int frameNo, int threadNo)
{
// FIXME: this either should be removed completely, or
// trigger an error message.
if (stateIsOn(s_dbgBusy|s_dbgNotStarted|s_shuttingDown))
return;
if (threadNo != -1)
{
if (viewedThread_ != threadNo)
queueCmd(new GDBCommand(
QString("-thread-select %1").arg(threadNo).ascii()));
}
queueCmd(new GDBCommand(
QString("-stack-select-frame %1").arg(frameNo).ascii()));
// Will emit the 'thread_or_frame_changed' event.
queueCmd(new GDBCommand("-stack-info-frame",
this, &GDBController::handleMiFrameSwitch));
// FIXME: the above commands might not be the first in queue, and
// previous commands might using values of 'viewedThread_' or
// 'currentFrame_'. Ideally, should change the values only after
// response from gdb.
viewedThread_ = threadNo;
currentFrame_ = frameNo;
}
// **************************************************************************
void GDBController::defaultErrorHandler(const GDBMI::ResultRecord& result)
{
QString msg = result["msg"].literal();
if (msg.contains("No such process"))
{
setState(s_appNotStarted|s_programExited);
emit dbgStatus (i18n("Process exited"), state_);
raiseEvent(program_exited);
return;
}
KMessageBox::information(
0,
i18n("<b>Debugger error</b>"
"<p>Debugger reported the following error:"
"<p><tt>") + result["msg"].literal(),
i18n("Debugger error"), "gdb_error");
// Error most likely means that some change made in GUI
// was not communicated to the gdb, so GUI is now not
// in sync with gdb. Resync it.
//
// Another approach is to make each widget reload it content
// on errors from commands that it sent, but that's too complex.
// Errors are supposed to happen rarely, so full reload on error
// is not a big deal. Well, maybe except for memory view, but
// it's no auto-reloaded anyway.
//
// Also, don't reload state on errors appeared during state
// reloading!
if (stateReloadingCommands_.count(currentCmd_) == 0)
raiseEvent(program_state_changed);
}
void GDBController::processMICommandResponse(const GDBMI::ResultRecord& result)
{
kdDebug(9012) << "MI stop reason " << result.reason << "\n";
if (result.reason == "stopped")
{
actOnProgramPauseMI(result);
}
else if (result.reason == "done")
{
// At least in one case, for 'detach', debuger write
// command directly, and 'currentCmd_' will be unset.
// Checking for currentCmd_ is safer in any case.
if (currentCmd_)
{
// Assume that if this command is part of state reloading,
// then any further commands issued in command handler
// are part of state reloading as well.
if (stateReloadingCommands_.count(currentCmd_))
{
stateReloadInProgress_ = true;
}
currentCmd_->invokeHandler(result);
stateReloadInProgress_ = false;
}
}
else if (result.reason == "error")
{
// Some commands want to handle errors themself.
if (currentCmd_ && currentCmd_->handlesError() &&
currentCmd_->invokeHandler(result))
{
// Done, nothing more needed
}
else
{
defaultErrorHandler(result);
}
}
}
// Data from gdb gets processed here.
void GDBController::slotDbgStdout(KProcess *, char *buf, int buflen)
{
static bool parsing = false;
QCString msg(buf, buflen+1);
// Copy the data out of the KProcess buffer before it gets overwritten
// Append to the back of the holding zone.
holdingZone_ += QCString(buf, buflen+1);
// Already parsing? then get out quick.
// VP, 2006-01-30. I'm not sure how this could happen, since
// parsing of gdb reply should not ever execute Qt message loop. Except,
// maybe, when we pop up a message box. But even in that case,
// it's likely we won't return to slotDbgStdout again.
if (parsing)
{
kdDebug(9012) << "Already parsing" << endl;
return;
}
bool ready_for_next_command = false;
int i;
bool got_any_command = false;
// For each gdb reply. In MI mode, each reply is one string.
while((i = holdingZone_.find('\n')) != -1)
{
got_any_command = true;
QCString reply(holdingZone_.left(i));
holdingZone_ = holdingZone_.mid(i+1);
kdDebug(9012) << "REPLY: " << reply << "\n";
FileSymbol file;
file.contents = reply;
std::auto_ptr<GDBMI::Record> r(mi_parser_.parse(&file));
if (r.get() == 0)
{
// FIXME: Issue an error!
kdDebug(9012) << "Invalid MI message: " << reply << "\n";
ready_for_next_command = true;
continue;
}
try {
switch(r->kind)
{
case GDBMI::Record::Result: {
GDBMI::ResultRecord& result = static_cast<GDBMI::ResultRecord&>(*r);
if (result.reason != "running")
{
kdDebug(9012) << "Command execution time "
<< commandExecutionTime.elapsed() << " ms.\n";
}
/* The currentCmd_ may be NULL here, because when detaching
from debugger, we directly write "detach" to gdb and
busy-wait for a reply. Uisng the commands mechanism
won't work there, because command result are
communicated asynchronously.
This is will be fixed in KDevelop4. */
if (currentCmd_ && currentCmd_->isUserCommand())
emit gdbUserCommandStdout(reply);
else
emit gdbInternalCommandStdout(reply + "\n");
if (result.reason == "stopped")
{
// Transfers ownership.
// Needed so that in
// handleMiFileListExecSourceFile(GDBMI::ResultRecord& r);
// we can use the last stop reason.
last_stop_result.reset(static_cast<GDBMI::ResultRecord*>(r.get()));
r.release();
state_reload_needed = true;
}
else if (result.reason == "running")
{
setStateOn(s_appRunning);
raiseEvent(program_running);
}
// All MI commands have just one response, except for
// run-like command, which result in
//
// ^running
//
// followed by
//
// stopped.
ready_for_next_command = (result.reason != "running");
if (ready_for_next_command)
{
// Need to do this before procesing response,
// so that when processing response we don't
// think that application is running.
setStateOff(s_appRunning);
}
processMICommandResponse(result);
if (ready_for_next_command)
{
destroyCurrentCommand();
}
break;
}
case GDBMI::Record::Stream: {
GDBMI::StreamRecord& s = dynamic_cast<GDBMI::StreamRecord&>(*r);
/* The way current code works is that we start gdb,
and immediately send commands to it without waiting for
a prompt. As result, when we return back to the event
loop and read the first line from GDB, currentCmd_ is
already set. But really, we want to output everything
that gdb prints prior to prompt -- it might be
output from user's .gdbinit that user cares about. */
if (!saw_gdb_prompt_
|| !currentCmd_ || currentCmd_->isUserCommand())
emit gdbUserCommandStdout(s.message.ascii());
else
emit gdbInternalCommandStdout(s.message.ascii());
if (currentCmd_)
currentCmd_->newOutput(s.message);
parseCliLine(s.message);
static QRegExp print_output("^\\$(\\d+) = ");
if (print_output.search(s.message) != -1)
{
kdDebug(9012) << "Found 'print' output: " << s.message << "\n";
print_command_result = s.message.ascii();
}
/* This is output from the program. Route it to
the Application window. */
if (s.reason == '@')
emit ttyStderr(s.message.ascii());
break;
}
case GDBMI::Record::Prompt:
saw_gdb_prompt_ = true;
break;
}
}
catch(const std::exception& e)
{
KMessageBox::detailedSorry(
0,
i18n("<b>Internal debugger error</b>",
"<p>The debugger component encountered internal error while "
"processing reply from gdb. Please submit a bug report."),
i18n("The exception is: %1\n"
"The MI response is: %2").arg(e.what()).arg(reply),
i18n("Internal debugger error"));
destroyCurrentCommand();
ready_for_next_command = true;
}
}
// check the queue for any commands to send
if (ready_for_next_command)
{
executeCmd();
}
if (got_any_command)
kdDebug(9012) << "COMMANDS: " << cmdList_.count() << " in queue, "
<< int(bool(currentCmd_)) << " executing\n";
commandDone();
}
void GDBController::commandDone()
{
bool no_more_commands = (cmdList_.isEmpty() && !currentCmd_);
if (no_more_commands && state_reload_needed)
{
kdDebug(9012) << "Finishing program stop\n";
// Set to false right now, so that if 'actOnProgramPauseMI_part2'
// sends some commands, we won't call it again when handling replies
// from that commands.
state_reload_needed = false;
reloadProgramState();
}
if (no_more_commands)
{
kdDebug(9012) << "No more commands\n";
setStateOff(s_dbgBusy);
emit dbgStatus("", state_);
raiseEvent(debugger_ready);
}
}
void GDBController::destroyCurrentCommand()
{
stateReloadingCommands_.erase(currentCmd_);
delete currentCmd_;
currentCmd_ = 0;
}
void GDBController::removeStateReloadingCommands()
{
int i = cmdList_.count();
while (i)
{
i--;
GDBCommand* cmd = cmdList_.at(i);
if (stateReloadingCommands_.count(cmd))
{
kdDebug(9012) << "UNQUEUE: " << cmd->initialString() << "\n";
delete cmdList_.take(i);
}
}
if (stateReloadingCommands_.count(currentCmd_))
{
// This effectively prevents handler for this command
// to be ever invoked.
destroyCurrentCommand();
}
}
void GDBController::raiseEvent(event_t e)
{
if (e == program_exited || e == debugger_exited)
{
stateReloadInProgress_ = false;
}
if (e == program_state_changed)
{
stateReloadInProgress_ = true;
kdDebug(9012) << "State reload in progress\n";
}
emit event(e);
if (e == program_state_changed)
{
stateReloadInProgress_ = false;
}
}
void GDBController::slotDbgStderr(KProcess *proc, char *buf, int buflen)
{
// At the moment, just drop a message out and redirect
kdDebug(9012) << "STDERR: " << QString::fromLatin1(buf, buflen+1) << endl;
slotDbgStdout(proc, buf, buflen);
}
// **************************************************************************
void GDBController::slotDbgWroteStdin(KProcess *)
{
commandExecutionTime.start();
setStateOff(s_waitForWrite);
// FIXME: need to remove s_waitForWrite flag completely.
executeCmd();
}
// **************************************************************************
void GDBController::slotDbgProcessExited(KProcess* process)
{
Q_ASSERT(process == dbgProcess_);
bool abnormal = !process->normalExit();
delete dbgProcess_;
dbgProcess_ = 0;
delete tty_;
tty_ = 0;
if (abnormal)
emit debuggerAbnormalExit();
raiseEvent(debugger_exited);
destroyCmds();
setState(s_dbgNotStarted|s_appNotStarted|s_programExited);
emit dbgStatus (i18n("Process exited"), state_);
emit gdbUserCommandStdout("(gdb) Process exited\n");
}
// **************************************************************************
void GDBController::slotUserGDBCmd(const QString& cmd)
{
queueCmd(new UserCommand(cmd.latin1()));
// User command can theoreticall modify absolutely everything,
// so need to force a reload.
// We can do it right now, and don't wait for user command to finish
// since commands used to reload all view will be executed after
// user command anyway.
//if (!stateIsOn(s_appNotStarted) && !stateIsOn(s_programExited))
// raiseEvent(program_state_changed);
}
void GDBController::explainDebuggerStatus()
{
QString information("%1 commands in queue\n"
"%2 commands being processed by gdb\n"
"Debugger state: %3\n");
information =
information.arg(cmdList_.count()).arg(currentCmd_ ? 1 : 0)
.arg(state_);
if (currentCmd_)
{
QString extra("Current command class: '%1'\n"
"Current command text: '%2'\n"
"Current command origianl text: '%3'\n");
extra = extra.arg(
typeid(*currentCmd_).name()).arg(currentCmd_->cmdToSend()).
arg(currentCmd_->initialString());
information += extra;
}
KMessageBox::information(0, information, "Debugger status");
}
bool GDBController::stateIsOn(int state)
{
return state_ & state;
}
void GDBController::setStateOn(int stateOn)
{
debugStateChange(state_, state_ | stateOn);
state_ |= stateOn;
}
void GDBController::setStateOff(int stateOff)
{
debugStateChange(state_, state_ & ~stateOff);
state_ &= ~stateOff;
}
void GDBController::setState(int newState)
{
debugStateChange(state_, newState);
state_ = newState;
}
void GDBController::debugStateChange(int oldState, int newState)
{
int delta = oldState ^ newState;
if (delta)
{
QString out = "STATE: ";
for(unsigned i = 1; i < s_lastDbgState; i <<= 1)
{
if (delta & i)
{
if (i & newState)
out += "+";
else
out += "-";
bool found = false;
#define STATE_CHECK(name)\
if (i == name) { out += #name; found = true; }
STATE_CHECK(s_dbgNotStarted);
STATE_CHECK(s_appNotStarted);
STATE_CHECK(s_waitForWrite);
STATE_CHECK(s_programExited);
STATE_CHECK(s_viewBT);
STATE_CHECK(s_viewBP);
STATE_CHECK(s_attached);
STATE_CHECK(s_core);
STATE_CHECK(s_waitTimer);
STATE_CHECK(s_shuttingDown);
STATE_CHECK(s_explicitBreakInto);
STATE_CHECK(s_dbgBusy);
STATE_CHECK(s_appRunning);
#undef STATE_CHECK
if (!found)
out += QString::number(i);
out += " ";
}
}
kdDebug(9012) << out << "\n";
}
}
int GDBController::qtVersion( ) const
{
return DomUtil::readIntEntry( dom, "/kdevcppsupport/qt/version", 3 );
}
void GDBController::demandAttention() const
{
if ( QWidget * w = kapp->mainWidget() )
{
KWin::demandAttention( w->winId(), true );
}
}
bool GDBController::miPendingBreakpoints() const
{
return mi_pending_breakpoints_;
}
}
// **************************************************************************
// **************************************************************************
// **************************************************************************
#include "gdbcontroller.moc"
|