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;
62 std::string m_msg_config;
63 std::string m_stat_req;
64 yazpp_1::SocketManager mySocketManager;
66 yazpp_1::PDU_Assoc **pdu;
67 int m_duration_freq[22];
68 double m_duration_lim[22];
69 double m_duration_max;
70 double m_duration_min;
71 double m_duration_total;
77 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
79 yazpp_1::ISocketObservable *m_obs;
83 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
84 void socketNotify(int event);
87 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
90 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
91 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
92 const mp::Package *package,
98 yazpp_1::IPDU_Observer* sessionNotify(
99 yazpp_1::IPDU_Observable *the_PDU_Observable,
101 void recv_GDU(Z_GDU *apdu, int len);
102 void report(Z_HTTP_Request *hreq);
104 void timeoutNotify();
105 void connectNotify();
107 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
108 mp::Session m_session;
111 const mp::Package *m_package;
114 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
116 ThreadPoolPackage(mp::Package *package,
117 yf::FrontendNet::ZAssocChild *ses,
119 ~ThreadPoolPackage();
120 IThreadPoolMsg *handle();
121 void result(const char *t_info);
122 bool cleanup(void *info);
125 ZAssocChild *m_assoc_child;
126 mp::Package *m_package;
129 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
132 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
135 void set_package(const mp::Package *package);
136 void set_thread_pool(ThreadPoolSocketObserver *observer);
138 yazpp_1::IPDU_Observer* sessionNotify(
139 yazpp_1::IPDU_Observable *the_PDU_Observable,
141 void recv_GDU(Z_GDU *apdu, int len);
144 void timeoutNotify();
145 void connectNotify();
147 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
148 const mp::Package *m_package;
149 yazpp_1::LimitConnect limit_connect;
156 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
159 m_assoc_child(ses), m_package(package), m_p(rep)
161 timer = yaz_timing_create();
164 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
166 yaz_timing_destroy(&timer); // timer may be NULL
170 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
172 mp::Session *ses = (mp::Session *) info;
174 return *ses == m_package->session();
177 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
179 m_assoc_child->m_no_requests--;
181 yazpp_1::GDU *gdu = &m_package->response();
186 m_assoc_child->send_GDU(gdu->get(), &len);
188 yaz_timing_stop(timer);
189 double duration = yaz_timing_get_real(timer);
192 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
194 m_p->m_duration_freq[ent]++;
196 m_p->m_duration_total += duration;
198 if (m_p->m_duration_max < duration)
199 m_p->m_duration_max = duration;
201 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
202 m_p->m_duration_min = duration;
204 if (m_p->m_msg_config.length())
206 Z_GDU *z_gdu = gdu->get();
208 std::ostringstream os;
209 os << m_p->m_msg_config << " "
211 << std::fixed << std::setprecision (6) << duration << " ";
218 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
221 else if (!m_package->session().is_closed())
223 // no response package and yet the session is still open..
224 // means that request is unhandled..
225 yazpp_1::GDU *gdu_req = &m_package->request();
226 Z_GDU *z_gdu = gdu_req->get();
227 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
229 // For Z39.50, response with a Close and shutdown
232 Z_APDU *apdu_response = odr.create_close(
233 z_gdu->u.z3950, Z_Close_systemProblem,
234 "unhandled Z39.50 request");
236 m_assoc_child->send_Z_PDU(apdu_response, &len);
238 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
240 // For HTTP, respond with Server Error
244 = odr.create_HTTP_Response(m_package->session(),
245 z_gdu->u.HTTP_Request, 500);
246 m_assoc_child->send_GDU(zgdu_res, &len);
248 m_package->session().close();
251 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
253 m_assoc_child->close();
260 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
262 m_package->move(m_assoc_child->m_route);
266 yf::FrontendNet::ZAssocChild::ZAssocChild(
267 yazpp_1::IPDU_Observable *PDU_Observable,
268 mp::ThreadPoolSocketObserver *my_thread_pool,
269 const mp::Package *package,
270 std::string route, Rep *rep)
271 : Z_Assoc(PDU_Observable), m_p(rep)
273 m_thread_pool_observer = my_thread_pool;
275 m_delete_flag = false;
278 const char *peername = PDU_Observable->getpeername();
280 peername = "unknown";
283 const char *cp = strchr(peername, ':');
287 m_origin.set_tcpip_address(std::string(peername), m_session.id());
288 timeout(m_p->m_session_timeout);
291 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
292 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
297 yf::FrontendNet::ZAssocChild::~ZAssocChild()
301 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
305 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
307 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
311 int number_total = 0;
313 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
314 number_total += m_p->m_duration_freq[i];
315 number_total += m_p->m_duration_freq[i];
317 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
318 wrbuf_puts(w, "<frontend_net>\n");
319 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
320 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
322 if (m_p->m_duration_freq[i] > 0)
324 w, " <response duration_start=\"%f\" "
325 "duration_end=\"%f\" frequency=\"%d\"/>\n",
326 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
327 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
330 if (m_p->m_duration_freq[i] > 0)
332 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
333 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
335 if (m_p->m_duration_max != 0.0)
337 w, " <response duration_max=\"%f\"/>\n",
338 m_p->m_duration_max);
339 if (m_p->m_duration_min != 0.0)
341 w, " <response duration_min=\"%f\"/>\n",
342 m_p->m_duration_min);
343 if (m_p->m_duration_total != 0.0)
345 w, " <response duration_average=\"%f\"/>\n",
346 m_p->m_duration_total / number_total);
348 wrbuf_puts(w, " </responses>\n");
352 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
354 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
355 thread_busy, thread_total);
357 wrbuf_puts(w, "</frontend_net>\n");
359 hres->content_len = w.len();
360 hres->content_buf = (char *) w.buf();
363 send_GDU(gdu_res, &len);
366 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
370 mp::Package *p = new mp::Package(m_session, m_origin);
372 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
374 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
376 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
378 p->origin().set_tcpip_address(std::string(f), m_session.id());
380 if (m_p->m_stat_req.length()
381 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
388 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
389 p->copy_route(*m_package);
390 p->request() = yazpp_1::GDU(z_pdu);
392 if (m_p->m_msg_config.length())
396 std::ostringstream os;
397 os << m_p->m_msg_config << " "
401 yaz_log(YLOG_LOG, "%s", os.str().c_str());
404 m_thread_pool_observer->put(tp);
407 void yf::FrontendNet::ZAssocChild::failNotify()
409 // TODO: send Package to signal "close"
410 if (m_session.is_closed())
412 if (m_no_requests == 0)
420 mp::Package *p = new mp::Package(m_session, m_origin);
422 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
423 p->copy_route(*m_package);
424 m_thread_pool_observer->cleanup(tp, &m_session);
425 m_thread_pool_observer->put(tp);
428 void yf::FrontendNet::ZAssocChild::timeoutNotify()
433 void yf::FrontendNet::ZAssocChild::connectNotify()
438 yf::FrontendNet::ZAssocServer::ZAssocServer(
439 yazpp_1::IPDU_Observable *PDU_Observable,
443 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
449 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
454 void yf::FrontendNet::ZAssocServer::set_thread_pool(
455 mp::ThreadPoolSocketObserver *observer)
457 m_thread_pool_observer = observer;
460 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
461 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
464 const char *peername = the_PDU_Observable->getpeername();
467 limit_connect.add_connect(peername);
468 limit_connect.cleanup(false);
469 int con_sz = limit_connect.get_total(peername);
470 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
473 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
474 m_thread_pool_observer,
475 m_package, m_route, m_p);
479 yf::FrontendNet::ZAssocServer::~ZAssocServer()
483 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
487 void yf::FrontendNet::ZAssocServer::failNotify()
491 void yf::FrontendNet::ZAssocServer::timeoutNotify()
495 void yf::FrontendNet::ZAssocServer::connectNotify()
499 yf::FrontendNet::FrontendNet() : m_p(new Rep)
503 yf::FrontendNet::Rep::Rep()
506 m_listen_duration = 0;
507 m_session_timeout = 300; // 5 minutes
511 for (i = 0; i < 22; i++)
512 m_duration_freq[i] = 0;
513 m_duration_lim[0] = 0.000001;
514 m_duration_lim[1] = 0.00001;
515 m_duration_lim[2] = 0.0001;
516 m_duration_lim[3] = 0.001;
517 m_duration_lim[4] = 0.01;
518 m_duration_lim[5] = 0.1;
519 m_duration_lim[6] = 0.2;
520 m_duration_lim[7] = 0.3;
521 m_duration_lim[8] = 0.5;
522 m_duration_lim[9] = 1.0;
523 m_duration_lim[10] = 1.5;
524 m_duration_lim[11] = 2.0;
525 m_duration_lim[12] = 3.0;
526 m_duration_lim[13] = 4.0;
527 m_duration_lim[14] = 5.0;
528 m_duration_lim[15] = 6.0;
529 m_duration_lim[16] = 8.0;
530 m_duration_lim[17] = 10.0;
531 m_duration_lim[18] = 15.0;
532 m_duration_lim[19] = 20.0;
533 m_duration_lim[20] = 30.0;
534 m_duration_lim[21] = 0.0;
535 m_duration_max = 0.0;
536 m_duration_min = 0.0;
537 m_duration_total = 0.0;
541 yf::FrontendNet::Rep::~Rep()
546 for (i = 0; i < m_ports.size(); i++)
554 yf::FrontendNet::~FrontendNet()
558 void yf::FrontendNet::stop(int signo) const
560 m_p->m_stop_signo = signo;
563 bool yf::FrontendNet::My_Timer_Thread::timeout()
568 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
569 yazpp_1::ISocketObservable *obs,
571 m_obs(obs), m_pipe(9123), m_timeout(false)
573 obs->addObserver(m_pipe.read_fd(), this);
574 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
575 obs->timeoutObserver(this, duration);
578 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
581 m_obs->deleteObserver(this);
584 void yf::FrontendNet::process(mp::Package &package) const
589 My_Timer_Thread *tt = 0;
591 if (m_p->m_listen_duration)
592 tt = new My_Timer_Thread(&m_p->mySocketManager,
593 m_p->m_listen_duration);
595 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
597 for (i = 0; i<m_p->m_ports.size(); i++)
599 m_p->az[i]->set_package(&package);
600 m_p->az[i]->set_thread_pool(&tp);
602 while (m_p->mySocketManager.processEvent() > 0)
604 if (m_p->m_stop_signo == SIGTERM)
606 yaz_log(YLOG_LOG, "metaproxy received SIGTERM");
610 for (i = 0; i < m_p->m_ports.size(); i++)
612 m_p->pdu[i]->shutdown();
613 m_p->az[i]->server("");
617 break; /* stop right away */
620 if (m_p->m_stop_signo == SIGUSR1)
621 { /* just stop listeners and cont till all sessions are done*/
622 yaz_log(YLOG_LOG, "metaproxy received SIGUSR1");
623 m_p->m_stop_signo = 0;
627 for (i = 0; i < m_p->m_ports.size(); i++)
628 m_p->az[i]->server("");
633 int no = m_p->mySocketManager.getNumberOfObservers();
636 if (tt && tt->timeout())
642 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
645 if (!ptr || !ptr->children)
647 throw yf::FilterException("No ports for Frontend");
649 std::vector<Port> ports;
650 for (ptr = ptr->children; ptr; ptr = ptr->next)
652 if (ptr->type != XML_ELEMENT_NODE)
654 if (!strcmp((const char *) ptr->name, "port"))
658 const char *names[5] = {"route", "max_recv_bytes", "port",
660 std::string values[4];
662 mp::xml::parse_attr(ptr, names, values);
663 port.route = values[0];
664 if (values[1].length() > 0)
665 port.max_recv_bytes = atoi(values[1].c_str());
667 port.max_recv_bytes = 0;
668 if (values[2].length() > 0)
669 port.port = values[2];
671 port.port = mp::xml::get_text(ptr);
672 port.cert_fname = values[3];
673 ports.push_back(port);
675 else if (!strcmp((const char *) ptr->name, "threads"))
677 std::string threads_str = mp::xml::get_text(ptr);
678 int threads = atoi(threads_str.c_str());
680 throw yf::FilterException("Bad value for threads: "
682 m_p->m_no_threads = threads;
684 else if (!strcmp((const char *) ptr->name, "timeout"))
686 std::string timeout_str = mp::xml::get_text(ptr);
687 int timeout = atoi(timeout_str.c_str());
689 throw yf::FilterException("Bad value for timeout: "
691 m_p->m_session_timeout = timeout;
693 else if (!strcmp((const char *) ptr->name, "connect-max"))
695 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
697 else if (!strcmp((const char *) ptr->name, "message"))
699 m_p->m_msg_config = mp::xml::get_text(ptr);
701 else if (!strcmp((const char *) ptr->name, "stat-req"))
703 m_p->m_stat_req = mp::xml::get_text(ptr);
707 throw yf::FilterException("Bad element "
708 + std::string((const char *)
717 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
719 std::vector<Port> nports;
722 for (i = 0; i < ports.size(); i++)
726 nport.port = ports[i];
728 nports.push_back(nport);
734 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
736 m_p->m_ports = ports;
738 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
739 m_p->pdu = new yazpp_1::PDU_Assoc *[m_p->m_ports.size()];
741 // Create yf::FrontendNet::ZAssocServer for each port
743 for (i = 0; i < m_p->m_ports.size(); i++)
745 for (i = 0; i < m_p->m_ports.size(); i++)
747 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
748 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
750 if (m_p->m_ports[i].cert_fname.length())
751 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
752 // create ZAssoc with PDU Assoc
754 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
755 as, m_p->m_ports[i].route, m_p.get());
756 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
758 throw yf::FilterException("Unable to bind to address "
759 + std::string(m_p->m_ports[i].port));
761 COMSTACK cs = as->get_comstack();
763 if (cs && m_p->m_ports[i].max_recv_bytes)
764 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
769 void yf::FrontendNet::set_listen_duration(int d)
771 m_p->m_listen_duration = d;
774 static yf::Base* filter_creator()
776 return new yf::FrontendNet;
780 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
790 * c-file-style: "Stroustrup"
791 * indent-tabs-mode: nil
793 * vim: shiftwidth=4 tabstop=8 expandtab