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
21 #include <metaproxy/filter.hpp>
22 #include <metaproxy/package.hpp>
24 #include <boost/thread/mutex.hpp>
25 #include <boost/thread/condition.hpp>
26 #include <boost/thread/thread.hpp>
27 #include <boost/thread/xtime.hpp>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/format.hpp>
31 #include <metaproxy/util.hpp>
32 #include "filter_session_shared.hpp"
34 #include <yaz/copy_types.h>
37 #include <yaz/otherinfo.h>
38 #include <yaz/diagbib1.h>
39 #include <yazpp/z-query.h>
40 #include <yazpp/record-cache.h>
45 namespace mp = metaproxy_1;
46 namespace yf = metaproxy_1::filter;
48 namespace metaproxy_1 {
51 // key for session.. We'll only share sessions with same InitKey
52 class SessionShared::InitKey {
54 bool operator < (const SessionShared::InitKey &k) const;
55 InitKey(Z_InitRequest *req);
56 InitKey(const InitKey &);
59 char *m_idAuthentication_buf;
60 int m_idAuthentication_size;
61 char *m_otherInfo_buf;
65 // worker thread .. for expiry of sessions
66 class SessionShared::Worker {
68 Worker(SessionShared::Rep *rep);
69 void operator() (void);
71 SessionShared::Rep *m_p;
74 class SessionShared::BackendSet {
76 std::string m_result_set_id;
77 Databases m_databases;
78 Odr_int m_result_set_size;
79 yazpp_1::Yaz_Z_Query m_query;
80 time_t m_time_last_use;
82 yazpp_1::RecordCache m_record_cache;
84 const std::string &result_set_id,
85 const Databases &databases,
86 const yazpp_1::Yaz_Z_Query &query);
88 Package &frontend_package,
89 Package &search_package,
90 const Z_APDU *apdu_req,
91 const BackendInstancePtr bp,
92 Z_Records **z_records,
93 Z_OtherInformation *additionalSearchInfo);
95 // backend connection instance
96 class SessionShared::BackendInstance {
98 friend class BackendClass;
99 friend class BackendSet;
101 mp::Session m_session;
102 BackendSetList m_sets;
105 int m_result_set_sequence;
106 time_t m_time_last_use;
107 mp::Package * m_close_package;
111 // backends of some class (all with same InitKey)
112 class SessionShared::BackendClass : boost::noncopyable {
114 friend struct Frontend;
115 bool m_named_result_sets;
116 BackendInstanceList m_backend_list;
117 BackendInstancePtr create_backend(const Package &package);
118 void remove_backend(BackendInstancePtr b);
119 BackendInstancePtr get_backend(const Package &package);
120 void use_backend(BackendInstancePtr b);
121 void release_backend(BackendInstancePtr b);
122 bool expire_instances();
123 yazpp_1::GDU m_init_request;
124 yazpp_1::GDU m_init_response;
125 boost::mutex m_mutex_backend_class;
127 time_t m_backend_set_ttl;
128 time_t m_backend_expiry_ttl;
129 size_t m_backend_set_max;
130 Odr_int m_preferredMessageSize;
131 Odr_int m_maximumRecordSize;
133 BackendClass(const yazpp_1::GDU &init_request,
137 Odr_int preferredRecordSize,
138 Odr_int maximumRecordSize);
141 // frontend result set
142 class SessionShared::FrontendSet {
143 Databases m_databases;
144 yazpp_1::Yaz_Z_Query m_query;
146 const Databases &get_databases();
147 const yazpp_1::Yaz_Z_Query &get_query();
149 const Databases &databases,
150 const yazpp_1::Yaz_Z_Query &query);
154 struct SessionShared::Frontend {
159 Z_Options m_init_options;
160 void search(Package &package, Z_APDU *apdu);
161 void present(Package &package, Z_APDU *apdu);
162 void scan(Package &package, Z_APDU *apdu);
164 int result_set_ref(ODR o,
165 const Databases &databases,
166 Z_RPNStructure *s, std::string &rset);
167 void get_set(mp::Package &package,
168 const Z_APDU *apdu_req,
169 const Databases &databases,
170 yazpp_1::Yaz_Z_Query &query,
171 BackendInstancePtr &found_backend,
172 BackendSetPtr &found_set);
173 void override_set(BackendInstancePtr &found_backend,
174 std::string &result_set_id,
175 const Databases &databases,
176 bool out_of_sessions);
179 BackendClassPtr m_backend_class;
180 FrontendSets m_frontend_sets;
183 class SessionShared::Rep {
184 friend class SessionShared;
185 friend struct Frontend;
187 FrontendPtr get_frontend(Package &package);
188 void release_frontend(Package &package);
193 void expire_classes();
195 void init(Package &package, const Z_GDU *gdu,
196 FrontendPtr frontend);
198 boost::mutex m_mutex;
199 boost::condition m_cond_session_ready;
200 std::map<mp::Session, FrontendPtr> m_clients;
202 BackendClassMap m_backend_map;
203 boost::mutex m_mutex_backend_map;
204 boost::thread_group m_thrds;
208 bool m_optimize_search;
211 Odr_int m_preferredMessageSize;
212 Odr_int m_maximumRecordSize;
217 yf::SessionShared::FrontendSet::FrontendSet(
218 const Databases &databases,
219 const yazpp_1::Yaz_Z_Query &query)
220 : m_databases(databases), m_query(query)
224 const yf::SessionShared::Databases &
225 yf::SessionShared::FrontendSet::get_databases()
230 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
235 yf::SessionShared::InitKey::InitKey(const InitKey &k)
237 m_odr = odr_createmem(ODR_ENCODE);
239 m_idAuthentication_size = k.m_idAuthentication_size;
240 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
241 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
242 m_idAuthentication_size);
244 m_otherInfo_size = k.m_otherInfo_size;
245 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
246 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
250 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
252 m_odr = odr_createmem(ODR_ENCODE);
254 Z_IdAuthentication *t = req->idAuthentication;
255 z_IdAuthentication(m_odr, &t, 1, 0);
256 m_idAuthentication_buf =
257 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
259 Z_OtherInformation *o = req->otherInfo;
260 z_OtherInformation(m_odr, &o, 1, 0);
261 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
264 yf::SessionShared::InitKey::~InitKey()
269 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
273 c = mp::util::memcmp2(
274 (void*) m_idAuthentication_buf, m_idAuthentication_size,
275 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
281 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
282 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
290 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
292 boost::mutex::scoped_lock lock(m_mutex_backend_class);
297 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
299 BackendInstanceList::iterator it = m_backend_list.begin();
301 while (it != m_backend_list.end())
306 (*it)->m_close_package->response() = odr.create_close(
307 0, Z_Close_lackOfActivity, 0);
308 (*it)->m_close_package->session().close();
309 (*it)->m_close_package->move();
311 it = m_backend_list.erase(it);
320 yf::SessionShared::BackendInstancePtr
321 yf::SessionShared::BackendClass::get_backend(
322 const mp::Package &frontend_package)
325 boost::mutex::scoped_lock lock(m_mutex_backend_class);
327 BackendInstanceList::const_iterator it = m_backend_list.begin();
329 BackendInstancePtr backend1; // null
331 for (; it != m_backend_list.end(); it++)
333 if (!(*it)->m_in_use)
336 || (*it)->m_sequence_this < backend1->m_sequence_this)
342 use_backend(backend1);
346 return create_backend(frontend_package);
349 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
351 backend->m_in_use = true;
352 backend->m_sequence_this = m_sequence_top++;
355 void yf::SessionShared::BackendInstance::timestamp()
358 time(&m_time_last_use);
361 yf::SessionShared::BackendInstance::~BackendInstance()
363 delete m_close_package;
366 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
367 const mp::Package &frontend_package)
369 BackendInstancePtr bp(new BackendInstance);
370 BackendInstancePtr null;
372 bp->m_close_package =
373 new mp::Package(bp->m_session, frontend_package.origin());
374 bp->m_close_package->copy_filter(frontend_package);
376 Package init_package(bp->m_session, frontend_package.origin());
378 init_package.copy_filter(frontend_package);
380 yazpp_1::GDU actual_init_request = m_init_request;
381 Z_GDU *init_pdu = actual_init_request.get();
383 assert(init_pdu->which == Z_GDU_Z3950);
384 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
386 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
387 ODR_MASK_ZERO(req->options);
389 ODR_MASK_SET(req->options, Z_Options_search);
390 ODR_MASK_SET(req->options, Z_Options_present);
391 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
392 ODR_MASK_SET(req->options, Z_Options_scan);
394 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
395 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
396 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
398 if (m_preferredMessageSize)
399 *req->preferredMessageSize = m_preferredMessageSize;
400 if (m_maximumRecordSize)
401 *req->maximumRecordSize = m_maximumRecordSize;
403 init_package.request() = init_pdu;
407 boost::mutex::scoped_lock lock(m_mutex_backend_class);
409 m_named_result_sets = false;
410 Z_GDU *gdu = init_package.response().get();
412 if (gdu && gdu->which == Z_GDU_Z3950
413 && gdu->u.z3950->which == Z_APDU_initResponse)
415 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
416 m_init_response = gdu->u.z3950;
417 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
419 m_named_result_sets = true;
421 if (*gdu->u.z3950->u.initResponse->result
422 && !init_package.session().is_closed())
425 time(&bp->m_time_last_use);
426 bp->m_sequence_this = 0;
427 bp->m_result_set_sequence = 0;
428 m_backend_list.push_back(bp);
434 yazpp_1::GDU empty_gdu;
435 m_init_response = empty_gdu;
438 if (!init_package.session().is_closed())
440 init_package.copy_filter(frontend_package);
441 init_package.session().close();
448 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
452 Odr_int preferredMessageSize,
453 Odr_int maximumRecordSize)
454 : m_named_result_sets(false), m_init_request(init_request),
455 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
456 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max),
457 m_preferredMessageSize(preferredMessageSize),
458 m_maximumRecordSize(maximumRecordSize)
461 yf::SessionShared::BackendClass::~BackendClass()
464 void yf::SessionShared::Rep::stat()
467 int no_instances = 0;
468 BackendClassMap::const_iterator it;
470 boost::mutex::scoped_lock lock(m_mutex_backend_map);
471 for (it = m_backend_map.begin(); it != m_backend_map.end(); it++)
473 BackendClassPtr bc = it->second;
475 BackendInstanceList::iterator bit = bc->m_backend_list.begin();
476 for (; bit != bc->m_backend_list.end(); bit++)
480 yaz_log(YLOG_LOG, "backend classes=%d instances=%d", no_classes,
484 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
485 FrontendPtr frontend)
487 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
489 frontend->m_is_virtual = true;
490 frontend->m_init_options = *req->options;
493 boost::mutex::scoped_lock lock(m_mutex_backend_map);
494 BackendClassMap::const_iterator it;
495 it = m_backend_map.find(k);
496 if (it == m_backend_map.end())
498 BackendClassPtr b(new BackendClass(gdu->u.z3950,
502 m_preferredMessageSize,
503 m_maximumRecordSize));
504 m_backend_map[k] = b;
505 frontend->m_backend_class = b;
509 frontend->m_backend_class = it->second;
512 BackendClassPtr bc = frontend->m_backend_class;
515 // we only need to get init response from "first" target in
516 // backend class - the assumption being that init response is
518 if (bc->m_backend_list.size() == 0)
520 BackendInstancePtr backend = bc->create_backend(package);
522 bc->release_backend(backend);
525 yazpp_1::GDU init_response;
527 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
529 init_response = bc->m_init_response;
532 if (init_response.get())
534 Z_GDU *response_gdu = init_response.get();
535 mp::util::transfer_referenceId(odr, gdu->u.z3950,
536 response_gdu->u.z3950);
537 Z_InitResponse *init_res = response_gdu->u.z3950->u.initResponse;
538 Z_Options *server_options = init_res->options;
539 Z_Options *client_options = &frontend->m_init_options;
541 for (i = 0; i < 30; i++)
542 if (!ODR_MASK_GET(client_options, i))
543 ODR_MASK_CLEAR(server_options, i);
545 if (!m_preferredMessageSize ||
546 *init_res->preferredMessageSize > *req->preferredMessageSize)
547 *init_res->preferredMessageSize = *req->preferredMessageSize;
549 if (!m_maximumRecordSize ||
550 *init_res->maximumRecordSize > *req->maximumRecordSize)
551 *init_res->maximumRecordSize = *req->maximumRecordSize;
553 package.response() = init_response;
554 if (!*response_gdu->u.z3950->u.initResponse->result)
555 package.session().close();
560 odr.create_initResponse(
561 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
562 "session_shared: target closed connection during init");
563 *apdu->u.initResponse->result = 0;
564 package.response() = apdu;
565 package.session().close();
569 void yf::SessionShared::BackendSet::timestamp()
571 time(&m_time_last_use);
574 yf::SessionShared::BackendSet::BackendSet(
575 const std::string &result_set_id,
576 const Databases &databases,
577 const yazpp_1::Yaz_Z_Query &query) :
578 m_result_set_id(result_set_id),
579 m_databases(databases), m_result_set_size(0), m_query(query)
584 static int get_diagnostic(Z_DefaultDiagFormat *r)
586 return *r->condition;
589 bool yf::SessionShared::BackendSet::search(
590 mp::Package &frontend_package,
591 mp::Package &search_package,
592 const Z_APDU *frontend_apdu,
593 const BackendInstancePtr bp,
594 Z_Records **z_records,
595 Z_OtherInformation *additionalSearchInfo)
598 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
599 Z_SearchRequest *req = apdu_req->u.searchRequest;
601 req->additionalSearchInfo = additionalSearchInfo;
602 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
603 req->query = m_query.get_Z_Query();
605 req->num_databaseNames = m_databases.size();
606 req->databaseNames = (char**)
607 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
608 Databases::const_iterator it = m_databases.begin();
610 for (; it != m_databases.end(); it++)
611 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
613 if (frontend_apdu->which == Z_APDU_searchRequest)
614 req->preferredRecordSyntax =
615 frontend_apdu->u.searchRequest->preferredRecordSyntax;
617 search_package.request() = apdu_req;
619 search_package.move();
621 Z_GDU *gdu = search_package.response().get();
622 if (!search_package.session().is_closed()
623 && gdu && gdu->which == Z_GDU_Z3950
624 && gdu->u.z3950->which == Z_APDU_searchResponse)
626 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
627 *z_records = b_resp->records;
628 m_result_set_size = *b_resp->resultCount;
629 // b_resp->additionalSearchInfo;
633 const char *addinfo = "session_shared: "
634 "target closed connection during search";
635 if (frontend_apdu->which == Z_APDU_searchRequest)
636 f_apdu = odr.create_searchResponse(
637 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
638 else if (frontend_apdu->which == Z_APDU_presentRequest)
639 f_apdu = odr.create_presentResponse(
640 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
642 f_apdu = odr.create_close(
643 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
644 frontend_package.response() = f_apdu;
648 void yf::SessionShared::Frontend::override_set(
649 BackendInstancePtr &found_backend,
650 std::string &result_set_id,
651 const Databases &databases,
652 bool out_of_sessions)
654 BackendClassPtr bc = m_backend_class;
655 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
659 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
660 for (; it != bc->m_backend_list.end(); it++)
662 if (!(*it)->m_in_use)
664 BackendSetList::iterator set_it = (*it)->m_sets.begin();
665 for (; set_it != (*it)->m_sets.end(); set_it++)
667 if ((max_sets > 1 || (*set_it)->m_databases == databases)
670 now < (*set_it)->m_time_last_use ||
671 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
674 result_set_id = (*set_it)->m_result_set_id;
675 found_backend->m_sets.erase(set_it);
681 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
683 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
686 if (bc->m_named_result_sets)
688 result_set_id = boost::io::str(
689 boost::format("%1%") %
690 found_backend->m_result_set_sequence);
691 found_backend->m_result_set_sequence++;
694 result_set_id = "default";
700 void yf::SessionShared::Frontend::get_set(mp::Package &package,
701 const Z_APDU *apdu_req,
702 const Databases &databases,
703 yazpp_1::Yaz_Z_Query &query,
704 BackendInstancePtr &found_backend,
705 BackendSetPtr &found_set)
707 bool session_restarted = false;
708 Z_OtherInformation *additionalSearchInfo = 0;
710 if (apdu_req->which == Z_APDU_searchRequest)
711 additionalSearchInfo = apdu_req->u.searchRequest->additionalSearchInfo;
714 std::string result_set_id;
715 bool out_of_sessions = false;
716 BackendClassPtr bc = m_backend_class;
718 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
720 if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
721 out_of_sessions = true;
723 if (m_p->m_optimize_search && !additionalSearchInfo)
725 // look at each backend and see if we have a similar search
726 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
727 for (; it != bc->m_backend_list.end(); it++)
729 if (!(*it)->m_in_use)
731 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
732 for (; set_it != (*it)->m_sets.end(); set_it++)
734 if ((*set_it)->m_databases == databases
735 && query.match(&(*set_it)->m_query))
739 bc->use_backend(found_backend);
740 // found matching set. No need to search again
747 override_set(found_backend, result_set_id, databases, out_of_sessions);
749 bc->use_backend(found_backend);
753 // create a new backend set (and new set) if we're not out of sessions
754 if (!out_of_sessions)
755 found_backend = bc->create_backend(package);
761 const char *addinfo = 0;
764 addinfo = "session_shared: all sessions in use";
766 addinfo = "session_shared: could not create backend";
767 if (apdu_req->which == Z_APDU_searchRequest)
769 f_apdu = odr.create_searchResponse(
770 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
772 else if (apdu_req->which == Z_APDU_presentRequest)
774 f_apdu = odr.create_presentResponse(
775 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
779 f_apdu = odr.create_close(
780 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
782 package.response() = f_apdu;
785 if (bc->m_named_result_sets)
787 result_set_id = boost::io::str(
788 boost::format("%1%") % found_backend->m_result_set_sequence);
789 found_backend->m_result_set_sequence++;
792 result_set_id = "default";
794 found_backend->timestamp();
796 // we must search ...
797 BackendSetPtr new_set(new BackendSet(result_set_id,
799 Z_Records *z_records = 0;
801 Package search_package(found_backend->m_session, package.origin());
802 search_package.copy_filter(package);
804 if (!new_set->search(package, search_package,
805 apdu_req, found_backend, &z_records,
806 additionalSearchInfo))
808 bc->remove_backend(found_backend);
809 return; // search error
815 if (z_records->which == Z_Records_NSD)
818 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
820 else if (z_records->which == Z_Records_multipleNSD)
822 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
825 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
826 Z_DiagRec_defaultFormat)
828 condition = get_diagnostic(
829 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
833 if (m_p->m_restart && !session_restarted &&
834 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
836 package.log("session_shared", YLOG_LOG, "restart");
837 bc->remove_backend(found_backend);
838 session_restarted = true;
839 found_backend.reset();
847 if (apdu_req->which == Z_APDU_searchRequest)
849 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
851 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
852 *f_resp->searchStatus = Z_SearchResponse_none;
853 f_resp->records = z_records;
854 package.response() = f_apdu;
856 if (apdu_req->which == Z_APDU_presentRequest)
858 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
860 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
861 f_resp->records = z_records;
862 package.response() = f_apdu;
864 bc->release_backend(found_backend);
865 return; // search error
868 if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
870 package.log("session_shared", YLOG_LOG, "restart");
871 bc->remove_backend(found_backend);
872 session_restarted = true;
873 found_backend.reset();
878 found_set->timestamp();
879 found_backend->m_sets.push_back(found_set);
882 int yf::SessionShared::Frontend::result_set_ref(ODR o,
883 const Databases &databases,
890 case Z_RPNStructure_simple:
891 if (s->u.simple->which == Z_Operand_resultSetId)
893 const char *id = s->u.simple->u.resultSetId;
896 FrontendSets::iterator fset_it = m_frontend_sets.find(id);
897 if (fset_it == m_frontend_sets.end())
899 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
901 else if (fset_it->second->get_databases() != databases)
903 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
907 yazpp_1::Yaz_Z_Query query = fset_it->second->get_query();
908 Z_Query *q = yaz_copy_Z_Query(query.get_Z_Query(), o);
909 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
911 s->which = q->u.type_1->RPNStructure->which;
912 s->u.simple = q->u.type_1->RPNStructure->u.simple;
916 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
921 case Z_RPNStructure_complex:
922 ret = result_set_ref(o, databases, s->u.complex->s1, rset);
924 ret = result_set_ref(o, databases, s->u.complex->s2, rset);
930 void yf::SessionShared::Frontend::search(mp::Package &package,
933 Z_SearchRequest *req = apdu_req->u.searchRequest;
934 FrontendSets::iterator fset_it =
935 m_frontend_sets.find(req->resultSetName);
936 if (fset_it != m_frontend_sets.end())
938 // result set already exist
939 // if replace indicator is off: we return diagnostic if
940 // result set already exist.
941 if (*req->replaceIndicator == 0)
945 odr.create_searchResponse(
947 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
949 package.response() = apdu;
952 m_frontend_sets.erase(fset_it);
957 for (i = 0; i < req->num_databaseNames; i++)
958 databases.push_back(req->databaseNames[i]);
961 yazpp_1::Yaz_Z_Query query;
962 query.set_Z_Query(req->query);
964 Z_Query *q = query.get_Z_Query();
965 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
969 int diag = result_set_ref(odr, databases, q->u.type_1->RPNStructure,
974 odr.create_searchResponse(
978 package.response() = apdu;
981 query.set_Z_Query(q);
984 BackendSetPtr found_set; // null
985 BackendInstancePtr found_backend; // null
987 get_set(package, apdu_req, databases, query, found_backend, found_set);
992 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
993 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
994 *f_resp->resultCount = found_set->m_result_set_size;
995 package.response() = f_apdu;
997 FrontendSetPtr fset(new FrontendSet(databases, query));
998 m_frontend_sets[req->resultSetName] = fset;
1000 m_backend_class->release_backend(found_backend);
1003 void yf::SessionShared::Frontend::present(mp::Package &package,
1007 Z_PresentRequest *req = apdu_req->u.presentRequest;
1009 FrontendSets::iterator fset_it =
1010 m_frontend_sets.find(req->resultSetId);
1012 if (fset_it == m_frontend_sets.end())
1015 odr.create_presentResponse(
1017 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1019 package.response() = apdu;
1022 FrontendSetPtr fset = fset_it->second;
1024 Databases databases = fset->get_databases();
1025 yazpp_1::Yaz_Z_Query query = fset->get_query();
1027 BackendClassPtr bc = m_backend_class;
1028 BackendSetPtr found_set; // null
1029 BackendInstancePtr found_backend;
1031 get_set(package, apdu_req, databases, query, found_backend, found_set);
1035 Z_NamePlusRecordList *npr_res = 0;
1036 if (found_set->m_record_cache.lookup(odr, &npr_res,
1037 *req->resultSetStartPoint,
1038 *req->numberOfRecordsRequested,
1039 req->preferredRecordSyntax,
1040 req->recordComposition))
1042 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1043 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1045 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1046 " records in cache %p",
1047 *req->resultSetStartPoint,
1048 *req->numberOfRecordsRequested,
1049 &found_set->m_record_cache);
1051 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
1052 *f_resp->nextResultSetPosition =
1053 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
1054 // f_resp->presentStatus assumed OK.
1055 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
1056 f_resp->records->which = Z_Records_DBOSD;
1057 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
1058 package.response() = f_apdu_res;
1059 bc->release_backend(found_backend);
1063 found_backend->timestamp();
1065 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
1066 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
1067 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1068 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
1069 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
1070 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
1071 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1072 p_req->recordComposition = req->recordComposition;
1074 Package present_package(found_backend->m_session, package.origin());
1075 present_package.copy_filter(package);
1077 present_package.request() = p_apdu;
1079 present_package.move();
1081 Z_GDU *gdu = present_package.response().get();
1082 if (!present_package.session().is_closed()
1083 && gdu && gdu->which == Z_GDU_Z3950
1084 && gdu->u.z3950->which == Z_APDU_presentResponse)
1086 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
1087 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1088 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1090 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
1091 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
1092 f_resp->presentStatus= b_resp->presentStatus;
1093 f_resp->records = b_resp->records;
1094 f_resp->otherInfo = b_resp->otherInfo;
1095 package.response() = f_apdu_res;
1097 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
1100 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1101 " records to cache %p",
1102 *req->resultSetStartPoint,
1103 *f_resp->numberOfRecordsReturned,
1104 &found_set->m_record_cache);
1106 found_set->m_record_cache.add(
1108 b_resp->records->u.databaseOrSurDiagnostics,
1109 *req->resultSetStartPoint,
1110 *f_resp->numberOfRecordsReturned);
1112 bc->release_backend(found_backend);
1116 bc->remove_backend(found_backend);
1117 Z_APDU *f_apdu_res =
1118 odr.create_presentResponse(
1119 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1120 "session_shared: target closed connection during present");
1121 package.response() = f_apdu_res;
1125 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
1128 BackendClassPtr bc = m_backend_class;
1129 BackendInstancePtr backend = bc->get_backend(frontend_package);
1133 Z_APDU *apdu = odr.create_scanResponse(
1134 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1135 "session_shared: could not create backend");
1136 frontend_package.response() = apdu;
1140 Package scan_package(backend->m_session, frontend_package.origin());
1141 backend->timestamp();
1142 scan_package.copy_filter(frontend_package);
1143 scan_package.request() = apdu_req;
1144 scan_package.move();
1145 frontend_package.response() = scan_package.response();
1146 if (scan_package.session().is_closed())
1148 frontend_package.session().close();
1149 bc->remove_backend(backend);
1152 bc->release_backend(backend);
1156 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1160 void yf::SessionShared::Worker::operator() (void)
1165 bool yf::SessionShared::BackendClass::expire_instances()
1169 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1170 BackendInstanceList::iterator bit = m_backend_list.begin();
1171 while (bit != m_backend_list.end())
1173 time_t last_use = (*bit)->m_time_last_use;
1175 if ((*bit)->m_in_use)
1179 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1182 (*bit)->m_close_package->response() = odr.create_close(
1183 0, Z_Close_lackOfActivity, 0);
1184 (*bit)->m_close_package->session().close();
1185 (*bit)->m_close_package->move();
1187 bit = m_backend_list.erase(bit);
1194 if (m_backend_list.empty())
1199 void yf::SessionShared::Rep::expire_classes()
1201 boost::mutex::scoped_lock lock(m_mutex_backend_map);
1202 BackendClassMap::iterator b_it = m_backend_map.begin();
1203 while (b_it != m_backend_map.end())
1205 if (b_it->second->expire_instances())
1207 m_backend_map.erase(b_it);
1208 b_it = m_backend_map.begin();
1215 void yf::SessionShared::Rep::expire()
1220 boost::xtime_get(&xt,
1221 #if BOOST_VERSION >= 105000
1227 xt.sec += m_session_ttl / 3;
1228 boost::thread::sleep(xt);
1235 yf::SessionShared::Rep::Rep()
1237 m_resultset_ttl = 30;
1238 m_resultset_max = 10;
1240 m_optimize_search = true;
1242 m_session_max = 100;
1243 m_preferredMessageSize = 0;
1244 m_maximumRecordSize = 0;
1247 void yf::SessionShared::Rep::start()
1249 yf::SessionShared::Worker w(this);
1250 m_thrds.add_thread(new boost::thread(w));
1253 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1257 yf::SessionShared::~SessionShared() {
1260 void yf::SessionShared::start() const
1265 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1269 yf::SessionShared::Frontend::~Frontend()
1273 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1275 boost::mutex::scoped_lock lock(m_mutex);
1277 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1281 it = m_clients.find(package.session());
1282 if (it == m_clients.end())
1285 if (!it->second->m_in_use)
1287 it->second->m_in_use = true;
1290 m_cond_session_ready.wait(lock);
1292 FrontendPtr f(new Frontend(this));
1293 m_clients[package.session()] = f;
1298 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1300 boost::mutex::scoped_lock lock(m_mutex);
1301 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1303 it = m_clients.find(package.session());
1304 if (it != m_clients.end())
1306 if (package.session().is_closed())
1308 m_clients.erase(it);
1312 it->second->m_in_use = false;
1314 m_cond_session_ready.notify_all();
1319 void yf::SessionShared::process(mp::Package &package) const
1321 FrontendPtr f = m_p->get_frontend(package);
1323 Z_GDU *gdu = package.request().get();
1325 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1326 Z_APDU_initRequest && !f->m_is_virtual)
1328 m_p->init(package, gdu, f);
1330 else if (!f->m_is_virtual)
1332 else if (gdu && gdu->which == Z_GDU_Z3950)
1334 Z_APDU *apdu = gdu->u.z3950;
1335 if (apdu->which == Z_APDU_initRequest)
1339 package.response() = odr.create_close(
1341 Z_Close_protocolError,
1344 package.session().close();
1346 else if (apdu->which == Z_APDU_close)
1350 package.response() = odr.create_close(
1352 Z_Close_peerAbort, "received close from client");
1353 package.session().close();
1355 else if (apdu->which == Z_APDU_searchRequest)
1357 f->search(package, apdu);
1359 else if (apdu->which == Z_APDU_presentRequest)
1361 f->present(package, apdu);
1363 else if (apdu->which == Z_APDU_scanRequest)
1365 f->scan(package, apdu);
1371 package.response() = odr.create_close(
1372 apdu, Z_Close_protocolError,
1373 "unsupported APDU in filter_session_shared");
1375 package.session().close();
1378 m_p->release_frontend(package);
1381 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1384 for (ptr = ptr->children; ptr; ptr = ptr->next)
1386 if (ptr->type != XML_ELEMENT_NODE)
1388 if (!strcmp((const char *) ptr->name, "resultset"))
1390 const struct _xmlAttr *attr;
1391 for (attr = ptr->properties; attr; attr = attr->next)
1393 if (!strcmp((const char *) attr->name, "ttl"))
1394 m_p->m_resultset_ttl =
1395 mp::xml::get_int(attr->children, 30);
1396 else if (!strcmp((const char *) attr->name, "max"))
1398 m_p->m_resultset_max =
1399 mp::xml::get_int(attr->children, 10);
1401 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1403 m_p->m_optimize_search =
1404 mp::xml::get_bool(attr->children, true);
1406 else if (!strcmp((const char *) attr->name, "restart"))
1408 m_p->m_restart = mp::xml::get_bool(attr->children, true);
1411 throw mp::filter::FilterException(
1412 "Bad attribute " + std::string((const char *)
1416 else if (!strcmp((const char *) ptr->name, "session"))
1418 const struct _xmlAttr *attr;
1419 for (attr = ptr->properties; attr; attr = attr->next)
1421 if (!strcmp((const char *) attr->name, "ttl"))
1422 m_p->m_session_ttl =
1423 mp::xml::get_int(attr->children, 90);
1424 else if (!strcmp((const char *) attr->name, "max"))
1425 m_p->m_session_max =
1426 mp::xml::get_int(attr->children, 100);
1428 throw mp::filter::FilterException(
1429 "Bad attribute " + std::string((const char *)
1433 else if (!strcmp((const char *) ptr->name, "init"))
1435 const struct _xmlAttr *attr;
1436 for (attr = ptr->properties; attr; attr = attr->next)
1438 if (!strcmp((const char *) attr->name, "maximum-record-size"))
1439 m_p->m_maximumRecordSize =
1440 mp::xml::get_int(attr->children, 0);
1441 else if (!strcmp((const char *) attr->name,
1442 "preferred-message-size"))
1443 m_p->m_preferredMessageSize =
1444 mp::xml::get_int(attr->children, 0);
1446 throw mp::filter::FilterException(
1447 "Bad attribute " + std::string((const char *)
1453 throw mp::filter::FilterException("Bad element "
1454 + std::string((const char *)
1460 static mp::filter::Base* filter_creator()
1462 return new mp::filter::SessionShared;
1466 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1476 * c-file-style: "Stroustrup"
1477 * indent-tabs-mode: nil
1479 * vim: shiftwidth=4 tabstop=8 expandtab