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
|
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <Eris/Metaserver.h>
#include <Eris/MetaQuery.h>
#include <Eris/Utils.h>
#include <Eris/ServerInfo.h>
#include <Eris/Timeout.h>
#include <Eris/Poll.h>
#include <Eris/Log.h>
#include <Eris/Exceptions.h>
#include <Atlas/Objects/Operation/Info.h>
#include <Atlas/Objects/Entity/RootEntity.h>
#include <sigc++/object_slot.h>
#include <cassert>
#include <cstdio>
#ifdef __WIN32__
#ifndef snprintf
#define snprintf _snprintf
#endif
#endif // __WIN32__
namespace Eris {
char* pack_uint32(uint32_t data, char* buffer, unsigned int &size);
char* unpack_uint32(uint32_t &dest, char* buffer);
const int META_SERVER_PORT = 8453;
// meta-server protocol commands
const uint32_t CKEEP_ALIVE = 2,
HANDSHAKE = 3,
CLIENTSHAKE = 5,
LIST_REQ = 7,
LIST_RESP = 8,
PROTO_ERANGE = 9;
// special command value to track LIST_RESP processing
const uint32_t LIST_RESP2 = 999;
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
Meta::Meta(const std::string &/*cnm*/,
const std::string &msv,
unsigned int maxQueries) :
_status(INVALID),
_metaHost(msv),
_maxActiveQueries(maxQueries),
_stream(NULL),
_timeout(NULL)
{
Poll::instance().connect(SigC::slot(*this, &Meta::gotData));
}
Meta::~Meta()
{
disconnect();
// delete any outstanding queries
for (MetaQueryList::iterator Q=_activeQueries.begin(); Q!=_activeQueries.end();++Q)
delete *Q;
}
void Meta::connect()
{
disconnect();
_stream = new udp_socket_stream();
_stream->setTimeout(30);
_stream->setTarget(_metaHost, META_SERVER_PORT);
// open connection to meta server
if (!_stream->is_open()) {
doFailure("Couldn't open connection to metaserver " + _metaHost);
return;
}
Poll::instance().addStream(_stream);
// build the initial 'ping' and send
unsigned int dsz = 0;
pack_uint32(CKEEP_ALIVE, _data, dsz);
(*_stream) << std::string(_data, dsz) << std::flush;
setupRecvCmd();
_status = IN_PROGRESS;
// check for meta-server timeouts; this is going to be
// fairly common as long as the protocol is UDP, I think
_timeout = new Timeout("meta_ckeepalive_"+_metaHost, this, 8000);
_timeout->Expired.connect(SigC::slot(*this, &Meta::metaTimeout));
}
void Meta::disconnect()
{
if(_stream) {
Poll::instance().removeStream(_stream);
delete _stream;
_stream = NULL;
}
if (_timeout) {
delete _timeout;
_timeout = NULL;
}
}
void Meta::queryServer(const std::string &ip)
{
if (_status != IN_PROGRESS)
_status = IN_PROGRESS;
if (_activeQueries.size() >= _maxActiveQueries) {
_pendingQueries.push_back(ip);
} else {
MetaQuery *q = new MetaQuery(this, ip);
if (q->isComplete()) {
// indicated a failure occurred, so we'll kill it now and say no more
delete q;
} else
_activeQueries.push_back(q);
}
}
void Meta::refresh()
{
connect();
if (_status == VALID) {
// save the current list in case we fail
_lastValidList = _gameServers;
}
_gameServers.clear();
connect();
}
ServerList Meta::getGameServerList()
{
ServerList ret;
// bail out quickly if INVALID
if (_status == INVALID) return ret;
for (ServerInfoMap::iterator I=_gameServers.begin(); I!=_gameServers.end();++I)
ret.push_back(I->second);
return ret;
}
const ServerInfo& Meta::getInfoForServer(unsigned int index) const
{
ServerInfoMap::const_iterator I = _gameServers.begin();
for(unsigned int i = 0; I != _gameServers.end(); ++i, ++I) {
if (i == index) {
return I->second;
}
}
throw BaseException("Invalid serverinfo object requested");
}
int Meta::getGameServerCount() const
{
if (_status == INVALID) return 0;
return _gameServers.size();
}
void Meta::gotData(PollData &data)
{
bool got_one = false; // set if at least one socket had data
if (_stream) {
if (!_stream->is_open()) {
// it died, delete it
doFailure("Connection to the meta-server failed");
} else {
if (data.isReady(_stream)) {
recv();
got_one = true;
}
}
} // of _stream being valid
for (MetaQueryList::iterator Q=_activeQueries.begin();
Q != _activeQueries.end(); ++Q)
{
(*Q)->recv();
got_one = true;
}
if(!got_one)
return; // nothing had data, so do not run the clean up stuff
// clean up old queries
while (!_deleteQueries.empty()) {
MetaQuery *qr = _deleteQueries.front();
_activeQueries.remove(qr);
delete qr;
_deleteQueries.pop_front();
}
// start pending queries as slots become available
while (!_pendingQueries.empty() && (_activeQueries.size() < _maxActiveQueries)) {
queryServer(_pendingQueries.front());
_pendingQueries.pop_front();
}
if ((_status == VALID) && (_activeQueries.empty())) {
// we're all done, emit the signal
CompletedServerList.emit();
}
}
void Meta::recv()
{
assert(_bytesToRecv);
Eris::log(LOG_DEBUG, "got data from the meta-server");
do {
int d = _stream->get();
*(_dataPtr++) = static_cast<char>(d);
_bytesToRecv--;
} while (_stream->rdbuf()->in_avail() && _bytesToRecv);
if (_bytesToRecv == 0) {
// recieved the next set
if (_recvCmd) {
uint32_t op;
unpack_uint32(op, _data);
recvCmd(op);
} else {
processCmd();
}
// try and read more
if (_bytesToRecv && _stream->rdbuf()->in_avail())
recv();
}
}
void Meta::cancel()
{
_pendingQueries.clear();
for (MetaQueryList::iterator Q=_activeQueries.begin(); Q!=_activeQueries.end();++Q)
delete *Q;
_activeQueries.clear();
disconnect();
// revert to the last valid list if possible
if (!_lastValidList.empty()) {
_gameServers = _lastValidList;
_status = VALID;
} else
_status = INVALID;
}
void Meta::recvCmd(uint32_t op)
{
Eris::log(LOG_DEBUG, "recvd meta-server CMD %i", op);
switch (op) {
case HANDSHAKE:
setupRecvData(1, HANDSHAKE);
break;
case PROTO_ERANGE:
doFailure("Got list range error from Metaserver");
break;
case LIST_RESP:
setupRecvData(2, LIST_RESP);
break;
default:
doFailure("Unknown Meta server command");
}
}
void Meta::processCmd()
{
switch (_gotCmd) {
case HANDSHAKE: {
uint32_t stamp;
unpack_uint32(stamp, _data);
unsigned int dsz = 0;
_dataPtr = pack_uint32(CLIENTSHAKE, _data, dsz);
pack_uint32(stamp, _dataPtr, dsz);
(*_stream) << std::string(_data, dsz) << std::flush;
// clear the handshake timeout, so listReq can start it's own.
delete _timeout;
_timeout = NULL;
Eris::log(LOG_DEBUG, "processed HANDSHAKE, sending list request");
// send the initial list request
listReq(0);
} break;
case LIST_RESP: {
//uint32_t _totalServers, _packed;
_dataPtr = unpack_uint32(_totalServers, _data);
unpack_uint32(_packed, _dataPtr);
setupRecvData(_packed, LIST_RESP2);
Eris::log(LOG_DEBUG, "processed LIST_RESP");
// allow progress bars to setup, etc, etc
GotServerCount.emit(_totalServers);
} break;
case LIST_RESP2: {
_dataPtr = _data;
while (_packed--) {
uint32_t ip;
_dataPtr = unpack_uint32(ip, _dataPtr);
char buf[32];
snprintf(buf, 32, "%i.%i.%i.%i",
(ip & 0x000000FF),
(ip & 0x0000FF00) >> 8,
(ip & 0x00FF0000) >> 16,
(ip & 0xFF000000) >> 24
);
// FIXME - decide whther a reverse name lookup is necessary here or not
// create as required
if (_gameServers.find(buf) == _gameServers.end())
_gameServers.insert(
ServerInfoMap::value_type(buf, ServerInfo(buf))
);
Eris::log(LOG_DEBUG, "queueing game server %s for query", buf);
// is always querying a good idea?
queryServer(buf);
}
if (_gameServers.size() < _totalServers) {
// request some more
Eris::log(LOG_DEBUG, "in LIST_RESP2, issuing request for next block");
listReq(_gameServers.size());
} else {
// all done, clean up
disconnect();
}
} break;
default:
doFailure("Unknown Meta server command");
}
}
void Meta::listReq(int base)
{
unsigned int dsz=0;
char* _dataPtr = pack_uint32(LIST_REQ, _data, dsz);
pack_uint32(base, _dataPtr, dsz);
(*_stream) << std::string(_data, dsz) << std::flush;
setupRecvCmd();
if (_timeout)
_timeout->reset(5000);
else {
_timeout = new Timeout("meta_list_req", this, 8000);
_timeout->Expired.connect(SigC::slot(*this, &Meta::metaTimeout));
}
}
void Meta::objectArrived(const Atlas::Message::Element &msg)
{
// build an info op (quick hack)
Atlas::Objects::Operation::Info ifo;
Atlas::Message::Element::MapType::const_iterator I = msg.asMap().begin();
for (; I != msg.asMap().end(); ++I)
ifo.setAttr(I->first, I->second);
// work out which query this is
long refno = ifo.getRefno();
MetaQueryList::iterator Q;
for (Q = _activeQueries.begin(); Q != _activeQueries.end(); ++Q)
if ((*Q)->getQueryNo() == refno) break;
if (Q == _activeQueries.end()) {
// handle old behaviour (no serial / refno set in reply); this only works
// with single query mode (i.e Max-Queries = 1)
if (_activeQueries.size() == 1)
Q = _activeQueries.begin();
else {
Eris::log(LOG_ERROR, "Couldn't locate query for meta-query reply");
return;
}
}
// extract the server object
Atlas::Objects::Entity::RootEntity svr;
Atlas::Message::Element::MapType m = getArg(ifo, 0).asMap();
for (Atlas::Message::Element::MapType::iterator I=m.begin() ; I != m.end(); ++I)
svr.setAttr(I->first, I->second);
// update the server-info structure
ServerInfoMap::iterator S = _gameServers.find((*Q)->getHost());
assert(S != _gameServers.end());
S->second.processServer(svr);
S->second.setPing((*Q)->getElapsed());
// emit the signal
ReceivedServerInfo.emit(S->second);
_deleteQueries.push_back(*Q);
}
void Meta::doFailure(const std::string &msg)
{
Failure.emit(msg);
disconnect();
// try to revert back to the last good list
if (!_lastValidList.empty()) {
_gameServers = _lastValidList;
_status = VALID;
} else
_status = INVALID;
}
void Meta::metaTimeout()
{
// might want different behaviour in the future, I suppose
doFailure("Connection to the meta-server timed out");
}
void Meta::queryFailure(MetaQuery *q, const std::string &msg)
{
// we do NOT emit a failure signal here (becuase that would probably cause the
// host app to pop up a dialog or something) since query failures are likely to
// be very frequent.
Eris::log(LOG_DEBUG, "Query Failure: %s", msg.c_str());
_deleteQueries.push_back(q);
}
void Meta::queryTimeout(MetaQuery *q)
{
Eris::log(LOG_DEBUG, "Query Timeout");
_deleteQueries.push_back(q);
}
void Meta::setupRecvCmd()
{
_recvCmd = true;
_bytesToRecv = sizeof(uint32_t);
_dataPtr = (char*) _data;
}
void Meta::setupRecvData(int words, uint32_t got)
{
_recvCmd = false;
_bytesToRecv = words * sizeof(uint32_t);
_dataPtr = (char*) _data;
_gotCmd = got;
}
/* pack the data into the specified buffer, update the buffer size, and return
the new buffer insert pointer */
char* pack_uint32(uint32_t data, char* buffer, unsigned int &size)
{
uint32_t netorder;
netorder = htonl(data);
memcpy(buffer, &netorder, sizeof(uint32_t));
size += sizeof(uint32_t);
return buffer+sizeof(uint32_t);
}
/* unpack one data from the buffer, and return the next extract pointer */
char* unpack_uint32(uint32_t &dest, char* buffer)
{
uint32_t netorder;
memcpy(&netorder, buffer, sizeof(uint32_t));
dest = ntohl(netorder);
return buffer+sizeof(uint32_t);
}
} // of Eris namespace
|