1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2012 Index Data
4 Metaproxy is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Metaproxy is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 #include <metaproxy/util.hpp>
25 #include <metaproxy/filter.hpp>
26 #include <metaproxy/package.hpp>
27 #include "thread_pool_observer.hpp"
28 #include "filter_frontend_net.hpp"
29 #include <yazpp/z-assoc.h>
30 #include <yazpp/pdu-assoc.h>
31 #include <yazpp/socket-manager.h>
32 #include <yazpp/limit-connect.h>
33 #include <yaz/timing.h>
35 #include "gduutil.hpp"
39 namespace mp = metaproxy_1;
40 namespace yf = metaproxy_1::filter;
42 namespace metaproxy_1 {
44 class FrontendNet::Port {
46 friend class FrontendNet;
50 class FrontendNet::Rep {
51 friend class FrontendNet;
54 std::vector<Port> m_ports;
55 int m_listen_duration;
56 int m_session_timeout;
58 std::string m_msg_config;
59 std::string m_stat_req;
60 yazpp_1::SocketManager mySocketManager;
62 int m_duration_freq[22];
63 double m_duration_lim[22];
64 double m_duration_max;
65 double m_duration_min;
66 double m_duration_total;
71 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
73 yazpp_1::ISocketObservable *m_obs;
77 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
78 void socketNotify(int event);
81 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
84 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
85 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
86 const mp::Package *package,
92 yazpp_1::IPDU_Observer* sessionNotify(
93 yazpp_1::IPDU_Observable *the_PDU_Observable,
95 void recv_GDU(Z_GDU *apdu, int len);
96 void report(Z_HTTP_Request *hreq);
101 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
102 mp::Session m_session;
105 const mp::Package *m_package;
108 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
110 ThreadPoolPackage(mp::Package *package,
111 yf::FrontendNet::ZAssocChild *ses,
113 ~ThreadPoolPackage();
114 IThreadPoolMsg *handle();
115 void result(const char *t_info);
116 bool cleanup(void *info);
119 ZAssocChild *m_assoc_child;
120 mp::Package *m_package;
123 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
126 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
129 void set_package(const mp::Package *package);
130 void set_thread_pool(ThreadPoolSocketObserver *observer);
132 yazpp_1::IPDU_Observer* sessionNotify(
133 yazpp_1::IPDU_Observable *the_PDU_Observable,
135 void recv_GDU(Z_GDU *apdu, int len);
138 void timeoutNotify();
139 void connectNotify();
141 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
142 const mp::Package *m_package;
143 yazpp_1::LimitConnect limit_connect;
150 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
153 m_assoc_child(ses), m_package(package), m_p(rep)
155 timer = yaz_timing_create();
158 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
160 yaz_timing_destroy(&timer); // timer may be NULL
164 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
166 mp::Session *ses = (mp::Session *) info;
168 return *ses == m_package->session();
171 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
173 m_assoc_child->m_no_requests--;
175 yazpp_1::GDU *gdu = &m_package->response();
180 m_assoc_child->send_GDU(gdu->get(), &len);
182 yaz_timing_stop(timer);
183 double duration = yaz_timing_get_real(timer);
186 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
188 m_p->m_duration_freq[ent]++;
190 m_p->m_duration_total += duration;
192 if (m_p->m_duration_max < duration)
193 m_p->m_duration_max = duration;
195 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
196 m_p->m_duration_min = duration;
198 if (m_p->m_msg_config.length())
200 Z_GDU *z_gdu = gdu->get();
202 std::ostringstream os;
203 os << m_p->m_msg_config << " "
205 << std::fixed << std::setprecision (6) << duration << " ";
212 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
215 else if (!m_package->session().is_closed())
217 // no response package and yet the session is still open..
218 // means that request is unhandled..
219 yazpp_1::GDU *gdu_req = &m_package->request();
220 Z_GDU *z_gdu = gdu_req->get();
221 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
223 // For Z39.50, response with a Close and shutdown
226 Z_APDU *apdu_response = odr.create_close(
227 z_gdu->u.z3950, Z_Close_systemProblem,
228 "unhandled Z39.50 request");
230 m_assoc_child->send_Z_PDU(apdu_response, &len);
232 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
234 // For HTTP, respond with Server Error
238 = odr.create_HTTP_Response(m_package->session(),
239 z_gdu->u.HTTP_Request, 500);
240 m_assoc_child->send_GDU(zgdu_res, &len);
242 m_package->session().close();
245 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
247 m_assoc_child->close();
254 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
256 m_package->move(m_assoc_child->m_route);
260 yf::FrontendNet::ZAssocChild::ZAssocChild(
261 yazpp_1::IPDU_Observable *PDU_Observable,
262 mp::ThreadPoolSocketObserver *my_thread_pool,
263 const mp::Package *package,
264 std::string route, Rep *rep)
265 : Z_Assoc(PDU_Observable), m_p(rep)
267 m_thread_pool_observer = my_thread_pool;
269 m_delete_flag = false;
272 const char *peername = PDU_Observable->getpeername();
274 peername = "unknown";
275 m_origin.set_tcpip_address(std::string(peername), m_session.id());
276 timeout(m_p->m_session_timeout);
279 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
280 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
285 yf::FrontendNet::ZAssocChild::~ZAssocChild()
289 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
293 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
295 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
299 int number_total = 0;
301 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
302 number_total += m_p->m_duration_freq[i];
303 number_total += m_p->m_duration_freq[i];
305 wrbuf_puts(w, "<?xml version=\"1.0\">\n");
306 wrbuf_puts(w, "<frontend_net>\n");
307 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
308 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
310 if (m_p->m_duration_freq[i] > 0)
312 w, " <response duration_start=\"%f\" "
313 "duration_end=\"%f\" frequency=\"%d\"/>\n",
314 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
315 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
318 if (m_p->m_duration_freq[i] > 0)
320 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
321 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
323 if (m_p->m_duration_max != 0.0)
325 w, " <response duration_max=\"%f\"/>\n",
326 m_p->m_duration_max);
327 if (m_p->m_duration_min != 0.0)
329 w, " <response duration_min=\"%f\"/>\n",
330 m_p->m_duration_min);
331 if (m_p->m_duration_total != 0.0)
333 w, " <response duration_average=\"%f\"/>\n",
334 m_p->m_duration_total / number_total);
336 wrbuf_puts(w, " </responses>\n");
337 wrbuf_puts(w, "</frontend_net>\n");
339 hres->content_len = w.len();
340 hres->content_buf = (char *) w.buf();
343 send_GDU(gdu_res, &len);
346 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
350 mp::Package *p = new mp::Package(m_session, m_origin);
352 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
354 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
356 if (m_p->m_stat_req.length()
357 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
364 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
365 p->copy_route(*m_package);
366 p->request() = yazpp_1::GDU(z_pdu);
368 if (m_p->m_msg_config.length())
372 std::ostringstream os;
373 os << m_p->m_msg_config << " "
377 yaz_log(YLOG_LOG, "%s", os.str().c_str());
380 m_thread_pool_observer->put(tp);
383 void yf::FrontendNet::ZAssocChild::failNotify()
385 // TODO: send Package to signal "close"
386 if (m_session.is_closed())
388 if (m_no_requests == 0)
396 mp::Package *p = new mp::Package(m_session, m_origin);
398 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
399 p->copy_route(*m_package);
400 m_thread_pool_observer->cleanup(tp, &m_session);
401 m_thread_pool_observer->put(tp);
404 void yf::FrontendNet::ZAssocChild::timeoutNotify()
409 void yf::FrontendNet::ZAssocChild::connectNotify()
414 yf::FrontendNet::ZAssocServer::ZAssocServer(
415 yazpp_1::IPDU_Observable *PDU_Observable,
419 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
425 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
430 void yf::FrontendNet::ZAssocServer::set_thread_pool(
431 ThreadPoolSocketObserver *observer)
433 m_thread_pool_observer = observer;
436 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
437 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
440 const char *peername = the_PDU_Observable->getpeername();
443 limit_connect.add_connect(peername);
444 limit_connect.cleanup(false);
445 int con_sz = limit_connect.get_total(peername);
446 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
449 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
450 m_thread_pool_observer,
451 m_package, m_route, m_p);
455 yf::FrontendNet::ZAssocServer::~ZAssocServer()
459 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
463 void yf::FrontendNet::ZAssocServer::failNotify()
467 void yf::FrontendNet::ZAssocServer::timeoutNotify()
471 void yf::FrontendNet::ZAssocServer::connectNotify()
475 yf::FrontendNet::FrontendNet() : m_p(new Rep)
479 yf::FrontendNet::Rep::Rep()
482 m_listen_duration = 0;
483 m_session_timeout = 300; // 5 minutes
487 for (i = 0; i < 22; i++)
488 m_duration_freq[i] = 0;
489 m_duration_lim[0] = 0.000001;
490 m_duration_lim[1] = 0.00001;
491 m_duration_lim[2] = 0.0001;
492 m_duration_lim[3] = 0.001;
493 m_duration_lim[4] = 0.01;
494 m_duration_lim[5] = 0.1;
495 m_duration_lim[6] = 0.2;
496 m_duration_lim[7] = 0.3;
497 m_duration_lim[8] = 0.5;
498 m_duration_lim[9] = 1.0;
499 m_duration_lim[10] = 1.5;
500 m_duration_lim[11] = 2.0;
501 m_duration_lim[12] = 3.0;
502 m_duration_lim[13] = 4.0;
503 m_duration_lim[14] = 5.0;
504 m_duration_lim[15] = 6.0;
505 m_duration_lim[16] = 8.0;
506 m_duration_lim[17] = 10.0;
507 m_duration_lim[18] = 15.0;
508 m_duration_lim[19] = 20.0;
509 m_duration_lim[20] = 30.0;
510 m_duration_lim[21] = 0.0;
511 m_duration_max = 0.0;
512 m_duration_min = 0.0;
513 m_duration_total = 0.0;
516 yf::FrontendNet::Rep::~Rep()
521 for (i = 0; i < m_ports.size(); i++)
528 yf::FrontendNet::~FrontendNet()
532 void yf::FrontendNet::stop() const
537 for (i = 0; i < m_p->m_ports.size(); i++)
538 m_p->az[i]->server("");
542 bool yf::FrontendNet::My_Timer_Thread::timeout()
547 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
548 yazpp_1::ISocketObservable *obs,
550 m_obs(obs), m_pipe(9123), m_timeout(false)
552 obs->addObserver(m_pipe.read_fd(), this);
553 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
554 obs->timeoutObserver(this, duration);
557 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
560 m_obs->deleteObserver(this);
563 void yf::FrontendNet::process(Package &package) const
568 My_Timer_Thread *tt = 0;
570 if (m_p->m_listen_duration)
571 tt = new My_Timer_Thread(&m_p->mySocketManager,
572 m_p->m_listen_duration);
574 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
576 for (i = 0; i<m_p->m_ports.size(); i++)
578 m_p->az[i]->set_package(&package);
579 m_p->az[i]->set_thread_pool(&tp);
581 while (m_p->mySocketManager.processEvent() > 0)
583 int no = m_p->mySocketManager.getNumberOfObservers();
586 if (tt && tt->timeout())
592 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
595 if (!ptr || !ptr->children)
597 throw yf::FilterException("No ports for Frontend");
599 std::vector<Port> ports;
600 for (ptr = ptr->children; ptr; ptr = ptr->next)
602 if (ptr->type != XML_ELEMENT_NODE)
604 if (!strcmp((const char *) ptr->name, "port"))
607 const struct _xmlAttr *attr;
608 for (attr = ptr->properties; attr; attr = attr->next)
610 if (!strcmp((const char *) attr->name, "route"))
611 port.route = mp::xml::get_text(attr);
613 port.port = mp::xml::get_text(ptr);
614 ports.push_back(port);
617 else if (!strcmp((const char *) ptr->name, "threads"))
619 std::string threads_str = mp::xml::get_text(ptr);
620 int threads = atoi(threads_str.c_str());
622 throw yf::FilterException("Bad value for threads: "
624 m_p->m_no_threads = threads;
626 else if (!strcmp((const char *) ptr->name, "timeout"))
628 std::string timeout_str = mp::xml::get_text(ptr);
629 int timeout = atoi(timeout_str.c_str());
631 throw yf::FilterException("Bad value for timeout: "
633 m_p->m_session_timeout = timeout;
635 else if (!strcmp((const char *) ptr->name, "connect-max"))
637 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
639 else if (!strcmp((const char *) ptr->name, "message"))
641 m_p->m_msg_config = mp::xml::get_text(ptr);
643 else if (!strcmp((const char *) ptr->name, "stat-req"))
645 m_p->m_stat_req = mp::xml::get_text(ptr);
649 throw yf::FilterException("Bad element "
650 + std::string((const char *)
659 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
661 std::vector<Port> nports;
664 for (i = 0; i < ports.size(); i++)
668 nport.port = ports[i];
670 nports.push_back(nport);
676 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
678 m_p->m_ports = ports;
680 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
682 // Create yf::FrontendNet::ZAssocServer for each port
684 for (i = 0; i<m_p->m_ports.size(); i++)
686 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
687 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
689 // create ZAssoc with PDU Assoc
690 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
691 as, m_p->m_ports[i].route, m_p.get());
692 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
694 throw yf::FilterException("Unable to bind to address "
695 + std::string(m_p->m_ports[i].port));
700 void yf::FrontendNet::set_listen_duration(int d)
702 m_p->m_listen_duration = d;
705 static yf::Base* filter_creator()
707 return new yf::FrontendNet;
711 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
721 * c-file-style: "Stroustrup"
722 * indent-tabs-mode: nil
724 * vim: shiftwidth=4 tabstop=8 expandtab