shibsp/remoting/impl/SocketListener.cpp

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * SocketListener.cpp
  19  *
  20  * Berkeley Socket-based ListenerService implementation
  21  */
  22
  23 #include "internal.h"
  24 #include "exceptions.h"
  25 #include "ServiceProvider.h"
  26 #include "remoting/impl/SocketListener.h"
  27
  28 #include <errno.h>
  29 #include <stack>
  30 #include <sstream>
  31 #include <shibsp/SPConfig.h>
  32 #include <xmltooling/util/NDC.h>
  33
  34 #ifndef WIN32
  35 # include <netinet/in.h>
  36 #endif
  37
  38 #ifdef HAVE_UNISTD_H
  39 # include <unistd.h>
  40 #endif
  41
  42 using namespace shibsp;
  43 using namespace xmltooling;
  44 using namespace std;
  45 using xercesc::DOMElement;
  46
  47 namespace shibsp {
  48
  49     // Manages the pool of connections
  50     class SocketPool
  51     {
  52     public:
  53         SocketPool(Category& log, const SocketListener* listener)
  54             : m_log(log), m_listener(listener), m_lock(Mutex::create()) {}
  55         ~SocketPool();
  56         SocketListener::ShibSocket get();
  57         void put(SocketListener::ShibSocket s);
  58
  59     private:
  60         SocketListener::ShibSocket connect();
  61
  62         Category& m_log;
  63         const SocketListener* m_listener;
  64         auto_ptr<Mutex> m_lock;
  65         stack<SocketListener::ShibSocket> m_pool;
  66     };
  67
  68     // Worker threads in server
  69     class ServerThread {
  70     public:
  71         ServerThread(SocketListener::ShibSocket& s, SocketListener* listener, unsigned long id);
  72         ~ServerThread();
  73         void run();
  74         int job();  // Return -1 on error, 1 for closed, 0 for success
  75
  76     private:
  77         SocketListener::ShibSocket m_sock;
  78         Thread* m_child;
  79         SocketListener* m_listener;
  80         string m_id;
  81         char m_buf[16384];
  82     };
  83 }
  84
  85 SocketListener::ShibSocket SocketPool::connect()
  86 {
  87 #ifdef _DEBUG
  88     NDC ndc("connect");
  89 #endif
  90
  91     m_log.debug("trying to connect to listener");
  92
  93     SocketListener::ShibSocket sock;
  94     if (!m_listener->create(sock)) {
  95         m_log.error("cannot create socket");
  96         throw ListenerException("Cannot create socket");
  97     }
  98
  99     bool connected = false;
 100     int num_tries = 3;
 101
 102     for (int i = num_tries-1; i >= 0; i--) {
 103         if (m_listener->connect(sock)) {
 104             connected = true;
 105             break;
 106         }
 107
 108         m_log.warn("cannot connect socket (%u)...%s", sock, (i > 0 ? "retrying" : ""));
 109
 110         if (i) {
 111 #ifdef WIN32
 112             Sleep(2000*(num_tries-i));
 113 #else
 114             sleep(2*(num_tries-i));
 115 #endif
 116         }
 117     }
 118
 119     if (!connected) {
 120         m_log.crit("socket server unavailable, failing");
 121         m_listener->close(sock);
 122         throw ListenerException("Cannot connect to shibd process, a site adminstrator should be notified.");
 123     }
 124
 125     m_log.debug("socket (%u) connected successfully", sock);
 126     return sock;
 127 }
 128
 129 SocketPool::~SocketPool()
 130 {
 131     while (!m_pool.empty()) {
 132 #ifdef WIN32
 133         closesocket(m_pool.top());
 134 #else
 135         ::close(m_pool.top());
 136 #endif
 137         m_pool.pop();
 138     }
 139 }
 140
 141 SocketListener::ShibSocket SocketPool::get()
 142 {
 143     m_lock->lock();
 144     if (m_pool.empty()) {
 145         m_lock->unlock();
 146         return connect();
 147     }
 148     SocketListener::ShibSocket ret=m_pool.top();
 149     m_pool.pop();
 150     m_lock->unlock();
 151     return ret;
 152 }
 153
 154 void SocketPool::put(SocketListener::ShibSocket s)
 155 {
 156     m_lock->lock();
 157     m_pool.push(s);
 158     m_lock->unlock();
 159 }
 160
 161 SocketListener::SocketListener(const DOMElement* e) : m_catchAll(false), log(&Category::getInstance(SHIBSP_LOGCAT".Listener")),
 162     m_socketpool(NULL), m_shutdown(NULL), m_child_lock(NULL), m_child_wait(NULL), m_socket((ShibSocket)0)
 163 {
 164     // Are we a client?
 165     if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
 166         m_socketpool=new SocketPool(*log,this);
 167     }
 168     // Are we a server?
 169     if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
 170         m_child_lock = Mutex::create();
 171         m_child_wait = CondWait::create();
 172     }
 173 }
 174
 175 SocketListener::~SocketListener()
 176 {
 177     delete m_socketpool;
 178     delete m_child_wait;
 179     delete m_child_lock;
 180 }
 181
 182 bool SocketListener::run(bool* shutdown)
 183 {
 184 #ifdef _DEBUG
 185     NDC ndc("run");
 186 #endif
 187     log->info("listener service starting");
 188
 189     ServiceProvider* sp = SPConfig::getConfig().getServiceProvider();
 190     sp->lock();
 191     const PropertySet* props = sp->getPropertySet("OutOfProcess");
 192     if (props) {
 193         pair<bool,bool> flag = props->getBool("catchAll");
 194         m_catchAll = flag.first && flag.second;
 195     }
 196     sp->unlock();
 197
 198     // Save flag to monitor for shutdown request.
 199     m_shutdown=shutdown;
 200     unsigned long count = 0;
 201
 202     if (!create(m_socket)) {
 203         log->crit("failed to create socket");
 204         return false;
 205     }
 206     if (!bind(m_socket,true)) {
 207         this->close(m_socket);
 208         log->crit("failed to bind to socket.");
 209         return false;
 210     }
 211
 212     while (!*m_shutdown) {
 213         fd_set readfds;
 214         FD_ZERO(&readfds);
 215         FD_SET(m_socket, &readfds);
 216         struct timeval tv = { 0, 0 };
 217         tv.tv_sec = 5;
 218
 219         switch (select(m_socket + 1, &readfds, 0, 0, &tv)) {
 220 #ifdef WIN32
 221             case SOCKET_ERROR:
 222 #else
 223             case -1:
 224 #endif
 225                 if (errno == EINTR) continue;
 226                 log_error();
 227                 log->error("select() on main listener socket failed");
 228                 return false;
 229
 230             case 0:
 231                 continue;
 232
 233             default:
 234             {
 235                 // Accept the connection.
 236                 SocketListener::ShibSocket newsock;
 237                 if (!accept(m_socket, newsock))
 238                     log->crit("failed to accept incoming socket connection");
 239
 240                 // We throw away the result because the children manage themselves...
 241                 try {
 242                     new ServerThread(newsock,this,++count);
 243                 }
 244                 catch (exception& ex) {
 245                     log->crit("exception starting new server thread to service incoming request: %s", ex.what());
 246                 }
 247                 catch (...) {
 248                     log->crit("unknown error starting new server thread to service incoming request");
 249                     if (!m_catchAll)
 250                         *m_shutdown = true;
 251                 }
 252             }
 253         }
 254     }
 255     log->info("listener service shutting down");
 256
 257     // Wait for all children to exit.
 258     m_child_lock->lock();
 259     while (!m_children.empty())
 260         m_child_wait->wait(m_child_lock);
 261     m_child_lock->unlock();
 262
 263     this->close(m_socket);
 264     m_socket=(ShibSocket)0;
 265     return true;
 266 }
 267
 268 DDF SocketListener::send(const DDF& in)
 269 {
 270 #ifdef _DEBUG
 271     NDC ndc("send");
 272 #endif
 273
 274     log->debug("sending message (%s)", in.name() ? in.name() : "unnamed");
 275
 276     // Serialize data for transmission.
 277     ostringstream os;
 278     os << in;
 279     string ostr(os.str());
 280
 281     // Loop on the RPC in case we lost contact the first time through
 282 #ifdef WIN32
 283     u_long len;
 284 #else
 285     uint32_t len;
 286 #endif
 287     int retry = 1;
 288     SocketListener::ShibSocket sock;
 289     while (retry >= 0) {
 290         sock = m_socketpool->get();
 291
 292         int outlen = ostr.length();
 293         len = htonl(outlen);
 294         if (send(sock,(char*)&len,sizeof(len)) != sizeof(len) || send(sock,ostr.c_str(),outlen) != outlen) {
 295             log_error();
 296             this->close(sock);
 297             if (retry)
 298                 retry--;
 299             else
 300                 throw ListenerException("Failure sending remoted message ($1).", params(1,in.name()));
 301         }
 302         else {
 303             // SUCCESS.
 304             retry = -1;
 305         }
 306     }
 307
 308     log->debug("send completed, reading response message");
 309
 310     // Read the message.
 311     while (recv(sock,(char*)&len,sizeof(len)) != sizeof(len)) {
 312         if (errno == EINTR) continue;   // Apparently this happens when a signal interrupts the blocking call.
 313         log->error("error reading size of output message");
 314         this->close(sock);
 315         throw ListenerException("Failure receiving response to remoted message ($1).", params(1,in.name()));
 316     }
 317     len = ntohl(len);
 318
 319     char buf[16384];
 320     int size_read;
 321     stringstream is;
 322     while (len) {
 323         size_read = recv(sock, buf, sizeof(buf));
 324         if (size_read > 0) {
 325             is.write(buf, size_read);
 326             len -= size_read;
 327         }
 328         else if (errno != EINTR) {
 329                 break;
 330         }
 331     }
 332
 333     if (len) {
 334         log->error("error reading output message from socket");
 335         this->close(sock);
 336         throw ListenerException("Failure receiving response to remoted message ($1).", params(1,in.name()));
 337     }
 338
 339     m_socketpool->put(sock);
 340
 341     // Unmarshall data.
 342     DDF out;
 343     is >> out;
 344
 345     // Check for exception to unmarshall and throw, otherwise return.
 346     if (out.isstring() && out.name() && !strcmp(out.name(),"exception")) {
 347         // Reconstitute exception object.
 348         DDFJanitor jout(out);
 349         XMLToolingException* except=NULL;
 350         try {
 351             except=XMLToolingException::fromString(out.string());
 352             log->error("remoted message returned an error: %s", except->what());
 353         }
 354         catch (XMLToolingException& e) {
 355             log->error("caught XMLToolingException while building the XMLToolingException: %s", e.what());
 356             log->error("XML was: %s", out.string());
 357             throw ListenerException("Remote call failed with an unparsable exception.");
 358         }
 359
 360         auto_ptr<XMLToolingException> wrapper(except);
 361         wrapper->raise();
 362     }
 363
 364     return out;
 365 }
 366
 367 bool SocketListener::log_error() const
 368 {
 369 #ifdef WIN32
 370     int rc=WSAGetLastError();
 371 #else
 372     int rc=errno;
 373 #endif
 374 #ifdef HAVE_STRERROR_R
 375     char buf[256];
 376     memset(buf,0,sizeof(buf));
 377     strerror_r(rc,buf,sizeof(buf));
 378     log->error("socket call resulted in error (%d): %s",rc,isprint(*buf) ? buf : "no message");
 379 #else
 380     const char* buf=strerror(rc);
 381     log->error("socket call resulted in error (%d): %s",rc,isprint(*buf) ? buf : "no message");
 382 #endif
 383     return false;
 384 }
 385
 386 // actual function run in listener on server threads
 387 void* server_thread_fn(void* arg)
 388 {
 389     ServerThread* child = (ServerThread*)arg;
 390
 391 #ifndef WIN32
 392     // First, let's block all signals
 393     Thread::mask_all_signals();
 394 #endif
 395
 396     // Run the child until it exits.
 397     child->run();
 398
 399     // Now we can clean up and exit the thread.
 400     delete child;
 401     return NULL;
 402 }
 403
 404 ServerThread::ServerThread(SocketListener::ShibSocket& s, SocketListener* listener, unsigned long id)
 405     : m_sock(s), m_child(NULL), m_listener(listener)
 406 {
 407
 408     ostringstream buf;
 409     buf << "[" << id << "]";
 410     m_id = buf.str();
 411
 412     // Create the child thread
 413     m_child = Thread::create(server_thread_fn, (void*)this);
 414     m_child->detach();
 415 }
 416
 417 ServerThread::~ServerThread()
 418 {
 419     // Then lock the children map, remove this socket/thread, signal waiters, and return
 420     m_listener->m_child_lock->lock();
 421     m_listener->m_children.erase(m_sock);
 422     m_listener->m_child_lock->unlock();
 423     m_listener->m_child_wait->signal();
 424
 425     delete m_child;
 426 }
 427
 428 void ServerThread::run()
 429 {
 430     NDC ndc(m_id);
 431
 432     // Before starting up, make sure we fully "own" this socket.
 433     m_listener->m_child_lock->lock();
 434     while (m_listener->m_children.find(m_sock)!=m_listener->m_children.end())
 435         m_listener->m_child_wait->wait(m_listener->m_child_lock);
 436     m_listener->m_children[m_sock] = m_child;
 437     m_listener->m_child_lock->unlock();
 438
 439     int result;
 440     fd_set readfds;
 441     struct timeval tv = { 0, 0 };
 442
 443     while(!*(m_listener->m_shutdown)) {
 444         FD_ZERO(&readfds);
 445         FD_SET(m_sock, &readfds);
 446         tv.tv_sec = 1;
 447
 448         switch (select(m_sock+1, &readfds, 0, 0, &tv)) {
 449 #ifdef WIN32
 450         case SOCKET_ERROR:
 451 #else
 452         case -1:
 453 #endif
 454             if (errno == EINTR) continue;
 455             m_listener->log_error();
 456             m_listener->log->error("select() on incoming request socket (%u) returned error", m_sock);
 457             return;
 458
 459         case 0:
 460             break;
 461
 462         default:
 463             result = job();
 464             if (result) {
 465                 if (result < 0) {
 466                     m_listener->log_error();
 467                     m_listener->log->error("I/O failure processing request on socket (%u)", m_sock);
 468                 }
 469                 m_listener->close(m_sock);
 470                 return;
 471             }
 472         }
 473     }
 474 }
 475
 476 int ServerThread::job()
 477 {
 478     Category& log = Category::getInstance(SHIBSP_LOGCAT".Listener");
 479
 480     bool incomingError = true;  // set false once incoming message is received
 481     ostringstream sink;
 482 #ifdef WIN32
 483     u_long len;
 484 #else
 485     uint32_t len;
 486 #endif
 487
 488     try {
 489         // Read the message.
 490         int readlength = m_listener->recv(m_sock,(char*)&len,sizeof(len));
 491         if (readlength == 0) {
 492             log.info("detected socket closure, shutting down worker thread");
 493             return 1;
 494         }
 495         else if (readlength != sizeof(len)) {
 496             log.error("error reading size of input message");
 497             return -1;
 498         }
 499         len = ntohl(len);
 500
 501         int size_read;
 502         stringstream is;
 503         while (len && (size_read = m_listener->recv(m_sock, m_buf, sizeof(m_buf))) > 0) {
 504             is.write(m_buf, size_read);
 505             len -= size_read;
 506         }
 507
 508         if (len) {
 509             log.error("error reading input message from socket");
 510             return -1;
 511         }
 512
 513         // Unmarshall the message.
 514         DDF in;
 515         DDFJanitor jin(in);
 516         is >> in;
 517
 518         log.debug("dispatching message (%s)", in.name() ? in.name() : "unnamed");
 519
 520         incomingError = false;
 521
 522         // Dispatch the message.
 523         m_listener->receive(in, sink);
 524     }
 525     catch (XMLToolingException& e) {
 526         if (incomingError)
 527             log.error("error processing incoming message: %s", e.what());
 528         DDF out=DDF("exception").string(e.toString().c_str());
 529         DDFJanitor jout(out);
 530         sink << out;
 531     }
 532     catch (exception& e) {
 533         if (incomingError)
 534             log.error("error processing incoming message: %s", e.what());
 535         ListenerException ex(e.what());
 536         DDF out=DDF("exception").string(ex.toString().c_str());
 537         DDFJanitor jout(out);
 538         sink << out;
 539     }
 540     catch (...) {
 541         if (incomingError)
 542             log.error("unexpected error processing incoming message");
 543         if (!m_listener->m_catchAll)
 544             throw;
 545         ListenerException ex("An unexpected error occurred while processing an incoming message.");
 546         DDF out=DDF("exception").string(ex.toString().c_str());
 547         DDFJanitor jout(out);
 548         sink << out;
 549     }
 550
 551     // Return whatever's available.
 552     string response(sink.str());
 553     int outlen = response.length();
 554     len = htonl(outlen);
 555     if (m_listener->send(m_sock,(char*)&len,sizeof(len)) != sizeof(len)) {
 556         log.error("error sending output message size");
 557         return -1;
 558     }
 559     if (m_listener->send(m_sock,response.c_str(),outlen) != outlen) {
 560         log.error("error sending output message");
 561         return -1;
 562     }
 563
 564     return 0;
 565 }