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 <yaz/daemon.h>
36 #include "gduutil.hpp"
40 namespace mp = metaproxy_1;
41 namespace yf = metaproxy_1::filter;
43 namespace metaproxy_1 {
45 class FrontendNet::Port {
47 friend class FrontendNet;
51 class FrontendNet::Rep {
52 friend class FrontendNet;
55 std::vector<Port> m_ports;
56 int m_listen_duration;
57 int m_session_timeout;
59 std::string m_msg_config;
60 std::string m_stat_req;
61 yazpp_1::SocketManager mySocketManager;
63 int m_duration_freq[22];
64 double m_duration_lim[22];
65 double m_duration_max;
66 double m_duration_min;
67 double m_duration_total;
73 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
75 yazpp_1::ISocketObservable *m_obs;
79 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
80 void socketNotify(int event);
83 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
86 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
87 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
88 const mp::Package *package,
94 yazpp_1::IPDU_Observer* sessionNotify(
95 yazpp_1::IPDU_Observable *the_PDU_Observable,
97 void recv_GDU(Z_GDU *apdu, int len);
98 void report(Z_HTTP_Request *hreq);
100 void timeoutNotify();
101 void connectNotify();
103 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
104 mp::Session m_session;
107 const mp::Package *m_package;
110 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
112 ThreadPoolPackage(mp::Package *package,
113 yf::FrontendNet::ZAssocChild *ses,
115 ~ThreadPoolPackage();
116 IThreadPoolMsg *handle();
117 void result(const char *t_info);
118 bool cleanup(void *info);
121 ZAssocChild *m_assoc_child;
122 mp::Package *m_package;
125 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
128 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
131 void set_package(const mp::Package *package);
132 void set_thread_pool(ThreadPoolSocketObserver *observer);
134 yazpp_1::IPDU_Observer* sessionNotify(
135 yazpp_1::IPDU_Observable *the_PDU_Observable,
137 void recv_GDU(Z_GDU *apdu, int len);
140 void timeoutNotify();
141 void connectNotify();
143 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
144 const mp::Package *m_package;
145 yazpp_1::LimitConnect limit_connect;
152 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
155 m_assoc_child(ses), m_package(package), m_p(rep)
157 timer = yaz_timing_create();
160 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
162 yaz_timing_destroy(&timer); // timer may be NULL
166 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
168 mp::Session *ses = (mp::Session *) info;
170 return *ses == m_package->session();
173 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
175 m_assoc_child->m_no_requests--;
177 yazpp_1::GDU *gdu = &m_package->response();
182 m_assoc_child->send_GDU(gdu->get(), &len);
184 yaz_timing_stop(timer);
185 double duration = yaz_timing_get_real(timer);
188 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
190 m_p->m_duration_freq[ent]++;
192 m_p->m_duration_total += duration;
194 if (m_p->m_duration_max < duration)
195 m_p->m_duration_max = duration;
197 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
198 m_p->m_duration_min = duration;
200 if (m_p->m_msg_config.length())
202 Z_GDU *z_gdu = gdu->get();
204 std::ostringstream os;
205 os << m_p->m_msg_config << " "
207 << std::fixed << std::setprecision (6) << duration << " ";
214 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
217 else if (!m_package->session().is_closed())
219 // no response package and yet the session is still open..
220 // means that request is unhandled..
221 yazpp_1::GDU *gdu_req = &m_package->request();
222 Z_GDU *z_gdu = gdu_req->get();
223 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
225 // For Z39.50, response with a Close and shutdown
228 Z_APDU *apdu_response = odr.create_close(
229 z_gdu->u.z3950, Z_Close_systemProblem,
230 "unhandled Z39.50 request");
232 m_assoc_child->send_Z_PDU(apdu_response, &len);
234 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
236 // For HTTP, respond with Server Error
240 = odr.create_HTTP_Response(m_package->session(),
241 z_gdu->u.HTTP_Request, 500);
242 m_assoc_child->send_GDU(zgdu_res, &len);
244 m_package->session().close();
247 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
249 m_assoc_child->close();
256 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
258 m_package->move(m_assoc_child->m_route);
262 yf::FrontendNet::ZAssocChild::ZAssocChild(
263 yazpp_1::IPDU_Observable *PDU_Observable,
264 mp::ThreadPoolSocketObserver *my_thread_pool,
265 const mp::Package *package,
266 std::string route, Rep *rep)
267 : Z_Assoc(PDU_Observable), m_p(rep)
269 m_thread_pool_observer = my_thread_pool;
271 m_delete_flag = false;
274 const char *peername = PDU_Observable->getpeername();
276 peername = "unknown";
277 m_origin.set_tcpip_address(std::string(peername), m_session.id());
278 timeout(m_p->m_session_timeout);
281 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
282 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
287 yf::FrontendNet::ZAssocChild::~ZAssocChild()
291 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
295 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
297 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
301 int number_total = 0;
303 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
304 number_total += m_p->m_duration_freq[i];
305 number_total += m_p->m_duration_freq[i];
307 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
308 wrbuf_puts(w, "<frontend_net>\n");
309 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
310 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
312 if (m_p->m_duration_freq[i] > 0)
314 w, " <response duration_start=\"%f\" "
315 "duration_end=\"%f\" frequency=\"%d\"/>\n",
316 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
317 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
320 if (m_p->m_duration_freq[i] > 0)
322 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
323 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
325 if (m_p->m_duration_max != 0.0)
327 w, " <response duration_max=\"%f\"/>\n",
328 m_p->m_duration_max);
329 if (m_p->m_duration_min != 0.0)
331 w, " <response duration_min=\"%f\"/>\n",
332 m_p->m_duration_min);
333 if (m_p->m_duration_total != 0.0)
335 w, " <response duration_average=\"%f\"/>\n",
336 m_p->m_duration_total / number_total);
338 wrbuf_puts(w, " </responses>\n");
342 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
344 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
345 thread_busy, thread_total);
347 wrbuf_puts(w, "</frontend_net>\n");
349 hres->content_len = w.len();
350 hres->content_buf = (char *) w.buf();
353 send_GDU(gdu_res, &len);
356 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
360 mp::Package *p = new mp::Package(m_session, m_origin);
362 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
364 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
366 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
368 p->origin().set_tcpip_address(std::string(f), m_session.id());
370 if (m_p->m_stat_req.length()
371 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
378 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
379 p->copy_route(*m_package);
380 p->request() = yazpp_1::GDU(z_pdu);
382 if (m_p->m_msg_config.length())
386 std::ostringstream os;
387 os << m_p->m_msg_config << " "
391 yaz_log(YLOG_LOG, "%s", os.str().c_str());
394 m_thread_pool_observer->put(tp);
397 void yf::FrontendNet::ZAssocChild::failNotify()
399 // TODO: send Package to signal "close"
400 if (m_session.is_closed())
402 if (m_no_requests == 0)
410 mp::Package *p = new mp::Package(m_session, m_origin);
412 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
413 p->copy_route(*m_package);
414 m_thread_pool_observer->cleanup(tp, &m_session);
415 m_thread_pool_observer->put(tp);
418 void yf::FrontendNet::ZAssocChild::timeoutNotify()
423 void yf::FrontendNet::ZAssocChild::connectNotify()
428 yf::FrontendNet::ZAssocServer::ZAssocServer(
429 yazpp_1::IPDU_Observable *PDU_Observable,
433 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
439 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
444 void yf::FrontendNet::ZAssocServer::set_thread_pool(
445 ThreadPoolSocketObserver *observer)
447 m_thread_pool_observer = observer;
450 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
451 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
454 const char *peername = the_PDU_Observable->getpeername();
457 limit_connect.add_connect(peername);
458 limit_connect.cleanup(false);
459 int con_sz = limit_connect.get_total(peername);
460 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
463 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
464 m_thread_pool_observer,
465 m_package, m_route, m_p);
469 yf::FrontendNet::ZAssocServer::~ZAssocServer()
473 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
477 void yf::FrontendNet::ZAssocServer::failNotify()
481 void yf::FrontendNet::ZAssocServer::timeoutNotify()
485 void yf::FrontendNet::ZAssocServer::connectNotify()
489 yf::FrontendNet::FrontendNet() : m_p(new Rep)
493 yf::FrontendNet::Rep::Rep()
496 m_listen_duration = 0;
497 m_session_timeout = 300; // 5 minutes
501 for (i = 0; i < 22; i++)
502 m_duration_freq[i] = 0;
503 m_duration_lim[0] = 0.000001;
504 m_duration_lim[1] = 0.00001;
505 m_duration_lim[2] = 0.0001;
506 m_duration_lim[3] = 0.001;
507 m_duration_lim[4] = 0.01;
508 m_duration_lim[5] = 0.1;
509 m_duration_lim[6] = 0.2;
510 m_duration_lim[7] = 0.3;
511 m_duration_lim[8] = 0.5;
512 m_duration_lim[9] = 1.0;
513 m_duration_lim[10] = 1.5;
514 m_duration_lim[11] = 2.0;
515 m_duration_lim[12] = 3.0;
516 m_duration_lim[13] = 4.0;
517 m_duration_lim[14] = 5.0;
518 m_duration_lim[15] = 6.0;
519 m_duration_lim[16] = 8.0;
520 m_duration_lim[17] = 10.0;
521 m_duration_lim[18] = 15.0;
522 m_duration_lim[19] = 20.0;
523 m_duration_lim[20] = 30.0;
524 m_duration_lim[21] = 0.0;
525 m_duration_max = 0.0;
526 m_duration_min = 0.0;
527 m_duration_total = 0.0;
531 yf::FrontendNet::Rep::~Rep()
536 for (i = 0; i < m_ports.size(); i++)
543 yf::FrontendNet::~FrontendNet()
547 void yf::FrontendNet::stop() const
552 bool yf::FrontendNet::My_Timer_Thread::timeout()
557 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
558 yazpp_1::ISocketObservable *obs,
560 m_obs(obs), m_pipe(9123), m_timeout(false)
562 obs->addObserver(m_pipe.read_fd(), this);
563 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
564 obs->timeoutObserver(this, duration);
567 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
570 m_obs->deleteObserver(this);
573 void yf::FrontendNet::process(Package &package) const
578 My_Timer_Thread *tt = 0;
580 if (m_p->m_listen_duration)
581 tt = new My_Timer_Thread(&m_p->mySocketManager,
582 m_p->m_listen_duration);
584 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
586 for (i = 0; i<m_p->m_ports.size(); i++)
588 m_p->az[i]->set_package(&package);
589 m_p->az[i]->set_thread_pool(&tp);
591 while (m_p->mySocketManager.processEvent() > 0)
599 for (i = 0; i < m_p->m_ports.size(); i++)
600 m_p->az[i]->server("");
604 int no = m_p->mySocketManager.getNumberOfObservers();
607 if (tt && tt->timeout())
613 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
616 if (!ptr || !ptr->children)
618 throw yf::FilterException("No ports for Frontend");
620 std::vector<Port> ports;
621 for (ptr = ptr->children; ptr; ptr = ptr->next)
623 if (ptr->type != XML_ELEMENT_NODE)
625 if (!strcmp((const char *) ptr->name, "port"))
628 const struct _xmlAttr *attr;
629 for (attr = ptr->properties; attr; attr = attr->next)
631 if (!strcmp((const char *) attr->name, "route"))
632 port.route = mp::xml::get_text(attr);
634 port.port = mp::xml::get_text(ptr);
635 ports.push_back(port);
638 else if (!strcmp((const char *) ptr->name, "threads"))
640 std::string threads_str = mp::xml::get_text(ptr);
641 int threads = atoi(threads_str.c_str());
643 throw yf::FilterException("Bad value for threads: "
645 m_p->m_no_threads = threads;
647 else if (!strcmp((const char *) ptr->name, "timeout"))
649 std::string timeout_str = mp::xml::get_text(ptr);
650 int timeout = atoi(timeout_str.c_str());
652 throw yf::FilterException("Bad value for timeout: "
654 m_p->m_session_timeout = timeout;
656 else if (!strcmp((const char *) ptr->name, "connect-max"))
658 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
660 else if (!strcmp((const char *) ptr->name, "message"))
662 m_p->m_msg_config = mp::xml::get_text(ptr);
664 else if (!strcmp((const char *) ptr->name, "stat-req"))
666 m_p->m_stat_req = mp::xml::get_text(ptr);
670 throw yf::FilterException("Bad element "
671 + std::string((const char *)
680 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
682 std::vector<Port> nports;
685 for (i = 0; i < ports.size(); i++)
689 nport.port = ports[i];
691 nports.push_back(nport);
697 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
699 m_p->m_ports = ports;
701 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
703 // Create yf::FrontendNet::ZAssocServer for each port
705 for (i = 0; i<m_p->m_ports.size(); i++)
707 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
708 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
710 // create ZAssoc with PDU Assoc
711 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
712 as, m_p->m_ports[i].route, m_p.get());
713 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
715 throw yf::FilterException("Unable to bind to address "
716 + std::string(m_p->m_ports[i].port));
721 void yf::FrontendNet::set_listen_duration(int d)
723 m_p->m_listen_duration = d;
726 static yf::Base* filter_creator()
728 return new yf::FrontendNet;
732 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
742 * c-file-style: "Stroustrup"
743 * indent-tabs-mode: nil
745 * vim: shiftwidth=4 tabstop=8 expandtab