1 /* This file is part of Metaproxy.
2 Copyright (C) 2005-2013 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 int m_duration_freq[22];
67 double m_duration_lim[22];
68 double m_duration_max;
69 double m_duration_min;
70 double m_duration_total;
76 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
78 yazpp_1::ISocketObservable *m_obs;
82 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
83 void socketNotify(int event);
86 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
89 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
90 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
91 const mp::Package *package,
97 yazpp_1::IPDU_Observer* sessionNotify(
98 yazpp_1::IPDU_Observable *the_PDU_Observable,
100 void recv_GDU(Z_GDU *apdu, int len);
101 void report(Z_HTTP_Request *hreq);
103 void timeoutNotify();
104 void connectNotify();
106 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
107 mp::Session m_session;
110 const mp::Package *m_package;
113 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
115 ThreadPoolPackage(mp::Package *package,
116 yf::FrontendNet::ZAssocChild *ses,
118 ~ThreadPoolPackage();
119 IThreadPoolMsg *handle();
120 void result(const char *t_info);
121 bool cleanup(void *info);
124 ZAssocChild *m_assoc_child;
125 mp::Package *m_package;
128 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
131 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
134 void set_package(const mp::Package *package);
135 void set_thread_pool(ThreadPoolSocketObserver *observer);
137 yazpp_1::IPDU_Observer* sessionNotify(
138 yazpp_1::IPDU_Observable *the_PDU_Observable,
140 void recv_GDU(Z_GDU *apdu, int len);
143 void timeoutNotify();
144 void connectNotify();
146 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
147 const mp::Package *m_package;
148 yazpp_1::LimitConnect limit_connect;
155 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
158 m_assoc_child(ses), m_package(package), m_p(rep)
160 timer = yaz_timing_create();
163 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
165 yaz_timing_destroy(&timer); // timer may be NULL
169 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
171 mp::Session *ses = (mp::Session *) info;
173 return *ses == m_package->session();
176 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
178 m_assoc_child->m_no_requests--;
180 yazpp_1::GDU *gdu = &m_package->response();
185 m_assoc_child->send_GDU(gdu->get(), &len);
187 yaz_timing_stop(timer);
188 double duration = yaz_timing_get_real(timer);
191 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
193 m_p->m_duration_freq[ent]++;
195 m_p->m_duration_total += duration;
197 if (m_p->m_duration_max < duration)
198 m_p->m_duration_max = duration;
200 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
201 m_p->m_duration_min = duration;
203 if (m_p->m_msg_config.length())
205 Z_GDU *z_gdu = gdu->get();
207 std::ostringstream os;
208 os << m_p->m_msg_config << " "
210 << std::fixed << std::setprecision (6) << duration << " ";
217 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
220 else if (!m_package->session().is_closed())
222 // no response package and yet the session is still open..
223 // means that request is unhandled..
224 yazpp_1::GDU *gdu_req = &m_package->request();
225 Z_GDU *z_gdu = gdu_req->get();
226 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
228 // For Z39.50, response with a Close and shutdown
231 Z_APDU *apdu_response = odr.create_close(
232 z_gdu->u.z3950, Z_Close_systemProblem,
233 "unhandled Z39.50 request");
235 m_assoc_child->send_Z_PDU(apdu_response, &len);
237 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
239 // For HTTP, respond with Server Error
243 = odr.create_HTTP_Response(m_package->session(),
244 z_gdu->u.HTTP_Request, 500);
245 m_assoc_child->send_GDU(zgdu_res, &len);
247 m_package->session().close();
250 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
252 m_assoc_child->close();
259 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
261 m_package->move(m_assoc_child->m_route);
265 yf::FrontendNet::ZAssocChild::ZAssocChild(
266 yazpp_1::IPDU_Observable *PDU_Observable,
267 mp::ThreadPoolSocketObserver *my_thread_pool,
268 const mp::Package *package,
269 std::string route, Rep *rep)
270 : Z_Assoc(PDU_Observable), m_p(rep)
272 m_thread_pool_observer = my_thread_pool;
274 m_delete_flag = false;
277 const char *peername = PDU_Observable->getpeername();
279 peername = "unknown";
280 m_origin.set_tcpip_address(std::string(peername), m_session.id());
281 timeout(m_p->m_session_timeout);
284 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
285 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
290 yf::FrontendNet::ZAssocChild::~ZAssocChild()
294 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
298 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
300 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
304 int number_total = 0;
306 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
307 number_total += m_p->m_duration_freq[i];
308 number_total += m_p->m_duration_freq[i];
310 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
311 wrbuf_puts(w, "<frontend_net>\n");
312 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
313 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
315 if (m_p->m_duration_freq[i] > 0)
317 w, " <response duration_start=\"%f\" "
318 "duration_end=\"%f\" frequency=\"%d\"/>\n",
319 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
320 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
323 if (m_p->m_duration_freq[i] > 0)
325 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
326 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
328 if (m_p->m_duration_max != 0.0)
330 w, " <response duration_max=\"%f\"/>\n",
331 m_p->m_duration_max);
332 if (m_p->m_duration_min != 0.0)
334 w, " <response duration_min=\"%f\"/>\n",
335 m_p->m_duration_min);
336 if (m_p->m_duration_total != 0.0)
338 w, " <response duration_average=\"%f\"/>\n",
339 m_p->m_duration_total / number_total);
341 wrbuf_puts(w, " </responses>\n");
345 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
347 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
348 thread_busy, thread_total);
350 wrbuf_puts(w, "</frontend_net>\n");
352 hres->content_len = w.len();
353 hres->content_buf = (char *) w.buf();
356 send_GDU(gdu_res, &len);
359 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
363 mp::Package *p = new mp::Package(m_session, m_origin);
365 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
367 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
369 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
371 p->origin().set_tcpip_address(std::string(f), m_session.id());
373 if (m_p->m_stat_req.length()
374 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
381 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
382 p->copy_route(*m_package);
383 p->request() = yazpp_1::GDU(z_pdu);
385 if (m_p->m_msg_config.length())
389 std::ostringstream os;
390 os << m_p->m_msg_config << " "
394 yaz_log(YLOG_LOG, "%s", os.str().c_str());
397 m_thread_pool_observer->put(tp);
400 void yf::FrontendNet::ZAssocChild::failNotify()
402 // TODO: send Package to signal "close"
403 if (m_session.is_closed())
405 if (m_no_requests == 0)
413 mp::Package *p = new mp::Package(m_session, m_origin);
415 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
416 p->copy_route(*m_package);
417 m_thread_pool_observer->cleanup(tp, &m_session);
418 m_thread_pool_observer->put(tp);
421 void yf::FrontendNet::ZAssocChild::timeoutNotify()
426 void yf::FrontendNet::ZAssocChild::connectNotify()
431 yf::FrontendNet::ZAssocServer::ZAssocServer(
432 yazpp_1::IPDU_Observable *PDU_Observable,
436 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
442 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
447 void yf::FrontendNet::ZAssocServer::set_thread_pool(
448 mp::ThreadPoolSocketObserver *observer)
450 m_thread_pool_observer = observer;
453 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
454 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
457 const char *peername = the_PDU_Observable->getpeername();
460 limit_connect.add_connect(peername);
461 limit_connect.cleanup(false);
462 int con_sz = limit_connect.get_total(peername);
463 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
466 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
467 m_thread_pool_observer,
468 m_package, m_route, m_p);
472 yf::FrontendNet::ZAssocServer::~ZAssocServer()
476 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
480 void yf::FrontendNet::ZAssocServer::failNotify()
484 void yf::FrontendNet::ZAssocServer::timeoutNotify()
488 void yf::FrontendNet::ZAssocServer::connectNotify()
492 yf::FrontendNet::FrontendNet() : m_p(new Rep)
496 yf::FrontendNet::Rep::Rep()
499 m_listen_duration = 0;
500 m_session_timeout = 300; // 5 minutes
504 for (i = 0; i < 22; i++)
505 m_duration_freq[i] = 0;
506 m_duration_lim[0] = 0.000001;
507 m_duration_lim[1] = 0.00001;
508 m_duration_lim[2] = 0.0001;
509 m_duration_lim[3] = 0.001;
510 m_duration_lim[4] = 0.01;
511 m_duration_lim[5] = 0.1;
512 m_duration_lim[6] = 0.2;
513 m_duration_lim[7] = 0.3;
514 m_duration_lim[8] = 0.5;
515 m_duration_lim[9] = 1.0;
516 m_duration_lim[10] = 1.5;
517 m_duration_lim[11] = 2.0;
518 m_duration_lim[12] = 3.0;
519 m_duration_lim[13] = 4.0;
520 m_duration_lim[14] = 5.0;
521 m_duration_lim[15] = 6.0;
522 m_duration_lim[16] = 8.0;
523 m_duration_lim[17] = 10.0;
524 m_duration_lim[18] = 15.0;
525 m_duration_lim[19] = 20.0;
526 m_duration_lim[20] = 30.0;
527 m_duration_lim[21] = 0.0;
528 m_duration_max = 0.0;
529 m_duration_min = 0.0;
530 m_duration_total = 0.0;
534 yf::FrontendNet::Rep::~Rep()
539 for (i = 0; i < m_ports.size(); i++)
546 yf::FrontendNet::~FrontendNet()
550 void yf::FrontendNet::stop(int signo) const
552 m_p->m_stop_signo = signo;
555 bool yf::FrontendNet::My_Timer_Thread::timeout()
560 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
561 yazpp_1::ISocketObservable *obs,
563 m_obs(obs), m_pipe(9123), m_timeout(false)
565 obs->addObserver(m_pipe.read_fd(), this);
566 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
567 obs->timeoutObserver(this, duration);
570 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
573 m_obs->deleteObserver(this);
576 void yf::FrontendNet::process(mp::Package &package) const
581 My_Timer_Thread *tt = 0;
583 if (m_p->m_listen_duration)
584 tt = new My_Timer_Thread(&m_p->mySocketManager,
585 m_p->m_listen_duration);
587 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
589 for (i = 0; i<m_p->m_ports.size(); i++)
591 m_p->az[i]->set_package(&package);
592 m_p->az[i]->set_thread_pool(&tp);
594 while (m_p->mySocketManager.processEvent() > 0)
596 if (m_p->m_stop_signo == SIGTERM)
597 break; /* stop right away */
598 if (m_p->m_stop_signo == SIGUSR1)
599 { /* just stop listeners and cont till all sessions are done*/
600 m_p->m_stop_signo = 0;
604 for (i = 0; i < m_p->m_ports.size(); i++)
605 m_p->az[i]->server("");
609 int no = m_p->mySocketManager.getNumberOfObservers();
612 if (tt && tt->timeout())
618 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
621 if (!ptr || !ptr->children)
623 throw yf::FilterException("No ports for Frontend");
625 std::vector<Port> ports;
626 for (ptr = ptr->children; ptr; ptr = ptr->next)
628 if (ptr->type != XML_ELEMENT_NODE)
630 if (!strcmp((const char *) ptr->name, "port"))
634 const char *names[5] = {"route", "max_recv_bytes", "port",
636 std::string values[4];
638 mp::xml::parse_attr(ptr, names, values);
639 port.route = values[0];
640 if (values[1].length() > 0)
641 port.max_recv_bytes = atoi(values[1].c_str());
643 port.max_recv_bytes = 0;
644 if (values[2].length() > 0)
645 port.port = values[2];
647 port.port = mp::xml::get_text(ptr);
648 port.cert_fname = values[3];
649 ports.push_back(port);
651 else if (!strcmp((const char *) ptr->name, "threads"))
653 std::string threads_str = mp::xml::get_text(ptr);
654 int threads = atoi(threads_str.c_str());
656 throw yf::FilterException("Bad value for threads: "
658 m_p->m_no_threads = threads;
660 else if (!strcmp((const char *) ptr->name, "timeout"))
662 std::string timeout_str = mp::xml::get_text(ptr);
663 int timeout = atoi(timeout_str.c_str());
665 throw yf::FilterException("Bad value for timeout: "
667 m_p->m_session_timeout = timeout;
669 else if (!strcmp((const char *) ptr->name, "connect-max"))
671 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
673 else if (!strcmp((const char *) ptr->name, "message"))
675 m_p->m_msg_config = mp::xml::get_text(ptr);
677 else if (!strcmp((const char *) ptr->name, "stat-req"))
679 m_p->m_stat_req = mp::xml::get_text(ptr);
683 throw yf::FilterException("Bad element "
684 + std::string((const char *)
693 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
695 std::vector<Port> nports;
698 for (i = 0; i < ports.size(); i++)
702 nport.port = ports[i];
704 nports.push_back(nport);
710 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
712 m_p->m_ports = ports;
714 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
716 // Create yf::FrontendNet::ZAssocServer for each port
718 for (i = 0; i<m_p->m_ports.size(); i++)
720 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
721 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
723 if (m_p->m_ports[i].cert_fname.length())
724 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
725 // create ZAssoc with PDU Assoc
726 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
727 as, m_p->m_ports[i].route, m_p.get());
728 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
730 throw yf::FilterException("Unable to bind to address "
731 + std::string(m_p->m_ports[i].port));
733 COMSTACK cs = as->get_comstack();
735 if (cs && m_p->m_ports[i].max_recv_bytes)
736 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
741 void yf::FrontendNet::set_listen_duration(int d)
743 m_p->m_listen_duration = d;
746 static yf::Base* filter_creator()
748 return new yf::FrontendNet;
752 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
762 * c-file-style: "Stroustrup"
763 * indent-tabs-mode: nil
765 * vim: shiftwidth=4 tabstop=8 expandtab