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;
132 boost::condition m_cond_set_ready;
134 time_t m_backend_set_ttl;
135 time_t m_backend_expiry_ttl;
136 size_t m_backend_set_max;
137 Odr_int m_preferredMessageSize;
138 Odr_int m_maximumRecordSize;
143 BackendClass(const yazpp_1::GDU &init_request,
147 Odr_int preferredRecordSize,
148 Odr_int maximumRecordSize);
151 // frontend result set
152 class SessionShared::FrontendSet {
153 Databases m_databases;
154 yazpp_1::Yaz_Z_Query m_query;
156 const Databases &get_databases();
157 const yazpp_1::Yaz_Z_Query &get_query();
159 const Databases &databases,
160 const yazpp_1::Yaz_Z_Query &query);
164 struct SessionShared::Frontend {
169 Z_Options m_init_options;
170 void search(Package &package, Z_APDU *apdu);
171 void present(Package &package, Z_APDU *apdu);
172 void scan(Package &package, Z_APDU *apdu);
174 int result_set_ref(ODR o,
175 const Databases &databases,
176 Z_RPNStructure *s, std::string &rset);
177 void get_set(mp::Package &package,
178 const Z_APDU *apdu_req,
179 const Databases &databases,
180 yazpp_1::Yaz_Z_Query &query,
181 BackendInstancePtr &found_backend,
182 BackendSetPtr &found_set);
183 void override_set(BackendInstancePtr &found_backend,
184 std::string &result_set_id,
185 const Databases &databases,
186 bool out_of_sessions);
189 BackendClassPtr m_backend_class;
190 FrontendSets m_frontend_sets;
193 class SessionShared::Rep {
194 friend class SessionShared;
195 friend struct Frontend;
197 FrontendPtr get_frontend(Package &package);
198 void release_frontend(Package &package);
204 void expire_classes();
206 void init(Package &package, const Z_GDU *gdu,
207 FrontendPtr frontend);
209 boost::mutex m_mutex;
210 boost::condition m_cond_session_ready;
211 boost::condition m_cond_expire_ready;
212 std::map<mp::Session, FrontendPtr> m_clients;
214 BackendClassMap m_backend_map;
215 boost::mutex m_mutex_backend_map;
216 boost::thread_group m_thrds;
220 bool m_optimize_search;
223 Odr_int m_preferredMessageSize;
224 Odr_int m_maximumRecordSize;
230 yf::SessionShared::FrontendSet::FrontendSet(
231 const Databases &databases,
232 const yazpp_1::Yaz_Z_Query &query)
233 : m_databases(databases), m_query(query)
237 const yf::SessionShared::Databases &
238 yf::SessionShared::FrontendSet::get_databases()
243 const yazpp_1::Yaz_Z_Query& yf::SessionShared::FrontendSet::get_query()
248 yf::SessionShared::InitKey::InitKey(const InitKey &k)
250 m_odr = odr_createmem(ODR_ENCODE);
252 m_idAuthentication_size = k.m_idAuthentication_size;
253 m_idAuthentication_buf = (char*)odr_malloc(m_odr, m_idAuthentication_size);
254 memcpy(m_idAuthentication_buf, k.m_idAuthentication_buf,
255 m_idAuthentication_size);
257 m_otherInfo_size = k.m_otherInfo_size;
258 m_otherInfo_buf = (char*)odr_malloc(m_odr, m_otherInfo_size);
259 memcpy(m_otherInfo_buf, k.m_otherInfo_buf,
263 yf::SessionShared::InitKey::InitKey(Z_InitRequest *req)
265 m_odr = odr_createmem(ODR_ENCODE);
267 Z_IdAuthentication *t = req->idAuthentication;
268 z_IdAuthentication(m_odr, &t, 1, 0);
269 m_idAuthentication_buf =
270 odr_getbuf(m_odr, &m_idAuthentication_size, 0);
272 Z_OtherInformation *o = req->otherInfo;
273 z_OtherInformation(m_odr, &o, 1, 0);
274 m_otherInfo_buf = odr_getbuf(m_odr, &m_otherInfo_size, 0);
277 yf::SessionShared::InitKey::~InitKey()
282 bool yf::SessionShared::InitKey::operator < (const SessionShared::InitKey &k)
286 c = mp::util::memcmp2(
287 (void*) m_idAuthentication_buf, m_idAuthentication_size,
288 (void*) k.m_idAuthentication_buf, k.m_idAuthentication_size);
294 c = mp::util::memcmp2((void*) m_otherInfo_buf, m_otherInfo_size,
295 (void*) k.m_otherInfo_buf, k.m_otherInfo_size);
303 void yf::SessionShared::BackendClass::release_backend(BackendInstancePtr b)
305 boost::mutex::scoped_lock lock(m_mutex_backend_class);
306 m_cond_set_ready.notify_all();
311 void yf::SessionShared::BackendClass::remove_backend(BackendInstancePtr b)
314 boost::mutex::scoped_lock lock(m_mutex_backend_class);
315 BackendInstanceList::iterator it = m_backend_list.begin();
318 if (it == m_backend_list.end())
322 it = m_backend_list.erase(it);
329 b->m_close_package->response() = odr.create_close(
330 0, Z_Close_lackOfActivity, 0);
331 b->m_close_package->session().close();
332 b->m_close_package->move();
336 yf::SessionShared::BackendInstancePtr
337 yf::SessionShared::BackendClass::get_backend(
338 const mp::Package &frontend_package)
341 boost::mutex::scoped_lock lock(m_mutex_backend_class);
343 BackendInstanceList::const_iterator it = m_backend_list.begin();
345 BackendInstancePtr backend1; // null
347 for (; it != m_backend_list.end(); it++)
349 if (!(*it)->m_in_use)
352 || (*it)->m_sequence_this < backend1->m_sequence_this)
358 use_backend(backend1);
362 return create_backend(frontend_package);
365 void yf::SessionShared::BackendClass::use_backend(BackendInstancePtr backend)
367 backend->m_in_use = true;
368 backend->m_sequence_this = m_sequence_top++;
371 void yf::SessionShared::BackendInstance::timestamp()
374 time(&m_time_last_use);
377 yf::SessionShared::BackendInstance::~BackendInstance()
382 m_close_package->response() = odr.create_close(
383 0, Z_Close_lackOfActivity, 0);
384 m_close_package->session().close();
385 m_close_package->move();
387 delete m_close_package;
390 yf::SessionShared::BackendInstancePtr yf::SessionShared::BackendClass::create_backend(
391 const mp::Package &frontend_package)
393 BackendInstancePtr null;
395 boost::mutex::scoped_lock lock(m_mutex_backend_class);
396 if (m_no_failed && !m_no_succeeded)
402 BackendInstancePtr bp(new BackendInstance);
403 bp->m_close_package =
404 new mp::Package(bp->m_session, frontend_package.origin());
405 bp->m_close_package->copy_filter(frontend_package);
407 Package init_package(bp->m_session, frontend_package.origin());
409 init_package.copy_filter(frontend_package);
411 yazpp_1::GDU actual_init_request = m_init_request;
412 Z_GDU *init_pdu = actual_init_request.get();
414 assert(init_pdu->which == Z_GDU_Z3950);
415 assert(init_pdu->u.z3950->which == Z_APDU_initRequest);
417 Z_InitRequest *req = init_pdu->u.z3950->u.initRequest;
418 ODR_MASK_ZERO(req->options);
420 ODR_MASK_SET(req->options, Z_Options_search);
421 ODR_MASK_SET(req->options, Z_Options_present);
422 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
423 ODR_MASK_SET(req->options, Z_Options_scan);
425 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
426 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
427 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
429 if (m_preferredMessageSize)
430 *req->preferredMessageSize = m_preferredMessageSize;
431 if (m_maximumRecordSize)
432 *req->maximumRecordSize = m_maximumRecordSize;
434 init_package.request() = init_pdu;
437 boost::mutex::scoped_lock lock(m_mutex_backend_class);
443 boost::mutex::scoped_lock lock(m_mutex_backend_class);
445 m_named_result_sets = false;
446 Z_GDU *gdu = init_package.response().get();
448 if (gdu && gdu->which == Z_GDU_Z3950
449 && gdu->u.z3950->which == Z_APDU_initResponse)
451 Z_InitResponse *res = gdu->u.z3950->u.initResponse;
452 m_init_response = gdu->u.z3950;
453 if (ODR_MASK_GET(res->options, Z_Options_namedResultSets))
455 m_named_result_sets = true;
457 if (*gdu->u.z3950->u.initResponse->result
458 && !init_package.session().is_closed())
461 time(&bp->m_time_last_use);
462 bp->m_sequence_this = 0;
463 bp->m_result_set_sequence = 0;
464 m_backend_list.push_back(bp);
471 yazpp_1::GDU empty_gdu;
472 m_init_response = empty_gdu;
475 if (!init_package.session().is_closed())
477 init_package.copy_filter(frontend_package);
478 init_package.session().close();
482 m_cond_set_ready.notify_all();
487 yf::SessionShared::BackendClass::BackendClass(const yazpp_1::GDU &init_request,
491 Odr_int preferredMessageSize,
492 Odr_int maximumRecordSize)
493 : m_named_result_sets(false), m_init_request(init_request),
494 m_sequence_top(0), m_backend_set_ttl(resultset_ttl),
495 m_backend_expiry_ttl(session_ttl), m_backend_set_max(resultset_max),
496 m_preferredMessageSize(preferredMessageSize),
497 m_maximumRecordSize(maximumRecordSize),
498 m_no_failed(0), m_no_succeeded(0), m_no_init(0)
501 yf::SessionShared::BackendClass::~BackendClass()
504 void yf::SessionShared::Rep::stat()
507 int no_instances = 0;
508 BackendClassMap::const_iterator it;
510 boost::mutex::scoped_lock lock(m_mutex_backend_map);
511 for (it = m_backend_map.begin(); it != m_backend_map.end(); it++)
513 BackendClassPtr bc = it->second;
515 BackendInstanceList::iterator bit = bc->m_backend_list.begin();
516 for (; bit != bc->m_backend_list.end(); bit++)
522 void yf::SessionShared::Rep::init(mp::Package &package, const Z_GDU *gdu,
523 FrontendPtr frontend)
525 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
527 frontend->m_is_virtual = true;
528 frontend->m_init_options = *req->options;
531 boost::mutex::scoped_lock lock(m_mutex_backend_map);
532 BackendClassMap::const_iterator it;
533 it = m_backend_map.find(k);
534 if (it == m_backend_map.end())
536 BackendClassPtr b(new BackendClass(gdu->u.z3950,
540 m_preferredMessageSize,
541 m_maximumRecordSize));
542 m_backend_map[k] = b;
543 frontend->m_backend_class = b;
547 frontend->m_backend_class = it->second;
550 BackendClassPtr bc = frontend->m_backend_class;
553 // we only need to get init response from "first" target in
554 // backend class - the assumption being that init response is
556 bool create_first_one = false;
558 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
559 if (!bc->m_no_failed && !bc->m_no_succeeded && !bc->m_no_init)
560 create_first_one = true;
563 // first for first one to finish
564 while (!bc->m_no_failed && !bc->m_no_succeeded && bc->m_no_init)
566 bc->m_cond_set_ready.wait(lock);
570 if (create_first_one)
572 BackendInstancePtr backend = bc->create_backend(package);
574 bc->release_backend(backend);
576 yazpp_1::GDU init_response;
578 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
580 init_response = bc->m_init_response;
583 if (init_response.get())
585 Z_GDU *response_gdu = init_response.get();
586 mp::util::transfer_referenceId(odr, gdu->u.z3950,
587 response_gdu->u.z3950);
588 Z_InitResponse *init_res = response_gdu->u.z3950->u.initResponse;
589 Z_Options *server_options = init_res->options;
590 Z_Options *client_options = &frontend->m_init_options;
592 for (i = 0; i < 30; i++)
593 if (!ODR_MASK_GET(client_options, i))
594 ODR_MASK_CLEAR(server_options, i);
596 if (!m_preferredMessageSize ||
597 *init_res->preferredMessageSize > *req->preferredMessageSize)
598 *init_res->preferredMessageSize = *req->preferredMessageSize;
600 if (!m_maximumRecordSize ||
601 *init_res->maximumRecordSize > *req->maximumRecordSize)
602 *init_res->maximumRecordSize = *req->maximumRecordSize;
604 package.response() = init_response;
605 if (!*response_gdu->u.z3950->u.initResponse->result)
606 package.session().close();
611 odr.create_initResponse(
612 gdu->u.z3950, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
613 "session_shared: target closed connection during init");
614 *apdu->u.initResponse->result = 0;
615 package.response() = apdu;
616 package.session().close();
620 void yf::SessionShared::BackendSet::timestamp()
622 time(&m_time_last_use);
625 yf::SessionShared::BackendSet::BackendSet(
626 const std::string &result_set_id,
627 const Databases &databases,
628 const yazpp_1::Yaz_Z_Query &query,
629 Z_OtherInformation *additionalSearchInfo) :
630 m_result_set_id(result_set_id),
631 m_databases(databases), m_result_set_size(0), m_query(query)
634 mem_additionalSearchInfo = nmem_create();
635 additionalSearchInfoResponse = 0;
636 additionalSearchInfoRequest =
637 yaz_clone_z_OtherInformation(additionalSearchInfo,
638 mem_additionalSearchInfo);
641 yf::SessionShared::BackendSet::~BackendSet()
643 nmem_destroy(mem_additionalSearchInfo);
646 static int get_diagnostic(Z_DefaultDiagFormat *r)
648 return *r->condition;
651 bool yf::SessionShared::BackendSet::search(
652 mp::Package &frontend_package,
653 mp::Package &search_package,
654 const Z_APDU *frontend_apdu,
655 const BackendInstancePtr bp,
656 Z_Records **z_records)
659 Z_APDU *apdu_req = zget_APDU(odr, Z_APDU_searchRequest);
660 Z_SearchRequest *req = apdu_req->u.searchRequest;
662 req->additionalSearchInfo = additionalSearchInfoRequest;
663 req->resultSetName = odr_strdup(odr, m_result_set_id.c_str());
664 req->query = m_query.get_Z_Query();
666 req->num_databaseNames = m_databases.size();
667 req->databaseNames = (char**)
668 odr_malloc(odr, req->num_databaseNames * sizeof(char *));
669 Databases::const_iterator it = m_databases.begin();
671 for (; it != m_databases.end(); it++)
672 req->databaseNames[i++] = odr_strdup(odr, it->c_str());
674 if (frontend_apdu->which == Z_APDU_searchRequest)
675 req->preferredRecordSyntax =
676 frontend_apdu->u.searchRequest->preferredRecordSyntax;
678 search_package.request() = apdu_req;
680 search_package.move();
682 Z_GDU *gdu = search_package.response().get();
683 if (!search_package.session().is_closed()
684 && gdu && gdu->which == Z_GDU_Z3950
685 && gdu->u.z3950->which == Z_APDU_searchResponse)
687 Z_SearchResponse *b_resp = gdu->u.z3950->u.searchResponse;
688 *z_records = b_resp->records;
689 m_result_set_size = *b_resp->resultCount;
691 additionalSearchInfoResponse = yaz_clone_z_OtherInformation(
692 b_resp->additionalSearchInfo, mem_additionalSearchInfo);
696 const char *addinfo = "session_shared: "
697 "target closed connection during search";
698 if (frontend_apdu->which == Z_APDU_searchRequest)
699 f_apdu = odr.create_searchResponse(
700 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
701 else if (frontend_apdu->which == Z_APDU_presentRequest)
702 f_apdu = odr.create_presentResponse(
703 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
705 f_apdu = odr.create_close(
706 frontend_apdu, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
707 frontend_package.response() = f_apdu;
711 void yf::SessionShared::Frontend::override_set(
712 BackendInstancePtr &found_backend,
713 std::string &result_set_id,
714 const Databases &databases,
715 bool out_of_sessions)
717 BackendClassPtr bc = m_backend_class;
718 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
722 size_t max_sets = bc->m_named_result_sets ? bc->m_backend_set_max : 1;
723 for (; it != bc->m_backend_list.end(); it++)
725 if (!(*it)->m_in_use)
727 BackendSetList::iterator set_it = (*it)->m_sets.begin();
728 for (; set_it != (*it)->m_sets.end(); set_it++)
730 if ((max_sets > 1 || (*set_it)->m_databases == databases)
733 now < (*set_it)->m_time_last_use ||
734 now - (*set_it)->m_time_last_use >= bc->m_backend_set_ttl))
737 result_set_id = (*set_it)->m_result_set_id;
738 found_backend->m_sets.erase(set_it);
744 for (it = bc->m_backend_list.begin(); it != bc->m_backend_list.end(); it++)
746 if (!(*it)->m_in_use && (*it)->m_sets.size() < max_sets)
749 if (bc->m_named_result_sets)
751 result_set_id = boost::io::str(
752 boost::format("%1%") %
753 found_backend->m_result_set_sequence);
754 found_backend->m_result_set_sequence++;
757 result_set_id = "default";
763 void yf::SessionShared::Frontend::get_set(mp::Package &package,
764 const Z_APDU *apdu_req,
765 const Databases &databases,
766 yazpp_1::Yaz_Z_Query &query,
767 BackendInstancePtr &found_backend,
768 BackendSetPtr &found_set)
770 bool session_restarted = false;
771 Z_OtherInformation *additionalSearchInfo = 0;
773 if (apdu_req->which == Z_APDU_searchRequest)
774 additionalSearchInfo = apdu_req->u.searchRequest->additionalSearchInfo;
777 std::string result_set_id;
778 bool out_of_sessions = false;
779 BackendClassPtr bc = m_backend_class;
781 boost::mutex::scoped_lock lock(bc->m_mutex_backend_class);
783 if ((int) bc->m_backend_list.size() >= m_p->m_session_max)
784 out_of_sessions = true;
786 if (m_p->m_optimize_search)
788 // look at each backend and see if we have a similar search
789 BackendInstanceList::const_iterator it = bc->m_backend_list.begin();
790 while (it != bc->m_backend_list.end())
792 bool restart = false;
793 BackendSetList::const_iterator set_it = (*it)->m_sets.begin();
794 for (; set_it != (*it)->m_sets.end(); set_it++)
796 // for real present request we don't care
797 // if additionalSearchInfo matches: same records
798 if ((*set_it)->m_databases == databases
799 && query.match(&(*set_it)->m_query)
800 && (apdu_req->which != Z_APDU_searchRequest ||
801 yaz_compare_z_OtherInformation(
802 additionalSearchInfo,
803 (*set_it)->additionalSearchInfoRequest)))
807 bc->m_cond_set_ready.wait(lock);
815 bc->use_backend(found_backend);
816 // found matching set. No need to search again
822 it = bc->m_backend_list.begin();
827 override_set(found_backend, result_set_id, databases, out_of_sessions);
829 bc->use_backend(found_backend);
833 // create a new backend set (and new set) if we're not out of sessions
834 if (!out_of_sessions)
835 found_backend = bc->create_backend(package);
841 const char *addinfo = 0;
844 addinfo = "session_shared: all sessions in use";
846 addinfo = "session_shared: could not create backend";
847 if (apdu_req->which == Z_APDU_searchRequest)
849 f_apdu = odr.create_searchResponse(
850 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
852 else if (apdu_req->which == Z_APDU_presentRequest)
854 f_apdu = odr.create_presentResponse(
855 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
859 f_apdu = odr.create_close(
860 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, addinfo);
862 package.response() = f_apdu;
865 if (bc->m_named_result_sets)
867 result_set_id = boost::io::str(
868 boost::format("%1%") % found_backend->m_result_set_sequence);
869 found_backend->m_result_set_sequence++;
872 result_set_id = "default";
874 found_backend->timestamp();
876 // we must search ...
877 BackendSetPtr new_set(new BackendSet(result_set_id,
879 additionalSearchInfo));
882 found_set->timestamp();
884 Z_Records *z_records = 0;
886 Package search_package(found_backend->m_session, package.origin());
887 search_package.copy_filter(package);
889 if (!new_set->search(package, search_package,
890 apdu_req, found_backend, &z_records))
892 bc->remove_backend(found_backend);
893 return; // search error
899 if (z_records->which == Z_Records_NSD)
902 get_diagnostic(z_records->u.nonSurrogateDiagnostic);
904 else if (z_records->which == Z_Records_multipleNSD)
906 if (z_records->u.multipleNonSurDiagnostics->num_diagRecs >= 1
909 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->which ==
910 Z_DiagRec_defaultFormat)
912 condition = get_diagnostic(
913 z_records->u.multipleNonSurDiagnostics->diagRecs[0]->u.defaultFormat);
917 if (m_p->m_restart && !session_restarted &&
918 condition == YAZ_BIB1_TEMPORARY_SYSTEM_ERROR)
920 package.log("session_shared", YLOG_LOG, "restart");
921 bc->remove_backend(found_backend);
922 session_restarted = true;
923 found_backend.reset();
931 if (apdu_req->which == Z_APDU_searchRequest)
933 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req,
935 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
936 *f_resp->searchStatus = Z_SearchResponse_none;
937 f_resp->records = z_records;
938 package.response() = f_apdu;
940 if (apdu_req->which == Z_APDU_presentRequest)
942 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req,
944 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
945 f_resp->records = z_records;
946 package.response() = f_apdu;
948 bc->release_backend(found_backend);
950 return; // search error
953 if (m_p->m_restart && !session_restarted && new_set->m_result_set_size < 0)
955 package.log("session_shared", YLOG_LOG, "restart");
956 bc->remove_backend(found_backend);
957 session_restarted = true;
958 found_backend.reset();
961 found_backend->m_sets.push_back(found_set);
964 int yf::SessionShared::Frontend::result_set_ref(ODR o,
965 const Databases &databases,
972 case Z_RPNStructure_simple:
973 if (s->u.simple->which == Z_Operand_resultSetId)
975 const char *id = s->u.simple->u.resultSetId;
978 FrontendSets::iterator fset_it = m_frontend_sets.find(id);
979 if (fset_it == m_frontend_sets.end())
981 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
983 else if (fset_it->second->get_databases() != databases)
985 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
989 yazpp_1::Yaz_Z_Query query = fset_it->second->get_query();
990 Z_Query *q = yaz_copy_Z_Query(query.get_Z_Query(), o);
991 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
993 s->which = q->u.type_1->RPNStructure->which;
994 s->u.simple = q->u.type_1->RPNStructure->u.simple;
998 ret = YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
1003 case Z_RPNStructure_complex:
1004 ret = result_set_ref(o, databases, s->u.complex->s1, rset);
1006 ret = result_set_ref(o, databases, s->u.complex->s2, rset);
1012 void yf::SessionShared::Frontend::search(mp::Package &package,
1015 Z_SearchRequest *req = apdu_req->u.searchRequest;
1016 FrontendSets::iterator fset_it =
1017 m_frontend_sets.find(req->resultSetName);
1018 if (fset_it != m_frontend_sets.end())
1020 // result set already exist
1021 // if replace indicator is off: we return diagnostic if
1022 // result set already exist.
1023 if (*req->replaceIndicator == 0)
1027 odr.create_searchResponse(
1029 YAZ_BIB1_RESULT_SET_EXISTS_AND_REPLACE_INDICATOR_OFF,
1031 package.response() = apdu;
1034 m_frontend_sets.erase(fset_it);
1037 Databases databases;
1039 for (i = 0; i < req->num_databaseNames; i++)
1040 databases.push_back(req->databaseNames[i]);
1043 yazpp_1::Yaz_Z_Query query;
1044 query.set_Z_Query(req->query);
1046 Z_Query *q = query.get_Z_Query();
1047 if (q->which == Z_Query_type_1 || q->which == Z_Query_type_101)
1051 int diag = result_set_ref(odr, databases, q->u.type_1->RPNStructure,
1056 odr.create_searchResponse(
1060 package.response() = apdu;
1063 query.set_Z_Query(q);
1066 BackendSetPtr found_set; // null
1067 BackendInstancePtr found_backend; // null
1069 get_set(package, apdu_req, databases, query, found_backend, found_set);
1074 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
1075 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
1076 *f_resp->resultCount = found_set->m_result_set_size;
1077 f_resp->additionalSearchInfo = found_set->additionalSearchInfoResponse;
1078 package.response() = f_apdu;
1080 FrontendSetPtr fset(new FrontendSet(databases, query));
1081 m_frontend_sets[req->resultSetName] = fset;
1083 m_backend_class->release_backend(found_backend);
1086 void yf::SessionShared::Frontend::present(mp::Package &package,
1090 Z_PresentRequest *req = apdu_req->u.presentRequest;
1092 FrontendSets::iterator fset_it =
1093 m_frontend_sets.find(req->resultSetId);
1095 if (fset_it == m_frontend_sets.end())
1098 odr.create_presentResponse(
1100 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1102 package.response() = apdu;
1105 FrontendSetPtr fset = fset_it->second;
1107 Databases databases = fset->get_databases();
1108 yazpp_1::Yaz_Z_Query query = fset->get_query();
1110 BackendClassPtr bc = m_backend_class;
1111 BackendSetPtr found_set; // null
1112 BackendInstancePtr found_backend;
1114 get_set(package, apdu_req, databases, query, found_backend, found_set);
1118 Z_NamePlusRecordList *npr_res = 0;
1119 // record_cache.lookup types are int's. Avoid non-fitting values
1120 if (*req->resultSetStartPoint > 0
1121 && *req->resultSetStartPoint < INT_MAX
1122 && *req->numberOfRecordsRequested > 0
1123 && *req->numberOfRecordsRequested < INT_MAX
1124 && found_set->m_record_cache.lookup(odr, &npr_res,
1125 *req->resultSetStartPoint,
1126 *req->numberOfRecordsRequested,
1127 req->preferredRecordSyntax,
1128 req->recordComposition))
1130 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1131 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1133 yaz_log(YLOG_LOG, "Found " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1134 " records in cache %p",
1135 *req->resultSetStartPoint,
1136 *req->numberOfRecordsRequested,
1137 &found_set->m_record_cache);
1139 *f_resp->numberOfRecordsReturned = *req->numberOfRecordsRequested;
1140 *f_resp->nextResultSetPosition =
1141 *req->resultSetStartPoint + *req->numberOfRecordsRequested;
1142 // f_resp->presentStatus assumed OK.
1143 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
1144 f_resp->records->which = Z_Records_DBOSD;
1145 f_resp->records->u.databaseOrSurDiagnostics = npr_res;
1146 package.response() = f_apdu_res;
1147 bc->release_backend(found_backend);
1151 found_backend->timestamp();
1153 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
1154 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
1155 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1156 p_req->resultSetId = odr_strdup(odr, found_set->m_result_set_id.c_str());
1157 *p_req->resultSetStartPoint = *req->resultSetStartPoint;
1158 *p_req->numberOfRecordsRequested = *req->numberOfRecordsRequested;
1159 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
1160 p_req->recordComposition = req->recordComposition;
1162 Package present_package(found_backend->m_session, package.origin());
1163 present_package.copy_filter(package);
1165 present_package.request() = p_apdu;
1167 present_package.move();
1169 Z_GDU *gdu = present_package.response().get();
1170 if (!present_package.session().is_closed()
1171 && gdu && gdu->which == Z_GDU_Z3950
1172 && gdu->u.z3950->which == Z_APDU_presentResponse)
1174 Z_PresentResponse *b_resp = gdu->u.z3950->u.presentResponse;
1175 Z_APDU *f_apdu_res = odr.create_presentResponse(apdu_req, 0, 0);
1176 Z_PresentResponse *f_resp = f_apdu_res->u.presentResponse;
1178 f_resp->numberOfRecordsReturned = b_resp->numberOfRecordsReturned;
1179 f_resp->nextResultSetPosition = b_resp->nextResultSetPosition;
1180 f_resp->presentStatus= b_resp->presentStatus;
1181 f_resp->records = b_resp->records;
1182 f_resp->otherInfo = b_resp->otherInfo;
1183 package.response() = f_apdu_res;
1185 if (b_resp->records && b_resp->records->which == Z_Records_DBOSD)
1187 Z_NamePlusRecordList *npr =
1188 b_resp->records->u.databaseOrSurDiagnostics;
1189 // record_cache.add types are int's. Avoid non-fitting values
1190 if (*req->resultSetStartPoint > 0
1191 && npr->num_records + *req->resultSetStartPoint < INT_MAX)
1194 yaz_log(YLOG_LOG, "Adding " ODR_INT_PRINTF "+" ODR_INT_PRINTF
1195 " records to cache %p",
1196 *req->resultSetStartPoint,
1197 *f_resp->numberOfRecordsReturned,
1198 &found_set->m_record_cache);
1200 found_set->m_record_cache.add(
1201 odr, npr, *req->resultSetStartPoint,
1202 p_req->recordComposition);
1205 bc->release_backend(found_backend);
1209 bc->remove_backend(found_backend);
1210 Z_APDU *f_apdu_res =
1211 odr.create_presentResponse(
1212 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1213 "session_shared: target closed connection during present");
1214 package.response() = f_apdu_res;
1218 void yf::SessionShared::Frontend::scan(mp::Package &frontend_package,
1221 BackendClassPtr bc = m_backend_class;
1222 BackendInstancePtr backend = bc->get_backend(frontend_package);
1226 Z_APDU *apdu = odr.create_scanResponse(
1227 apdu_req, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1228 "session_shared: could not create backend");
1229 frontend_package.response() = apdu;
1233 Package scan_package(backend->m_session, frontend_package.origin());
1234 backend->timestamp();
1235 scan_package.copy_filter(frontend_package);
1236 scan_package.request() = apdu_req;
1237 scan_package.move();
1238 frontend_package.response() = scan_package.response();
1239 if (scan_package.session().is_closed())
1241 frontend_package.session().close();
1242 bc->remove_backend(backend);
1245 bc->release_backend(backend);
1249 yf::SessionShared::Worker::Worker(SessionShared::Rep *rep) : m_p(rep)
1253 void yf::SessionShared::Worker::operator() (void)
1258 bool yf::SessionShared::BackendClass::expire_instances()
1262 boost::mutex::scoped_lock lock(m_mutex_backend_class);
1263 BackendInstanceList::iterator bit = m_backend_list.begin();
1264 while (bit != m_backend_list.end())
1266 time_t last_use = (*bit)->m_time_last_use;
1268 if ((*bit)->m_in_use)
1272 else if (now < last_use || now - last_use > m_backend_expiry_ttl)
1274 bit = m_backend_list.erase(bit);
1281 if (m_backend_list.empty())
1286 void yf::SessionShared::Rep::expire_classes()
1288 boost::mutex::scoped_lock lock(m_mutex_backend_map);
1289 BackendClassMap::iterator b_it = m_backend_map.begin();
1290 while (b_it != m_backend_map.end())
1292 if (b_it->second->expire_instances())
1294 m_backend_map.erase(b_it);
1295 b_it = m_backend_map.begin();
1302 void yf::SessionShared::Rep::expire()
1307 boost::xtime_get(&xt,
1308 #if BOOST_VERSION >= 105000
1314 xt.sec += m_session_ttl;
1316 boost::mutex::scoped_lock lock(m_mutex);
1317 m_cond_expire_ready.timed_wait(lock, xt);
1326 yf::SessionShared::Rep::Rep()
1328 m_resultset_ttl = 30;
1329 m_resultset_max = 10;
1331 m_optimize_search = true;
1333 m_session_max = 100;
1334 m_preferredMessageSize = 0;
1335 m_maximumRecordSize = 0;
1339 yf::SessionShared::Rep::~Rep()
1342 boost::mutex::scoped_lock lock(m_mutex);
1344 m_cond_expire_ready.notify_all();
1349 void yf::SessionShared::Rep::start()
1351 yf::SessionShared::Worker w(this);
1352 m_thrds.add_thread(new boost::thread(w));
1355 yf::SessionShared::SessionShared() : m_p(new SessionShared::Rep)
1359 yf::SessionShared::~SessionShared() {
1362 void yf::SessionShared::start() const
1367 yf::SessionShared::Frontend::Frontend(Rep *rep) : m_is_virtual(false), m_p(rep)
1371 yf::SessionShared::Frontend::~Frontend()
1375 yf::SessionShared::FrontendPtr yf::SessionShared::Rep::get_frontend(mp::Package &package)
1377 boost::mutex::scoped_lock lock(m_mutex);
1379 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1383 it = m_clients.find(package.session());
1384 if (it == m_clients.end())
1387 if (!it->second->m_in_use)
1389 it->second->m_in_use = true;
1392 m_cond_session_ready.wait(lock);
1394 FrontendPtr f(new Frontend(this));
1395 m_clients[package.session()] = f;
1400 void yf::SessionShared::Rep::release_frontend(mp::Package &package)
1402 boost::mutex::scoped_lock lock(m_mutex);
1403 std::map<mp::Session,yf::SessionShared::FrontendPtr>::iterator it;
1405 it = m_clients.find(package.session());
1406 if (it != m_clients.end())
1408 if (package.session().is_closed())
1410 m_clients.erase(it);
1414 it->second->m_in_use = false;
1416 m_cond_session_ready.notify_all();
1421 void yf::SessionShared::process(mp::Package &package) const
1423 FrontendPtr f = m_p->get_frontend(package);
1425 Z_GDU *gdu = package.request().get();
1427 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
1428 Z_APDU_initRequest && !f->m_is_virtual)
1430 m_p->init(package, gdu, f);
1432 else if (!f->m_is_virtual)
1434 else if (gdu && gdu->which == Z_GDU_Z3950)
1436 Z_APDU *apdu = gdu->u.z3950;
1437 if (apdu->which == Z_APDU_initRequest)
1441 package.response() = odr.create_close(
1443 Z_Close_protocolError,
1446 package.session().close();
1448 else if (apdu->which == Z_APDU_close)
1452 package.response() = odr.create_close(
1454 Z_Close_peerAbort, "received close from client");
1455 package.session().close();
1457 else if (apdu->which == Z_APDU_searchRequest)
1459 f->search(package, apdu);
1461 else if (apdu->which == Z_APDU_presentRequest)
1463 f->present(package, apdu);
1465 else if (apdu->which == Z_APDU_scanRequest)
1467 f->scan(package, apdu);
1473 package.response() = odr.create_close(
1474 apdu, Z_Close_protocolError,
1475 "unsupported APDU in filter_session_shared");
1477 package.session().close();
1480 m_p->release_frontend(package);
1483 void yf::SessionShared::configure(const xmlNode *ptr, bool test_only,
1486 for (ptr = ptr->children; ptr; ptr = ptr->next)
1488 if (ptr->type != XML_ELEMENT_NODE)
1490 if (!strcmp((const char *) ptr->name, "resultset"))
1492 const struct _xmlAttr *attr;
1493 for (attr = ptr->properties; attr; attr = attr->next)
1495 if (!strcmp((const char *) attr->name, "ttl"))
1496 m_p->m_resultset_ttl =
1497 mp::xml::get_int(attr->children, 30);
1498 else if (!strcmp((const char *) attr->name, "max"))
1500 m_p->m_resultset_max =
1501 mp::xml::get_int(attr->children, 10);
1503 else if (!strcmp((const char *) attr->name, "optimizesearch"))
1505 m_p->m_optimize_search =
1506 mp::xml::get_bool(attr->children, true);
1508 else if (!strcmp((const char *) attr->name, "restart"))
1510 m_p->m_restart = mp::xml::get_bool(attr->children, true);
1513 throw mp::filter::FilterException(
1514 "Bad attribute " + std::string((const char *)
1518 else if (!strcmp((const char *) ptr->name, "session"))
1520 const struct _xmlAttr *attr;
1521 for (attr = ptr->properties; attr; attr = attr->next)
1523 if (!strcmp((const char *) attr->name, "ttl"))
1524 m_p->m_session_ttl =
1525 mp::xml::get_int(attr->children, 90);
1526 else if (!strcmp((const char *) attr->name, "max"))
1527 m_p->m_session_max =
1528 mp::xml::get_int(attr->children, 100);
1530 throw mp::filter::FilterException(
1531 "Bad attribute " + std::string((const char *)
1535 else if (!strcmp((const char *) ptr->name, "init"))
1537 const struct _xmlAttr *attr;
1538 for (attr = ptr->properties; attr; attr = attr->next)
1540 if (!strcmp((const char *) attr->name, "maximum-record-size"))
1541 m_p->m_maximumRecordSize =
1542 mp::xml::get_int(attr->children, 0);
1543 else if (!strcmp((const char *) attr->name,
1544 "preferred-message-size"))
1545 m_p->m_preferredMessageSize =
1546 mp::xml::get_int(attr->children, 0);
1548 throw mp::filter::FilterException(
1549 "Bad attribute " + std::string((const char *)
1555 throw mp::filter::FilterException("Bad element "
1556 + std::string((const char *)
1562 static mp::filter::Base* filter_creator()
1564 return new mp::filter::SessionShared;
1568 struct metaproxy_1_filter_struct metaproxy_1_filter_session_shared = {
1578 * c-file-style: "Stroustrup"
1579 * indent-tabs-mode: nil
1581 * vim: shiftwidth=4 tabstop=8 expandtab