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
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>
46 namespace mp = metaproxy_1;
47 namespace yf = metaproxy_1::filter;
49 namespace metaproxy_1 {
52 // key for session.. We'll only share sessions with same InitKey
53 class SessionShared::InitKey {
55 bool operator < (const SessionShared::InitKey &k) const;
56 InitKey(Z_InitRequest *req);
57 InitKey(const InitKey &);
60 char *m_idAuthentication_buf;
61 int m_idAuthentication_size;
62 char *m_otherInfo_buf;
66 // worker thread .. for expiry of sessions
67 class SessionShared::Worker {
69 Worker(SessionShared::Rep *rep);
70 void operator() (void);
72 SessionShared::Rep *m_p;
75 class SessionShared::BackendSet {
77 std::string m_result_set_id;
78 Databases m_databases;
79 Odr_int m_result_set_size;
80 yazpp_1::Yaz_Z_Query m_query;
81 time_t m_time_last_use;
83 yazpp_1::RecordCache m_record_cache;
85 Z_OtherInformation *additionalSearchInfoRequest;
86 Z_OtherInformation *additionalSearchInfoResponse;
87 NMEM mem_additionalSearchInfo;
89 const std::string &result_set_id,
90 const Databases &databases,
91 const yazpp_1::Yaz_Z_Query &query,
92 Z_OtherInformation *additionalSearchInfoRequest);
95 Package &frontend_package,
96 Package &search_package,
97 const Z_APDU *apdu_req,
98 const BackendInstancePtr bp,
99 Z_Records **z_records);
101 // backend connection instance
102 class SessionShared::BackendInstance {
104 friend class BackendClass;
105 friend class BackendSet;
107 mp::Session m_session;
108 BackendSetList m_sets;
111 int m_result_set_sequence;
112 time_t m_time_last_use;
113 mp::Package * m_close_package;
117 // backends of some class (all with same InitKey)
118 class SessionShared::BackendClass : boost::noncopyable {
120 friend struct Frontend;
121 bool m_named_result_sets;
122 BackendInstanceList m_backend_list;
123 BackendInstancePtr create_backend(const Package &package);
124 void remove_backend(BackendInstancePtr b);
125 BackendInstancePtr get_backend(const Package &package);
126 void use_backend(BackendInstancePtr b);
127 void release_backend(BackendInstancePtr b);
128 bool expire_instances();
129 yazpp_1::GDU m_init_request;
130 yazpp_1::GDU m_init_response;
131 boost::mutex m_mutex_backend_class;
133 time_t m_backend_set_ttl;
134 time_t m_backend_expiry_ttl;
135 size_t m_backend_set_max;
136 Odr_int m_preferredMessageSize;
137 Odr_int m_maximumRecordSize;
139 BackendClass(const yazpp_1::GDU &init_request,
143 Odr_int preferredRecordSize,
144 Odr_int maximumRecordSize);
147 // frontend result set
148 class SessionShared::FrontendSet {
149 Databases m_databases;
150 yazpp_1::Yaz_Z_Query m_query;
152 const Databases &get_databases();
153 const yazpp_1::Yaz_Z_Query &get_query();
155 const Databases &databases,
156 const yazpp_1::Yaz_Z_Query &query);
160 struct SessionShared::Frontend {
165 Z_Options m_init_options;
166 void search(Package &package, Z_APDU *apdu);
167 void present(Package &package, Z_APDU *apdu);
168 void scan(Package &package, Z_APDU *apdu);
170 int result_set_ref(ODR o,
171 const Databases &databases,
172 Z_RPNStructure *s, std::string &rset);
173 void get_set(mp::Package &package,
174 const Z_APDU *apdu_req,
175 const Databases &databases,
176 yazpp_1::Yaz_Z_Query &query,
177 BackendInstancePtr &found_backend,
178 BackendSetPtr &found_set);
179 void override_set(BackendInstancePtr &found_backend,
180 std::string &result_set_id,
181 const Databases &databases,
182 bool out_of_sessions);
185 BackendClassPtr m_backend_class;
186 FrontendSets m_frontend_sets;
189 class SessionShared::Rep {
190 friend class SessionShared;
191 friend struct Frontend;
193 FrontendPtr get_frontend(Package &package);
194 void release_frontend(Package &package);
200 void expire_classes();
202 void init(Package &package, const Z_GDU *gdu,
203 FrontendPtr frontend);
205 boost::mutex m_mutex;
206 boost::condition m_cond_session_ready;
207 boost::condition m_cond_expire_ready;
208 std::map<mp::Session, FrontendPtr> m_clients;
210 BackendClassMap m_backend_map;
211 boost::mutex m_mutex_backend_map;
212 boost::thread_group m_thrds;
216 bool m_optimize_search;
219 Odr_int m_preferredMessageSize;
220 Odr_int m_maximumRecordSize;
226 yf::SessionShared::FrontendSet::FrontendSet(
227 const Databases &databases,
228 const yazpp_1::Yaz_Z_Query &query)
229 : m_databases(databases), m_query(query)
233 const yf::SessionShared::Databases &
234 yf::SessionShared::FrontendSet::get_databases()
239 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
244 yf::SessionShared::InitKey::InitKey(const InitKey &k)
246 m_odr = odr_createmem(ODR_ENCODE);
248 m_idAuthentication_size = k.m_idAuthentication_size;
249 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
250 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
251 m_idAuthentication_size);
253 m_otherInfo_size = k.m_otherInfo_size;
254 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
255 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
259 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
261 m_odr = odr_createmem(ODR_ENCODE);
263 Z_IdAuthentication *t = req->idAuthentication;
264 z_IdAuthentication(m_odr, &t, 1, 0);
265 m_idAuthentication_buf =
266 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
268 Z_OtherInformation *o = req->otherInfo;
269 z_OtherInformation(m_odr, &o, 1, 0);
270 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
273 yf::SessionShared::InitKey::~InitKey()
278 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
282 c = mp::util::memcmp2(
283 (void*) m_idAuthentication_buf, m_idAuthentication_size,
284 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
290 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
291 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
299 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
301 boost::mutex::scoped_lock lock(m_mutex_backend_class);
306 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
309 boost::mutex::scoped_lock lock(m_mutex_backend_class);
310 BackendInstanceList::iterator it = m_backend_list.begin();
313 if (it == m_backend_list.end())
317 it = m_backend_list.erase(it);
324 b->m_close_package->response() = odr.create_close(
325 0, Z_Close_lackOfActivity, 0);
326 b->m_close_package->session().close();
327 b->m_close_package->move();
331 yf::SessionShared::BackendInstancePtr
332 yf::SessionShared::BackendClass::get_backend(
333 const mp::Package &frontend_package)
336 boost::mutex::scoped_lock lock(m_mutex_backend_class);
338 BackendInstanceList::const_iterator it = m_backend_list.begin();
340 BackendInstancePtr backend1; // null
342 for (; it != m_backend_list.end(); it++)
344 if (!(*it)->m_in_use)
347 || (*it)->m_sequence_this < backend1->m_sequence_this)
353 use_backend(backend1);
357 return create_backend(frontend_package);
360 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
362 backend->m_in_use = true;
363 backend->m_sequence_this = m_sequence_top++;
366 void yf::SessionShared::BackendInstance::timestamp()
369 time(&m_time_last_use);
372 yf::SessionShared::BackendInstance::~BackendInstance()
377 m_close_package->response() = odr.create_close(
378 0, Z_Close_lackOfActivity, 0);
379 m_close_package->session().close();
380 m_close_package->move();
382 delete m_close_package;
385 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
386 const mp::Package &frontend_package)
388 BackendInstancePtr bp(new BackendInstance);
389 BackendInstancePtr null;
391 bp->m_close_package =
392 new mp::Package(bp->m_session, frontend_package.origin());
393 bp->m_close_package->copy_filter(frontend_package);
395 Package init_package(bp->m_session, frontend_package.origin());
397 init_package.copy_filter(frontend_package);
399 yazpp_1::GDU actual_init_request = m_init_request;
400 Z_GDU *init_pdu = actual_init_request.get();
402 assert(init_pdu->which == Z_GDU_Z3950);
403 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
405 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
406 ODR_MASK_ZERO(req->options);
408 ODR_MASK_SET(req->options, Z_Options_search);
409 ODR_MASK_SET(req->options, Z_Options_present);
410 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
411 ODR_MASK_SET(req->options, Z_Options_scan);
413 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
414 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
415 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
417 if (m_preferredMessageSize)
418 *req->preferredMessageSize = m_preferredMessageSize;
419 if (m_maximumRecordSize)
420 *req->maximumRecordSize = m_maximumRecordSize;
422 init_package.request() = init_pdu;
426 boost::mutex::scoped_lock lock(m_mutex_backend_class);
428 m_named_result_sets = false;
429 Z_GDU *gdu = init_package.response().get();
431 if (gdu && gdu->which == Z_GDU_Z3950
432 && gdu->u.z3950->which == Z_APDU_initResponse)
434 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
435 m_init_response = gdu->u.z3950;
436 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
438 m_named_result_sets = true;
440 if (*gdu->u.z3950->u.initResponse->result
441 && !init_package.session().is_closed())
444 time(&bp->m_time_last_use);
445 bp->m_sequence_this = 0;
446 bp->m_result_set_sequence = 0;
447 m_backend_list.push_back(bp);
453 yazpp_1::GDU empty_gdu;
454 m_init_response = empty_gdu;
457 if (!init_package.session().is_closed())
459 init_package.copy_filter(frontend_package);
460 init_package.session().close();
467 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
471 Odr_int preferredMessageSize,
472 Odr_int maximumRecordSize)
473 : m_named_result_sets(false), m_init_request(init_request),
474 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
475 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max),
476 m_preferredMessageSize(preferredMessageSize),
477 m_maximumRecordSize(maximumRecordSize)
480 yf::SessionShared::BackendClass::~BackendClass()
483 void yf::SessionShared::Rep::stat()
486 int no_instances = 0;
487 BackendClassMap::const_iterator it;
489 boost::mutex::scoped_lock lock(m_mutex_backend_map);
490 for (it = m_backend_map.begin(); it != m_backend_map.end(); it++)
492 BackendClassPtr bc = it->second;
494 BackendInstanceList::iterator bit = bc->m_backend_list.begin();
495 for (; bit != bc->m_backend_list.end(); bit++)
501 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
502 FrontendPtr frontend)
504 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
506 frontend->m_is_virtual = true;
507 frontend->m_init_options = *req->options;
510 boost::mutex::scoped_lock lock(m_mutex_backend_map);
511 BackendClassMap::const_iterator it;
512 it = m_backend_map.find(k);
513 if (it == m_backend_map.end())
515 BackendClassPtr b(new BackendClass(gdu->u.z3950,
519 m_preferredMessageSize,
520 m_maximumRecordSize));
521 m_backend_map[k] = b;
522 frontend->m_backend_class = b;
526 frontend->m_backend_class = it->second;
529 BackendClassPtr bc = frontend->m_backend_class;
532 // we only need to get init response from "first" target in
533 // backend class - the assumption being that init response is
535 if (bc->m_backend_list.size() == 0)
537 BackendInstancePtr backend = bc->create_backend(package);
539 bc->release_backend(backend);
542 yazpp_1::GDU init_response;
544 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
546 init_response = bc->m_init_response;
549 if (init_response.get())
551 Z_GDU *response_gdu = init_response.get();
552 mp::util::transfer_referenceId(odr, gdu->u.z3950,
553 response_gdu->u.z3950);
554 Z_InitResponse *init_res = response_gdu->u.z3950->u.initResponse;
555 Z_Options *server_options = init_res->options;
556 Z_Options *client_options = &frontend->m_init_options;
558 for (i = 0; i < 30; i++)
559 if (!ODR_MASK_GET(client_options, i))
560 ODR_MASK_CLEAR(server_options, i);
562 if (!m_preferredMessageSize ||
563 *init_res->preferredMessageSize > *req->preferredMessageSize)
564 *init_res->preferredMessageSize = *req->preferredMessageSize;
566 if (!m_maximumRecordSize ||
567 *init_res->maximumRecordSize > *req->maximumRecordSize)
568 *init_res->maximumRecordSize = *req->maximumRecordSize;
570 package.response() = init_response;
571 if (!*response_gdu->u.z3950->u.initResponse->result)
572 package.session().close();
577 odr.create_initResponse(
578 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
579 "session_shared: target closed connection during init");
580 *apdu->u.initResponse->result = 0;
581 package.response() = apdu;
582 package.session().close();
586 void yf::SessionShared::BackendSet::timestamp()
588 time(&m_time_last_use);
591 yf::SessionShared::BackendSet::BackendSet(
592 const std::string &result_set_id,
593 const Databases &databases,
594 const yazpp_1::Yaz_Z_Query &query,
595 Z_OtherInformation *additionalSearchInfo) :
596 m_result_set_id(result_set_id),
597 m_databases(databases), m_result_set_size(0), m_query(query)
600 mem_additionalSearchInfo = nmem_create();
601 additionalSearchInfoResponse = 0;
602 additionalSearchInfoRequest =
603 yaz_clone_z_OtherInformation(additionalSearchInfo,
604 mem_additionalSearchInfo);
607 yf::SessionShared::BackendSet::~BackendSet()
609 nmem_destroy(mem_additionalSearchInfo);
612 static int get_diagnostic(Z_DefaultDiagFormat *r)
614 return *r->condition;
617 bool yf::SessionShared::BackendSet::search(
618 mp::Package &frontend_package,
619 mp::Package &search_package,
620 const Z_APDU *frontend_apdu,
621 const BackendInstancePtr bp,
622 Z_Records **z_records)
625 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
626 Z_SearchRequest *req = apdu_req->u.searchRequest;
628 req->additionalSearchInfo = additionalSearchInfoRequest;
629 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
630 req->query = m_query.get_Z_Query();
632 req->num_databaseNames = m_databases.size();
633 req->databaseNames = (char**)
634 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
635 Databases::const_iterator it = m_databases.begin();
637 for (; it != m_databases.end(); it++)
638 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
640 if (frontend_apdu->which == Z_APDU_searchRequest)
641 req->preferredRecordSyntax =
642 frontend_apdu->u.searchRequest->preferredRecordSyntax;
644 search_package.request() = apdu_req;
646 search_package.move();
648 Z_GDU *gdu = search_package.response().get();
649 if (!search_package.session().is_closed()
650 && gdu && gdu->which == Z_GDU_Z3950
651 && gdu->u.z3950->which == Z_APDU_searchResponse)
653 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
654 *z_records = b_resp->records;
655 m_result_set_size = *b_resp->resultCount;
657 additionalSearchInfoResponse = yaz_clone_z_OtherInformation(
658 b_resp->additionalSearchInfo, mem_additionalSearchInfo);
662 const char *addinfo = "session_shared: "
663 "target closed connection during search";
664 if (frontend_apdu->which == Z_APDU_searchRequest)
665 f_apdu = odr.create_searchResponse(
666 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
667 else if (frontend_apdu->which == Z_APDU_presentRequest)
668 f_apdu = odr.create_presentResponse(
669 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
671 f_apdu = odr.create_close(
672 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
673 frontend_package.response() = f_apdu;
677 void yf::SessionShared::Frontend::override_set(
678 BackendInstancePtr &found_backend,
679 std::string &result_set_id,
680 const Databases &databases,
681 bool out_of_sessions)
683 BackendClassPtr bc = m_backend_class;
684 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
688 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
689 for (; it != bc->m_backend_list.end(); it++)
691 if (!(*it)->m_in_use)
693 BackendSetList::iterator set_it = (*it)->m_sets.begin();
694 for (; set_it != (*it)->m_sets.end(); set_it++)
696 if ((max_sets > 1 || (*set_it)->m_databases == databases)
699 now < (*set_it)->m_time_last_use ||
700 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
703 result_set_id = (*set_it)->m_result_set_id;
704 found_backend->m_sets.erase(set_it);
710 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
712 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
715 if (bc->m_named_result_sets)
717 result_set_id = boost::io::str(
718 boost::format("%1%") %
719 found_backend->m_result_set_sequence);
720 found_backend->m_result_set_sequence++;
723 result_set_id = "default";
729 void yf::SessionShared::Frontend::get_set(mp::Package &package,
730 const Z_APDU *apdu_req,
731 const Databases &databases,
732 yazpp_1::Yaz_Z_Query &query,
733 BackendInstancePtr &found_backend,
734 BackendSetPtr &found_set)
736 bool session_restarted = false;
737 Z_OtherInformation *additionalSearchInfo = 0;
739 if (apdu_req->which == Z_APDU_searchRequest)
740 additionalSearchInfo = apdu_req->u.searchRequest->additionalSearchInfo;
743 std::string result_set_id;
744 bool out_of_sessions = false;
745 BackendClassPtr bc = m_backend_class;
747 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
749 if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
750 out_of_sessions = true;
752 if (m_p->m_optimize_search)
754 // look at each backend and see if we have a similar search
755 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
756 for (; it != bc->m_backend_list.end(); it++)
758 if (!(*it)->m_in_use)
760 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
761 for (; set_it != (*it)->m_sets.end(); set_it++)
763 // for real present request we don't care
764 // if additionalSearchInfo matches: same records
765 if ((*set_it)->m_databases == databases
766 && query.match(&(*set_it)->m_query)
767 && (apdu_req->which != Z_APDU_searchRequest ||
768 yaz_compare_z_OtherInformation(
769 additionalSearchInfo,
770 (*set_it)->additionalSearchInfoRequest)))
774 bc->use_backend(found_backend);
775 // found matching set. No need to search again
782 override_set(found_backend, result_set_id, databases, out_of_sessions);
784 bc->use_backend(found_backend);
788 // create a new backend set (and new set) if we're not out of sessions
789 if (!out_of_sessions)
790 found_backend = bc->create_backend(package);
796 const char *addinfo = 0;
799 addinfo = "session_shared: all sessions in use";
801 addinfo = "session_shared: could not create backend";
802 if (apdu_req->which == Z_APDU_searchRequest)
804 f_apdu = odr.create_searchResponse(
805 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
807 else if (apdu_req->which == Z_APDU_presentRequest)
809 f_apdu = odr.create_presentResponse(
810 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
814 f_apdu = odr.create_close(
815 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
817 package.response() = f_apdu;
820 if (bc->m_named_result_sets)
822 result_set_id = boost::io::str(
823 boost::format("%1%") % found_backend->m_result_set_sequence);
824 found_backend->m_result_set_sequence++;
827 result_set_id = "default";
829 found_backend->timestamp();
831 // we must search ...
832 BackendSetPtr new_set(new BackendSet(result_set_id,
834 additionalSearchInfo));
835 Z_Records *z_records = 0;
837 Package search_package(found_backend->m_session, package.origin());
838 search_package.copy_filter(package);
840 if (!new_set->search(package, search_package,
841 apdu_req, found_backend, &z_records))
843 bc->remove_backend(found_backend);
844 return; // search error
850 if (z_records->which == Z_Records_NSD)
853 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
855 else if (z_records->which == Z_Records_multipleNSD)
857 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
860 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
861 Z_DiagRec_defaultFormat)
863 condition = get_diagnostic(
864 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
868 if (m_p->m_restart && !session_restarted &&
869 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
871 package.log("session_shared", YLOG_LOG, "restart");
872 bc->remove_backend(found_backend);
873 session_restarted = true;
874 found_backend.reset();
882 if (apdu_req->which == Z_APDU_searchRequest)
884 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
886 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
887 *f_resp->searchStatus = Z_SearchResponse_none;
888 f_resp->records = z_records;
889 package.response() = f_apdu;
891 if (apdu_req->which == Z_APDU_presentRequest)
893 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
895 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
896 f_resp->records = z_records;
897 package.response() = f_apdu;
899 bc->release_backend(found_backend);
900 return; // search error
903 if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
905 package.log("session_shared", YLOG_LOG, "restart");
906 bc->remove_backend(found_backend);
907 session_restarted = true;
908 found_backend.reset();
913 found_set->timestamp();
914 found_backend->m_sets.push_back(found_set);
917 int yf::SessionShared::Frontend::result_set_ref(ODR o,
918 const Databases &databases,
925 case Z_RPNStructure_simple:
926 if (s->u.simple->which == Z_Operand_resultSetId)
928 const char *id = s->u.simple->u.resultSetId;
931 FrontendSets::iterator fset_it = m_frontend_sets.find(id);
932 if (fset_it == m_frontend_sets.end())
934 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
936 else if (fset_it->second->get_databases() != databases)
938 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
942 yazpp_1::Yaz_Z_Query query = fset_it->second->get_query();
943 Z_Query *q = yaz_copy_Z_Query(query.get_Z_Query(), o);
944 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
946 s->which = q->u.type_1->RPNStructure->which;
947 s->u.simple = q->u.type_1->RPNStructure->u.simple;
951 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
956 case Z_RPNStructure_complex:
957 ret = result_set_ref(o, databases, s->u.complex->s1, rset);
959 ret = result_set_ref(o, databases, s->u.complex->s2, rset);
965 void yf::SessionShared::Frontend::search(mp::Package &package,
968 Z_SearchRequest *req = apdu_req->u.searchRequest;
969 FrontendSets::iterator fset_it =
970 m_frontend_sets.find(req->resultSetName);
971 if (fset_it != m_frontend_sets.end())
973 // result set already exist
974 // if replace indicator is off: we return diagnostic if
975 // result set already exist.
976 if (*req->replaceIndicator == 0)
980 odr.create_searchResponse(
982 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
984 package.response() = apdu;
987 m_frontend_sets.erase(fset_it);
992 for (i = 0; i < req->num_databaseNames; i++)
993 databases.push_back(req->databaseNames[i]);
996 yazpp_1::Yaz_Z_Query query;
997 query.set_Z_Query(req->query);
999 Z_Query *q = query.get_Z_Query();
1000 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
1004 int diag = result_set_ref(odr, databases, q->u.type_1->RPNStructure,
1009 odr.create_searchResponse(
1013 package.response() = apdu;
1016 query.set_Z_Query(q);
1019 BackendSetPtr found_set; // null
1020 BackendInstancePtr found_backend; // null
1022 get_set(package, apdu_req, databases, query, found_backend, found_set);
1027 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
1028 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
1029 *f_resp->resultCount = found_set->m_result_set_size;
1030 f_resp->additionalSearchInfo = found_set->additionalSearchInfoResponse;
1031 package.response() = f_apdu;
1033 FrontendSetPtr fset(new FrontendSet(databases, query));
1034 m_frontend_sets[req->resultSetName] = fset;
1036 m_backend_class->release_backend(found_backend);
1039 void yf::SessionShared::Frontend::present(mp::Package &package,
1043 Z_PresentRequest *req = apdu_req->u.presentRequest;
1045 FrontendSets::iterator fset_it =
1046 m_frontend_sets.find(req->resultSetId);
1048 if (fset_it == m_frontend_sets.end())
1051 odr.create_presentResponse(
1053 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1055 package.response() = apdu;
1058 FrontendSetPtr fset = fset_it->second;
1060 Databases databases = fset->get_databases();
1061 yazpp_1::Yaz_Z_Query query = fset->get_query();
1063 BackendClassPtr bc = m_backend_class;
1064 BackendSetPtr found_set; // null
1065 BackendInstancePtr found_backend;
1067 get_set(package, apdu_req, databases, query, found_backend, found_set);
1071 Z_NamePlusRecordList *npr_res = 0;
1072 // record_cache.lookup types are int's. Avoid non-fitting values
1073 if (*req->resultSetStartPoint > 0
1074 && *req->resultSetStartPoint < INT_MAX
1075 && *req->numberOfRecordsRequested > 0
1076 && *req->numberOfRecordsRequested < INT_MAX
1077 && found_set->m_record_cache.lookup(odr, &npr_res,
1078 *req->resultSetStartPoint,
1079 *req->numberOfRecordsRequested,
1080 req->preferredRecordSyntax,
1081 req->recordComposition))
1083 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1084 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1086 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1087 " records in cache %p",
1088 *req->resultSetStartPoint,
1089 *req->numberOfRecordsRequested,
1090 &found_set->m_record_cache);
1092 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
1093 *f_resp->nextResultSetPosition =
1094 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
1095 // f_resp->presentStatus assumed OK.
1096 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
1097 f_resp->records->which = Z_Records_DBOSD;
1098 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
1099 package.response() = f_apdu_res;
1100 bc->release_backend(found_backend);
1104 found_backend->timestamp();
1106 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
1107 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
1108 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1109 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
1110 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
1111 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
1112 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1113 p_req->recordComposition = req->recordComposition;
1115 Package present_package(found_backend->m_session, package.origin());
1116 present_package.copy_filter(package);
1118 present_package.request() = p_apdu;
1120 present_package.move();
1122 Z_GDU *gdu = present_package.response().get();
1123 if (!present_package.session().is_closed()
1124 && gdu && gdu->which == Z_GDU_Z3950
1125 && gdu->u.z3950->which == Z_APDU_presentResponse)
1127 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
1128 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1129 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1131 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
1132 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
1133 f_resp->presentStatus= b_resp->presentStatus;
1134 f_resp->records = b_resp->records;
1135 f_resp->otherInfo = b_resp->otherInfo;
1136 package.response() = f_apdu_res;
1138 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
1140 Z_NamePlusRecordList *npr =
1141 b_resp->records->u.databaseOrSurDiagnostics;
1142 // record_cache.add types are int's. Avoid non-fitting values
1143 if (*req->resultSetStartPoint > 0
1144 && npr->num_records + *req->resultSetStartPoint < INT_MAX)
1147 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1148 " records to cache %p",
1149 *req->resultSetStartPoint,
1150 *f_resp->numberOfRecordsReturned,
1151 &found_set->m_record_cache);
1153 found_set->m_record_cache.add(
1154 odr, npr, *req->resultSetStartPoint,
1155 p_req->recordComposition);
1158 bc->release_backend(found_backend);
1162 bc->remove_backend(found_backend);
1163 Z_APDU *f_apdu_res =
1164 odr.create_presentResponse(
1165 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1166 "session_shared: target closed connection during present");
1167 package.response() = f_apdu_res;
1171 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
1174 BackendClassPtr bc = m_backend_class;
1175 BackendInstancePtr backend = bc->get_backend(frontend_package);
1179 Z_APDU *apdu = odr.create_scanResponse(
1180 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1181 "session_shared: could not create backend");
1182 frontend_package.response() = apdu;
1186 Package scan_package(backend->m_session, frontend_package.origin());
1187 backend->timestamp();
1188 scan_package.copy_filter(frontend_package);
1189 scan_package.request() = apdu_req;
1190 scan_package.move();
1191 frontend_package.response() = scan_package.response();
1192 if (scan_package.session().is_closed())
1194 frontend_package.session().close();
1195 bc->remove_backend(backend);
1198 bc->release_backend(backend);
1202 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1206 void yf::SessionShared::Worker::operator() (void)
1211 bool yf::SessionShared::BackendClass::expire_instances()
1215 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1216 BackendInstanceList::iterator bit = m_backend_list.begin();
1217 while (bit != m_backend_list.end())
1219 time_t last_use = (*bit)->m_time_last_use;
1221 if ((*bit)->m_in_use)
1225 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1227 bit = m_backend_list.erase(bit);
1234 if (m_backend_list.empty())
1239 void yf::SessionShared::Rep::expire_classes()
1241 boost::mutex::scoped_lock lock(m_mutex_backend_map);
1242 BackendClassMap::iterator b_it = m_backend_map.begin();
1243 while (b_it != m_backend_map.end())
1245 if (b_it->second->expire_instances())
1247 m_backend_map.erase(b_it);
1248 b_it = m_backend_map.begin();
1255 void yf::SessionShared::Rep::expire()
1260 boost::xtime_get(&xt,
1261 #if BOOST_VERSION >= 105000
1267 xt.sec += m_session_ttl / 3;
1269 boost::mutex::scoped_lock lock(m_mutex);
1270 m_cond_expire_ready.timed_wait(lock, xt);
1279 yf::SessionShared::Rep::Rep()
1281 m_resultset_ttl = 30;
1282 m_resultset_max = 10;
1284 m_optimize_search = true;
1286 m_session_max = 100;
1287 m_preferredMessageSize = 0;
1288 m_maximumRecordSize = 0;
1292 yf::SessionShared::Rep::~Rep()
1295 boost::mutex::scoped_lock lock(m_mutex);
1297 m_cond_expire_ready.notify_all();
1302 void yf::SessionShared::Rep::start()
1304 yf::SessionShared::Worker w(this);
1305 m_thrds.add_thread(new boost::thread(w));
1308 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1312 yf::SessionShared::~SessionShared() {
1315 void yf::SessionShared::start() const
1320 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1324 yf::SessionShared::Frontend::~Frontend()
1328 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1330 boost::mutex::scoped_lock lock(m_mutex);
1332 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1336 it = m_clients.find(package.session());
1337 if (it == m_clients.end())
1340 if (!it->second->m_in_use)
1342 it->second->m_in_use = true;
1345 m_cond_session_ready.wait(lock);
1347 FrontendPtr f(new Frontend(this));
1348 m_clients[package.session()] = f;
1353 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1355 boost::mutex::scoped_lock lock(m_mutex);
1356 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1358 it = m_clients.find(package.session());
1359 if (it != m_clients.end())
1361 if (package.session().is_closed())
1363 m_clients.erase(it);
1367 it->second->m_in_use = false;
1369 m_cond_session_ready.notify_all();
1374 void yf::SessionShared::process(mp::Package &package) const
1376 FrontendPtr f = m_p->get_frontend(package);
1378 Z_GDU *gdu = package.request().get();
1380 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1381 Z_APDU_initRequest && !f->m_is_virtual)
1383 m_p->init(package, gdu, f);
1385 else if (!f->m_is_virtual)
1387 else if (gdu && gdu->which == Z_GDU_Z3950)
1389 Z_APDU *apdu = gdu->u.z3950;
1390 if (apdu->which == Z_APDU_initRequest)
1394 package.response() = odr.create_close(
1396 Z_Close_protocolError,
1399 package.session().close();
1401 else if (apdu->which == Z_APDU_close)
1405 package.response() = odr.create_close(
1407 Z_Close_peerAbort, "received close from client");
1408 package.session().close();
1410 else if (apdu->which == Z_APDU_searchRequest)
1412 f->search(package, apdu);
1414 else if (apdu->which == Z_APDU_presentRequest)
1416 f->present(package, apdu);
1418 else if (apdu->which == Z_APDU_scanRequest)
1420 f->scan(package, apdu);
1426 package.response() = odr.create_close(
1427 apdu, Z_Close_protocolError,
1428 "unsupported APDU in filter_session_shared");
1430 package.session().close();
1433 m_p->release_frontend(package);
1436 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1439 for (ptr = ptr->children; ptr; ptr = ptr->next)
1441 if (ptr->type != XML_ELEMENT_NODE)
1443 if (!strcmp((const char *) ptr->name, "resultset"))
1445 const struct _xmlAttr *attr;
1446 for (attr = ptr->properties; attr; attr = attr->next)
1448 if (!strcmp((const char *) attr->name, "ttl"))
1449 m_p->m_resultset_ttl =
1450 mp::xml::get_int(attr->children, 30);
1451 else if (!strcmp((const char *) attr->name, "max"))
1453 m_p->m_resultset_max =
1454 mp::xml::get_int(attr->children, 10);
1456 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1458 m_p->m_optimize_search =
1459 mp::xml::get_bool(attr->children, true);
1461 else if (!strcmp((const char *) attr->name, "restart"))
1463 m_p->m_restart = mp::xml::get_bool(attr->children, true);
1466 throw mp::filter::FilterException(
1467 "Bad attribute " + std::string((const char *)
1471 else if (!strcmp((const char *) ptr->name, "session"))
1473 const struct _xmlAttr *attr;
1474 for (attr = ptr->properties; attr; attr = attr->next)
1476 if (!strcmp((const char *) attr->name, "ttl"))
1477 m_p->m_session_ttl =
1478 mp::xml::get_int(attr->children, 90);
1479 else if (!strcmp((const char *) attr->name, "max"))
1480 m_p->m_session_max =
1481 mp::xml::get_int(attr->children, 100);
1483 throw mp::filter::FilterException(
1484 "Bad attribute " + std::string((const char *)
1488 else if (!strcmp((const char *) ptr->name, "init"))
1490 const struct _xmlAttr *attr;
1491 for (attr = ptr->properties; attr; attr = attr->next)
1493 if (!strcmp((const char *) attr->name, "maximum-record-size"))
1494 m_p->m_maximumRecordSize =
1495 mp::xml::get_int(attr->children, 0);
1496 else if (!strcmp((const char *) attr->name,
1497 "preferred-message-size"))
1498 m_p->m_preferredMessageSize =
1499 mp::xml::get_int(attr->children, 0);
1501 throw mp::filter::FilterException(
1502 "Bad attribute " + std::string((const char *)
1508 throw mp::filter::FilterException("Bad element "
1509 + std::string((const char *)
1515 static mp::filter::Base* filter_creator()
1517 return new mp::filter::SessionShared;
1521 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1531 * c-file-style: "Stroustrup"
1532 * indent-tabs-mode: nil
1534 * vim: shiftwidth=4 tabstop=8 expandtab