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"
40 namespace mp = metaproxy_1;
41 namespace yf = metaproxy_1::filter;
43 namespace metaproxy_1 {
45 class FrontendNet::Port {
47 friend class FrontendNet;
52 class FrontendNet::Rep {
53 friend class FrontendNet;
56 std::vector<Port> m_ports;
57 int m_listen_duration;
58 int m_session_timeout;
60 std::string m_msg_config;
61 std::string m_stat_req;
62 yazpp_1::SocketManager mySocketManager;
64 int m_duration_freq[22];
65 double m_duration_lim[22];
66 double m_duration_max;
67 double m_duration_min;
68 double m_duration_total;
74 class FrontendNet::My_Timer_Thread : public yazpp_1::ISocketObserver {
76 yazpp_1::ISocketObservable *m_obs;
80 My_Timer_Thread(yazpp_1::ISocketObservable *obs, int duration);
81 void socketNotify(int event);
84 class FrontendNet::ZAssocChild : public yazpp_1::Z_Assoc {
87 ZAssocChild(yazpp_1::IPDU_Observable *the_PDU_Observable,
88 mp::ThreadPoolSocketObserver *m_thread_pool_observer,
89 const mp::Package *package,
95 yazpp_1::IPDU_Observer* sessionNotify(
96 yazpp_1::IPDU_Observable *the_PDU_Observable,
98 void recv_GDU(Z_GDU *apdu, int len);
99 void report(Z_HTTP_Request *hreq);
101 void timeoutNotify();
102 void connectNotify();
104 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
105 mp::Session m_session;
108 const mp::Package *m_package;
111 class FrontendNet::ThreadPoolPackage : public mp::IThreadPoolMsg {
113 ThreadPoolPackage(mp::Package *package,
114 yf::FrontendNet::ZAssocChild *ses,
116 ~ThreadPoolPackage();
117 IThreadPoolMsg *handle();
118 void result(const char *t_info);
119 bool cleanup(void *info);
122 ZAssocChild *m_assoc_child;
123 mp::Package *m_package;
126 class FrontendNet::ZAssocServer : public yazpp_1::Z_Assoc {
129 ZAssocServer(yazpp_1::IPDU_Observable *PDU_Observable,
132 void set_package(const mp::Package *package);
133 void set_thread_pool(ThreadPoolSocketObserver *observer);
135 yazpp_1::IPDU_Observer* sessionNotify(
136 yazpp_1::IPDU_Observable *the_PDU_Observable,
138 void recv_GDU(Z_GDU *apdu, int len);
141 void timeoutNotify();
142 void connectNotify();
144 mp::ThreadPoolSocketObserver *m_thread_pool_observer;
145 const mp::Package *m_package;
146 yazpp_1::LimitConnect limit_connect;
153 yf::FrontendNet::ThreadPoolPackage::ThreadPoolPackage(mp::Package *package,
156 m_assoc_child(ses), m_package(package), m_p(rep)
158 timer = yaz_timing_create();
161 yf::FrontendNet::ThreadPoolPackage::~ThreadPoolPackage()
163 yaz_timing_destroy(&timer); // timer may be NULL
167 bool yf::FrontendNet::ThreadPoolPackage::cleanup(void *info)
169 mp::Session *ses = (mp::Session *) info;
171 return *ses == m_package->session();
174 void yf::FrontendNet::ThreadPoolPackage::result(const char *t_info)
176 m_assoc_child->m_no_requests--;
178 yazpp_1::GDU *gdu = &m_package->response();
183 m_assoc_child->send_GDU(gdu->get(), &len);
185 yaz_timing_stop(timer);
186 double duration = yaz_timing_get_real(timer);
189 while (m_p->m_duration_lim[ent] != 0.0 && duration > m_p->m_duration_lim[ent])
191 m_p->m_duration_freq[ent]++;
193 m_p->m_duration_total += duration;
195 if (m_p->m_duration_max < duration)
196 m_p->m_duration_max = duration;
198 if (m_p->m_duration_min == 0.0 || m_p->m_duration_min > duration)
199 m_p->m_duration_min = duration;
201 if (m_p->m_msg_config.length())
203 Z_GDU *z_gdu = gdu->get();
205 std::ostringstream os;
206 os << m_p->m_msg_config << " "
208 << std::fixed << std::setprecision (6) << duration << " ";
215 yaz_log(YLOG_LOG, "%s %s", os.str().c_str(), t_info);
218 else if (!m_package->session().is_closed())
220 // no response package and yet the session is still open..
221 // means that request is unhandled..
222 yazpp_1::GDU *gdu_req = &m_package->request();
223 Z_GDU *z_gdu = gdu_req->get();
224 if (z_gdu && z_gdu->which == Z_GDU_Z3950)
226 // For Z39.50, response with a Close and shutdown
229 Z_APDU *apdu_response = odr.create_close(
230 z_gdu->u.z3950, Z_Close_systemProblem,
231 "unhandled Z39.50 request");
233 m_assoc_child->send_Z_PDU(apdu_response, &len);
235 else if (z_gdu && z_gdu->which == Z_GDU_HTTP_Request)
237 // For HTTP, respond with Server Error
241 = odr.create_HTTP_Response(m_package->session(),
242 z_gdu->u.HTTP_Request, 500);
243 m_assoc_child->send_GDU(zgdu_res, &len);
245 m_package->session().close();
248 if (m_assoc_child->m_no_requests == 0 && m_package->session().is_closed())
250 m_assoc_child->close();
257 mp::IThreadPoolMsg *yf::FrontendNet::ThreadPoolPackage::handle()
259 m_package->move(m_assoc_child->m_route);
263 yf::FrontendNet::ZAssocChild::ZAssocChild(
264 yazpp_1::IPDU_Observable *PDU_Observable,
265 mp::ThreadPoolSocketObserver *my_thread_pool,
266 const mp::Package *package,
267 std::string route, Rep *rep)
268 : Z_Assoc(PDU_Observable), m_p(rep)
270 m_thread_pool_observer = my_thread_pool;
272 m_delete_flag = false;
275 const char *peername = PDU_Observable->getpeername();
277 peername = "unknown";
278 m_origin.set_tcpip_address(std::string(peername), m_session.id());
279 timeout(m_p->m_session_timeout);
282 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocChild::sessionNotify(
283 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
288 yf::FrontendNet::ZAssocChild::~ZAssocChild()
292 void yf::FrontendNet::ZAssocChild::report(Z_HTTP_Request *hreq)
296 Z_GDU *gdu_res = o.create_HTTP_Response(m_session, hreq, 200);
298 Z_HTTP_Response *hres = gdu_res->u.HTTP_Response;
302 int number_total = 0;
304 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
305 number_total += m_p->m_duration_freq[i];
306 number_total += m_p->m_duration_freq[i];
308 wrbuf_puts(w, "<?xml version=\"1.0\"?>\n");
309 wrbuf_puts(w, "<frontend_net>\n");
310 wrbuf_printf(w, " <responses frequency=\"%d\">\n", number_total);
311 for (i = 0; m_p->m_duration_lim[i] != 0.0; i++)
313 if (m_p->m_duration_freq[i] > 0)
315 w, " <response duration_start=\"%f\" "
316 "duration_end=\"%f\" frequency=\"%d\"/>\n",
317 i > 0 ? m_p->m_duration_lim[i - 1] : 0.0,
318 m_p->m_duration_lim[i], m_p->m_duration_freq[i]);
321 if (m_p->m_duration_freq[i] > 0)
323 w, " <response duration_start=\"%f\" frequency=\"%d\"/>\n",
324 m_p->m_duration_lim[i - 1], m_p->m_duration_freq[i]);
326 if (m_p->m_duration_max != 0.0)
328 w, " <response duration_max=\"%f\"/>\n",
329 m_p->m_duration_max);
330 if (m_p->m_duration_min != 0.0)
332 w, " <response duration_min=\"%f\"/>\n",
333 m_p->m_duration_min);
334 if (m_p->m_duration_total != 0.0)
336 w, " <response duration_average=\"%f\"/>\n",
337 m_p->m_duration_total / number_total);
339 wrbuf_puts(w, " </responses>\n");
343 m_thread_pool_observer->get_thread_info(thread_busy, thread_total);
345 wrbuf_printf(w, " <thread_info busy=\"%d\" total=\"%d\"/>\n",
346 thread_busy, thread_total);
348 wrbuf_puts(w, "</frontend_net>\n");
350 hres->content_len = w.len();
351 hres->content_buf = (char *) w.buf();
354 send_GDU(gdu_res, &len);
357 void yf::FrontendNet::ZAssocChild::recv_GDU(Z_GDU *z_pdu, int len)
361 mp::Package *p = new mp::Package(m_session, m_origin);
363 if (z_pdu && z_pdu->which == Z_GDU_HTTP_Request)
365 Z_HTTP_Request *hreq = z_pdu->u.HTTP_Request;
367 const char *f = z_HTTP_header_lookup(hreq->headers, "X-Forwarded-For");
369 p->origin().set_tcpip_address(std::string(f), m_session.id());
371 if (m_p->m_stat_req.length()
372 && !strcmp(hreq->path, m_p->m_stat_req.c_str()))
379 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
380 p->copy_route(*m_package);
381 p->request() = yazpp_1::GDU(z_pdu);
383 if (m_p->m_msg_config.length())
387 std::ostringstream os;
388 os << m_p->m_msg_config << " "
392 yaz_log(YLOG_LOG, "%s", os.str().c_str());
395 m_thread_pool_observer->put(tp);
398 void yf::FrontendNet::ZAssocChild::failNotify()
400 // TODO: send Package to signal "close"
401 if (m_session.is_closed())
403 if (m_no_requests == 0)
411 mp::Package *p = new mp::Package(m_session, m_origin);
413 ThreadPoolPackage *tp = new ThreadPoolPackage(p, this, m_p);
414 p->copy_route(*m_package);
415 m_thread_pool_observer->cleanup(tp, &m_session);
416 m_thread_pool_observer->put(tp);
419 void yf::FrontendNet::ZAssocChild::timeoutNotify()
424 void yf::FrontendNet::ZAssocChild::connectNotify()
429 yf::FrontendNet::ZAssocServer::ZAssocServer(
430 yazpp_1::IPDU_Observable *PDU_Observable,
434 Z_Assoc(PDU_Observable), m_route(route), m_p(rep)
440 void yf::FrontendNet::ZAssocServer::set_package(const mp::Package *package)
445 void yf::FrontendNet::ZAssocServer::set_thread_pool(
446 mp::ThreadPoolSocketObserver *observer)
448 m_thread_pool_observer = observer;
451 yazpp_1::IPDU_Observer *yf::FrontendNet::ZAssocServer::sessionNotify(
452 yazpp_1::IPDU_Observable *the_PDU_Observable, int fd)
455 const char *peername = the_PDU_Observable->getpeername();
458 limit_connect.add_connect(peername);
459 limit_connect.cleanup(false);
460 int con_sz = limit_connect.get_total(peername);
461 if (m_p->m_connect_max && con_sz > m_p->m_connect_max)
464 ZAssocChild *my = new ZAssocChild(the_PDU_Observable,
465 m_thread_pool_observer,
466 m_package, m_route, m_p);
470 yf::FrontendNet::ZAssocServer::~ZAssocServer()
474 void yf::FrontendNet::ZAssocServer::recv_GDU(Z_GDU *apdu, int len)
478 void yf::FrontendNet::ZAssocServer::failNotify()
482 void yf::FrontendNet::ZAssocServer::timeoutNotify()
486 void yf::FrontendNet::ZAssocServer::connectNotify()
490 yf::FrontendNet::FrontendNet() : m_p(new Rep)
494 yf::FrontendNet::Rep::Rep()
497 m_listen_duration = 0;
498 m_session_timeout = 300; // 5 minutes
502 for (i = 0; i < 22; i++)
503 m_duration_freq[i] = 0;
504 m_duration_lim[0] = 0.000001;
505 m_duration_lim[1] = 0.00001;
506 m_duration_lim[2] = 0.0001;
507 m_duration_lim[3] = 0.001;
508 m_duration_lim[4] = 0.01;
509 m_duration_lim[5] = 0.1;
510 m_duration_lim[6] = 0.2;
511 m_duration_lim[7] = 0.3;
512 m_duration_lim[8] = 0.5;
513 m_duration_lim[9] = 1.0;
514 m_duration_lim[10] = 1.5;
515 m_duration_lim[11] = 2.0;
516 m_duration_lim[12] = 3.0;
517 m_duration_lim[13] = 4.0;
518 m_duration_lim[14] = 5.0;
519 m_duration_lim[15] = 6.0;
520 m_duration_lim[16] = 8.0;
521 m_duration_lim[17] = 10.0;
522 m_duration_lim[18] = 15.0;
523 m_duration_lim[19] = 20.0;
524 m_duration_lim[20] = 30.0;
525 m_duration_lim[21] = 0.0;
526 m_duration_max = 0.0;
527 m_duration_min = 0.0;
528 m_duration_total = 0.0;
532 yf::FrontendNet::Rep::~Rep()
537 for (i = 0; i < m_ports.size(); i++)
544 yf::FrontendNet::~FrontendNet()
548 void yf::FrontendNet::stop() const
553 bool yf::FrontendNet::My_Timer_Thread::timeout()
558 yf::FrontendNet::My_Timer_Thread::My_Timer_Thread(
559 yazpp_1::ISocketObservable *obs,
561 m_obs(obs), m_pipe(9123), m_timeout(false)
563 obs->addObserver(m_pipe.read_fd(), this);
564 obs->maskObserver(this, yazpp_1::SOCKET_OBSERVE_READ);
565 obs->timeoutObserver(this, duration);
568 void yf::FrontendNet::My_Timer_Thread::socketNotify(int event)
571 m_obs->deleteObserver(this);
574 void yf::FrontendNet::process(mp::Package &package) const
579 My_Timer_Thread *tt = 0;
581 if (m_p->m_listen_duration)
582 tt = new My_Timer_Thread(&m_p->mySocketManager,
583 m_p->m_listen_duration);
585 ThreadPoolSocketObserver tp(&m_p->mySocketManager, m_p->m_no_threads);
587 for (i = 0; i<m_p->m_ports.size(); i++)
589 m_p->az[i]->set_package(&package);
590 m_p->az[i]->set_thread_pool(&tp);
592 while (m_p->mySocketManager.processEvent() > 0)
600 for (i = 0; i < m_p->m_ports.size(); i++)
601 m_p->az[i]->server("");
605 int no = m_p->mySocketManager.getNumberOfObservers();
608 if (tt && tt->timeout())
614 void yf::FrontendNet::configure(const xmlNode * ptr, bool test_only,
617 if (!ptr || !ptr->children)
619 throw yf::FilterException("No ports for Frontend");
621 std::vector<Port> ports;
622 for (ptr = ptr->children; ptr; ptr = ptr->next)
624 if (ptr->type != XML_ELEMENT_NODE)
626 if (!strcmp((const char *) ptr->name, "port"))
630 const char *names[4] = {"route", "max_recv_bytes", "port", 0};
631 std::string values[3];
633 mp::xml::parse_attr(ptr, names, values);
634 port.route = values[0];
635 if (values[1].length() > 0)
636 port.max_recv_bytes = atoi(values[1].c_str());
638 port.max_recv_bytes = 0;
639 if (values[2].length() > 0)
640 port.port = values[2];
642 port.port = mp::xml::get_text(ptr);
643 ports.push_back(port);
645 else if (!strcmp((const char *) ptr->name, "threads"))
647 std::string threads_str = mp::xml::get_text(ptr);
648 int threads = atoi(threads_str.c_str());
650 throw yf::FilterException("Bad value for threads: "
652 m_p->m_no_threads = threads;
654 else if (!strcmp((const char *) ptr->name, "timeout"))
656 std::string timeout_str = mp::xml::get_text(ptr);
657 int timeout = atoi(timeout_str.c_str());
659 throw yf::FilterException("Bad value for timeout: "
661 m_p->m_session_timeout = timeout;
663 else if (!strcmp((const char *) ptr->name, "connect-max"))
665 m_p->m_connect_max = mp::xml::get_int(ptr, 0);
667 else if (!strcmp((const char *) ptr->name, "message"))
669 m_p->m_msg_config = mp::xml::get_text(ptr);
671 else if (!strcmp((const char *) ptr->name, "stat-req"))
673 m_p->m_stat_req = mp::xml::get_text(ptr);
677 throw yf::FilterException("Bad element "
678 + std::string((const char *)
687 void yf::FrontendNet::set_ports(std::vector<std::string> &ports)
689 std::vector<Port> nports;
692 for (i = 0; i < ports.size(); i++)
696 nport.port = ports[i];
698 nports.push_back(nport);
704 void yf::FrontendNet::set_ports(std::vector<Port> &ports)
706 m_p->m_ports = ports;
708 m_p->az = new yf::FrontendNet::ZAssocServer *[m_p->m_ports.size()];
710 // Create yf::FrontendNet::ZAssocServer for each port
712 for (i = 0; i<m_p->m_ports.size(); i++)
714 // create a PDU assoc object (one per yf::FrontendNet::ZAssocServer)
715 yazpp_1::PDU_Assoc *as = new yazpp_1::PDU_Assoc(&m_p->mySocketManager);
717 // create ZAssoc with PDU Assoc
718 m_p->az[i] = new yf::FrontendNet::ZAssocServer(
719 as, m_p->m_ports[i].route, m_p.get());
720 if (m_p->az[i]->server(m_p->m_ports[i].port.c_str()))
722 throw yf::FilterException("Unable to bind to address "
723 + std::string(m_p->m_ports[i].port));
725 COMSTACK cs = as->get_comstack();
727 if (cs && m_p->m_ports[i].max_recv_bytes)
728 cs_set_max_recv_bytes(cs, m_p->m_ports[i].max_recv_bytes);
733 void yf::FrontendNet::set_listen_duration(int d)
735 m_p->m_listen_duration = d;
738 static yf::Base* filter_creator()
740 return new yf::FrontendNet;
744 struct metaproxy_1_filter_struct metaproxy_1_filter_frontend_net = {
754 * c-file-style: "Stroustrup"
755 * indent-tabs-mode: nil
757 * vim: shiftwidth=4 tabstop=8 expandtab