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;
60 std::vector<Port> m_ports;
61 int m_listen_duration;
62 int m_session_timeout;
65 std::string m_msg_config;
66 std::string m_stat_req;
67 yazpp_1::SocketManager mySocketManager;
69 yazpp_1::PDU_Assoc **pdu;
70 int m_duration_freq[22];
71 double m_duration_lim[22];
72 double m_duration_max;
73 double m_duration_min;
74 double m_duration_total;
80 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
82 yazpp_1::ISocketObservable *m_obs;
86 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
87 void socketNotify(int event);
90 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
93 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
94 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
95 const mp::Package *package,
98 yazpp_1::LimitConnect &limit_connect);
102 yazpp_1::IPDU_Observer* sessionNotify(
103 yazpp_1::IPDU_Observable *the_PDU_Observable,
105 void recv_GDU(Z_GDU *apdu, int len);
106 void report(Z_HTTP_Request *hreq);
108 void timeoutNotify();
109 void connectNotify();
111 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
112 mp::Session m_session;
115 const mp::Package *m_package;
117 yazpp_1::LimitConnect &m_limit_connect;
119 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
121 ThreadPoolPackage(mp::Package *package,
122 yf::FrontendNet::ZAssocChild *ses,
124 ~ThreadPoolPackage();
125 IThreadPoolMsg *handle();
126 void result(const char *t_info);
127 bool cleanup(void *info);
130 ZAssocChild *m_assoc_child;
131 mp::Package *m_package;
134 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
137 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
138 FrontendNet::Port *port,
140 void set_package(const mp::Package *package);
141 void set_thread_pool(ThreadPoolSocketObserver *observer);
143 yazpp_1::IPDU_Observer* sessionNotify(
144 yazpp_1::IPDU_Observable *the_PDU_Observable,
146 void recv_GDU(Z_GDU *apdu, int len);
149 void timeoutNotify();
150 void connectNotify();
152 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
153 const mp::Package *m_package;
154 yazpp_1::LimitConnect limit_connect;
161 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
164 m_assoc_child(ses), m_package(package), m_p(rep)
166 timer = yaz_timing_create();
169 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
171 yaz_timing_destroy(&timer); // timer may be NULL
175 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
177 mp::Session *ses = (mp::Session *) info;
179 return *ses == m_package->session();
182 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
184 m_assoc_child->m_no_requests--;
186 yazpp_1::GDU *gdu = &m_package->response();
191 m_assoc_child->send_GDU(gdu->get(), &len);
193 yaz_timing_stop(timer);
194 double duration = yaz_timing_get_real(timer);
197 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
199 m_p->m_duration_freq[ent]++;
201 m_p->m_duration_total += duration;
203 if (m_p->m_duration_max < duration)
204 m_p->m_duration_max = duration;
206 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
207 m_p->m_duration_min = duration;
209 if (m_p->m_msg_config.length())
211 Z_GDU *z_gdu = gdu->get();
213 std::ostringstream os;
214 os << m_p->m_msg_config << " "
216 << std::fixed << std::setprecision (6) << duration << " ";
223 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
226 else if (!m_package->session().is_closed())
228 // no response package and yet the session is still open..
229 // means that request is unhandled..
230 yazpp_1::GDU *gdu_req = &m_package->request();
231 Z_GDU *z_gdu = gdu_req->get();
232 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
234 // For Z39.50, response with a Close and shutdown
237 Z_APDU *apdu_response = odr.create_close(
238 z_gdu->u.z3950, Z_Close_systemProblem,
239 "unhandled Z39.50 request");
241 m_assoc_child->send_Z_PDU(apdu_response, &len);
243 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
245 // For HTTP, respond with Server Error
249 = odr.create_HTTP_Response(m_package->session(),
250 z_gdu->u.HTTP_Request, 500);
251 m_assoc_child->send_GDU(zgdu_res, &len);
253 m_package->session().close();
256 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
258 m_assoc_child->close();
265 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
267 m_package->move(m_assoc_child->m_port->route);
271 yf::FrontendNet::ZAssocChild::ZAssocChild(
272 yazpp_1::IPDU_Observable *PDU_Observable,
273 mp::ThreadPoolSocketObserver *my_thread_pool,
274 const mp::Package *package,
275 Port *port, Rep *rep,
276 yazpp_1::LimitConnect &limit_connect)
277 : Z_Assoc(PDU_Observable), m_p(rep), m_limit_connect(limit_connect)
279 m_thread_pool_observer = my_thread_pool;
281 m_delete_flag = false;
284 const char *peername = PDU_Observable->getpeername();
286 peername = "unknown";
289 const char *cp = strchr(peername, ':');
294 addr.append(peername);
296 addr.append(port->port);
297 m_origin.set_tcpip_address(addr, m_session.id());
298 timeout(m_p->m_session_timeout);
301 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
302 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
307 yf::FrontendNet::ZAssocChild::~ZAssocChild()
311 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
315 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
317 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
321 int number_total = 0;
323 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
324 number_total += m_p->m_duration_freq[i];
325 number_total += m_p->m_duration_freq[i];
327 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
328 wrbuf_puts(w, "<frontend_net>\n");
329 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
330 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
332 if (m_p->m_duration_freq[i] > 0)
334 w, " <response duration_start=\"%f\" "
335 "duration_end=\"%f\" frequency=\"%d\"/>\n",
336 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
337 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
340 if (m_p->m_duration_freq[i] > 0)
342 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
343 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
345 if (m_p->m_duration_max != 0.0)
347 w, " <response duration_max=\"%f\"/>\n",
348 m_p->m_duration_max);
349 if (m_p->m_duration_min != 0.0)
351 w, " <response duration_min=\"%f\"/>\n",
352 m_p->m_duration_min);
353 if (m_p->m_duration_total != 0.0)
355 w, " <response duration_average=\"%f\"/>\n",
356 m_p->m_duration_total / number_total);
358 wrbuf_puts(w, " </responses>\n");
362 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
364 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
365 thread_busy, thread_total);
367 wrbuf_puts(w, "</frontend_net>\n");
369 hres->content_len = w.len();
370 hres->content_buf = (char *) w.buf();
373 send_GDU(gdu_res, &len);
376 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
380 mp::Package *p = new mp::Package(m_session, m_origin);
382 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
384 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
386 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
388 p->origin().set_tcpip_address(std::string(f), m_session.id());
390 if (m_p->m_stat_req.length()
391 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
396 std::string peername = p->origin().get_address();
398 m_limit_connect.add_connect(peername.c_str());
399 m_limit_connect.cleanup(false);
400 int con_sz = m_limit_connect.get_total(peername.c_str());
402 if (m_p->m_http_req_max && con_sz >= m_p->m_http_req_max)
405 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 500);
407 send_GDU(gdu_res, &len);
412 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
413 p->copy_route(*m_package);
414 p->request() = yazpp_1::GDU(z_pdu);
416 if (m_p->m_msg_config.length())
420 std::ostringstream os;
421 os << m_p->m_msg_config << " "
425 yaz_log(YLOG_LOG, "%s", os.str().c_str());
428 m_thread_pool_observer->put(tp);
431 void yf::FrontendNet::ZAssocChild::failNotify()
433 // TODO: send Package to signal "close"
434 if (m_session.is_closed())
436 if (m_no_requests == 0)
444 mp::Package *p = new mp::Package(m_session, m_origin);
446 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
447 p->copy_route(*m_package);
448 m_thread_pool_observer->cleanup(tp, &m_session);
449 m_thread_pool_observer->put(tp);
452 void yf::FrontendNet::ZAssocChild::timeoutNotify()
457 void yf::FrontendNet::ZAssocChild::connectNotify()
462 yf::FrontendNet::ZAssocServer::ZAssocServer(
463 yazpp_1::IPDU_Observable *PDU_Observable,
467 Z_Assoc(PDU_Observable), m_port(port), m_p(rep)
473 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
478 void yf::FrontendNet::ZAssocServer::set_thread_pool(
479 mp::ThreadPoolSocketObserver *observer)
481 m_thread_pool_observer = observer;
484 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
485 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
488 const char *peername = the_PDU_Observable->getpeername();
491 limit_connect.add_connect(peername);
492 limit_connect.cleanup(false);
493 int con_sz = limit_connect.get_total(peername);
494 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
497 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
498 m_thread_pool_observer,
499 m_package, m_port, m_p, limit_connect);
503 yf::FrontendNet::ZAssocServer::~ZAssocServer()
507 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
511 void yf::FrontendNet::ZAssocServer::failNotify()
515 void yf::FrontendNet::ZAssocServer::timeoutNotify()
519 void yf::FrontendNet::ZAssocServer::connectNotify()
523 yf::FrontendNet::FrontendNet() : m_p(new Rep)
527 yf::FrontendNet::Rep::Rep()
529 m_max_threads = m_no_threads = 5;
531 m_listen_duration = 0;
532 m_session_timeout = 300; // 5 minutes
536 for (i = 0; i < 22; i++)
537 m_duration_freq[i] = 0;
538 m_duration_lim[0] = 0.000001;
539 m_duration_lim[1] = 0.00001;
540 m_duration_lim[2] = 0.0001;
541 m_duration_lim[3] = 0.001;
542 m_duration_lim[4] = 0.01;
543 m_duration_lim[5] = 0.1;
544 m_duration_lim[6] = 0.2;
545 m_duration_lim[7] = 0.3;
546 m_duration_lim[8] = 0.5;
547 m_duration_lim[9] = 1.0;
548 m_duration_lim[10] = 1.5;
549 m_duration_lim[11] = 2.0;
550 m_duration_lim[12] = 3.0;
551 m_duration_lim[13] = 4.0;
552 m_duration_lim[14] = 5.0;
553 m_duration_lim[15] = 6.0;
554 m_duration_lim[16] = 8.0;
555 m_duration_lim[17] = 10.0;
556 m_duration_lim[18] = 15.0;
557 m_duration_lim[19] = 20.0;
558 m_duration_lim[20] = 30.0;
559 m_duration_lim[21] = 0.0;
560 m_duration_max = 0.0;
561 m_duration_min = 0.0;
562 m_duration_total = 0.0;
566 yf::FrontendNet::Rep::~Rep()
571 for (i = 0; i < m_ports.size(); i++)
579 yf::FrontendNet::~FrontendNet()
583 void yf::FrontendNet::stop(int signo) const
585 m_p->m_stop_signo = signo;
588 bool yf::FrontendNet::My_Timer_Thread::timeout()
593 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
594 yazpp_1::ISocketObservable *obs,
596 m_obs(obs), m_pipe(9123), m_timeout(false)
598 obs->addObserver(m_pipe.read_fd(), this);
599 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
600 obs->timeoutObserver(this, duration);
603 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
606 m_obs->deleteObserver(this);
609 void yf::FrontendNet::process(mp::Package &package) const
614 My_Timer_Thread *tt = 0;
616 if (m_p->m_listen_duration)
617 tt = new My_Timer_Thread(&m_p->mySocketManager,
618 m_p->m_listen_duration);
620 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads,
624 for (i = 0; i<m_p->m_ports.size(); i++)
626 m_p->az[i]->set_package(&package);
627 m_p->az[i]->set_thread_pool(&tp);
629 while (m_p->mySocketManager.processEvent() > 0)
631 if (m_p->m_stop_signo == SIGTERM)
633 yaz_log(YLOG_LOG, "metaproxy received SIGTERM");
637 for (i = 0; i < m_p->m_ports.size(); i++)
639 m_p->pdu[i]->shutdown();
640 m_p->az[i]->server("");
644 break; /* stop right away */
647 if (m_p->m_stop_signo == SIGUSR1)
648 { /* just stop listeners and cont till all sessions are done*/
649 yaz_log(YLOG_LOG, "metaproxy received SIGUSR1");
650 m_p->m_stop_signo = 0;
654 for (i = 0; i < m_p->m_ports.size(); i++)
655 m_p->az[i]->server("");
660 int no = m_p->mySocketManager.getNumberOfObservers();
663 if (tt && tt->timeout())
669 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
672 if (!ptr || !ptr->children)
674 throw yf::FilterException("No ports for Frontend");
676 std::vector<Port> ports;
677 for (ptr = ptr->children; ptr; ptr = ptr->next)
679 if (ptr->type != XML_ELEMENT_NODE)
681 if (!strcmp((const char *) ptr->name, "port"))
685 const char *names[5] = {"route", "max_recv_bytes", "port",
687 std::string values[4];
689 mp::xml::parse_attr(ptr, names, values);
690 port.route = values[0];
691 if (values[1].length() > 0)
692 port.max_recv_bytes = atoi(values[1].c_str());
694 port.max_recv_bytes = 0;
695 if (values[2].length() > 0)
696 port.port = values[2];
698 port.port = mp::xml::get_text(ptr);
699 port.cert_fname = values[3];
700 ports.push_back(port);
702 else if (!strcmp((const char *) ptr->name, "threads"))
704 std::string threads_str = mp::xml::get_text(ptr);
705 int threads = atoi(threads_str.c_str());
707 throw yf::FilterException("Bad value for threads: "
709 m_p->m_no_threads = threads;
711 else if (!strcmp((const char *) ptr->name, "max-threads"))
713 std::string threads_str = mp::xml::get_text(ptr);
714 int threads = atoi(threads_str.c_str());
716 throw yf::FilterException("Bad value for max-threads: "
718 m_p->m_max_threads = threads;
720 else if (!strcmp((const char *) ptr->name, "stack-size"))
722 std::string sz_str = mp::xml::get_text(ptr);
723 int sz = atoi(sz_str.c_str());
725 throw yf::FilterException("Bad value for stack-size: "
727 m_p->m_stack_size = sz * 1024;
729 else if (!strcmp((const char *) ptr->name, "timeout"))
731 std::string timeout_str = mp::xml::get_text(ptr);
732 int timeout = atoi(timeout_str.c_str());
734 throw yf::FilterException("Bad value for timeout: "
736 m_p->m_session_timeout = timeout;
738 else if (!strcmp((const char *) ptr->name, "connect-max"))
740 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
742 else if (!strcmp((const char *) ptr->name, "http-req-max"))
744 m_p->m_http_req_max = mp::xml::get_int(ptr, 0);
746 else if (!strcmp((const char *) ptr->name, "message"))
748 m_p->m_msg_config = mp::xml::get_text(ptr);
750 else if (!strcmp((const char *) ptr->name, "stat-req"))
752 m_p->m_stat_req = mp::xml::get_text(ptr);
756 throw yf::FilterException("Bad element "
757 + std::string((const char *)
766 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
768 std::vector<Port> nports;
771 for (i = 0; i < ports.size(); i++)
775 nport.port = ports[i];
777 nports.push_back(nport);
783 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
785 m_p->m_ports = ports;
787 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
788 m_p->pdu = new yazpp_1::PDU_Assoc *[m_p->m_ports.size()];
790 // Create yf::FrontendNet::ZAssocServer for each port
792 for (i = 0; i < m_p->m_ports.size(); i++)
794 for (i = 0; i < m_p->m_ports.size(); i++)
796 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
797 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
799 if (m_p->m_ports[i].cert_fname.length())
800 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
801 // create ZAssoc with PDU Assoc
803 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
804 as, &m_p->m_ports[i], m_p.get());
805 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
807 throw yf::FilterException("Unable to bind to address "
808 + std::string(m_p->m_ports[i].port));
810 COMSTACK cs = as->get_comstack();
812 if (cs && m_p->m_ports[i].max_recv_bytes)
813 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
818 void yf::FrontendNet::set_listen_duration(int d)
820 m_p->m_listen_duration = d;
823 static yf::Base* filter_creator()
825 return new yf::FrontendNet;
829 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
839 * c-file-style: "Stroustrup"
840 * indent-tabs-mode: nil
842 * vim: shiftwidth=4 tabstop=8 expandtab