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
|
/*
Copyright (C) 2004 T. Scott Dattalo
This file is part of gpsim.
gpsim 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, or (at your option)
any later version.
gpsim is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with gpsim; see the file COPYING. If not, write to
the Free Software Foundation, 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */
#include <glib.h>
#include <string>
#include <iostream>
#include <memory>
#ifndef _WIN32
#include <pthread.h>
#endif
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include "../config.h"
#include "../src/symbol.h"
#include "../src/protocol.h"
#include "../src/gpsim_interface.h"
#include "../src/breakpoints.h"
#include "../src/gpsim_time.h"
#include "../src/trigger.h"
#include "../src/value.h"
#ifndef _WIN32
#include <sys/socket.h>
#include <netinet/in.h>
#else
#include <winsock2.h>
#endif
void exit_gpsim(int);
//#define DEBUG
#if defined(DEBUG)
#include "../config.h"
#define Dprintf(arg) {printf("%s:%d ",__FILE__,__LINE__); printf arg; }
#else
#define Dprintf(arg) {}
#endif
//******** E X P E R I M E N T A L C O D E !!! *************************
// Here is an experimental attribute for testing the socket interface.
// The purpose is to isolate socket testing from the rest of the simulator.
//
class TestInt32Array : public Value
{
public:
TestInt32Array(const char *_name, int _sz)
: Value(_name, " test array for testing sockets"),
size(_sz)
{
array = new int[size];
}
TestInt32Array(const TestInt32Array &) = delete;
TestInt32Array& operator =(const TestInt32Array &) = delete;
~TestInt32Array()
{
delete[] array;
}
void set(const char * /* cP */, int len = 0) override
{
(void)len;
std::cout << name() << " set\n";
}
void get(char *, int /* len */ ) override
{
std::cout << name() << " get\n";
}
std::string toString() override
{
return name();
}
private:
int size;
int *array;
};
//************************* end of experimental code ********************
class SocketLink;
class Socket;
// in input.cc -- parse_string sends a string through the command parser
extern int parse_string(const char * str);
#ifdef WIN32
#define snprintf _snprintf
#define socklen_t int
bool server_started = false;
void psocketerror(const char *str)
{
fprintf(stderr, "%s: %s\n", str, g_win32_error_message(WSAGetLastError()));
}
bool winsockets_init()
{
WSADATA wsaData;
int err;
if (0 != (err = WSAStartup(MAKEWORD(2, 2), &wsaData)))
{
return false;
}
/* Confirm that the WinSock DLL supports 2.2.*/
/* Note that if the DLL supports versions greater */
/* than 2.2 in addition to 2.2, it will still return */
/* 2.2 in wVersion since that is the version we */
/* requested. */
if (LOBYTE(wsaData.wVersion) != 2 || HIBYTE(wsaData.wVersion) != 2)
{
/* Tell the user that we could not find a usable */
/* WinSock DLL. */
WSACleanup();
return false;
}
return true;
}
#else
#define psocketerror(s) perror(s)
#define closesocket(s) close(s)
#define SOCKET int
#define INVALID_SOCKET -1
#endif
//
/*
gpsim sockets.
The purpose of a socket interface into the simulator is to provide an
external interface that only loosely depends upon gpsim's internals.
Towards the bottom of this file is code that will start a server
'process' that will listen for clients. This 'process' is really
a glib GIOChannel. The GIOChannel is a glib mechanism for handling
things like sockets so that they work nicely when compiled for other
platforms. Now, whenever a client connects to gpsim, another GIOChannel
is created. This new channel has the client socket associated with
it and is used to communicate with the client.
Thus, like most socket server applications, gpsim creates a single
socket to listen for clients. As clients come along, connections are
established with them. gpsim uses GLIB's GIOChannels to facilitate
the simultaneous multiple connections.
Once a client has connected to gpsim, it can do just about everything
a user sitting at a keyboard can do. In fact, the client can issue
command line commands that are directed to the command line parser.
Although, at the moment, the output of these commands still is sent
to the terminal from which the gpsim executable was spawned (instead
of being sent to the client socket...). Probably more powerful though
is the ability for a client to establish 'links' to gpsim internal
objects. These links are provide a client with an efficient access
to gpsim's symbol table.
There are two kinds of socket connection types that gpsim supports.
I call them 'Simulator Source' and 'Simulator Sink' sockets. They're
both similar in that they connect to a client through the normal
mechanism. However, they're different in how they behave while the
simulator is running. The Simulator Sink sockets are designed to be
controlled by a GLIB GIOChannel. They are intended to receive
unsolicited data from a client. In addition, since they're
controlled by a GIOChannel, they can only be processed while the GTK
main loop has control (which in the current implementation is all
time except when the simulation is running). So the idea is that
clients can send stuff to the simulator, and if the simulator is not
running, the information is processed and a response is returned to
the client.
Simulator Sources are for sending unsolicited simulator data to a
client. This is a blocking operation, i.e. it will not return until
the client has sent a response. Now, the client is responsible for
setting Simulator Source Sockets up. So during the socket connection
and initialization the client specifies what it wants the simulator
to send unsolicited. You might imagine a situation where a plugin
module may be receiving data from a script.
*/
#define SIM_SINK_PORT 0x1234
#define SIM_SOURCE_PORT 0x1235
#define BUFSIZE 8192
//------------------------------------------------------------------------
class AttributeLink;
bool ParseSocketLink(Packet *buffer, AttributeLink **);
//------------------------------------------------------------------------
//------------------------------------------------------------------------
//
class SocketInterface : public Interface
{
private:
// Socket *sock;
public:
explicit SocketInterface(Socket *);
virtual ~SocketInterface();
virtual void SimulationHasStopped(gpointer object);
virtual void Update(gpointer object);
};
//------------------------------------------------------------------------
// Socket wrapper class
//
// This class is a simple wrapper around the standard BSD socket calls.
//
class SocketBase
{
public:
explicit SocketBase(SOCKET s);
SocketBase(const SocketBase &) = delete;
SocketBase& operator =(const SocketBase &) = delete;
~SocketBase();
SOCKET getSocket();
void Close();
bool Send(const char *);
void Service();
void ParseObject();
Packet *packet;
private:
SOCKET socket;
};
//------------------------------------------------------------------------
// Socket class
// This class is responsible for listening to clients.
//
class Socket
{
public:
Socket();
~Socket();
void init(int port);
void AssignChannel(gboolean(*server_func)(GIOChannel *, GIOCondition, void *));
void Close(SocketBase**);
void Bind();
void Listen();
SocketBase * Accept();
SocketBase *my_socket;
struct sockaddr_in addr;
};
class SocketLink
{
public:
SocketLink(unsigned int _handle, SocketBase *);
virtual ~SocketLink()
{
}
/// Send a response back to the link.
/// if the bTimeStamp is true, then the cycle counter is sent too.
bool Send(bool bTimeStamp = false);
bool Receive();
virtual void set(Packet &) = 0;
virtual void get(Packet &) = 0;
unsigned int getHandle()
{
return handle;
}
void setBlocking(bool bBlocking)
{
bWaitForResponse = bBlocking;
}
bool bBlocking()
{
return bWaitForResponse;
}
private:
unsigned int handle;
SocketBase *parent;
bool bWaitForResponse;
};
///========================================================================
/// AttributeLink
/// An attribute link is a link associated with a gpsim attribute.
/// Clients will establish attribute links by providing the name
/// of the gpsim object with which they wish to link. The over head
/// for parsing the link name and looking it up in the table only
/// has to be done once.
class AttributeLink : public SocketLink
{
public:
AttributeLink(unsigned int _handle, SocketBase *, gpsimObject *);
virtual ~AttributeLink()
{
}
void set(Packet &) override;
void get(Packet &) override;
//Value *getValue()
gpsimObject *getValue()
{
return v;
}
private:
/// This is a pointer to the gpsim Value object associated with
/// this link.
// Value *v;
gpsimObject *v;
};
///========================================================================
/// NotifyLink
/// A notify link is a link designed to be a sort of cross reference. It
/// is associated with a gpsim attribute in such a way that whenever the
/// gpsim attribute changes, the notify link will notify a client socket.
class NotifyLink : public XrefObject
{
public:
explicit NotifyLink(AttributeLink *);
void set(gint64);
void update();
private:
AttributeLink *sl;
};
///========================================================================
/// CyclicCallBackLink
/// A cyclic call back link is a link that periodically sends a message
/// to the client.
class CyclicCallBackLink : public TriggerObject
{
public:
CyclicCallBackLink(guint64, SocketBase *);
~CyclicCallBackLink();
void callback() override;
void callback_print() override;
private:
guint64 interval;
SocketBase *sb;
};
//========================================================================
#define nSOCKET_LINKS 16
AttributeLink *links[nSOCKET_LINKS];
AttributeLink *gCreateSocketLink(unsigned int, Packet &, SocketBase *);
unsigned int FindFreeHandle()
{
unsigned int i;
static unsigned int sequence = 0;
for (i = 0; i < nSOCKET_LINKS; i++)
if (links[i] == nullptr)
{
return i | (++sequence << 16);
}
return 0xffff;
}
//========================================================================
SocketBase::SocketBase(SOCKET s)
: socket(s)
{
packet = new Packet(BUFSIZE, BUFSIZE);
}
SocketBase::~SocketBase()
{
delete packet;
}
SOCKET SocketBase::getSocket()
{
return socket;
}
void SocketBase::Close()
{
if (socket != INVALID_SOCKET)
{
closesocket(socket);
}
socket = INVALID_SOCKET;
}
//========================================================================
bool ParseSocketLink(Packet *buffer, AttributeLink **al)
{
if (!al)
{
return false;
}
unsigned int handle;
if (buffer->DecodeUInt32(handle))
{
*al = links[handle & 0x0f];
if ((*al) && (*al)->getHandle() != handle)
{
*al = nullptr;
}
return true;
}
*al = nullptr;
printf("ParseSocketLink fail no handle\n");
return false;
}
//========================================================================
void CloseSocketLink(SocketLink *sl)
{
if (!sl)
{
return;
}
unsigned int handle = sl->getHandle();
std::cout << " closing link with handle 0x" << std::hex << handle << '\n';
if (links[handle & 0x000f] == sl)
{
links[handle & 0x000f] = nullptr;
}
}
//========================================================================
Socket::Socket()
{
my_socket = nullptr;
for (int i = 0; i < nSOCKET_LINKS; i++)
{
links[i] = nullptr;
}
}
Socket::~Socket()
{
Close(&my_socket);
}
void Socket::init(int port)
{
SOCKET new_socket;
if ((new_socket = socket(AF_INET, SOCK_STREAM, 0)) == INVALID_SOCKET)
{
psocketerror("socket");
exit_gpsim(1);
}
my_socket = new SocketBase(new_socket);
int on = 1;
if (setsockopt(new_socket, SOL_SOCKET, SO_REUSEADDR, (const char*) &on, sizeof(on)) != 0)
{
psocketerror("setsockopt");
exit_gpsim(1);
}
memset(&addr, 0, sizeof(addr));
addr.sin_family = AF_INET;
addr.sin_addr.s_addr = INADDR_ANY;
addr.sin_port = htons(port);
Bind();
Listen();
}
void Socket::AssignChannel(gboolean(*server_function)(GIOChannel *, GIOCondition, void *))
{
if (my_socket->getSocket() > 0)
{
GIOChannel *channel = g_io_channel_unix_new(my_socket->getSocket());
GIOCondition condition = (GIOCondition)(G_IO_IN | G_IO_HUP | G_IO_ERR);
GError *err = nullptr;
g_io_channel_set_encoding(channel, nullptr, &err);
#if !defined _WIN32 || defined _DEBUG
g_io_channel_set_flags(channel, G_IO_FLAG_SET_MASK, &err);
#endif
g_io_add_watch(channel,
condition,
server_function,
(void*)this);
}
}
void Socket::Close(SocketBase **sock)
{
if (sock && *sock)
{
(*sock)->Close();
*sock = nullptr;
}
}
void Socket::Bind()
{
if (!my_socket)
{
return;
}
if (bind(my_socket->getSocket(), (struct sockaddr *) &addr, sizeof(addr)) != 0)
{
psocketerror("bind");
}
}
void Socket::Listen()
{
if (!my_socket)
{
return;
}
if (listen(my_socket->getSocket(), 5) != 0)
{
psocketerror("listen");
}
}
SocketBase *Socket::Accept()
{
socklen_t addrlen = sizeof(addr);
SOCKET client_socket = accept(my_socket->getSocket(), (struct sockaddr *) &addr, &addrlen);
if (client_socket == INVALID_SOCKET)
{
psocketerror("accept");
exit_gpsim(1);
}
return new SocketBase(client_socket);
}
bool SocketBase::Send(const char *b)
{
if (!socket)
{
return false;
}
//std::cout << "Sending sock="<<socket << " data " << b << std::endl;
if (send(socket, b, strlen(b), 0) < 0)
{
psocketerror("send");
closesocket(socket);
return false;
}
return true;
}
//------------------------------------------------------------------------
// ParseObject
//
// A client socket has sent data to gpsim that ParseObject has now been
// given the job to interpret. ParseObject will decode the data using
// the gpsim protocol (described in ../src/protocol.h).
//
// The protocol generally consists of a command/data pair. Each command
// has a unique identifier and specifies the type of object. ParseObject
// extracts this information and then uses a large switch statement to
// perform the operation for this type.
void SocketBase::ParseObject()
{
unsigned int ObjectType;
if (!packet->DecodeObjectType(ObjectType))
{
return;
}
switch (ObjectType)
{
case GPSIM_CMD_CREATE_SOCKET_LINK:
{
unsigned int handle = FindFreeHandle();
Dprintf(("Parse GPSIM_CMD_CREATE_SOCKET_LINK handle=0x%x\n", handle));
AttributeLink *al = gCreateSocketLink(handle, *packet, this);
if (al)
{
links[handle & 0x0f] = al;
packet->EncodeHeader();
packet->EncodeUInt32(handle);
packet->txTerminate();
Send(packet->txBuff());
}
}
break;
case GPSIM_CMD_CREATE_NOTIFY_LINK:
{
Dprintf(("Parse GPSIM_CMD_CREATE_NOTIFY_LINK\n"));
unsigned int handle = FindFreeHandle();
AttributeLink *al = gCreateSocketLink(handle, *packet, this);
if (al)
{
printf("Notify link not currently supported\n");
#ifdef RRR
unsigned int i = 0;
if (packet->DecodeUInt32(i) && i)
{
al->setBlocking(true);
}
//NotifyLink *nl = new NotifyLink(al);
new NotifyLink(al); //RRR
links[handle & 0x0f] = al;
packet->EncodeHeader();
packet->EncodeUInt32(handle);
packet->txTerminate();
Send(packet->txBuff());
#endif
}
}
break;
case GPSIM_CMD_CREATE_CALLBACK_LINK:
{
Dprintf(("Parse GPSIM_CMD_CREATE_CALLBACK_LINK\n"));
unsigned int handle = FindFreeHandle();
guint64 interval = 0;
if (packet->DecodeUInt64(interval) && interval)
{
std::cout << "Creating callback link interval=" << interval << '\n';
new CyclicCallBackLink(interval,this);
//links[handle&0x0f] = al;
packet->EncodeHeader();
packet->EncodeUInt32(handle);
packet->txTerminate();
Send(packet->txBuff());
}
}
break;
case GPSIM_CMD_REMOVE_SOCKET_LINK:
{
AttributeLink *al = nullptr;
std::cout << "remove socket link command\n";
ParseSocketLink(packet, &al);
if (al)
{
CloseSocketLink(al);
}
Send("$");
}
break;
case GPSIM_CMD_QUERY_SOCKET_LINK:
{
AttributeLink *al = nullptr;
ParseSocketLink(packet, &al);
Dprintf(("Parse GPSIM_CMD_QUERY_SOCKET_LINK %s type=%s\n", al->getValue()->name().c_str(), al->getValue()->showType().c_str()));
if (al)
{
al->Send();
}
}
break;
case GPSIM_CMD_WRITE_TO_SOCKET_LINK:
{
AttributeLink *al = nullptr;
ParseSocketLink(packet, &al);
Dprintf(("Parse GPSIM_CMD_WRITE_TO_SOCKET_LINK %s type=%s\n", al->getValue()->name().c_str(), al->getValue()->showType().c_str()));
if (al)
{
al->set(*packet);
Send("$");
}
}
break;
case GPSIM_CMD_QUERY_SYMBOL:
{
char tmp[256];
if (packet->DecodeString(tmp, 256))
{
gpsimObject *sym = globalSymbolTable().find(tmp);
Dprintf(("Parse GPSIM_CMD_QUERY_SYMBOL name=%s type=%s\n", tmp, sym->showType().c_str()));
if (sym)
{
packet->EncodeHeader();
//RRRsym->get(*packet);
packet->txTerminate();
Send(packet->txBuff());
}
else
{
Send("-");
}
}
}
break;
case GPSIM_CMD_WRITE_TO_SYMBOL:
{
// The client has requested to write directly to a symbol
// (without using a SocketLink). So, we'll extract the symbol
// name from the packet and look it up in the symbol table.
// If the symbol is found then, it will get assigned the
// value that's stored in the packet.
char tmp[256];
if (packet->DecodeString(tmp, 256))
{
Value *sym = globalSymbolTable().findValue(tmp);
Dprintf(("Parse GPSIM_CMD_WRITE_TO_SYMBOL %s type=%s\n", tmp, sym?sym->showType().c_str():"???"));
if (sym)
{
// We'll define the response header before we decode
// the rest of the packet. The reason for this is that
// some symbols may wish to generate a response.
packet->EncodeHeader();
sym->set(*packet);
packet->txTerminate();
Send(packet->txBuff());
}
else
{
Send("-");
}
}
}
break;
case GPSIM_CMD_RUN:
{
guint64 nCycles;
guint64 startCycle = get_cycles().get();
// Extract from the packet the number of cycles we should run.
// If the number of cycles is greater than 0, then we'll set
// a cycle breakpoint; otherwise we'll run forever.
if (packet->DecodeUInt64(nCycles))
{
guint64 fc = startCycle + nCycles;
if (nCycles)
{
get_bp().set_cycle_break(0, fc);
}
}
// Start running...
get_interface().start_simulation();
// The simulation has stopped. For the response (to the run
// command) we'll send the current value of the cycle counter.
// (A client can use this to determine if the break was due to
// cycle break set above or to something else).
packet->EncodeObjectType(GPSIM_CMD_RUN);
packet->EncodeUInt64(get_cycles().get() - startCycle);
packet->txTerminate();
Send(packet->txBuff());
}
break;
case GPSIM_CMD_RESET:
get_interface().reset();
Send("-");
break;
default:
printf("Invalid object type: %u\n", ObjectType);
Send("-");
}
}
//------------------------------------------------------------------------
// Service()
//
// A client has sent data to gpsim through the socket interface. It is here
// where we validate that data and decide how to handle it.
void SocketBase::Service()
{
if (packet->brxHasData())
{
// If the data is a 'pure socket command', which is to say it begins
// with a header as defined in ../src/protocol.h, then the data
// will be further parsed by ParseObject(). If the data has an
// invalid header, then we assume that the data is for the command
// line and we let the CLI parse_string() function handle it.
// FIXME gpsim poorly handles this CLI interface. We should send
// the output of the CLI back to the client socket.
if (packet->DecodeHeader())
{
ParseObject();
}
else
{
if (parse_string(packet->rxBuff()) >= 0)
{
Send("+ACK");
}
else
{
Send("+BUSY");
}
}
}
}
//========================================================================
// Socket Interface
SocketInterface::SocketInterface(Socket * )
// : sock(new_socket)
{
}
void SocketInterface::SimulationHasStopped(gpointer /* object */ )
{
}
void SocketInterface::Update(gpointer /* object */ )
{
/*
if(sock)
sock->Service();
printf("socket update\n");
*/
}
SocketInterface::~SocketInterface()
{
/*
if(sock)
sock->Service();
*/
}
//========================================================================
SocketLink::SocketLink(unsigned int _handle, SocketBase *sb)
: handle(_handle), parent(sb), bWaitForResponse(false)
{
}
bool SocketLink::Send(bool bTimeStamp)
{
if (parent)
{
parent->packet->prepare();
parent->packet->EncodeHeader();
get(*parent->packet);
if (bTimeStamp)
{
parent->packet->EncodeUInt64(get_cycles().get());
}
parent->packet->txTerminate();
/*
std::cout << "SocketLink::Send() "
<< " socket=" << parent->getSocket()
<< " sending "
<< parent->packet->txBuff() << std::endl;
*/
if (bWaitForResponse)
{
// std::cout << "SocketLink::Send waiting for response\n";
if (parent->Send(parent->packet->txBuff()))
{
return Receive();
}
}
else
{
return parent->Send(parent->packet->txBuff());
}
}
return false;
}
bool SocketLink::Receive()
{
if (parent)
{
//cout << "SocketLink is waiting for a client response\n";
parent->packet->prepare();
int bytes = recv(parent->getSocket(),
parent->packet->rxBuff(),
parent->packet->rxSize(), 0);
if (bytes == -1)
{
perror("recv");
exit_gpsim(1);
}
parent->packet->rxTerminate(bytes);
/*
cout << "SocketLink got client response: " << parent->packet->rxBuff() <<
endl;
*/
return true;
}
return false;
}
//========================================================================
AttributeLink::AttributeLink(unsigned int _handle, SocketBase *_sb, gpsimObject *_v)
: SocketLink(_handle, _sb), v(_v)
{
}
void AttributeLink::set(Packet &p)
{
if (v)
{
unsigned int new_value;
p.DecodeUInt32(new_value);
if (!v->showType().compare("Register"))
{
((Register *)v)->value.put(new_value);
}
else if (!v->showType().compare("Integer"))
{
gint64 i = new_value &0xffffffff;
((Integer *)v)->set(i);
((Value *)v)->get(i);
}
else
{
printf("Fix me AttributeLink::set %s unexpected type %s\n", v->name().c_str(), v->showType().c_str());
}
}
}
void AttributeLink::get(Packet &p)
{
if (v)
{
if (!v->showType().compare("Register"))
{
unsigned int i = ((Register *)v)->get();
//v->get(p);
p.EncodeUInt32(i & 0xffffff);
}
else if (!v->showType().compare("Integer"))
{
gint64 i;
((Integer *)v)->get(i);
p.EncodeUInt32(i & 0xffffff);
}
else
{
printf("Fix me AttributeLink::get %s unexpected type %s\n", v->name().c_str(), v->showType().c_str());
}
}
}
//========================================================================
NotifyLink::NotifyLink(AttributeLink *_sl)
: XrefObject(), sl(_sl)
{
std::cout << "Creating a notify link \n";
if (sl && sl->getValue())
{
gpsimObject *v = sl->getValue();
std::cout << "Creating a notify link and asoc with " << v->name() << " " << v->showType() << '\n';
if (!v->showType().compare("Register"))
{
((Register *)v)->add_xref(this);
}
//FIXME: removed 27JAN06 sl->getValue()->set_xref(this);
//v->set_xref(this);
}
}
void NotifyLink::update()
{
printf("RRR NotifyLink::update()\n");
}
void NotifyLink::set(gint64 )
{
//std::cout << "notify link is sending data back to client\n";
if (sl)
{
sl->Send(true);
}
}
//========================================================================
CyclicCallBackLink::CyclicCallBackLink(guint64 i, SocketBase *_sb)
: interval(i), sb(_sb)
{
std::cout << " cyclic callback object\n ";
get_cycles().set_break(get_cycles().get() + interval, this);
get_cycles().dump_breakpoints();
}
CyclicCallBackLink::~CyclicCallBackLink()
{
}
void CyclicCallBackLink::callback()
{
std::cout << "CyclicCallBackLink callback now=" << get_cycles().get() <<"\n";
if (sb)
{
static bool bfirst = true;
static char st[5];
if (bfirst)
{
bfirst = false;
st[0] = 'h';
st[1] = 'e';
st[2] = 'y';
st[3] = '0';
st[4] = 0;
}
else if (++st[3] > '9')
{
st[3] = '0';
}
if (sb->Send(st))
{
get_cycles().set_break(get_cycles().get() + interval, this);
}
else
{
static int seq = 0;
std::cout << "socket callback failed seq:" << seq++ << '\n';
}
}
}
void CyclicCallBackLink::callback_print()
{
std::cout << "CyclicCallBackLink callback\n ";
}
//========================================================================
AttributeLink *gCreateSocketLink(unsigned int handle, Packet &p, SocketBase *sb)
{
char tmp[256];
if (p.DecodeString(tmp, 256))
{
gpsimObject *sym = globalSymbolTable().find(tmp);
if (sym)
{
return new AttributeLink(handle, sb, sym);
}
else
{
globalSymbolTable().addSymbol(sym = new Integer(tmp, 0));
return new AttributeLink(handle, sb, sym);
}
}
printf("AttributeLink *gCreateSocketLink Symbol name not in packet\n");
return nullptr;
}
//////////////////////////////////////////////////////////////////////////
#ifdef USE_THREADS_BUT_NOT_RECOMMENDED_BECAUSE_OF_CROSS_PLATFORM_ISSUES
void *server_thread(void *ignored)
{
std::cout << "running....\n";
Socket s;
while (true)
{
s.receive();
}
return nullptr;
}
pthread_t thSocketServer;
pthread_attr_t thAttribute;
int something = 1;
void start_server()
{
std::cout << "starting server....\n";
pthread_attr_init(&thAttribute);
pthread_attr_setdetachstate(&thAttribute, PTHREAD_CREATE_JOINABLE);
pthread_create(&thSocketServer, &thAttribute, server_thread, (void *)&something);
std::cout << " started server\n";
}
#else // if USE_THREADS
static void debugPrintChannelStatus(GIOStatus stat)
{
switch (stat)
{
case G_IO_STATUS_ERROR:
std::cout << "G_IO_STATUS_ERROR\n";
break;
case G_IO_STATUS_NORMAL:
std::cout << "G_IO_STATUS_NORMAL\n";
break;
case G_IO_STATUS_EOF:
std::cout << "G_IO_STATUS_EOF\n";
break;
case G_IO_STATUS_AGAIN:
std::cout << "G_IO_STATUS_AGAIN\n";
break;
}
}
#if 0 // defined but not used
static void debugPrintCondition(GIOCondition cond)
{
if (cond & G_IO_IN)
{
std::cout << " G_IO_IN\n";
}
if (cond & G_IO_OUT)
{
std::cout << " G_IO_OUT\n";
}
if (cond & G_IO_PRI)
{
std::cout << " G_IO_PRI\n";
}
if (cond & G_IO_ERR)
{
std::cout << " G_IO_ERR\n";
}
if (cond & G_IO_HUP)
{
std::cout << " G_IO_HUP\n";
}
if (cond & G_IO_NVAL)
{
std::cout << " G_IO_NVAL\n";
}
}
#endif
/*========================================================================
server_callback ()
This call back function is invoked from the GTK main loop whenever a client
socket has sent something to send to gpsim. This callback will only be
invoked for those clients that have already connected to gpsim. Those
connected clients have associated with them a 'SocketBase' object. A pointer
to that object is passed in the server_callback parameters.
This function essentially will respond to the messages that clients send
in much the same way the BSD socket command recv() does. Which is to say,
the data that the clients send is read from the socket. The actual parsing
of the data is done by the routine 'SocketBase::Service()'.
*/
static gboolean server_callback(GIOChannel *channel,
GIOCondition condition,
void *pSocketBase)
{
SocketBase *s = static_cast<SocketBase *>(pSocketBase);
if (condition & G_IO_HUP)
{
std::cout << "client has gone away\n";
GError *err = nullptr;
GIOStatus stat = g_io_channel_shutdown(channel, TRUE, &err);
std::cout << "channel status " << std::hex << stat << " " ;
debugPrintChannelStatus(stat);
delete s;
return FALSE;
}
if (condition & G_IO_IN)
{
gsize bytes_read = 0;
s->packet->prepare();
memset(s->packet->rxBuff(), 0, 256);
GError *err = nullptr;
gsize b;
#if !defined _WIN32 || defined _DEBUG
g_io_channel_set_flags(channel, G_IO_FLAG_NONBLOCK, &err);
#endif
g_io_channel_read_chars(channel,
s->packet->rxBuff(),
s->packet->rxSize(),
&b,
&err);
bytes_read = b;
s->packet->rxAdvance(bytes_read);
if (err)
{
std::cout << "GError:" << err->message << '\n';
}
if (bytes_read)
{
if (get_interface().bSimulating())
{
std::cout << "setting a socket break point because sim is running \n";
get_bp().set_socket_break();
}
else
{
s->Service();
}
}
else
{
return FALSE;
}
return TRUE;
}
return FALSE;
}
/*========================================================================
server_accept( )
This call back function is invoked from the GTK loop whenever a client
is attempting to establish a socket connection to gpsim. The purpose
of this function is to accept a socket connection and to create a GLIB
GIOChannel associated with it. This GIOChannel will listen to the client
socket and will invoke the server_callback() callback whenever the client
sends data. In addition, a new 'SocketBase' object will be created when
the connection is accepted. This SocketBase object wraps the BSD socket
and provides additional support for simplifying the socket communication.
*/
static gboolean sink_server_accept(GIOChannel *channel, GIOCondition /* condition */, void *d)
{
Socket *s = static_cast<Socket *>(d);
std::cout << " SourceSink accepting new client connect\n";
SocketBase *client = s->Accept();
if (!client)
{
return FALSE;
}
GIOChannel *new_channel = g_io_channel_unix_new(client->getSocket());
GIOCondition new_condition = (GIOCondition)(G_IO_IN | G_IO_HUP | G_IO_ERR);
GError *err = nullptr;
g_io_channel_set_encoding(channel, nullptr, &err);
#if !defined _WIN32 || defined _DEBUG
//stat = g_io_channel_set_flags (channel, G_IO_FLAG_SET_MASK, &err);
g_io_channel_set_flags(channel, G_IO_FLAG_NONBLOCK, &err);
#endif
g_io_add_watch(new_channel,
new_condition,
server_callback,
(void*)client);
return TRUE;
}
static gboolean source_server_accept(GIOChannel * /* channel */, GIOCondition /* condition */, void *d)
{
Socket *s = static_cast<Socket *>(d);
std::cout << " SourceServer accepting new client connect\n";
SocketBase *client = s->Accept();
std::cout << " SourceServer accepted connection\n";
if (!client)
{
return FALSE;
}
int bytes = recv(client->getSocket(),
client->packet->rxBuff(),
client->packet->rxSize(), 0);
std::cout << " SourceServer received data" << client->packet->rxBuff()
<< '\n';
if (bytes == -1)
{
perror("recv");
exit_gpsim(1);
}
client->packet->rxAdvance(bytes);
client->Service();
std::cout << " SourceServer serviced client\n";
// FIXME: SocketBase *client goes out of scope almost certainly leaking resources.
return TRUE;
}
void start_server()
{
// TestInt32Array *test = new TestInt32Array("test",16);
// symbol_table.add(test);
std::cout << "starting server....\n";
#ifdef _WIN32
if (!winsockets_init())
{
fprintf(stderr, "Could not find a usable WinSock DLL, sockets are disabled.\n");
server_started = false;
return;
}
server_started = true;
#endif
// Create the Sink and Source servers
static Socket sinkServer;
sinkServer.init(SIM_SINK_PORT);
sinkServer.AssignChannel(sink_server_accept);
get_interface().add_interface(new SocketInterface(&sinkServer));
static Socket sourceServer;
sourceServer.init(SIM_SOURCE_PORT);
sourceServer.AssignChannel(source_server_accept);
std::cout << " started server\n";
}
void stop_server()
{
#ifdef _WIN32
if (server_started)
{
WSACleanup();
}
#endif
}
#endif // if USE_THREADS
|