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,
133 FrontendNet::Port *port,
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_port->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 Port *port, 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, ':');
288 addr.append(peername);
290 addr.append(port->port);
291 m_origin.set_tcpip_address(addr, m_session.id());
292 timeout(m_p->m_session_timeout);
295 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
296 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
301 yf::FrontendNet::ZAssocChild::~ZAssocChild()
305 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
309 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
311 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
315 int number_total = 0;
317 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
318 number_total += m_p->m_duration_freq[i];
319 number_total += m_p->m_duration_freq[i];
321 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
322 wrbuf_puts(w, "<frontend_net>\n");
323 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
324 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
326 if (m_p->m_duration_freq[i] > 0)
328 w, " <response duration_start=\"%f\" "
329 "duration_end=\"%f\" frequency=\"%d\"/>\n",
330 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
331 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
334 if (m_p->m_duration_freq[i] > 0)
336 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
337 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
339 if (m_p->m_duration_max != 0.0)
341 w, " <response duration_max=\"%f\"/>\n",
342 m_p->m_duration_max);
343 if (m_p->m_duration_min != 0.0)
345 w, " <response duration_min=\"%f\"/>\n",
346 m_p->m_duration_min);
347 if (m_p->m_duration_total != 0.0)
349 w, " <response duration_average=\"%f\"/>\n",
350 m_p->m_duration_total / number_total);
352 wrbuf_puts(w, " </responses>\n");
356 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
358 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
359 thread_busy, thread_total);
361 wrbuf_puts(w, "</frontend_net>\n");
363 hres->content_len = w.len();
364 hres->content_buf = (char *) w.buf();
367 send_GDU(gdu_res, &len);
370 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
374 mp::Package *p = new mp::Package(m_session, m_origin);
376 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
378 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
380 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
382 p->origin().set_tcpip_address(std::string(f), m_session.id());
384 if (m_p->m_stat_req.length()
385 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
392 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
393 p->copy_route(*m_package);
394 p->request() = yazpp_1::GDU(z_pdu);
396 if (m_p->m_msg_config.length())
400 std::ostringstream os;
401 os << m_p->m_msg_config << " "
405 yaz_log(YLOG_LOG, "%s", os.str().c_str());
408 m_thread_pool_observer->put(tp);
411 void yf::FrontendNet::ZAssocChild::failNotify()
413 // TODO: send Package to signal "close"
414 if (m_session.is_closed())
416 if (m_no_requests == 0)
424 mp::Package *p = new mp::Package(m_session, m_origin);
426 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
427 p->copy_route(*m_package);
428 m_thread_pool_observer->cleanup(tp, &m_session);
429 m_thread_pool_observer->put(tp);
432 void yf::FrontendNet::ZAssocChild::timeoutNotify()
437 void yf::FrontendNet::ZAssocChild::connectNotify()
442 yf::FrontendNet::ZAssocServer::ZAssocServer(
443 yazpp_1::IPDU_Observable *PDU_Observable,
447 Z_Assoc(PDU_Observable), m_port(port), m_p(rep)
453 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
458 void yf::FrontendNet::ZAssocServer::set_thread_pool(
459 mp::ThreadPoolSocketObserver *observer)
461 m_thread_pool_observer = observer;
464 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
465 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
468 const char *peername = the_PDU_Observable->getpeername();
471 limit_connect.add_connect(peername);
472 limit_connect.cleanup(false);
473 int con_sz = limit_connect.get_total(peername);
474 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
477 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
478 m_thread_pool_observer,
479 m_package, m_port, m_p);
483 yf::FrontendNet::ZAssocServer::~ZAssocServer()
487 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
491 void yf::FrontendNet::ZAssocServer::failNotify()
495 void yf::FrontendNet::ZAssocServer::timeoutNotify()
499 void yf::FrontendNet::ZAssocServer::connectNotify()
503 yf::FrontendNet::FrontendNet() : m_p(new Rep)
507 yf::FrontendNet::Rep::Rep()
510 m_listen_duration = 0;
511 m_session_timeout = 300; // 5 minutes
515 for (i = 0; i < 22; i++)
516 m_duration_freq[i] = 0;
517 m_duration_lim[0] = 0.000001;
518 m_duration_lim[1] = 0.00001;
519 m_duration_lim[2] = 0.0001;
520 m_duration_lim[3] = 0.001;
521 m_duration_lim[4] = 0.01;
522 m_duration_lim[5] = 0.1;
523 m_duration_lim[6] = 0.2;
524 m_duration_lim[7] = 0.3;
525 m_duration_lim[8] = 0.5;
526 m_duration_lim[9] = 1.0;
527 m_duration_lim[10] = 1.5;
528 m_duration_lim[11] = 2.0;
529 m_duration_lim[12] = 3.0;
530 m_duration_lim[13] = 4.0;
531 m_duration_lim[14] = 5.0;
532 m_duration_lim[15] = 6.0;
533 m_duration_lim[16] = 8.0;
534 m_duration_lim[17] = 10.0;
535 m_duration_lim[18] = 15.0;
536 m_duration_lim[19] = 20.0;
537 m_duration_lim[20] = 30.0;
538 m_duration_lim[21] = 0.0;
539 m_duration_max = 0.0;
540 m_duration_min = 0.0;
541 m_duration_total = 0.0;
545 yf::FrontendNet::Rep::~Rep()
550 for (i = 0; i < m_ports.size(); i++)
558 yf::FrontendNet::~FrontendNet()
562 void yf::FrontendNet::stop(int signo) const
564 m_p->m_stop_signo = signo;
567 bool yf::FrontendNet::My_Timer_Thread::timeout()
572 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
573 yazpp_1::ISocketObservable *obs,
575 m_obs(obs), m_pipe(9123), m_timeout(false)
577 obs->addObserver(m_pipe.read_fd(), this);
578 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
579 obs->timeoutObserver(this, duration);
582 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
585 m_obs->deleteObserver(this);
588 void yf::FrontendNet::process(mp::Package &package) const
593 My_Timer_Thread *tt = 0;
595 if (m_p->m_listen_duration)
596 tt = new My_Timer_Thread(&m_p->mySocketManager,
597 m_p->m_listen_duration);
599 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
601 for (i = 0; i<m_p->m_ports.size(); i++)
603 m_p->az[i]->set_package(&package);
604 m_p->az[i]->set_thread_pool(&tp);
606 while (m_p->mySocketManager.processEvent() > 0)
608 if (m_p->m_stop_signo == SIGTERM)
610 yaz_log(YLOG_LOG, "metaproxy received SIGTERM");
614 for (i = 0; i < m_p->m_ports.size(); i++)
616 m_p->pdu[i]->shutdown();
617 m_p->az[i]->server("");
621 break; /* stop right away */
624 if (m_p->m_stop_signo == SIGUSR1)
625 { /* just stop listeners and cont till all sessions are done*/
626 yaz_log(YLOG_LOG, "metaproxy received SIGUSR1");
627 m_p->m_stop_signo = 0;
631 for (i = 0; i < m_p->m_ports.size(); i++)
632 m_p->az[i]->server("");
637 int no = m_p->mySocketManager.getNumberOfObservers();
640 if (tt && tt->timeout())
646 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
649 if (!ptr || !ptr->children)
651 throw yf::FilterException("No ports for Frontend");
653 std::vector<Port> ports;
654 for (ptr = ptr->children; ptr; ptr = ptr->next)
656 if (ptr->type != XML_ELEMENT_NODE)
658 if (!strcmp((const char *) ptr->name, "port"))
662 const char *names[5] = {"route", "max_recv_bytes", "port",
664 std::string values[4];
666 mp::xml::parse_attr(ptr, names, values);
667 port.route = values[0];
668 if (values[1].length() > 0)
669 port.max_recv_bytes = atoi(values[1].c_str());
671 port.max_recv_bytes = 0;
672 if (values[2].length() > 0)
673 port.port = values[2];
675 port.port = mp::xml::get_text(ptr);
676 port.cert_fname = values[3];
677 ports.push_back(port);
679 else if (!strcmp((const char *) ptr->name, "threads"))
681 std::string threads_str = mp::xml::get_text(ptr);
682 int threads = atoi(threads_str.c_str());
684 throw yf::FilterException("Bad value for threads: "
686 m_p->m_no_threads = threads;
688 else if (!strcmp((const char *) ptr->name, "timeout"))
690 std::string timeout_str = mp::xml::get_text(ptr);
691 int timeout = atoi(timeout_str.c_str());
693 throw yf::FilterException("Bad value for timeout: "
695 m_p->m_session_timeout = timeout;
697 else if (!strcmp((const char *) ptr->name, "connect-max"))
699 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
701 else if (!strcmp((const char *) ptr->name, "message"))
703 m_p->m_msg_config = mp::xml::get_text(ptr);
705 else if (!strcmp((const char *) ptr->name, "stat-req"))
707 m_p->m_stat_req = mp::xml::get_text(ptr);
711 throw yf::FilterException("Bad element "
712 + std::string((const char *)
721 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
723 std::vector<Port> nports;
726 for (i = 0; i < ports.size(); i++)
730 nport.port = ports[i];
732 nports.push_back(nport);
738 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
740 m_p->m_ports = ports;
742 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
743 m_p->pdu = new yazpp_1::PDU_Assoc *[m_p->m_ports.size()];
745 // Create yf::FrontendNet::ZAssocServer for each port
747 for (i = 0; i < m_p->m_ports.size(); i++)
749 for (i = 0; i < m_p->m_ports.size(); i++)
751 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
752 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
754 if (m_p->m_ports[i].cert_fname.length())
755 as->set_cert_fname(m_p->m_ports[i].cert_fname.c_str());
756 // create ZAssoc with PDU Assoc
758 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
759 as, &m_p->m_ports[i], m_p.get());
760 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
762 throw yf::FilterException("Unable to bind to address "
763 + std::string(m_p->m_ports[i].port));
765 COMSTACK cs = as->get_comstack();
767 if (cs && m_p->m_ports[i].max_recv_bytes)
768 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
773 void yf::FrontendNet::set_listen_duration(int d)
775 m_p->m_listen_duration = d;
778 static yf::Base* filter_creator()
780 return new yf::FrontendNet;
784 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
794 * c-file-style: "Stroustrup"
795 * indent-tabs-mode: nil
797 * vim: shiftwidth=4 tabstop=8 expandtab