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
|
/*
* 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.
*
* This program 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 Library General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* SLPServer.cpp
* Copyright (C) 2012 Simon Newton
*/
#if HAVE_CONFIG_H
#include <config.h>
#endif
#include <ola/BaseTypes.h>
#include <ola/Callback.h>
#include <ola/Logging.h>
#include <ola/StringUtils.h>
#include <ola/io/BigEndianStream.h>
#include <ola/io/MemoryBuffer.h>
#include <ola/io/SelectServer.h>
#include <ola/math/Random.h>
#include <ola/network/IPV4Address.h>
#include <ola/network/NetworkUtils.h>
#include <ola/network/Socket.h>
#include <ola/network/SocketAddress.h>
#include <ola/network/TCPSocketFactory.h>
#include <ola/stl/STLUtils.h>
#include <algorithm>
#include <map>
#include <set>
#include <sstream>
#include <string>
#include <vector>
#include <utility>
#include "slp/SLPPacketBuilder.h"
#include "slp/SLPPacketParser.h"
#include "slp/SLPPendingOperations.h"
#include "slp/SLPServer.h"
#include "slp/SLPStore.h"
#include "slp/SLPStrings.h"
#include "slp/SLPUtil.h"
#include "slp/ServerCommon.h"
namespace ola {
namespace slp {
using ola::NewCallback;
using ola::NewSingleCallback;
using ola::ToUpper;
using ola::io::BigEndianInputStream;
using ola::io::BigEndianOutputStream;
using ola::io::MemoryBuffer;
using ola::math::Random;
using ola::network::HostToNetwork;
using ola::network::IPV4Address;
using ola::network::IPV4SocketAddress;
using ola::network::NetworkToHost;
using ola::network::TCPAcceptingSocket;
using ola::network::TCPSocket;
using ola::network::UDPSocketInterface;
using std::auto_ptr;
using std::ostringstream;
using std::string;
using std::vector;
const char SLPServer::DAADVERT[] = "DAAdvert";
const char SLPServer::DEREGSRVS_ERROR_COUNT_VAR[] = "slp-dereg-srv-errors";
const char SLPServer::FINDSRVS_EMPTY_COUNT_VAR[] =
"slp-find-srvs-empty-response";
const char SLPServer::METHOD_CALLS_VAR[] = "slp-server-methods";
const char SLPServer::METHOD_DEREG_SERVICE[] = "DeRegisterService";
const char SLPServer::METHOD_FIND_SERVICE[] = "FindService";
const char SLPServer::METHOD_REG_SERVICE[] = "RegisterService";
const char SLPServer::REGSRVS_ERROR_COUNT_VAR[] = "slp-reg-srv-errors";
const char SLPServer::SLP_PORT_VAR[] = "slp-port";
const char SLPServer::SRVACK[] = "SrvAck";
const char SLPServer::SRVDEREG[] = "SrvDeReg";
const char SLPServer::SRVREG[] = "SrvReg";
const char SLPServer::SRVRPLY[] = "SrvRply";
const char SLPServer::SRVRQST[] = "SrvRqst";
const char SLPServer::SRVTYPERQST[] = "SrvTypeRqst";
const char SLPServer::UNKNOWN[] = "Unknown";
const char SLPServer::UNSUPPORTED[] = "Unsupported";
// This counter tracks the number of packets received by type.
// This is incremented prior to packet checks.
const char SLPServer::UDP_RX_PACKET_BY_TYPE_VAR[] = "slp-udp-rx-packets";
// The total number of received SLP UDP packets
const char SLPServer::UDP_RX_TOTAL_VAR[] = "slp-udp-rx";
const char SLPServer::UDP_TX_PACKET_BY_TYPE_VAR[] = "slp-udp-tx-packets";
SLPServer::UnicastOperationDeleter::~UnicastOperationDeleter() {
if (server && op)
server->CancelPendingDAOperationsForServiceAndDA(op->service.url().url(),
op->da_url);
}
void SLPServer::UnicastOperationDeleter::Cancel() {
op = NULL;
server = NULL;
}
/*
* Init the options to sensible defaults
*/
SLPServer::SLPServerOptions::SLPServerOptions()
: clock(NULL),
enable_da(true),
slp_port(DEFAULT_SLP_PORT),
config_da_find(CONFIG_DA_FIND),
config_da_beat(CONFIG_DA_BEAT),
config_mc_max(CONFIG_MC_MAX),
config_retry(CONFIG_RETRY),
config_retry_max(CONFIG_RETRY_MAX),
config_start_wait(CONFIG_START_WAIT),
config_reg_active_min(CONFIG_REG_ACTIVE_MIN),
config_reg_active_max(CONFIG_REG_ACTIVE_MAX),
initial_xid(Random(0, MAX_XID)),
boot_time(0) {
}
/**
* Setup a new SLP server.
* @param ss the SelectServer to use
* @param udp_socket the socket to use for UDP SLP traffic
* @param tcp_socket the TCP socket to listen for incoming TCP SLP connections.
* @param export_map the ExportMap to use for exporting variables, may be NULL
* @param options the SLP Server options.
*/
SLPServer::SLPServer(ola::io::SelectServerInterface *ss,
ola::network::UDPSocketInterface *udp_socket,
ola::network::TCPAcceptingSocket *tcp_socket,
ola::ExportMap *export_map,
const SLPServerOptions &options)
: m_config_da_beat(options.config_da_beat * ONE_THOUSAND),
m_config_da_find(options.config_da_find * ONE_THOUSAND),
m_config_mc_max(options.config_mc_max * ONE_THOUSAND),
m_config_retry(options.config_retry * ONE_THOUSAND),
m_config_retry_max(options.config_retry_max * ONE_THOUSAND),
m_config_start_wait(options.config_start_wait * ONE_THOUSAND),
m_config_reg_active_min(options.config_reg_active_min * ONE_THOUSAND),
m_config_reg_active_max(options.config_reg_active_max * ONE_THOUSAND),
m_enable_da(options.enable_da),
m_slp_port(options.slp_port),
m_en_lang(EN_LANGUAGE_TAG),
m_iface_address(options.ip_address),
m_multicast_endpoint(IPV4SocketAddress(
IPV4Address(HostToNetwork(SLP_MULTICAST_ADDRESS)), m_slp_port)),
m_ss(ss),
m_clock(options.clock),
m_da_beat_timer(ola::thread::INVALID_TIMEOUT),
m_store_cleaner_timer(ola::thread::INVALID_TIMEOUT),
m_active_da_discovery_timer(ola::thread::INVALID_TIMEOUT),
m_udp_socket(udp_socket),
m_slp_accept_socket(tcp_socket),
m_udp_sender(m_udp_socket),
m_configured_scopes(options.scopes),
m_xid_allocator(options.initial_xid),
m_export_map(export_map) {
ToLower(&m_en_lang);
if (m_configured_scopes.empty())
m_configured_scopes = ScopeSet(DEFAULT_SLP_SCOPE);
if (export_map) {
export_map->GetBoolVar("slp-da-enabled")->Set(options.enable_da);
export_map->GetIntegerVar("slp-config-da-beat")->Set(
options.config_da_beat);
export_map->GetIntegerVar("slp-config-da-find")->Set(
options.config_da_find);
export_map->GetIntegerVar("slp-config-mc-max")->Set(options.config_mc_max);
export_map->GetIntegerVar("slp-config-retry")->Set(options.config_retry);
export_map->GetIntegerVar("slp-config-retry-max")->Set(
options.config_retry_max);
export_map->GetIntegerVar("slp-config-start_wait")->Set(
options.config_start_wait);
export_map->GetIntegerVar("slp-port")->Set(options.slp_port);
export_map->GetIntegerVar(FINDSRVS_EMPTY_COUNT_VAR);
export_map->GetIntegerVar(UDP_RX_TOTAL_VAR);
export_map->GetStringVar("slp-scope-list")->Set(
m_configured_scopes.ToString());
export_map->GetUIntMapVar(UDP_RX_PACKET_BY_TYPE_VAR, "type");
export_map->GetUIntMapVar(METHOD_CALLS_VAR, "method");
}
if (options.boot_time) {
m_boot_time += TimeInterval(options.boot_time, 0);
}
}
SLPServer::~SLPServer() {
if (m_enable_da) {
// send a DAAdvert with a boot time of 0 to let everyone know we're going
// down
SendDAAdvert(m_multicast_endpoint, 0, 0);
}
m_ss->RemoveTimeout(m_da_beat_timer);
m_ss->RemoveTimeout(m_store_cleaner_timer);
m_ss->RemoveTimeout(m_active_da_discovery_timer);
if (m_outstanding_da_discovery.get()) {
m_ss->RemoveTimeout(m_outstanding_da_discovery->timer_id);
}
// delete any pending registration operations
for (PendingOperationsByURL::iterator iter = m_pending_ops.begin();
iter != m_pending_ops.end(); ++iter) {
FreePendingDAOperation(iter->second);
}
m_udp_socket->Close();
OLA_INFO << "Size of m_pending_acks is " << m_pending_acks.size();
OLA_INFO << "Size of m_pending_replies is " << m_pending_replies.size();
STLDeleteValues(&m_pending_acks);
}
/**
* Init the server
*/
bool SLPServer::Init() {
OLA_INFO << "SLP Interface address is " << m_iface_address;
if (!m_udp_socket->SetMulticastInterface(m_iface_address)) {
return false;
}
// join the multicast group
if (!m_udp_socket->JoinMulticast(m_iface_address,
m_multicast_endpoint.Host())) {
return false;
}
m_udp_socket->SetOnData(NewCallback(this, &SLPServer::UDPData));
m_ss->AddReadDescriptor(m_udp_socket);
// Setup a timeout to clean up the store
m_store_cleaner_timer = m_ss->RegisterRepeatingTimeout(
30 * 1000,
NewCallback(this, &SLPServer::CleanSLPStore));
// Register a callback to find out about new DAs
m_da_tracker.AddNewDACallback(NewCallback(this, &SLPServer::NewDACallback));
if (m_enable_da) {
if (m_boot_time.Seconds() == 0)
GetCurrentTime(&m_boot_time);
// setup the DA beat timer
m_da_beat_timer = m_ss->RegisterRepeatingTimeout(
m_config_da_beat,
NewCallback(this, &SLPServer::SendDABeat));
SendDABeat();
}
// schedule a SrvRqst for the directory agent
// Even DAs need to know about other DAs, since they may also be UAs or SAs
m_active_da_discovery_timer = m_ss->RegisterSingleTimeout(
Random(0, m_config_start_wait),
NewSingleCallback(this, &SLPServer::StartActiveDADiscovery));
return true;
}
/**
* Dump out the contents of the SLP store.
*/
void SLPServer::DumpStore() {
m_service_store.Dump(*(m_ss->WakeUpTime()));
}
/**
* Get a list of known DAs
*/
void SLPServer::GetDirectoryAgents(vector<DirectoryAgent> *output) {
m_da_tracker.GetDirectoryAgents(output);
}
/**
* Manually trigger active DA discovery.
*/
void SLPServer::TriggerActiveDADiscovery() {
StartActiveDADiscovery();
}
/**
* Locate a service
* @param scopes the set of scopes to search
* @param service_type the type of service to locate
* @param cb the callback to run
* TODO(simon): change this to execute the callback multiple times until all
* results arrive.
*/
void SLPServer::FindService(
const set<string> &scopes,
const string &service_type,
BaseCallback1<void, const URLEntries&> *cb) {
IncrementMethodVar(METHOD_FIND_SERVICE);
URLEntries urls;
ScopeSet scope_set(scopes);
OLA_INFO << "FindService(" << scope_set << ", " << service_type << ")";
if (m_enable_da) {
// if we're a DA handle all those scopes first
ScopeSet da_scopes = scope_set.DifferenceUpdate(m_configured_scopes);
if (!da_scopes.empty())
m_service_store.Lookup(*(m_ss->WakeUpTime()), da_scopes, service_type,
&urls);
} else {
// not DA, but we still need to check our local store for matching
// services.
m_service_store.Lookup(*(m_ss->WakeUpTime()), scope_set, service_type,
&urls);
}
if (m_enable_da && scope_set.empty()) {
// all scopes were handled by our local DA
if (urls.empty() && m_export_map)
(*m_export_map->GetIntegerVar(FINDSRVS_EMPTY_COUNT_VAR))++;
cb->Run(urls);
return;
}
PendingSrvRqst *srv_request_state = new PendingSrvRqst(service_type,
scope_set, cb);
srv_request_state->urls = urls;
FindServiceInScopes(srv_request_state, scope_set);
}
/**
* Register a service
* @param service the ServiceEntry to register
* @returns an SLP error code
*/
uint16_t SLPServer::RegisterService(const ServiceEntry &new_service) {
IncrementMethodVar(METHOD_REG_SERVICE);
ServiceEntry service(new_service);
service.set_local(true);
uint16_t error_code;
if (!service.url().lifetime()) {
OLA_WARN << "Attempt to register " << service << " with a lifetime of 0";
error_code = INVALID_REGISTRATION;
} else {
error_code = InternalRegisterService(service);
}
if (error_code && m_export_map)
(*m_export_map->GetIntegerVar(REGSRVS_ERROR_COUNT_VAR))++;
return error_code;
}
/**
* DeRegister a service
* @param service the ServiceEntry to de-register
* @returns an SLP error code
*/
uint16_t SLPServer::DeRegisterService(const ServiceEntry &service) {
IncrementMethodVar(METHOD_DEREG_SERVICE);
uint16_t error_code = InternalDeRegisterService(service);
if (error_code && m_export_map)
(*m_export_map->GetIntegerVar(DEREGSRVS_ERROR_COUNT_VAR))++;
return error_code;
}
/**
* Called when there is data on the UDP socket
*/
void SLPServer::UDPData() {
ssize_t packet_size = 1500;
uint8_t packet[packet_size];
ola::network::IPV4Address source_ip;
uint16_t port;
if (!m_udp_socket->RecvFrom(reinterpret_cast<uint8_t*>(&packet),
&packet_size, source_ip, port))
return;
IPV4SocketAddress source(source_ip, port);
OLA_DEBUG << "Got " << packet_size << " UDP bytes from " << source;
if (m_export_map)
(*m_export_map->GetIntegerVar(UDP_RX_TOTAL_VAR))++;
uint8_t function_id = SLPPacketParser::DetermineFunctionID(packet,
packet_size);
MemoryBuffer buffer(&packet[0], packet_size);
BigEndianInputStream stream(&buffer);
switch (function_id) {
case 0:
return;
case SERVICE_REQUEST:
IncrementPacketVar(SRVRQST);
HandleServiceRequest(packet, packet_size, source);
break;
case SERVICE_REPLY:
IncrementPacketVar(SRVRPLY);
HandleServiceReply(&stream, source);
break;
case SERVICE_REGISTRATION:
IncrementPacketVar(SRVREG);
HandleServiceRegistration(&stream, source);
break;
case SERVICE_ACKNOWLEDGE:
IncrementPacketVar(SRVACK);
HandleServiceAck(&stream, source);
break;
case DA_ADVERTISEMENT:
IncrementPacketVar(DAADVERT);
HandleDAAdvert(&stream, source);
break;
case SERVICE_TYPE_REQUEST:
IncrementPacketVar(SRVTYPERQST);
HandleServiceTypeRequest(&stream, source);
break;
case SERVICE_DEREGISTER:
IncrementPacketVar(SRVDEREG);
HandleServiceDeRegister(&stream, source);
break;
case ATTRIBUTE_REQUEST:
case ATTRIBUTE_REPLY:
case SERVICE_TYPE_REPLY:
case SA_ADVERTISEMENT:
IncrementPacketVar(UNSUPPORTED);
OLA_INFO << "Unsupported SLP function-id: "
<< static_cast<int>(function_id);
break;
default:
IncrementPacketVar(UNKNOWN);
OLA_WARN << "Unknown SLP function-id: " << static_cast<int>(function_id);
break;
}
}
/**
* Handle a Service Request packet.
*/
void SLPServer::HandleServiceRequest(const uint8_t *data,
unsigned int data_length,
const IPV4SocketAddress &source) {
OLA_INFO << "Got Service request from " << source;
URLEntries urls;
auto_ptr<const ServiceRequestPacket> request;
{
MemoryBuffer buffer(data, data_length);
BigEndianInputStream input(&buffer);
request.reset(SLPPacketParser::UnpackServiceRequest(&input));
}
if (!request.get()) {
// try to at least unpack the header, so we can send a PARSE_ERROR response
SLPPacket slp_packet;
MemoryBuffer buffer(data, data_length);
BigEndianInputStream input(&buffer);
if (SLPPacketParser::ExtractHeader(&input, &slp_packet, "SrvRqst")) {
SendErrorIfUnicast(&slp_packet, SERVICE_REPLY, source, PARSE_ERROR);
}
return;
}
// if we're in the PR list don't do anything
if (InPRList(request->pr_list)) {
OLA_INFO << m_iface_address <<
" found in PR list, not responding to request";
return;
}
if (!request->predicate.empty()) {
if (m_enable_da) {
// TODO(simon): support predicate matching
OLA_WARN << "Received request with predicate, ignoring";
} else if (!request->Multicast()) {
// For our purposes we assume that service's can't have attributes.
// Therefore all predicate matches will fail, so we can return an empty
// SrvRply here.
OLA_INFO << "Got request with predicate, sending empty SrvRply";
m_udp_sender.SendServiceReply(source, request->xid, request->language, 0,
urls);
}
return;
}
if (!request->spi.empty()) {
OLA_WARN << "Received request with SPI";
SendErrorIfUnicast(request.get(), SERVICE_REPLY, source,
AUTHENTICATION_UNKNOWN);
return;
}
// The language tag only applies to the predicate.
if (!request->predicate.empty() && request->language != m_en_lang) {
OLA_WARN << "Unsupported language " << request->language;
SendErrorIfUnicast(request.get(), SERVICE_REPLY, source,
LANGUAGE_NOT_SUPPORTED);
return;
}
OLA_INFO << "SrvRqst for '" << request->service_type << "', scopes " <<
request->scope_list;
// check service, MaybeSend[DS]AAdvert do their own scope checking
if (request->service_type.empty()) {
OLA_INFO << "Received SrvRqst with empty service-type from: " << source;
SendErrorIfUnicast(request.get(), SERVICE_REPLY, source, PARSE_ERROR);
return;
} else if (m_enable_da && request->service_type == DIRECTORY_AGENT_SERVICE) {
MaybeSendDAAdvert(request.get(), source);
return;
} else if (!m_enable_da && request->service_type == SERVICE_AGENT_SERVICE) {
MaybeSendSAAdvert(request.get(), source);
return;
}
// check scopes
if (request->scope_list.empty()) {
OLA_INFO << "Empty scope list";
SendErrorIfUnicast(request.get(), SERVICE_REPLY, source,
SCOPE_NOT_SUPPORTED);
return;
}
ScopeSet scope_set(request->scope_list);
if (!scope_set.Intersects(m_configured_scopes)) {
OLA_INFO << "Scopes don't match";
SendErrorIfUnicast(request.get(), SERVICE_REPLY, source,
SCOPE_NOT_SUPPORTED);
return;
}
OLA_INFO << "Received SrvRqst for " << request->service_type;
m_service_store.Lookup(*(m_ss->WakeUpTime()), scope_set,
request->service_type, &urls);
OLA_INFO << "sending SrvReply with " << urls.size() << " urls";
if (urls.empty() && request->Multicast())
return;
m_udp_sender.SendServiceReply(source, request->xid, request->language, 0,
urls);
}
/**
* Handle a Service Reply packet.
*/
void SLPServer::HandleServiceReply(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
OLA_INFO << "Got Service reply from " << source;
auto_ptr<const ServiceReplyPacket> srv_reply(
SLPPacketParser::UnpackServiceReply(stream));
if (!srv_reply.get())
return;
PendingReplyMap::iterator iter = m_pending_replies.find(srv_reply->xid);
if (iter == m_pending_replies.end()) {
OLA_INFO << "Can't locate a matching SrvRqst for xid " << srv_reply->xid;
} else {
// we don't erase the iter, that's left up to the callback to do.
iter->second->Run(source.Host(), srv_reply->error_code,
srv_reply->url_entries);
}
}
/**
* Handle a Service Registration packet, only DAs support this.
*/
void SLPServer::HandleServiceRegistration(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
OLA_INFO << "Got Service registration from " << source;
auto_ptr<const ServiceRegistrationPacket> srv_reg(
SLPPacketParser::UnpackServiceRegistration(stream));
if (!srv_reg.get())
return;
ScopeSet scopes(srv_reg->scope_list);
OLA_INFO << "Unpacked service registration for " << srv_reg->url
<< ", service-type " << srv_reg->service_type << ", with scopes "
<< scopes;
if (!m_enable_da)
return;
if (srv_reg->url.lifetime() == 0) {
m_udp_sender.SendServiceAck(source, srv_reg->xid, srv_reg->language,
INVALID_REGISTRATION);
return;
}
if (!m_configured_scopes.IsSuperSet(scopes)) {
m_udp_sender.SendServiceAck(source, srv_reg->xid, srv_reg->language,
SCOPE_NOT_SUPPORTED);
return;
}
ServiceEntry service(scopes, srv_reg->service_type, srv_reg->url.url(),
srv_reg->url.lifetime());
slp_error_code_t error_code = m_service_store.Insert(
*(m_ss->WakeUpTime()), service, srv_reg->Fresh());
m_udp_sender.SendServiceAck(source, srv_reg->xid, srv_reg->language,
error_code);
}
/**
* Handle a Service De-Registration packet, only DAs support this.
*/
void SLPServer::HandleServiceDeRegister(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
OLA_INFO << "Got Service de-registration from " << source;
auto_ptr<const ServiceDeRegistrationPacket> srv_dereg(
SLPPacketParser::UnpackServiceDeRegistration(stream));
if (!srv_dereg.get())
return;
ScopeSet scopes(srv_dereg->scope_list);
OLA_INFO << "Unpacked service de-registration for " << srv_dereg->url
<< ", scopes " << scopes;
if (!m_enable_da)
return;
// lifetime can be anything for a dereg
ServiceEntry service(scopes, srv_dereg->url.url(), 0);
slp_error_code_t ret = m_service_store.Remove(service);
m_udp_sender.SendServiceAck(source, srv_dereg->xid, srv_dereg->language, ret);
}
/**
* Handle a Service Ack packet.
*/
void SLPServer::HandleServiceAck(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
auto_ptr<const ServiceAckPacket> srv_ack(
SLPPacketParser::UnpackServiceAck(stream));
if (!srv_ack.get())
return;
// See if this matches one of our pending transactions
PendingAckMap::iterator iter = m_pending_acks.find(srv_ack->xid);
if (iter == m_pending_acks.end()) {
OLA_INFO << "Can't locate a matching request for xid " << srv_ack->xid;
return;
}
OLA_INFO << "SrvAck[" << srv_ack->xid << "] from " << source
<< ", error code is " << srv_ack->error_code;
AckCallback *cb = iter->second;
m_pending_acks.erase(iter);
cb->Run(srv_ack->error_code);
}
/**
* Handle a DAAdvert.
*/
void SLPServer::HandleDAAdvert(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
auto_ptr<const DAAdvertPacket> da_advert(
SLPPacketParser::UnpackDAAdvert(stream));
if (!da_advert.get()) {
OLA_INFO << "Dropped DAAdvert from " << source << " due to parse error";
return;
}
if (da_advert->error_code) {
OLA_WARN << "DAAdvert(" << source << "), error "
<< da_advert->error_code << " ("
<< SLPErrorToString(da_advert->error_code) << ")";
return;
}
OLA_INFO << "RX DAAdvert(" << source << "), xid " << da_advert->xid
<< ", scopes " << da_advert->scope_list << ", boot "
<< da_advert->boot_timestamp << ", " << da_advert->url;
if (m_outstanding_da_discovery.get()) {
// active discovery in progress
m_outstanding_da_discovery->AddPR(source.Host());
}
m_da_tracker.NewDAAdvert(*da_advert, source);
}
/**
* Handle a SrvTypeRqst.
*/
void SLPServer::HandleServiceTypeRequest(BigEndianInputStream *stream,
const IPV4SocketAddress &source) {
auto_ptr<const ServiceTypeRequestPacket> request(
SLPPacketParser::UnpackServiceTypeRequest(stream));
if (!request.get()) {
OLA_INFO << "Dropped SrvTypeRqst from " << source << " due to parse error";
return;
}
// If we're listed in the PR list ignore the request
if (InPRList(request->pr_list)) {
OLA_INFO << m_iface_address <<
" found in PR list, not responding to request";
return;
}
ScopeSet scopes(request->scope_list);
if (!scopes.Intersects(m_configured_scopes)) {
SendErrorIfUnicast(request.get(), SERVICE_TYPE_REPLY, source,
SCOPE_NOT_SUPPORTED);
return;
}
OLA_INFO << "RX SrvTypeRqst(" << source << "), scopes " << scopes
<< ", naming auth '" << request->naming_authority << "'";
vector<string> service_types;
if (request->include_all) {
m_service_store.GetAllServiceTypes(scopes, &service_types);
} else {
m_service_store.GetServiceTypesByNamingAuth(request->naming_authority,
scopes, &service_types);
}
if (service_types.empty() && request->Multicast())
return;
sort(service_types.begin(), service_types.end());
m_udp_sender.SendServiceTypeReply(source, request->xid, SLP_OK,
service_types);
}
/**
* Send an error response, only if this request was unicast
* @param request the request that triggered the response
* @param function_id the function-id to use in the response
* @param destination the socket address to send the message to
* @param error_code the error code to use
*/
void SLPServer::SendErrorIfUnicast(const SLPPacket *request,
slp_function_id_t function_id,
const IPV4SocketAddress &destination,
slp_error_code_t error_code) {
if (request->Multicast())
return;
// Per section 7, we can truncate the message if the error code is non-0
m_udp_sender.SendError(destination, function_id, request->xid,
request->language, error_code);
}
/**
* Send a SAAdvert if allowed.
*/
void SLPServer::MaybeSendSAAdvert(const ServiceRequestPacket *request,
const IPV4SocketAddress &source) {
if (m_enable_da)
return; // no SAAdverts in DA mode
// Section 11.2
ScopeSet scopes(request->scope_list);
if (!(scopes.empty() || scopes.Intersects(m_configured_scopes))) {
SendErrorIfUnicast(request, SERVICE_REPLY, source, SCOPE_NOT_SUPPORTED);
return;
}
ostringstream str;
str << SERVICE_AGENT_SERVICE << "://" << m_iface_address;
m_udp_sender.SendSAAdvert(source, request->xid, str.str(),
m_configured_scopes);
}
/**
* Send a DAAdvert if allows.
*/
void SLPServer::MaybeSendDAAdvert(const ServiceRequestPacket *request,
const IPV4SocketAddress &source) {
if (!m_enable_da)
return;
// Section 11.2
ScopeSet scopes(request->scope_list);
if (!scopes.empty() && !scopes.Intersects(m_configured_scopes)) {
OLA_INFO << "Scopes in SrvRqst " << DIRECTORY_AGENT_SERVICE << ": '"
<< scopes << "', don't match our scopes of '"
<< m_configured_scopes << "'";
SendErrorIfUnicast(request, DA_ADVERTISEMENT, source, SCOPE_NOT_SUPPORTED);
return;
}
SendDAAdvert(source, m_boot_time.Seconds(), request->xid);
}
/**
* Send a DAAdvert for this server
*/
void SLPServer::SendDAAdvert(const IPV4SocketAddress &dest,
uint32_t boot_time,
xid_t xid) {
OLA_INFO << "Sending DAAdvert to " << dest;
std::ostringstream str;
str << DIRECTORY_AGENT_SERVICE << "://" << m_iface_address;
m_udp_sender.SendDAAdvert(dest, xid, 0, boot_time, str.str(),
m_configured_scopes);
}
/**
* Send a multicast DAAdvert packet
*/
bool SLPServer::SendDABeat() {
// unsolicited DAAdverts have a xid of 0
SendDAAdvert(m_multicast_endpoint, m_boot_time.Seconds(), 0);
return true;
}
// UA methods
//------------------------------------------------------------------------------
/**
* For the given scopes, check if there are any DAs to use and if so, send
* SrvRqst messages. For scopes without DAs start the multicast dance.
*/
void SLPServer::FindServiceInScopes(PendingSrvRqst *request,
const ScopeSet &scopes) {
vector<DirectoryAgent> das;
m_da_tracker.GetMinimalCoveringList(scopes, &das);
ScopeSet remaining_scopes = scopes;
for (vector<DirectoryAgent>::iterator iter = das.begin(); iter != das.end();
iter++) {
ScopeSet this_das_scopes = remaining_scopes.DifferenceUpdate(
iter->scopes());
if (this_das_scopes.empty()) {
OLA_WARN << "Scopes for " << *iter
<< " are empty, this is a bug in GetMinimalCoveringList";
continue;
}
UnicastSrvRqstOperation *op = new UnicastSrvRqstOperation(
m_xid_allocator.Next(), m_config_retry, iter->URL(),
this_das_scopes, request);
SendSrvRqstToDA(op, *iter);
}
if (remaining_scopes.empty())
return;
// fallback to multicast for the rest
OLA_WARN << "We need to multicast for '" << remaining_scopes << "'";
MulicastSrvRqstOperation *op = new MulicastSrvRqstOperation(
m_xid_allocator.Next(), m_config_retry, remaining_scopes, request);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::RequestServiceMulticastTimeout, op));
m_udp_sender.SendServiceRequest(m_multicast_endpoint, op->xid, op->pr_list,
op->parent->service_type, op->scopes);
OLA_INFO << "adding callback for " << op->xid;
// note the multi-use callback
pair<xid_t, SrvReplyCallback*> p(
op->xid, NewCallback(this, &SLPServer::ReceivedSASrvReply, op));
if (!m_pending_replies.insert(p).second)
OLA_WARN << "Collision for xid " << op->xid
<< ", we're probably leaking memory!";
}
/**
* Send the SrvRqst to a DA, schedule the timeout and add the rx callbacks.
*/
void SLPServer::SendSrvRqstToDA(UnicastSrvRqstOperation *op,
const DirectoryAgent &da,
bool expect_reused_xid) {
op->da_busy = false; // reset the busy flag
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::RequestServiceDATimeout, op));
m_udp_sender.SendServiceRequest(
IPV4SocketAddress(da.IPAddress(), m_slp_port), op->xid,
op->parent->service_type, op->scopes);
OLA_INFO << "adding callback for " << op->xid;
PendingReplyMap::iterator iter = m_pending_replies.find(op->xid);
if (iter == m_pending_replies.end()) {
pair<xid_t, SrvReplyCallback*> p(
op->xid, NewSingleCallback(this, &SLPServer::ReceivedDASrvReply, op));
m_pending_replies.insert(p);
} else if (!expect_reused_xid) {
OLA_WARN << "Collision for xid " << op->xid
<< ", we're probably leaking memory!";
}
}
/**
* Called when we receive a reply to a SrvRqst from a DA.
*/
void SLPServer::ReceivedDASrvReply(UnicastSrvRqstOperation *op,
const IPV4Address&,
uint16_t error_code,
const URLEntries &urls) {
// erase xid from the map
m_pending_replies.erase(op->xid);
OLA_INFO << "Got DA SrvReply, error code is " << error_code;
if (error_code == SLP_OK) {
std::copy(urls.begin(), urls.end(), std::back_inserter(op->parent->urls));
// mark all these scopes as complete
for (ScopeSet::Iterator iter = op->scopes.begin(); iter != op->scopes.end();
++iter) {
op->parent->MarkScopeAsDone(*iter);
}
CheckIfFindSrvComplete(op->parent);
m_ss->RemoveTimeout(op->timer_id);
delete op;
} else if (error_code == DA_BUSY_NOW) {
// mark the DA as busy and let the timeout expire so we retry.
op->da_busy = true;
} else {
// declare this DA bad
OLA_INFO << "Declaring DA " << op->da_url << " bad due to error code";
m_ss->RemoveTimeout(op->timer_id);
m_da_tracker.MarkAsBad(op->da_url);
FindServiceInScopes(op->parent, op->scopes);
delete op;
}
}
/**
* Called when a SrvRqst to a DA times out. This may trigger a retry or, if
* we've hit the retry limit we'll move on to another DA, or fall back to
* multicast.
* This assumes ownership of op.
*/
void SLPServer::RequestServiceDATimeout(UnicastSrvRqstOperation *op) {
OLA_INFO << "SrvRqst to " << op->da_url << " timed out";
auto_ptr<UnicastSrvRqstOperation> op_deleter(op);
PendingReplyMap::iterator iter = m_pending_replies.find(op->xid);
if (iter == m_pending_replies.end()) {
OLA_WARN << "Unable to find matching xid: " << op->xid;
return;
}
op->UpdateRetryTime();
if (op->total_time() + op->retry_time() > m_config_retry_max) {
// this DA is bad
OLA_INFO << "Declaring DA " << op->da_url << " bad since total time is now "
<< op->total_time();
m_da_tracker.MarkAsBad(op->da_url);
CancelPendingSrvRqstAck(iter);
FindServiceInScopes(op->parent, op->scopes);
return;
}
DirectoryAgent da;
bool failed = false;
if (!m_da_tracker.LookupDA(op->da_url, &da)) {
// This DA no longer exists
OLA_WARN << "DA " << op->da_url << " no longer exists";
failed = true;
} else if (!da.scopes().Intersects(op->scopes)) {
OLA_WARN << "DA " << op->da_url << " no longer has scopes that match "
<< op->scopes;
failed = true;
}
if (failed) {
CancelPendingSrvRqstAck(iter);
FindServiceInScopes(op->parent, op->scopes);
return;
}
// we're going to reuse the op, so don't delete it.
op_deleter.release();
// we expect a XID collison here.
SendSrvRqstToDA(op, da, true);
}
/**
* Remove a pending SrvAck from the map, and delete the callback
*/
void SLPServer::CancelPendingSrvRqstAck(const PendingReplyMap::iterator &iter) {
delete iter->second;
m_pending_replies.erase(iter);
}
/**
* Called when a multicast SrvRqst request times out.
* It's not really clear from Section 6.3 what the terminating condition for
* this is. My interpretation is that we terminate if:
* - no new responses were received
* - the message no longer fits in a datagram
* - CONFIG_MC_MAX is reached
*/
void SLPServer::RequestServiceMulticastTimeout(
MulicastSrvRqstOperation *op) {
OLA_INFO << "xid " << op->xid << " timeout, attempt "
<< static_cast<unsigned int>(op->AttemptNumber());
bool first_attempt = op->AttemptNumber() == 1;
op->UpdateRetryTime();
PendingReplyMap::iterator iter = m_pending_replies.find(op->xid);
if (iter == m_pending_replies.end()) {
OLA_WARN << "Can't find callback for xid " << op->xid << ", this is a bug!";
return;
}
// make sure we always send the SrvRqst at least twice. The RFC isn't
// too clear about this, (6.3), but this protects against a dropped packet.
if ((!op->PRListChanged() && !first_attempt) ||
op->PRListSize() > MAX_PR_LIST_SIZE ||
op->total_time() >= m_config_mc_max) {
// We're done, cleaning up the multi-use callback
delete iter->second;
m_pending_replies.erase(iter);
for (ScopeSet::Iterator iter = op->scopes.begin(); iter != op->scopes.end();
++iter)
op->parent->MarkScopeAsDone(*iter);
CheckIfFindSrvComplete(op->parent);
delete op;
return;
}
if (op->PRListChanged()) {
op->ResetPRListChanged();
// we need a new xid now, reuse the callback though
SrvReplyCallback *cb = iter->second;
m_pending_replies.erase(iter);
op->xid = m_xid_allocator.Next();
pair<xid_t, SrvReplyCallback*> p(op->xid, cb);
if (!m_pending_replies.insert(p).second)
OLA_WARN << "Collision for xid " << op->xid
<< ", we're probably leaking memory!";
}
OLA_INFO << "Retry time for " << op->xid << " is now " << op->retry_time();
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::RequestServiceMulticastTimeout, op));
m_udp_sender.SendServiceRequest(m_multicast_endpoint, op->xid, op->pr_list,
op->parent->service_type, op->scopes);
}
/**
* Called when we receive a response to a multicast SrvRqst
*/
void SLPServer::ReceivedSASrvReply(MulicastSrvRqstOperation *op,
const IPV4Address &src,
uint16_t error_code,
const URLEntries &urls) {
OLA_INFO << "Got SrvReply with code " << error_code;
if (error_code == SLP_OK) {
// add the URLEntries add put this in the PR list
std::copy(urls.begin(), urls.end(), std::back_inserter(op->parent->urls));
op->AddPR(src);
} else {
// we should never get an error here
OLA_WARN << "Got non-0 error code (" << error_code << ") from "<< src;
}
}
/**
* Check if the Find Service request is complete. This is true if all scopes
* have completed. If the request is complete, we execute the callback and
* delete the PendingSrvRqst object.
*/
void SLPServer::CheckIfFindSrvComplete(PendingSrvRqst *request) {
if (!request->Complete())
return;
// ok we're done
request->callback->Run(request->urls);
delete request;
}
// SA methods
//------------------------------------------------------------------------------
/**
* Cancel any pending DA Reg / DeReg operations for this URL
* @param url the url to cancel operations for.
*/
void SLPServer::CancelPendingDAOperationsForService(const string &url) {
PendingOperationsByURL::iterator iter;
PendingOperationsByURL::iterator lower = m_pending_ops.lower_bound(url);
PendingOperationsByURL::iterator upper = m_pending_ops.upper_bound(url);
for (iter = lower; iter != upper; ++iter) {
FreePendingDAOperation(iter->second);
}
m_pending_ops.erase(lower, upper);
}
/**
* Cancel any pending DA Reg / DeReg operations for this (URL , DA URL) pair.
* @param url the url to cancel operations for.
* @param da_url the DA url to cancel operations for.
*/
void SLPServer::CancelPendingDAOperationsForServiceAndDA(const string &url,
const string &da_url) {
PendingOperationsByURL::iterator iter = m_pending_ops.lower_bound(url);
PendingOperationsByURL::iterator upper = m_pending_ops.upper_bound(url);
// take a copy of the da_url, since it may be a reference into an object
// we're about to delete
const string our_da_url = da_url;
while (iter != upper) {
if (iter->second->da_url == our_da_url) {
FreePendingDAOperation(iter->second);
m_pending_ops.erase(iter++);
} else {
iter++;
}
}
}
/**
* Free the resources associated with a pending Reg/DeReg operation.
*/
void SLPServer::FreePendingDAOperation(UnicastSrvRegOperation *op) {
m_ss->RemoveTimeout(op->timer_id); // cancel the timer
PendingAckMap::iterator ack_iter = m_pending_acks.find(op->xid);
if (ack_iter != m_pending_acks.end()) {
delete ack_iter->second;
m_pending_acks.erase(ack_iter);
}
delete op;
}
/**
* Register a service. May register with DAs if we know about any.
*/
uint16_t SLPServer::InternalRegisterService(const ServiceEntry &service) {
TimeStamp now;
GetCurrentTime(&now);
SLPStore::ReturnCode result = m_service_store.CheckIfScopesMatch(now,
service);
if (result == SLPStore::SCOPE_MISMATCH)
return SCOPE_NOT_SUPPORTED;
CancelPendingDAOperationsForService(service.url_string());
// TODO(simon): use the error from here, and maybe skip the DA part
m_service_store.Insert(now, service);
vector<DirectoryAgent> directory_agents;
m_da_tracker.GetDAsForScopes(service.scopes(), &directory_agents);
for (vector<DirectoryAgent>::iterator da_iter = directory_agents.begin();
da_iter != directory_agents.end(); ++da_iter) {
RegisterWithDA(*da_iter, service);
}
return SLP_OK;
}
/**
* Register a service. May register with DAs if we know about any.
*/
uint16_t SLPServer::InternalDeRegisterService(const ServiceEntry &service) {
TimeStamp now;
GetCurrentTime(&now);
SLPStore::ReturnCode result = m_service_store.CheckIfScopesMatch(now,
service);
if (result == SLPStore::SCOPE_MISMATCH)
return SCOPE_NOT_SUPPORTED;
else if (result == SLPStore::NOT_FOUND)
return SLP_OK;
CancelPendingDAOperationsForService(service.url_string());
vector<DirectoryAgent> directory_agents;
// This only works correctly if we assume DAs can't change scopes
// if a DA changes scopes it's not really clear what we're supposed to do
m_da_tracker.GetDAsForScopes(service.scopes(), &directory_agents);
for (vector<DirectoryAgent>::iterator da_iter = directory_agents.begin();
da_iter != directory_agents.end(); ++da_iter) {
DeRegisterWithDA(*da_iter, service);
}
// TODO(simon): use the error from here, and maybe skip the DA part
m_service_store.Remove(service);
return SLP_OK;
}
/**
* SrvAck callback for SrvReg and SrvDeReg requests.
*/
void SLPServer::ReceivedAck(UnicastSrvRegOperation *op,
uint16_t error_code) {
if (error_code == DA_BUSY_NOW)
// This is the same as a failure, so let the timeout expire.
// TODO(simon): does this count towards marking a DA as bad?
return;
if (error_code)
OLA_WARN << "xid " << op->xid << " returned " << error_code << " : "
<< SLPErrorToString(error_code);
else
OLA_INFO << "xid " << op->xid << " was acked";
// this deletes the timeout, and the UnicastSrvRegOperation
CancelPendingDAOperationsForServiceAndDA(op->service.url().url(),
op->da_url);
}
/*
* The timeout handler for SrvReg requests.
*/
void SLPServer::RegistrationTimeout(UnicastSrvRegOperation *op) {
UnicastOperationDeleter op_deleter(op, this);
PendingAckMap::iterator iter = m_pending_acks.find(op->xid);
if (iter == m_pending_acks.end()) {
OLA_WARN << "Unable to find matching xid: " << op->xid;
return;
}
OLA_INFO << "in timeout, retry was " << op->retry_time();
if (op->service.mutable_url().AgeLifetime(op->retry_time() / 1000)) {
// this service has expired while we're trying to register it
OLA_INFO << "Service " << op->service << " expired during registration.";
CancelPendingSrvAck(iter);
return;
}
op->UpdateRetryTime();
if (op->total_time() + op->retry_time() > m_config_retry_max) {
// this DA is bad
OLA_INFO << "Declaring DA " << op->da_url << " bad since total time is now "
<< op->total_time();
m_da_tracker.MarkAsBad(op->da_url);
CancelPendingSrvAck(iter);
return;
}
DirectoryAgent da;
if (!m_da_tracker.LookupDA(op->da_url, &da)) {
// This DA no longer exists
OLA_WARN << "DA " << op->da_url << " no longer exists";
CancelPendingSrvAck(iter);
return;
}
ScopeSet scopes_to_use = da.scopes().Intersection(op->service.scopes());
if (scopes_to_use.empty()) {
OLA_INFO << "DA " << op->da_url << " no longer has scopes that match "
<< op->service;
CancelPendingSrvAck(iter);
return;
}
// we're going to reuse the op, so don't delete it.
op_deleter.Cancel();
// if the scopes are different, do we need a new xid?
// TODO(simon)
// xid_t xid = m_xid_allocator.Next();
m_udp_sender.SendServiceRegistration(
IPV4SocketAddress(da.IPAddress(), m_slp_port),
op->xid, true, scopes_to_use, op->service);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::RegistrationTimeout, op));
}
/**
* The timeout handler for SrvDeReg requests
*/
void SLPServer::DeRegistrationTimeout(UnicastSrvRegOperation *op) {
UnicastOperationDeleter op_deleter(op, this);
PendingAckMap::iterator iter = m_pending_acks.find(op->xid);
if (iter == m_pending_acks.end()) {
OLA_WARN << "Unable to find matching xid: " << op->xid;
return;
}
// ok, we need to re-try
op->UpdateRetryTime();
if (op->total_time() + op->retry_time() >= m_config_retry_max) {
// this DA is bad
OLA_INFO << "Declaring DA " << op->da_url << " bad since total time is now "
<< op->total_time();
m_da_tracker.MarkAsBad(op->da_url);
CancelPendingSrvAck(iter);
return;
}
DirectoryAgent da;
if (!m_da_tracker.LookupDA(op->da_url, &da)) {
// This DA no longer exists
OLA_WARN << "DA " << op->da_url << " no longer exists";
CancelPendingSrvAck(iter);
return;
}
ScopeSet scopes_to_use = da.scopes().Intersection(op->service.scopes());
// we're going to reuse the op, so don't delete it.
op_deleter.Cancel();
// It's not clear which scopes we should use here if the DA has changed since
// we registered. For now we attempt to DeReg with the exact same scopes that
// we registered with (Section 8.3)
m_udp_sender.SendServiceDeRegistration(
IPV4SocketAddress(da.IPAddress(), m_slp_port), op->xid,
scopes_to_use, op->service);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::DeRegistrationTimeout, op));
}
/*
* Register a service with a DA. We only register for the scopes each DA
* supports.
* @param directory_agents the DA to register with
* @param service the service to register
*/
void SLPServer::RegisterWithDA(const DirectoryAgent &agent,
const ServiceEntry &service) {
OLA_INFO << "Registering " << service << " with " << agent;
UnicastSrvRegOperation *op = new UnicastSrvRegOperation(
m_xid_allocator.Next(), m_config_retry, agent.URL(), service);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::RegistrationTimeout, op));
m_pending_ops.insert(make_pair(service.url().url(), op));
ScopeSet scopes_to_use = agent.scopes().Intersection(service.scopes());
m_udp_sender.SendServiceRegistration(
IPV4SocketAddress(agent.IPAddress(), m_slp_port),
op->xid, true, scopes_to_use, service);
AddPendingSrvAck(op->xid,
NewSingleCallback(this, &SLPServer::ReceivedAck, op));
}
/*
* De-Register a service with a DA. We only register for the scopes each DA
* supports.
* @param directory_agents the DA to deregister with
* @param service the service to deregister
*/
void SLPServer::DeRegisterWithDA(const DirectoryAgent &agent,
const ServiceEntry &service) {
OLA_INFO << "DeRegistering " << service << " with " << agent;
UnicastSrvRegOperation *op = new UnicastSrvRegOperation(
m_xid_allocator.Next(), m_config_retry, agent.URL(), service);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::DeRegistrationTimeout, op));
m_pending_ops.insert(make_pair(service.url().url(), op));
// send message to DA
// TODO(simon): how do we know what scopes to de-register with?
ScopeSet scopes_to_use = agent.scopes().Intersection(service.scopes());
m_udp_sender.SendServiceDeRegistration(
IPV4SocketAddress(agent.IPAddress(), m_slp_port), op->xid, scopes_to_use,
service);
AddPendingSrvAck(op->xid,
NewSingleCallback(this, &SLPServer::ReceivedAck, op));
}
/**
* Remove a pending SrvAck from the map, and delete the callback
*/
void SLPServer::CancelPendingSrvAck(const PendingAckMap::iterator &iter) {
delete iter->second;
m_pending_acks.erase(iter);
}
/**
* Associate a callback with a xid.
*/
void SLPServer::AddPendingSrvAck(xid_t xid, AckCallback *callback) {
OLA_INFO << "adding callback for " << xid;
pair<xid_t, AckCallback*> p(xid, callback);
if (!m_pending_acks.insert(p).second)
OLA_WARN << "Collision for xid " << xid
<< ", we're probably leaking memory!";
}
/**
* Send a Service Request for 'directory-agent'
*/
void SLPServer::StartActiveDADiscovery() {
if (m_outstanding_da_discovery.get()) {
OLA_INFO << "Active DA Discovery already running.";
return;
}
m_outstanding_da_discovery.reset(
new PendingMulticastOperation(m_xid_allocator.Next(), m_config_retry));
SendDARequestAndSetupTimer(m_outstanding_da_discovery.get());
}
/**
* Called when we timeout a SrvRqst for service:directory-agent.
*/
void SLPServer::DASrvRqstTimeout() {
if (!m_outstanding_da_discovery.get()) {
OLA_WARN << "DA Tick but no outstanding DA request";
ScheduleActiveDADiscovery();
return;
}
PendingMulticastOperation *op = m_outstanding_da_discovery.get();
bool first_attempt = op->AttemptNumber() == 1;
op->UpdateRetryTime();
// make sure we always send the SrvRqst at least twice. The RFC isn't
// too clear about this, (6.3), but this protects against a dropped packet.
if ((!op->PRListChanged() && !first_attempt) ||
op->PRListSize() > MAX_PR_LIST_SIZE ||
op->total_time() >= m_config_mc_max) {
// we've come to the end of the road jack
m_outstanding_da_discovery.reset();
ScheduleActiveDADiscovery();
OLA_INFO << "Active DA discovery complete";
} else {
SendDARequestAndSetupTimer(op);
}
}
/**
* Send a SrvRqst for service:directory-agent and scheduler a timeout.
*/
void SLPServer::SendDARequestAndSetupTimer(PendingMulticastOperation *op) {
if (op->PRListChanged()) {
op->ResetPRListChanged();
// because the PR list changed we should use a new xid
op->xid = m_xid_allocator.Next();
}
m_udp_sender.SendServiceRequest(m_multicast_endpoint, op->xid,
op->pr_list, DIRECTORY_AGENT_SERVICE,
m_configured_scopes);
op->timer_id = m_ss->RegisterSingleTimeout(
op->retry_time(),
NewSingleCallback(this, &SLPServer::DASrvRqstTimeout));
}
/**
* Schedule the next active DA discovery run.
*/
void SLPServer::ScheduleActiveDADiscovery() {
m_active_da_discovery_timer = m_ss->RegisterSingleTimeout(
m_config_da_find,
NewSingleCallback(this, &SLPServer::StartActiveDADiscovery));
}
/**
* Called when the DA Tracker locates a new DA on the network.
*/
void SLPServer::NewDACallback(const DirectoryAgent &agent) {
m_ss->RegisterSingleTimeout(
Random(m_config_reg_active_min, m_config_reg_active_max),
NewSingleCallback(this, &SLPServer::RegisterServicesWithNewDA,
agent.URL()));
}
/**
* Register all of the relevent services with a DA
*/
void SLPServer::RegisterServicesWithNewDA(const string da_url) {
DirectoryAgent da;
if (!m_da_tracker.LookupDA(da_url, &da)) {
OLA_INFO << "DA " << da_url << " no longer exists";
return;
}
OLA_INFO << "Registering local services with " << da_url;
ServiceEntries services;
m_service_store.GetLocalServices(*(m_ss->WakeUpTime()), da.scopes(),
&services);
// Go through out local services and see if any need to be registered with
// this DA.
for (ServiceEntries::const_iterator iter = services.begin();
iter != services.end(); ++iter) {
RegisterWithDA(da, *iter);
}
}
/**
* Tidy up the SLP store
*/
bool SLPServer::CleanSLPStore() {
m_service_store.Clean(*(m_ss->WakeUpTime()));
return true;
}
/**
* Increment the method counter for the specified method.
*/
void SLPServer::IncrementMethodVar(const string &method) {
if (m_export_map)
m_export_map->GetUIntMapVar(METHOD_CALLS_VAR)->Increment(method);
}
/**
* Increment the packet counter for the specified packet type.
*/
void SLPServer::IncrementPacketVar(const string &packet) {
if (m_export_map)
m_export_map->GetUIntMapVar(UDP_RX_PACKET_BY_TYPE_VAR)->Increment(packet);
}
/**
* Get the current time, either from the Clock object given to us or the
* default clock.
*/
void SLPServer::GetCurrentTime(TimeStamp *time) {
if (m_clock) {
m_clock->CurrentTime(time);
} else {
ola::Clock clock;
clock.CurrentTime(time);
}
}
/**
* Check if we're in a PR list.
*/
bool SLPServer::InPRList(const vector<IPV4Address> &pr_list) {
return std::find(pr_list.begin(), pr_list.end(), m_iface_address) !=
pr_list.end();
}
} // namespace slp
} // namespace ola
|