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;
72 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
74 yazpp_1::ISocketObservable *m_obs;
78 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
79 void socketNotify(int event);
82 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
85 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
86 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
87 const mp::Package *package,
93 yazpp_1::IPDU_Observer* sessionNotify(
94 yazpp_1::IPDU_Observable *the_PDU_Observable,
96 void recv_GDU(Z_GDU *apdu, int len);
97 void report(Z_HTTP_Request *hreq);
100 void connectNotify();
102 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
103 mp::Session m_session;
106 const mp::Package *m_package;
109 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
111 ThreadPoolPackage(mp::Package *package,
112 yf::FrontendNet::ZAssocChild *ses,
114 ~ThreadPoolPackage();
115 IThreadPoolMsg *handle();
116 void result(const char *t_info);
117 bool cleanup(void *info);
120 ZAssocChild *m_assoc_child;
121 mp::Package *m_package;
124 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
127 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
130 void set_package(const mp::Package *package);
131 void set_thread_pool(ThreadPoolSocketObserver *observer);
133 yazpp_1::IPDU_Observer* sessionNotify(
134 yazpp_1::IPDU_Observable *the_PDU_Observable,
136 void recv_GDU(Z_GDU *apdu, int len);
139 void timeoutNotify();
140 void connectNotify();
142 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
143 const mp::Package *m_package;
144 yazpp_1::LimitConnect limit_connect;
151 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
154 m_assoc_child(ses), m_package(package), m_p(rep)
156 timer = yaz_timing_create();
159 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
161 yaz_timing_destroy(&timer); // timer may be NULL
165 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
167 mp::Session *ses = (mp::Session *) info;
169 return *ses == m_package->session();
172 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
174 m_assoc_child->m_no_requests--;
176 yazpp_1::GDU *gdu = &m_package->response();
181 m_assoc_child->send_GDU(gdu->get(), &len);
183 yaz_timing_stop(timer);
184 double duration = yaz_timing_get_real(timer);
187 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
189 m_p->m_duration_freq[ent]++;
191 m_p->m_duration_total += duration;
193 if (m_p->m_duration_max < duration)
194 m_p->m_duration_max = duration;
196 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
197 m_p->m_duration_min = duration;
199 if (m_p->m_msg_config.length())
201 Z_GDU *z_gdu = gdu->get();
203 std::ostringstream os;
204 os << m_p->m_msg_config << " "
206 << std::fixed << std::setprecision (6) << duration << " ";
213 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
216 else if (!m_package->session().is_closed())
218 // no response package and yet the session is still open..
219 // means that request is unhandled..
220 yazpp_1::GDU *gdu_req = &m_package->request();
221 Z_GDU *z_gdu = gdu_req->get();
222 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
224 // For Z39.50, response with a Close and shutdown
227 Z_APDU *apdu_response = odr.create_close(
228 z_gdu->u.z3950, Z_Close_systemProblem,
229 "unhandled Z39.50 request");
231 m_assoc_child->send_Z_PDU(apdu_response, &len);
233 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
235 // For HTTP, respond with Server Error
239 = odr.create_HTTP_Response(m_package->session(),
240 z_gdu->u.HTTP_Request, 500);
241 m_assoc_child->send_GDU(zgdu_res, &len);
243 m_package->session().close();
246 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
248 m_assoc_child->close();
255 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
257 m_package->move(m_assoc_child->m_route);
261 yf::FrontendNet::ZAssocChild::ZAssocChild(
262 yazpp_1::IPDU_Observable *PDU_Observable,
263 mp::ThreadPoolSocketObserver *my_thread_pool,
264 const mp::Package *package,
265 std::string route, Rep *rep)
266 : Z_Assoc(PDU_Observable), m_p(rep)
268 m_thread_pool_observer = my_thread_pool;
270 m_delete_flag = false;
273 const char *peername = PDU_Observable->getpeername();
275 peername = "unknown";
276 m_origin.set_tcpip_address(std::string(peername), m_session.id());
277 timeout(m_p->m_session_timeout);
280 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
281 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
286 yf::FrontendNet::ZAssocChild::~ZAssocChild()
290 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
294 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
296 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
300 int number_total = 0;
302 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
303 number_total += m_p->m_duration_freq[i];
304 number_total += m_p->m_duration_freq[i];
306 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
307 wrbuf_puts(w, "<frontend_net>\n");
308 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
309 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
311 if (m_p->m_duration_freq[i] > 0)
313 w, " <response duration_start=\"%f\" "
314 "duration_end=\"%f\" frequency=\"%d\"/>\n",
315 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
316 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
319 if (m_p->m_duration_freq[i] > 0)
321 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
322 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
324 if (m_p->m_duration_max != 0.0)
326 w, " <response duration_max=\"%f\"/>\n",
327 m_p->m_duration_max);
328 if (m_p->m_duration_min != 0.0)
330 w, " <response duration_min=\"%f\"/>\n",
331 m_p->m_duration_min);
332 if (m_p->m_duration_total != 0.0)
334 w, " <response duration_average=\"%f\"/>\n",
335 m_p->m_duration_total / number_total);
337 wrbuf_puts(w, " </responses>\n");
341 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
343 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
344 thread_busy, thread_total);
346 wrbuf_puts(w, "</frontend_net>\n");
348 hres->content_len = w.len();
349 hres->content_buf = (char *) w.buf();
352 send_GDU(gdu_res, &len);
355 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
359 mp::Package *p = new mp::Package(m_session, m_origin);
361 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
363 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
365 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
367 p->origin().set_tcpip_address(std::string(f), m_session.id());
369 if (m_p->m_stat_req.length()
370 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
377 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
378 p->copy_route(*m_package);
379 p->request() = yazpp_1::GDU(z_pdu);
381 if (m_p->m_msg_config.length())
385 std::ostringstream os;
386 os << m_p->m_msg_config << " "
390 yaz_log(YLOG_LOG, "%s", os.str().c_str());
393 m_thread_pool_observer->put(tp);
396 void yf::FrontendNet::ZAssocChild::failNotify()
398 // TODO: send Package to signal "close"
399 if (m_session.is_closed())
401 if (m_no_requests == 0)
409 mp::Package *p = new mp::Package(m_session, m_origin);
411 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
412 p->copy_route(*m_package);
413 m_thread_pool_observer->cleanup(tp, &m_session);
414 m_thread_pool_observer->put(tp);
417 void yf::FrontendNet::ZAssocChild::timeoutNotify()
422 void yf::FrontendNet::ZAssocChild::connectNotify()
427 yf::FrontendNet::ZAssocServer::ZAssocServer(
428 yazpp_1::IPDU_Observable *PDU_Observable,
432 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
438 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
443 void yf::FrontendNet::ZAssocServer::set_thread_pool(
444 ThreadPoolSocketObserver *observer)
446 m_thread_pool_observer = observer;
449 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
450 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
453 const char *peername = the_PDU_Observable->getpeername();
456 limit_connect.add_connect(peername);
457 limit_connect.cleanup(false);
458 int con_sz = limit_connect.get_total(peername);
459 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
462 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
463 m_thread_pool_observer,
464 m_package, m_route, m_p);
468 yf::FrontendNet::ZAssocServer::~ZAssocServer()
472 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
476 void yf::FrontendNet::ZAssocServer::failNotify()
480 void yf::FrontendNet::ZAssocServer::timeoutNotify()
484 void yf::FrontendNet::ZAssocServer::connectNotify()
488 yf::FrontendNet::FrontendNet() : m_p(new Rep)
492 yf::FrontendNet::Rep::Rep()
495 m_listen_duration = 0;
496 m_session_timeout = 300; // 5 minutes
500 for (i = 0; i < 22; i++)
501 m_duration_freq[i] = 0;
502 m_duration_lim[0] = 0.000001;
503 m_duration_lim[1] = 0.00001;
504 m_duration_lim[2] = 0.0001;
505 m_duration_lim[3] = 0.001;
506 m_duration_lim[4] = 0.01;
507 m_duration_lim[5] = 0.1;
508 m_duration_lim[6] = 0.2;
509 m_duration_lim[7] = 0.3;
510 m_duration_lim[8] = 0.5;
511 m_duration_lim[9] = 1.0;
512 m_duration_lim[10] = 1.5;
513 m_duration_lim[11] = 2.0;
514 m_duration_lim[12] = 3.0;
515 m_duration_lim[13] = 4.0;
516 m_duration_lim[14] = 5.0;
517 m_duration_lim[15] = 6.0;
518 m_duration_lim[16] = 8.0;
519 m_duration_lim[17] = 10.0;
520 m_duration_lim[18] = 15.0;
521 m_duration_lim[19] = 20.0;
522 m_duration_lim[20] = 30.0;
523 m_duration_lim[21] = 0.0;
524 m_duration_max = 0.0;
525 m_duration_min = 0.0;
526 m_duration_total = 0.0;
530 yf::FrontendNet::Rep::~Rep()
535 for (i = 0; i < m_ports.size(); i++)
542 yf::FrontendNet::~FrontendNet()
546 void yf::FrontendNet::stop() const
551 bool yf::FrontendNet::My_Timer_Thread::timeout()
556 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
557 yazpp_1::ISocketObservable *obs,
559 m_obs(obs), m_pipe(9123), m_timeout(false)
561 obs->addObserver(m_pipe.read_fd(), this);
562 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
563 obs->timeoutObserver(this, duration);
566 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
569 m_obs->deleteObserver(this);
572 void yf::FrontendNet::process(Package &package) const
577 My_Timer_Thread *tt = 0;
579 if (m_p->m_listen_duration)
580 tt = new My_Timer_Thread(&m_p->mySocketManager,
581 m_p->m_listen_duration);
583 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
585 for (i = 0; i<m_p->m_ports.size(); i++)
587 m_p->az[i]->set_package(&package);
588 m_p->az[i]->set_thread_pool(&tp);
590 while (m_p->mySocketManager.processEvent() > 0)
598 for (i = 0; i < m_p->m_ports.size(); i++)
599 m_p->az[i]->server("");
602 int no = m_p->mySocketManager.getNumberOfObservers();
605 if (tt && tt->timeout())
611 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
614 if (!ptr || !ptr->children)
616 throw yf::FilterException("No ports for Frontend");
618 std::vector<Port> ports;
619 for (ptr = ptr->children; ptr; ptr = ptr->next)
621 if (ptr->type != XML_ELEMENT_NODE)
623 if (!strcmp((const char *) ptr->name, "port"))
626 const struct _xmlAttr *attr;
627 for (attr = ptr->properties; attr; attr = attr->next)
629 if (!strcmp((const char *) attr->name, "route"))
630 port.route = mp::xml::get_text(attr);
632 port.port = mp::xml::get_text(ptr);
633 ports.push_back(port);
636 else if (!strcmp((const char *) ptr->name, "threads"))
638 std::string threads_str = mp::xml::get_text(ptr);
639 int threads = atoi(threads_str.c_str());
641 throw yf::FilterException("Bad value for threads: "
643 m_p->m_no_threads = threads;
645 else if (!strcmp((const char *) ptr->name, "timeout"))
647 std::string timeout_str = mp::xml::get_text(ptr);
648 int timeout = atoi(timeout_str.c_str());
650 throw yf::FilterException("Bad value for timeout: "
652 m_p->m_session_timeout = timeout;
654 else if (!strcmp((const char *) ptr->name, "connect-max"))
656 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
658 else if (!strcmp((const char *) ptr->name, "message"))
660 m_p->m_msg_config = mp::xml::get_text(ptr);
662 else if (!strcmp((const char *) ptr->name, "stat-req"))
664 m_p->m_stat_req = mp::xml::get_text(ptr);
668 throw yf::FilterException("Bad element "
669 + std::string((const char *)
678 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
680 std::vector<Port> nports;
683 for (i = 0; i < ports.size(); i++)
687 nport.port = ports[i];
689 nports.push_back(nport);
695 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
697 m_p->m_ports = ports;
699 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
701 // Create yf::FrontendNet::ZAssocServer for each port
703 for (i = 0; i<m_p->m_ports.size(); i++)
705 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
706 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
708 // create ZAssoc with PDU Assoc
709 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
710 as, m_p->m_ports[i].route, m_p.get());
711 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
713 throw yf::FilterException("Unable to bind to address "
714 + std::string(m_p->m_ports[i].port));
719 void yf::FrontendNet::set_listen_duration(int d)
721 m_p->m_listen_duration = d;
724 static yf::Base* filter_creator()
726 return new yf::FrontendNet;
730 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
740 * c-file-style: "Stroustrup"
741 * indent-tabs-mode: nil
743 * vim: shiftwidth=4 tabstop=8 expandtab