2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 * Berkeley Socket-based ListenerService implementation
24 #include "exceptions.h"
25 #include "remoting/impl/SocketListener.h"
30 #include <shibsp/SPConfig.h>
31 #include <xmltooling/util/NDC.h>
37 using namespace shibsp;
38 using namespace xmltooling;
39 using namespace log4cpp;
41 using xercesc::DOMElement;
45 // Manages the pool of connections
49 SocketPool(Category& log, const SocketListener* listener)
50 : m_log(log), m_listener(listener), m_lock(Mutex::create()) {}
52 SocketListener::ShibSocket get();
53 void put(SocketListener::ShibSocket s);
56 SocketListener::ShibSocket connect();
58 const SocketListener* m_listener;
60 auto_ptr<Mutex> m_lock;
61 stack<SocketListener::ShibSocket> m_pool;
64 // Worker threads in server
67 ServerThread(SocketListener::ShibSocket& s, SocketListener* listener, unsigned long id);
73 SocketListener::ShibSocket m_sock;
75 SocketListener* m_listener;
81 SocketListener::ShibSocket SocketPool::connect()
87 m_log.debug("trying to connect to listener");
89 SocketListener::ShibSocket sock;
90 if (!m_listener->create(sock)) {
91 m_log.error("cannot create socket");
92 throw ListenerException("Cannot create socket");
95 bool connected = false;
98 for (int i = num_tries-1; i >= 0; i--) {
99 if (m_listener->connect(sock)) {
104 m_log.warn("cannot connect socket (%u)...%s", sock, (i > 0 ? "retrying" : ""));
108 Sleep(2000*(num_tries-i));
110 sleep(2*(num_tries-i));
116 m_log.crit("socket server unavailable, failing");
117 m_listener->close(sock);
118 throw ListenerException("Cannot connect to shibd process, a site adminstrator should be notified.");
121 m_log.debug("socket (%u) connected successfully", sock);
125 SocketPool::~SocketPool()
127 while (!m_pool.empty()) {
129 closesocket(m_pool.top());
131 ::close(m_pool.top());
137 SocketListener::ShibSocket SocketPool::get()
140 if (m_pool.empty()) {
144 SocketListener::ShibSocket ret=m_pool.top();
150 void SocketPool::put(SocketListener::ShibSocket s)
157 SocketListener::SocketListener(const DOMElement* e) : log(&Category::getInstance(SHIBSP_LOGCAT".Listener")),
158 m_shutdown(NULL), m_child_lock(NULL), m_child_wait(NULL), m_socketpool(NULL), m_socket((ShibSocket)0)
161 if (SPConfig::getConfig().isEnabled(SPConfig::InProcess)) {
162 m_socketpool=new SocketPool(*log,this);
165 if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
166 m_child_lock = Mutex::create();
167 m_child_wait = CondWait::create();
171 SocketListener::~SocketListener()
178 bool SocketListener::run(bool* shutdown)
184 // Save flag to monitor for shutdown request.
186 unsigned long count = 0;
188 if (!create(m_socket)) {
189 log->crit("failed to create socket");
192 if (!bind(m_socket,true)) {
193 this->close(m_socket);
194 log->crit("failed to bind to socket.");
198 while (!*m_shutdown) {
201 FD_SET(m_socket, &readfds);
202 struct timeval tv = { 0, 0 };
205 switch (select(m_socket + 1, &readfds, 0, 0, &tv)) {
211 if (errno == EINTR) continue;
213 log->error("select() on main listener socket failed");
221 // Accept the connection.
222 SocketListener::ShibSocket newsock;
223 if (!accept(m_socket, newsock))
224 log->crit("failed to accept incoming socket connection");
226 // We throw away the result because the children manage themselves...
228 new ServerThread(newsock,this,++count);
231 log->crit("error starting new server thread to service incoming request");
236 log->info("listener service shutting down");
238 // Wait for all children to exit.
239 m_child_lock->lock();
240 while (!m_children.empty())
241 m_child_wait->wait(m_child_lock);
242 m_child_lock->unlock();
244 this->close(m_socket);
245 m_socket=(ShibSocket)0;
249 DDF SocketListener::send(const DDF& in)
255 log->debug("sending message: %s", in.name());
257 // Serialize data for transmission.
260 string ostr(os.str());
262 // Loop on the RPC in case we lost contact the first time through
269 SocketListener::ShibSocket sock;
271 sock = m_socketpool->get();
273 int outlen = ostr.length();
275 if (send(sock,(char*)&len,sizeof(len)) != sizeof(len) || send(sock,ostr.c_str(),outlen) != outlen) {
281 throw ListenerException("Failure sending remoted message ($1).", params(1,in.name()));
289 log->debug("send completed, reading response message");
292 if (recv(sock,(char*)&len,sizeof(len)) != sizeof(len)) {
293 log->error("error reading size of output message");
295 throw ListenerException("Failure receiving response to remoted message ($1).", params(1,in.name()));
302 while (len && (size_read = recv(sock, buf, sizeof(buf))) > 0) {
303 is.write(buf, size_read);
308 log->error("error reading output message from socket");
310 throw ListenerException("Failure receiving response to remoted message ($1).", params(1,in.name()));
313 m_socketpool->put(sock);
319 // Check for exception to unmarshall and throw, otherwise return.
320 if (out.isstring() && out.name() && !strcmp(out.name(),"exception")) {
321 // Reconstitute exception object.
322 DDFJanitor jout(out);
323 XMLToolingException* except=NULL;
325 except=XMLToolingException::fromString(out.string());
327 catch (XMLToolingException& e) {
328 log->error("caught XMLToolingException while building the XMLToolingException: %s", e.what());
329 log->error("XML was: %s", out.string());
330 throw ListenerException("Remote call failed with an unparsable exception.");
333 auto_ptr<XMLToolingException> wrapper(except);
340 bool SocketListener::log_error() const
343 int rc=WSAGetLastError();
347 #ifdef HAVE_STRERROR_R
349 memset(buf,0,sizeof(buf));
350 strerror_r(rc,buf,sizeof(buf));
351 log->error("socket call resulted in error (%d): %s",rc,isprint(*buf) ? buf : "no message");
353 const char* buf=strerror(rc);
354 log->error("socket call resulted in error (%d): %s",rc,isprint(*buf) ? buf : "no message");
359 // actual function run in listener on server threads
360 void* server_thread_fn(void* arg)
362 ServerThread* child = (ServerThread*)arg;
365 // First, let's block all signals
366 Thread::mask_all_signals();
369 // Run the child until it exits.
372 // Now we can clean up and exit the thread.
377 ServerThread::ServerThread(SocketListener::ShibSocket& s, SocketListener* listener, unsigned long id)
378 : m_sock(s), m_child(NULL), m_listener(listener)
382 buf << "[" << id << "]";
385 // Create the child thread
386 m_child = Thread::create(server_thread_fn, (void*)this);
390 ServerThread::~ServerThread()
392 // Then lock the children map, remove this socket/thread, signal waiters, and return
393 m_listener->m_child_lock->lock();
394 m_listener->m_children.erase(m_sock);
395 m_listener->m_child_lock->unlock();
396 m_listener->m_child_wait->signal();
401 void ServerThread::run()
405 // Before starting up, make sure we fully "own" this socket.
406 m_listener->m_child_lock->lock();
407 while (m_listener->m_children.find(m_sock)!=m_listener->m_children.end())
408 m_listener->m_child_wait->wait(m_listener->m_child_lock);
409 m_listener->m_children[m_sock] = m_child;
410 m_listener->m_child_lock->unlock();
413 struct timeval tv = { 0, 0 };
415 while(!*(m_listener->m_shutdown)) {
417 FD_SET(m_sock, &readfds);
420 switch (select(m_sock+1, &readfds, 0, 0, &tv)) {
426 if (errno == EINTR) continue;
427 m_listener->log_error();
428 m_listener->log->error("select() on incoming request socket (%u) returned error", m_sock);
436 m_listener->log_error();
437 m_listener->log->error("I/O failure processing request on socket (%u)", m_sock);
438 m_listener->close(m_sock);
445 bool ServerThread::job()
447 Category& log = Category::getInstance("shibd.Listener");
458 if (m_listener->recv(m_sock,(char*)&len,sizeof(len)) != sizeof(len)) {
459 log.error("error reading size of input message");
466 while (len && (size_read = m_listener->recv(m_sock, m_buf, sizeof(m_buf))) > 0) {
467 is.write(m_buf, size_read);
472 log.error("error reading input message from socket");
476 // Unmarshall the message.
481 // Dispatch the message.
482 m_listener->receive(in, sink);
484 catch (XMLToolingException& e) {
485 log.error("error processing incoming message: %s", e.what());
486 DDF out=DDF("exception").string(e.toString().c_str());
487 DDFJanitor jout(out);
490 catch (exception& e) {
491 log.error("error processing incoming message: %s", e.what());
492 ListenerException ex(e.what());
493 DDF out=DDF("exception").string(ex.toString().c_str());
494 DDFJanitor jout(out);
499 log.error("unexpected error processing incoming message");
500 ListenerException ex("An unexpected error occurred while processing an incoming message.");
501 DDF out=DDF("exception").string(ex.toString().c_str());
502 DDFJanitor jout(out);
507 // Return whatever's available.
508 string response(sink.str());
509 int outlen = response.length();
511 if (m_listener->send(m_sock,(char*)&len,sizeof(len)) != sizeof(len)) {
512 log.error("error sending output message size");
515 if (m_listener->send(m_sock,response.c_str(),outlen) != outlen) {
516 log.error("error sending output message");