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
22 #include <sys/resource.h>
26 #include <metaproxy/util.hpp>
28 #include <metaproxy/filter.hpp>
29 #include <metaproxy/package.hpp>
30 #include "thread_pool_observer.hpp"
31 #include "filter_frontend_net.hpp"
32 #include <yazpp/z-assoc.h>
33 #include <yazpp/pdu-assoc.h>
34 #include <yazpp/socket-manager.h>
35 #include <yazpp/limit-connect.h>
36 #include <yaz/timing.h>
38 #include <yaz/daemon.h>
39 #include "gduutil.hpp"
44 namespace mp = metaproxy_1;
45 namespace yf = metaproxy_1::filter;
47 namespace metaproxy_1 {
49 class FrontendNet::Port {
51 friend class FrontendNet;
54 std::string cert_fname;
57 class FrontendNet::IP_Pattern {
59 friend class FrontendNet;
63 class FrontendNet::Rep {
64 friend class FrontendNet;
69 std::vector<Port> m_ports;
70 int m_listen_duration;
71 int m_session_timeout;
73 std::list<IP_Pattern> http_req_max;
74 std::string m_msg_config;
75 std::string m_stat_req;
76 yazpp_1::SocketManager mySocketManager;
78 yazpp_1::PDU_Assoc **pdu;
79 int m_duration_freq[22];
80 double m_duration_lim[22];
81 double m_duration_max;
82 double m_duration_min;
83 double m_duration_total;
89 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
91 yazpp_1::ISocketObservable *m_obs;
95 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
96 void socketNotify(int event);
99 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
102 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
103 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
104 const mp::Package *package,
107 yazpp_1::LimitConnect &limit_connect);
111 yazpp_1::IPDU_Observer* sessionNotify(
112 yazpp_1::IPDU_Observable *the_PDU_Observable,
114 void recv_GDU(Z_GDU *apdu, int len);
115 void report(Z_HTTP_Request *hreq);
117 void timeoutNotify();
118 void connectNotify();
120 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
121 mp::Session m_session;
124 const mp::Package *m_package;
126 yazpp_1::LimitConnect &m_limit_connect;
128 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
130 ThreadPoolPackage(mp::Package *package,
131 yf::FrontendNet::ZAssocChild *ses,
133 ~ThreadPoolPackage();
134 IThreadPoolMsg *handle();
135 void result(const char *t_info);
136 bool cleanup(void *info);
139 ZAssocChild *m_assoc_child;
140 mp::Package *m_package;
143 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
146 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
147 FrontendNet::Port *port,
149 void set_package(const mp::Package *package);
150 void set_thread_pool(ThreadPoolSocketObserver *observer);
152 yazpp_1::IPDU_Observer* sessionNotify(
153 yazpp_1::IPDU_Observable *the_PDU_Observable,
155 void recv_GDU(Z_GDU *apdu, int len);
158 void timeoutNotify();
159 void connectNotify();
161 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
162 const mp::Package *m_package;
163 yazpp_1::LimitConnect limit_connect;
170 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
173 m_assoc_child(ses), m_package(package), m_p(rep)
175 timer = yaz_timing_create();
178 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
180 yaz_timing_destroy(&timer); // timer may be NULL
184 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
186 mp::Session *ses = (mp::Session *) info;
188 return *ses == m_package->session();
191 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
193 m_assoc_child->m_no_requests--;
195 yazpp_1::GDU *gdu = &m_package->response();
200 m_assoc_child->send_GDU(gdu->get(), &len);
202 yaz_timing_stop(timer);
203 double duration = yaz_timing_get_real(timer);
206 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
208 m_p->m_duration_freq[ent]++;
210 m_p->m_duration_total += duration;
212 if (m_p->m_duration_max < duration)
213 m_p->m_duration_max = duration;
215 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
216 m_p->m_duration_min = duration;
218 if (m_p->m_msg_config.length())
220 Z_GDU *z_gdu = gdu->get();
222 std::ostringstream os;
223 os << m_p->m_msg_config << " "
225 << std::fixed << std::setprecision (6) << duration << " ";
232 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
235 else if (!m_package->session().is_closed())
237 // no response package and yet the session is still open..
238 // means that request is unhandled..
239 yazpp_1::GDU *gdu_req = &m_package->request();
240 Z_GDU *z_gdu = gdu_req->get();
241 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
243 // For Z39.50, response with a Close and shutdown
246 Z_APDU *apdu_response = odr.create_close(
247 z_gdu->u.z3950, Z_Close_systemProblem,
248 "unhandled Z39.50 request");
250 m_assoc_child->send_Z_PDU(apdu_response, &len);
252 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
254 // For HTTP, respond with Server Error
258 = odr.create_HTTP_Response(m_package->session(),
259 z_gdu->u.HTTP_Request, 500);
260 m_assoc_child->send_GDU(zgdu_res, &len);
262 m_package->session().close();
265 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
267 m_assoc_child->close();
274 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
276 m_package->move(m_assoc_child->m_port->route);
280 yf::FrontendNet::ZAssocChild::ZAssocChild(
281 yazpp_1::IPDU_Observable *PDU_Observable,
282 mp::ThreadPoolSocketObserver *my_thread_pool,
283 const mp::Package *package,
284 Port *port, Rep *rep,
285 yazpp_1::LimitConnect &limit_connect)
286 : Z_Assoc(PDU_Observable), m_p(rep), m_limit_connect(limit_connect)
288 m_thread_pool_observer = my_thread_pool;
290 m_delete_flag = false;
293 const char *peername = PDU_Observable->getpeername();
295 peername = "unknown";
298 const char *cp = strchr(peername, ':');
303 addr.append(peername);
305 addr.append(port->port);
306 m_origin.set_tcpip_address(addr, m_session.id());
307 timeout(m_p->m_session_timeout);
310 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
311 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
316 yf::FrontendNet::ZAssocChild::~ZAssocChild()
320 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
324 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
326 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
330 int number_total = 0;
332 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
333 number_total += m_p->m_duration_freq[i];
334 number_total += m_p->m_duration_freq[i];
336 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
337 wrbuf_puts(w, "<frontend_net>\n");
338 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
339 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
341 if (m_p->m_duration_freq[i] > 0)
343 w, " <response duration_start=\"%f\" "
344 "duration_end=\"%f\" frequency=\"%d\"/>\n",
345 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
346 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
349 if (m_p->m_duration_freq[i] > 0)
351 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
352 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
354 if (m_p->m_duration_max != 0.0)
356 w, " <response duration_max=\"%f\"/>\n",
357 m_p->m_duration_max);
358 if (m_p->m_duration_min != 0.0)
360 w, " <response duration_min=\"%f\"/>\n",
361 m_p->m_duration_min);
362 if (m_p->m_duration_total != 0.0)
364 w, " <response duration_average=\"%f\"/>\n",
365 m_p->m_duration_total / number_total);
367 wrbuf_puts(w, " </responses>\n");
371 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
373 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
374 thread_busy, thread_total);
376 wrbuf_puts(w, "</frontend_net>\n");
378 hres->content_len = w.len();
379 hres->content_buf = (char *) w.buf();
382 send_GDU(gdu_res, &len);
385 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
389 mp::Package *p = new mp::Package(m_session, m_origin);
391 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
393 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
395 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
397 p->origin().set_tcpip_address(std::string(f), m_session.id());
399 if (m_p->m_stat_req.length()
400 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
405 std::string peername = p->origin().get_address();
407 m_limit_connect.add_connect(peername.c_str());
408 m_limit_connect.cleanup(false);
409 int con_sz = m_limit_connect.get_total(peername.c_str());
410 std::list<IP_Pattern>::const_iterator it = m_p->http_req_max.begin();
411 for (; it != m_p->http_req_max.end(); it++)
413 if (mp::util::match_ip(it->pattern, peername))
415 if (con_sz < it->value)
418 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 500);
420 send_GDU(gdu_res, &len);
426 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
427 p->copy_route(*m_package);
428 p->request() = yazpp_1::GDU(z_pdu);
430 if (m_p->m_msg_config.length())
434 std::ostringstream os;
435 os << m_p->m_msg_config << " "
439 yaz_log(YLOG_LOG, "%s", os.str().c_str());
442 m_thread_pool_observer->put(tp);
445 void yf::FrontendNet::ZAssocChild::failNotify()
447 // TODO: send Package to signal "close"
448 if (m_session.is_closed())
450 if (m_no_requests == 0)
458 mp::Package *p = new mp::Package(m_session, m_origin);
460 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
461 p->copy_route(*m_package);
462 m_thread_pool_observer->cleanup(tp, &m_session);
463 m_thread_pool_observer->put(tp);
466 void yf::FrontendNet::ZAssocChild::timeoutNotify()
471 void yf::FrontendNet::ZAssocChild::connectNotify()
476 yf::FrontendNet::ZAssocServer::ZAssocServer(
477 yazpp_1::IPDU_Observable *PDU_Observable,
481 Z_Assoc(PDU_Observable), m_port(port), m_p(rep)
487 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
492 void yf::FrontendNet::ZAssocServer::set_thread_pool(
493 mp::ThreadPoolSocketObserver *observer)
495 m_thread_pool_observer = observer;
498 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
499 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
502 const char *peername = the_PDU_Observable->getpeername();
505 limit_connect.add_connect(peername);
506 limit_connect.cleanup(false);
507 int con_sz = limit_connect.get_total(peername);
508 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
511 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
512 m_thread_pool_observer,
513 m_package, m_port, m_p, limit_connect);
517 yf::FrontendNet::ZAssocServer::~ZAssocServer()
521 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
525 void yf::FrontendNet::ZAssocServer::failNotify()
529 void yf::FrontendNet::ZAssocServer::timeoutNotify()
533 void yf::FrontendNet::ZAssocServer::connectNotify()
537 yf::FrontendNet::FrontendNet() : m_p(new Rep)
541 yf::FrontendNet::Rep::Rep()
543 m_max_threads = m_no_threads = 5;
545 m_listen_duration = 0;
546 m_session_timeout = 300; // 5 minutes
550 for (i = 0; i < 22; i++)
551 m_duration_freq[i] = 0;
552 m_duration_lim[0] = 0.000001;
553 m_duration_lim[1] = 0.00001;
554 m_duration_lim[2] = 0.0001;
555 m_duration_lim[3] = 0.001;
556 m_duration_lim[4] = 0.01;
557 m_duration_lim[5] = 0.1;
558 m_duration_lim[6] = 0.2;
559 m_duration_lim[7] = 0.3;
560 m_duration_lim[8] = 0.5;
561 m_duration_lim[9] = 1.0;
562 m_duration_lim[10] = 1.5;
563 m_duration_lim[11] = 2.0;
564 m_duration_lim[12] = 3.0;
565 m_duration_lim[13] = 4.0;
566 m_duration_lim[14] = 5.0;
567 m_duration_lim[15] = 6.0;
568 m_duration_lim[16] = 8.0;
569 m_duration_lim[17] = 10.0;
570 m_duration_lim[18] = 15.0;
571 m_duration_lim[19] = 20.0;
572 m_duration_lim[20] = 30.0;
573 m_duration_lim[21] = 0.0;
574 m_duration_max = 0.0;
575 m_duration_min = 0.0;
576 m_duration_total = 0.0;
580 yf::FrontendNet::Rep::~Rep()
585 for (i = 0; i < m_ports.size(); i++)
593 yf::FrontendNet::~FrontendNet()
597 void yf::FrontendNet::stop(int signo) const
599 m_p->m_stop_signo = signo;
602 void yf::FrontendNet::start() const
605 struct rlimit limit_data;
606 getrlimit(RLIMIT_NOFILE, &limit_data);
607 yaz_log(YLOG_LOG, "getrlimit NOFILE cur=%ld max=%ld",
608 (long) limit_data.rlim_cur, (long) limit_data.rlim_max);
612 bool yf::FrontendNet::My_Timer_Thread::timeout()
617 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
618 yazpp_1::ISocketObservable *obs,
620 m_obs(obs), m_pipe(9123), m_timeout(false)
622 obs->addObserver(m_pipe.read_fd(), this);
623 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
624 obs->timeoutObserver(this, duration);
627 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
630 m_obs->deleteObserver(this);
633 void yf::FrontendNet::process(mp::Package &package) const
638 My_Timer_Thread *tt = 0;
640 if (m_p->m_listen_duration)
641 tt = new My_Timer_Thread(&m_p->mySocketManager,
642 m_p->m_listen_duration);
644 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads,
648 for (i = 0; i<m_p->m_ports.size(); i++)
650 m_p->az[i]->set_package(&package);
651 m_p->az[i]->set_thread_pool(&tp);
653 while (m_p->mySocketManager.processEvent() > 0)
655 if (m_p->m_stop_signo == SIGTERM)
657 yaz_log(YLOG_LOG, "metaproxy received SIGTERM");
661 for (i = 0; i < m_p->m_ports.size(); i++)
663 m_p->pdu[i]->shutdown();
664 m_p->az[i]->server("");
668 break; /* stop right away */
671 if (m_p->m_stop_signo == SIGUSR1)
672 { /* just stop listeners and cont till all sessions are done*/
673 yaz_log(YLOG_LOG, "metaproxy received SIGUSR1");
674 m_p->m_stop_signo = 0;
678 for (i = 0; i < m_p->m_ports.size(); i++)
679 m_p->az[i]->server("");
684 int no = m_p->mySocketManager.getNumberOfObservers();
687 if (tt && tt->timeout())
693 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
696 if (!ptr || !ptr->children)
698 throw yf::FilterException("No ports for Frontend");
700 std::vector<Port> ports;
701 for (ptr = ptr->children; ptr; ptr = ptr->next)
703 if (ptr->type != XML_ELEMENT_NODE)
705 if (!strcmp((const char *) ptr->name, "port"))
709 const char *names[5] = {"route", "max_recv_bytes", "port",
711 std::string values[4];
713 mp::xml::parse_attr(ptr, names, values);
714 port.route = values[0];
715 if (values[1].length() > 0)
716 port.max_recv_bytes = atoi(values[1].c_str());
718 port.max_recv_bytes = 0;
719 if (values[2].length() > 0)
720 port.port = values[2];
722 port.port = mp::xml::get_text(ptr);
723 port.cert_fname = values[3];
724 ports.push_back(port);
726 else if (!strcmp((const char *) ptr->name, "threads"))
728 std::string threads_str = mp::xml::get_text(ptr);
729 int threads = atoi(threads_str.c_str());
731 throw yf::FilterException("Bad value for threads: "
733 m_p->m_no_threads = threads;
735 else if (!strcmp((const char *) ptr->name, "max-threads"))
737 std::string threads_str = mp::xml::get_text(ptr);
738 int threads = atoi(threads_str.c_str());
740 throw yf::FilterException("Bad value for max-threads: "
742 m_p->m_max_threads = threads;
744 else if (!strcmp((const char *) ptr->name, "stack-size"))
746 std::string sz_str = mp::xml::get_text(ptr);
747 int sz = atoi(sz_str.c_str());
749 throw yf::FilterException("Bad value for stack-size: "
751 m_p->m_stack_size = sz * 1024;
753 else if (!strcmp((const char *) ptr->name, "timeout"))
755 std::string timeout_str = mp::xml::get_text(ptr);
756 int timeout = atoi(timeout_str.c_str());
758 throw yf::FilterException("Bad value for timeout: "
760 m_p->m_session_timeout = timeout;
762 else if (!strcmp((const char *) ptr->name, "connect-max"))
764 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
766 else if (!strcmp((const char *) ptr->name, "http-req-max"))
768 const char *names[2] = {"ip", 0};
769 std::string values[1];
771 mp::xml::parse_attr(ptr, names, values);
773 m.value = mp::xml::get_int(ptr, 0);
774 m.pattern = values[0];
775 m_p->http_req_max.push_back(m);
777 else if (!strcmp((const char *) ptr->name, "message"))
779 m_p->m_msg_config = mp::xml::get_text(ptr);
781 else if (!strcmp((const char *) ptr->name, "stat-req"))
783 m_p->m_stat_req = mp::xml::get_text(ptr);
787 throw yf::FilterException("Bad element "
788 + std::string((const char *)
797 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
799 std::vector<Port> nports;
802 for (i = 0; i < ports.size(); i++)
806 nport.port = ports[i];
808 nports.push_back(nport);
814 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
816 m_p->m_ports = ports;
818 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
819 m_p->pdu = new yazpp_1::PDU_Assoc *[m_p->m_ports.size()];
821 // Create yf::FrontendNet::ZAssocServer for each port
823 for (i = 0; i < m_p->m_ports.size(); i++)
825 for (i = 0; i < m_p->m_ports.size(); i++)
827 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
828 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
830 if (m_p->m_ports[i].cert_fname.length())
831 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
832 // create ZAssoc with PDU Assoc
834 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
835 as, &m_p->m_ports[i], m_p.get());
836 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
838 throw yf::FilterException("Unable to bind to address "
839 + std::string(m_p->m_ports[i].port));
841 COMSTACK cs = as->get_comstack();
843 if (cs && m_p->m_ports[i].max_recv_bytes)
844 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
849 void yf::FrontendNet::set_listen_duration(int d)
851 m_p->m_listen_duration = d;
854 static yf::Base* filter_creator()
856 return new yf::FrontendNet;
860 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
870 * c-file-style: "Stroustrup"
871 * indent-tabs-mode: nil
873 * vim: shiftwidth=4 tabstop=8 expandtab