1 /* This file is part of Metaproxy.
2 Copyright (C) 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"
41 namespace mp = metaproxy_1;
42 namespace yf = metaproxy_1::filter;
44 namespace metaproxy_1 {
46 class FrontendNet::Port {
48 friend class FrontendNet;
51 std::string cert_fname;
54 class FrontendNet::Rep {
55 friend class FrontendNet;
58 std::vector<Port> m_ports;
59 int m_listen_duration;
60 int m_session_timeout;
63 std::string m_msg_config;
64 std::string m_stat_req;
65 yazpp_1::SocketManager mySocketManager;
67 yazpp_1::PDU_Assoc **pdu;
68 int m_duration_freq[22];
69 double m_duration_lim[22];
70 double m_duration_max;
71 double m_duration_min;
72 double m_duration_total;
78 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
80 yazpp_1::ISocketObservable *m_obs;
84 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
85 void socketNotify(int event);
88 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
91 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
92 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
93 const mp::Package *package,
96 yazpp_1::LimitConnect &limit_connect);
100 yazpp_1::IPDU_Observer* sessionNotify(
101 yazpp_1::IPDU_Observable *the_PDU_Observable,
103 void recv_GDU(Z_GDU *apdu, int len);
104 void report(Z_HTTP_Request *hreq);
106 void timeoutNotify();
107 void connectNotify();
109 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
110 mp::Session m_session;
113 const mp::Package *m_package;
115 yazpp_1::LimitConnect &m_limit_connect;
117 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
119 ThreadPoolPackage(mp::Package *package,
120 yf::FrontendNet::ZAssocChild *ses,
122 ~ThreadPoolPackage();
123 IThreadPoolMsg *handle();
124 void result(const char *t_info);
125 bool cleanup(void *info);
128 ZAssocChild *m_assoc_child;
129 mp::Package *m_package;
132 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
135 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
136 FrontendNet::Port *port,
138 void set_package(const mp::Package *package);
139 void set_thread_pool(ThreadPoolSocketObserver *observer);
141 yazpp_1::IPDU_Observer* sessionNotify(
142 yazpp_1::IPDU_Observable *the_PDU_Observable,
144 void recv_GDU(Z_GDU *apdu, int len);
147 void timeoutNotify();
148 void connectNotify();
150 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
151 const mp::Package *m_package;
152 yazpp_1::LimitConnect limit_connect;
159 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
162 m_assoc_child(ses), m_package(package), m_p(rep)
164 timer = yaz_timing_create();
167 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
169 yaz_timing_destroy(&timer); // timer may be NULL
173 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
175 mp::Session *ses = (mp::Session *) info;
177 return *ses == m_package->session();
180 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
182 m_assoc_child->m_no_requests--;
184 yazpp_1::GDU *gdu = &m_package->response();
189 m_assoc_child->send_GDU(gdu->get(), &len);
191 yaz_timing_stop(timer);
192 double duration = yaz_timing_get_real(timer);
195 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
197 m_p->m_duration_freq[ent]++;
199 m_p->m_duration_total += duration;
201 if (m_p->m_duration_max < duration)
202 m_p->m_duration_max = duration;
204 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
205 m_p->m_duration_min = duration;
207 if (m_p->m_msg_config.length())
209 Z_GDU *z_gdu = gdu->get();
211 std::ostringstream os;
212 os << m_p->m_msg_config << " "
214 << std::fixed << std::setprecision (6) << duration << " ";
221 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
224 else if (!m_package->session().is_closed())
226 // no response package and yet the session is still open..
227 // means that request is unhandled..
228 yazpp_1::GDU *gdu_req = &m_package->request();
229 Z_GDU *z_gdu = gdu_req->get();
230 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
232 // For Z39.50, response with a Close and shutdown
235 Z_APDU *apdu_response = odr.create_close(
236 z_gdu->u.z3950, Z_Close_systemProblem,
237 "unhandled Z39.50 request");
239 m_assoc_child->send_Z_PDU(apdu_response, &len);
241 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
243 // For HTTP, respond with Server Error
247 = odr.create_HTTP_Response(m_package->session(),
248 z_gdu->u.HTTP_Request, 500);
249 m_assoc_child->send_GDU(zgdu_res, &len);
251 m_package->session().close();
254 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
256 m_assoc_child->close();
263 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
265 m_package->move(m_assoc_child->m_port->route);
269 yf::FrontendNet::ZAssocChild::ZAssocChild(
270 yazpp_1::IPDU_Observable *PDU_Observable,
271 mp::ThreadPoolSocketObserver *my_thread_pool,
272 const mp::Package *package,
273 Port *port, Rep *rep,
274 yazpp_1::LimitConnect &limit_connect)
275 : Z_Assoc(PDU_Observable), m_p(rep), m_limit_connect(limit_connect)
277 m_thread_pool_observer = my_thread_pool;
279 m_delete_flag = false;
282 const char *peername = PDU_Observable->getpeername();
284 peername = "unknown";
287 const char *cp = strchr(peername, ':');
292 addr.append(peername);
294 addr.append(port->port);
295 m_origin.set_tcpip_address(addr, m_session.id());
296 timeout(m_p->m_session_timeout);
299 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
300 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
305 yf::FrontendNet::ZAssocChild::~ZAssocChild()
309 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
313 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
315 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
319 int number_total = 0;
321 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
322 number_total += m_p->m_duration_freq[i];
323 number_total += m_p->m_duration_freq[i];
325 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
326 wrbuf_puts(w, "<frontend_net>\n");
327 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
328 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
330 if (m_p->m_duration_freq[i] > 0)
332 w, " <response duration_start=\"%f\" "
333 "duration_end=\"%f\" frequency=\"%d\"/>\n",
334 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
335 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
338 if (m_p->m_duration_freq[i] > 0)
340 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
341 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
343 if (m_p->m_duration_max != 0.0)
345 w, " <response duration_max=\"%f\"/>\n",
346 m_p->m_duration_max);
347 if (m_p->m_duration_min != 0.0)
349 w, " <response duration_min=\"%f\"/>\n",
350 m_p->m_duration_min);
351 if (m_p->m_duration_total != 0.0)
353 w, " <response duration_average=\"%f\"/>\n",
354 m_p->m_duration_total / number_total);
356 wrbuf_puts(w, " </responses>\n");
360 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
362 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
363 thread_busy, thread_total);
365 wrbuf_puts(w, "</frontend_net>\n");
367 hres->content_len = w.len();
368 hres->content_buf = (char *) w.buf();
371 send_GDU(gdu_res, &len);
374 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
378 mp::Package *p = new mp::Package(m_session, m_origin);
380 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
382 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
384 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
386 p->origin().set_tcpip_address(std::string(f), m_session.id());
388 if (m_p->m_stat_req.length()
389 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
394 std::string peername = p->origin().get_address();
396 m_limit_connect.add_connect(peername.c_str());
397 m_limit_connect.cleanup(false);
398 int con_sz = m_limit_connect.get_total(peername.c_str());
400 if (m_p->m_http_req_max && con_sz >= m_p->m_http_req_max)
403 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 500);
405 send_GDU(gdu_res, &len);
410 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
411 p->copy_route(*m_package);
412 p->request() = yazpp_1::GDU(z_pdu);
414 if (m_p->m_msg_config.length())
418 std::ostringstream os;
419 os << m_p->m_msg_config << " "
423 yaz_log(YLOG_LOG, "%s", os.str().c_str());
426 m_thread_pool_observer->put(tp);
429 void yf::FrontendNet::ZAssocChild::failNotify()
431 // TODO: send Package to signal "close"
432 if (m_session.is_closed())
434 if (m_no_requests == 0)
442 mp::Package *p = new mp::Package(m_session, m_origin);
444 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
445 p->copy_route(*m_package);
446 m_thread_pool_observer->cleanup(tp, &m_session);
447 m_thread_pool_observer->put(tp);
450 void yf::FrontendNet::ZAssocChild::timeoutNotify()
455 void yf::FrontendNet::ZAssocChild::connectNotify()
460 yf::FrontendNet::ZAssocServer::ZAssocServer(
461 yazpp_1::IPDU_Observable *PDU_Observable,
465 Z_Assoc(PDU_Observable), m_port(port), m_p(rep)
471 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
476 void yf::FrontendNet::ZAssocServer::set_thread_pool(
477 mp::ThreadPoolSocketObserver *observer)
479 m_thread_pool_observer = observer;
482 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
483 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
486 const char *peername = the_PDU_Observable->getpeername();
489 limit_connect.add_connect(peername);
490 limit_connect.cleanup(false);
491 int con_sz = limit_connect.get_total(peername);
492 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
495 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
496 m_thread_pool_observer,
497 m_package, m_port, m_p, limit_connect);
501 yf::FrontendNet::ZAssocServer::~ZAssocServer()
505 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
509 void yf::FrontendNet::ZAssocServer::failNotify()
513 void yf::FrontendNet::ZAssocServer::timeoutNotify()
517 void yf::FrontendNet::ZAssocServer::connectNotify()
521 yf::FrontendNet::FrontendNet() : m_p(new Rep)
525 yf::FrontendNet::Rep::Rep()
528 m_listen_duration = 0;
529 m_session_timeout = 300; // 5 minutes
533 for (i = 0; i < 22; i++)
534 m_duration_freq[i] = 0;
535 m_duration_lim[0] = 0.000001;
536 m_duration_lim[1] = 0.00001;
537 m_duration_lim[2] = 0.0001;
538 m_duration_lim[3] = 0.001;
539 m_duration_lim[4] = 0.01;
540 m_duration_lim[5] = 0.1;
541 m_duration_lim[6] = 0.2;
542 m_duration_lim[7] = 0.3;
543 m_duration_lim[8] = 0.5;
544 m_duration_lim[9] = 1.0;
545 m_duration_lim[10] = 1.5;
546 m_duration_lim[11] = 2.0;
547 m_duration_lim[12] = 3.0;
548 m_duration_lim[13] = 4.0;
549 m_duration_lim[14] = 5.0;
550 m_duration_lim[15] = 6.0;
551 m_duration_lim[16] = 8.0;
552 m_duration_lim[17] = 10.0;
553 m_duration_lim[18] = 15.0;
554 m_duration_lim[19] = 20.0;
555 m_duration_lim[20] = 30.0;
556 m_duration_lim[21] = 0.0;
557 m_duration_max = 0.0;
558 m_duration_min = 0.0;
559 m_duration_total = 0.0;
563 yf::FrontendNet::Rep::~Rep()
568 for (i = 0; i < m_ports.size(); i++)
576 yf::FrontendNet::~FrontendNet()
580 void yf::FrontendNet::stop(int signo) const
582 m_p->m_stop_signo = signo;
585 bool yf::FrontendNet::My_Timer_Thread::timeout()
590 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
591 yazpp_1::ISocketObservable *obs,
593 m_obs(obs), m_pipe(9123), m_timeout(false)
595 obs->addObserver(m_pipe.read_fd(), this);
596 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
597 obs->timeoutObserver(this, duration);
600 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
603 m_obs->deleteObserver(this);
606 void yf::FrontendNet::process(mp::Package &package) const
611 My_Timer_Thread *tt = 0;
613 if (m_p->m_listen_duration)
614 tt = new My_Timer_Thread(&m_p->mySocketManager,
615 m_p->m_listen_duration);
617 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
619 for (i = 0; i<m_p->m_ports.size(); i++)
621 m_p->az[i]->set_package(&package);
622 m_p->az[i]->set_thread_pool(&tp);
624 while (m_p->mySocketManager.processEvent() > 0)
626 if (m_p->m_stop_signo == SIGTERM)
628 yaz_log(YLOG_LOG, "metaproxy received SIGTERM");
632 for (i = 0; i < m_p->m_ports.size(); i++)
634 m_p->pdu[i]->shutdown();
635 m_p->az[i]->server("");
639 break; /* stop right away */
642 if (m_p->m_stop_signo == SIGUSR1)
643 { /* just stop listeners and cont till all sessions are done*/
644 yaz_log(YLOG_LOG, "metaproxy received SIGUSR1");
645 m_p->m_stop_signo = 0;
649 for (i = 0; i < m_p->m_ports.size(); i++)
650 m_p->az[i]->server("");
655 int no = m_p->mySocketManager.getNumberOfObservers();
658 if (tt && tt->timeout())
664 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
667 if (!ptr || !ptr->children)
669 throw yf::FilterException("No ports for Frontend");
671 std::vector<Port> ports;
672 for (ptr = ptr->children; ptr; ptr = ptr->next)
674 if (ptr->type != XML_ELEMENT_NODE)
676 if (!strcmp((const char *) ptr->name, "port"))
680 const char *names[5] = {"route", "max_recv_bytes", "port",
682 std::string values[4];
684 mp::xml::parse_attr(ptr, names, values);
685 port.route = values[0];
686 if (values[1].length() > 0)
687 port.max_recv_bytes = atoi(values[1].c_str());
689 port.max_recv_bytes = 0;
690 if (values[2].length() > 0)
691 port.port = values[2];
693 port.port = mp::xml::get_text(ptr);
694 port.cert_fname = values[3];
695 ports.push_back(port);
697 else if (!strcmp((const char *) ptr->name, "threads"))
699 std::string threads_str = mp::xml::get_text(ptr);
700 int threads = atoi(threads_str.c_str());
702 throw yf::FilterException("Bad value for threads: "
704 m_p->m_no_threads = threads;
706 else if (!strcmp((const char *) ptr->name, "timeout"))
708 std::string timeout_str = mp::xml::get_text(ptr);
709 int timeout = atoi(timeout_str.c_str());
711 throw yf::FilterException("Bad value for timeout: "
713 m_p->m_session_timeout = timeout;
715 else if (!strcmp((const char *) ptr->name, "connect-max"))
717 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
719 else if (!strcmp((const char *) ptr->name, "http-req-max"))
721 m_p->m_http_req_max = mp::xml::get_int(ptr, 0);
723 else if (!strcmp((const char *) ptr->name, "message"))
725 m_p->m_msg_config = mp::xml::get_text(ptr);
727 else if (!strcmp((const char *) ptr->name, "stat-req"))
729 m_p->m_stat_req = mp::xml::get_text(ptr);
733 throw yf::FilterException("Bad element "
734 + std::string((const char *)
743 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
745 std::vector<Port> nports;
748 for (i = 0; i < ports.size(); i++)
752 nport.port = ports[i];
754 nports.push_back(nport);
760 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
762 m_p->m_ports = ports;
764 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
765 m_p->pdu = new yazpp_1::PDU_Assoc *[m_p->m_ports.size()];
767 // Create yf::FrontendNet::ZAssocServer for each port
769 for (i = 0; i < m_p->m_ports.size(); i++)
771 for (i = 0; i < m_p->m_ports.size(); i++)
773 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
774 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
776 if (m_p->m_ports[i].cert_fname.length())
777 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
778 // create ZAssoc with PDU Assoc
780 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
781 as, &m_p->m_ports[i], m_p.get());
782 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
784 throw yf::FilterException("Unable to bind to address "
785 + std::string(m_p->m_ports[i].port));
787 COMSTACK cs = as->get_comstack();
789 if (cs && m_p->m_ports[i].max_recv_bytes)
790 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
795 void yf::FrontendNet::set_listen_duration(int d)
797 m_p->m_listen_duration = d;
800 static yf::Base* filter_creator()
802 return new yf::FrontendNet;
806 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
816 * c-file-style: "Stroustrup"
817 * indent-tabs-mode: nil
819 * vim: shiftwidth=4 tabstop=8 expandtab