1 /* $Id: filter_multi.cpp,v 1.6 2006-01-17 18:55:55 adam Exp $
2 Copyright (c) 2005, Index Data.
10 #include "package.hpp"
12 #include <boost/thread/thread.hpp>
13 #include <boost/thread/mutex.hpp>
14 #include <boost/thread/condition.hpp>
15 #include <boost/shared_ptr.hpp>
18 #include "filter_multi.hpp"
21 #include <yaz/otherinfo.h>
22 #include <yaz/diagbib1.h>
27 namespace yf = yp2::filter;
32 struct Multi::BackendSet {
35 bool operator < (const BackendSet &k) const;
37 struct Multi::FrontendSet {
43 FrontendSet(std::string setname);
47 void round_robin(int pos, int number, std::list<PresentJob> &job);
49 std::list<BackendSet> m_backend_sets;
50 std::string m_setname;
52 struct Multi::Backend {
54 std::string m_backend_database;
57 void operator() (void); // thread operation
59 struct Multi::Frontend {
64 std::list<BackendPtr> m_backend_list;
65 std::map<std::string,Multi::FrontendSet> m_sets;
67 void multi_move(std::list<BackendPtr> &blist);
68 void init(Package &package, Z_GDU *gdu);
69 void close(Package &package);
70 void search(Package &package, Z_APDU *apdu);
71 void present(Package &package, Z_APDU *apdu);
72 void scan(Package &package, Z_APDU *apdu);
76 Map(std::list<std::string> hosts, std::string route);
78 std::list<std::string> m_hosts;
83 friend class Frontend;
85 FrontendPtr get_frontend(Package &package);
86 void release_frontend(Package &package);
88 boost::mutex m_sessions_mutex;
89 std::map<std::string, Multi::Map>m_maps;
92 boost::condition m_cond_session_ready;
93 std::map<yp2::Session, FrontendPtr> m_clients;
100 bool yf::Multi::BackendSet::operator < (const BackendSet &k) const
102 return m_count < k.m_count;
105 yf::Multi::Frontend::Frontend(Rep *rep)
111 yf::Multi::Frontend::~Frontend()
115 yf::Multi::FrontendPtr yf::Multi::Rep::get_frontend(Package &package)
117 boost::mutex::scoped_lock lock(m_mutex);
119 std::map<yp2::Session,yf::Multi::FrontendPtr>::iterator it;
123 it = m_clients.find(package.session());
124 if (it == m_clients.end())
127 if (!it->second->m_in_use)
129 it->second->m_in_use = true;
132 m_cond_session_ready.wait(lock);
134 FrontendPtr f(new Frontend(this));
135 m_clients[package.session()] = f;
140 void yf::Multi::Rep::release_frontend(Package &package)
142 boost::mutex::scoped_lock lock(m_mutex);
143 std::map<yp2::Session,yf::Multi::FrontendPtr>::iterator it;
145 it = m_clients.find(package.session());
146 if (it != m_clients.end())
148 if (package.session().is_closed())
150 it->second->close(package);
155 it->second->m_in_use = false;
157 m_cond_session_ready.notify_all();
161 yf::Multi::FrontendSet::FrontendSet(std::string setname)
167 yf::Multi::FrontendSet::FrontendSet()
172 yf::Multi::FrontendSet::~FrontendSet()
176 yf::Multi::Map::Map(std::list<std::string> hosts, std::string route)
177 : m_hosts(hosts), m_route(route)
181 yf::Multi::Map::Map()
185 yf::Multi::Multi() : m_p(new Multi::Rep)
189 yf::Multi::~Multi() {
193 void yf::Multi::add_map_host2hosts(std::string host,
194 std::list<std::string> hosts,
197 m_p->m_maps[host] = Multi::Map(hosts, route);
200 void yf::Multi::Backend::operator() (void)
202 m_package->move(m_route);
205 void yf::Multi::Frontend::close(Package &package)
207 std::list<BackendPtr>::const_iterator bit;
208 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
212 b->m_package->copy_filter(package);
213 b->m_package->request() = (Z_GDU *) 0;
214 b->m_package->session().close();
215 b->m_package->move(b->m_route);
219 void yf::Multi::Frontend::multi_move(std::list<BackendPtr> &blist)
221 std::list<BackendPtr>::const_iterator bit;
222 boost::thread_group g;
223 for (bit = blist.begin(); bit != blist.end(); bit++)
225 g.add_thread(new boost::thread(**bit));
231 void yf::Multi::FrontendSet::round_robin(int start, int number,
232 std::list<PresentJob> &jobs)
239 std::list<int> inside_pos;
240 std::list<BackendSet>::const_iterator bsit;
241 for (bsit = m_backend_sets.begin(); bsit != m_backend_sets.end(); bsit++)
244 inside_pos.push_back(0);
247 std::list<int>::iterator psit = pos.begin();
248 std::list<int>::iterator esit = inside_pos.begin();
249 bsit = m_backend_sets.begin();
250 while (fetched < number)
252 if (bsit == m_backend_sets.end())
255 esit = inside_pos.begin();
256 bsit = m_backend_sets.begin();
261 if (*psit <= bsit->m_count)
266 job.m_backend = bsit->m_backend;
268 job.m_inside_pos = *esit;
283 void yf::Multi::Frontend::init(Package &package, Z_GDU *gdu)
285 Z_InitRequest *req = gdu->u.z3950->u.initRequest;
287 std::list<std::string> targets;
289 yp2::util::get_vhost_otherinfo(&req->otherInfo, false, targets);
291 if (targets.size() < 1)
297 std::list<std::string>::const_iterator t_it = targets.begin();
298 for (; t_it != targets.end(); t_it++)
301 Backend *b = new Backend;
305 b->m_package = PackagePtr(new Package(s, package.origin()));
307 m_backend_list.push_back(BackendPtr(b));
311 // create init request
312 std::list<BackendPtr>::const_iterator bit;
313 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
317 Z_APDU *init_apdu = zget_APDU(odr, Z_APDU_initRequest);
319 yaz_oi_set_string_oidval(&init_apdu->u.initRequest->otherInfo, odr,
320 VAL_PROXY, 1, b->m_vhost.c_str());
322 Z_InitRequest *req = init_apdu->u.initRequest;
324 ODR_MASK_SET(req->options, Z_Options_search);
325 ODR_MASK_SET(req->options, Z_Options_present);
326 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
327 ODR_MASK_SET(req->options, Z_Options_scan);
329 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
330 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
331 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
333 b->m_package->request() = init_apdu;
335 b->m_package->copy_filter(package);
337 multi_move(m_backend_list);
339 // create the frontend init response based on each backend init response
342 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
343 Z_InitResponse *f_resp = f_apdu->u.initResponse;
345 ODR_MASK_SET(f_resp->options, Z_Options_search);
346 ODR_MASK_SET(f_resp->options, Z_Options_present);
347 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
349 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
350 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
351 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
353 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
355 PackagePtr p = (*bit)->m_package;
357 if (p->session().is_closed()) // if any backend closes, close frontend
358 package.session().close();
359 Z_GDU *gdu = p->response().get();
360 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
364 Z_APDU *b_apdu = gdu->u.z3950;
365 Z_InitResponse *b_resp = b_apdu->u.initResponse;
367 // common options for all backends
368 for (i = 0; i <= Z_Options_stringSchema; i++)
370 if (!ODR_MASK_GET(b_resp->options, i))
371 ODR_MASK_CLEAR(f_resp->options, i);
373 // common protocol version
374 for (i = 0; i <= Z_ProtocolVersion_3; i++)
375 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
376 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
377 // reject if any of the backends reject
378 if (!*b_resp->result)
383 // if any target does not return init return that (close or
385 package.response() = p->response();
389 package.response() = f_apdu;
392 void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
394 // create search request
395 Z_SearchRequest *req = apdu_req->u.searchRequest;
397 // save these for later
398 int smallSetUpperBound = *req->smallSetUpperBound;
399 int largeSetLowerBound = *req->largeSetLowerBound;
400 int mediumSetPresentNumber = *req->mediumSetPresentNumber;
402 // they are altered now - to disable piggyback
403 *req->smallSetUpperBound = 0;
404 *req->largeSetLowerBound = 1;
405 *req->mediumSetPresentNumber = 1;
407 int default_num_db = req->num_databaseNames;
408 char **default_db = req->databaseNames;
410 std::list<BackendPtr>::const_iterator bit;
411 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
413 PackagePtr p = (*bit)->m_package;
416 if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
417 &req->num_databaseNames,
418 &req->databaseNames))
420 req->num_databaseNames = default_num_db;
421 req->databaseNames = default_db;
423 p->request() = apdu_req;
424 p->copy_filter(package);
426 multi_move(m_backend_list);
428 // look at each response
429 FrontendSet resultSet(std::string(req->resultSetName));
431 int result_set_size = 0;
432 Z_Records *z_records_diag = 0; // no diagnostics (yet)
433 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
435 PackagePtr p = (*bit)->m_package;
437 if (p->session().is_closed()) // if any backend closes, close frontend
438 package.session().close();
440 Z_GDU *gdu = p->response().get();
441 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
442 Z_APDU_searchResponse)
444 Z_APDU *b_apdu = gdu->u.z3950;
445 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
447 // see we get any errors (AKA diagnstics)
450 if (b_resp->records->which == Z_Records_NSD
451 || b_resp->records->which == Z_Records_multipleNSD)
452 z_records_diag = b_resp->records;
453 // we may set this multiple times (TOO BAD!)
455 BackendSet backendSet;
456 backendSet.m_backend = *bit;
457 backendSet.m_count = *b_resp->resultCount;
458 result_set_size += *b_resp->resultCount;
459 resultSet.m_backend_sets.push_back(backendSet);
463 // if any target does not return search response - return that
464 package.response() = p->response();
470 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
471 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
473 *f_resp->resultCount = result_set_size;
477 f_resp->records = z_records_diag;
478 package.response() = f_apdu;
482 m_sets[resultSet.m_setname] = resultSet;
485 yp2::util::piggyback(smallSetUpperBound,
487 mediumSetPresentNumber,
490 Package pp(package.session(), package.origin());
493 pp.copy_filter(package);
494 Z_APDU *p_apdu = zget_APDU(odr, Z_APDU_presentRequest);
495 Z_PresentRequest *p_req = p_apdu->u.presentRequest;
496 p_req->preferredRecordSyntax = req->preferredRecordSyntax;
497 p_req->resultSetId = req->resultSetName;
498 *p_req->resultSetStartPoint = 1;
499 *p_req->numberOfRecordsRequested = number;
500 pp.request() = p_apdu;
503 if (pp.session().is_closed())
504 package.session().close();
506 Z_GDU *gdu = pp.response().get();
507 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
508 Z_APDU_presentResponse)
510 Z_PresentResponse *p_res = gdu->u.z3950->u.presentResponse;
511 f_resp->records = p_res->records;
512 *f_resp->numberOfRecordsReturned =
513 *p_res->numberOfRecordsReturned;
514 *f_resp->nextResultSetPosition =
515 *p_res->nextResultSetPosition;
519 package.response() = pp.response();
523 package.response() = f_apdu; // in this scope because of p
526 void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
528 // create present request
529 Z_PresentRequest *req = apdu_req->u.presentRequest;
532 it = m_sets.find(std::string(req->resultSetId));
533 if (it == m_sets.end())
537 odr.create_presentResponse(
539 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
541 package.response() = apdu;
544 std::list<Multi::FrontendSet::PresentJob> jobs;
545 int start = *req->resultSetStartPoint;
546 int number = *req->numberOfRecordsRequested;
547 it->second.round_robin(start, number, jobs);
549 std::list<BackendPtr> present_backend_list;
551 std::list<BackendSet>::const_iterator bsit;
552 bsit = it->second.m_backend_sets.begin();
553 for (; bsit != it->second.m_backend_sets.end(); bsit++)
555 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
559 for (jit = jobs.begin(); jit != jobs.end(); jit++)
561 if (jit->m_backend == bsit->m_backend)
563 if (start == -1 || jit->m_pos < start)
565 if (end == -1 || jit->m_pos > end)
571 PackagePtr p = bsit->m_backend->m_package;
573 *req->resultSetStartPoint = start;
574 *req->numberOfRecordsRequested = end - start + 1;
576 p->request() = apdu_req;
577 p->copy_filter(package);
579 present_backend_list.push_back(bsit->m_backend);
582 multi_move(present_backend_list);
584 // look at each response
585 Z_Records *z_records_diag = 0;
587 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
588 for (; pbit != present_backend_list.end(); pbit++)
590 PackagePtr p = (*pbit)->m_package;
592 if (p->session().is_closed()) // if any backend closes, close frontend
593 package.session().close();
595 Z_GDU *gdu = p->response().get();
596 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
597 Z_APDU_presentResponse)
599 Z_APDU *b_apdu = gdu->u.z3950;
600 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
602 // see we get any errors (AKA diagnstics)
605 if (b_resp->records->which != Z_Records_DBOSD)
606 z_records_diag = b_resp->records;
607 // we may set this multiple times (TOO BAD!)
612 // if any target does not return present response - return that
613 package.response() = p->response();
619 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
620 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
624 f_resp->records = z_records_diag;
625 *f_resp->presentStatus = Z_PresentStatus_failure;
629 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
630 Z_Records * records = f_resp->records;
631 records->which = Z_Records_DBOSD;
632 records->u.databaseOrSurDiagnostics =
633 (Z_NamePlusRecordList *)
634 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
635 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
636 nprl->num_records = jobs.size();
637 nprl->records = (Z_NamePlusRecord**)
638 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
640 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
641 for (jit = jobs.begin(); jit != jobs.end(); jit++)
643 PackagePtr p = jit->m_backend->m_package;
645 Z_GDU *gdu = p->response().get();
646 Z_APDU *b_apdu = gdu->u.z3950;
647 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
650 b_resp->records->u.databaseOrSurDiagnostics->
651 records[jit->m_inside_pos];
653 *f_resp->nextResultSetPosition = start + i;
654 *f_resp->numberOfRecordsReturned = i;
656 package.response() = f_apdu;
659 void yf::Multi::Frontend::scan(Package &package, Z_APDU *apdu_req)
661 if (m_backend_list.size() > 1)
665 odr.create_scanResponse(
666 apdu_req, YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP, 0);
667 package.response() = f_apdu;
670 Z_ScanRequest *req = apdu_req->u.scanRequest;
672 int default_num_db = req->num_databaseNames;
673 char **default_db = req->databaseNames;
675 std::list<BackendPtr>::const_iterator bit;
676 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
678 PackagePtr p = (*bit)->m_package;
681 if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
682 &req->num_databaseNames,
683 &req->databaseNames))
685 req->num_databaseNames = default_num_db;
686 req->databaseNames = default_db;
688 p->request() = apdu_req;
689 p->copy_filter(package);
691 multi_move(m_backend_list);
693 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
695 PackagePtr p = (*bit)->m_package;
697 if (p->session().is_closed()) // if any backend closes, close frontend
698 package.session().close();
700 Z_GDU *gdu = p->response().get();
701 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
704 package.response() = p->response();
709 // if any target does not return scan response - return that
710 package.response() = p->response();
716 void yf::Multi::process(Package &package) const
718 FrontendPtr f = m_p->get_frontend(package);
720 Z_GDU *gdu = package.request().get();
722 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
723 Z_APDU_initRequest && !f->m_is_multi)
725 f->init(package, gdu);
727 else if (!f->m_is_multi)
729 else if (gdu && gdu->which == Z_GDU_Z3950)
731 Z_APDU *apdu = gdu->u.z3950;
732 if (apdu->which == Z_APDU_initRequest)
736 package.response() = odr.create_close(
738 Z_Close_protocolError,
741 package.session().close();
743 else if (apdu->which == Z_APDU_searchRequest)
745 f->search(package, apdu);
747 else if (apdu->which == Z_APDU_presentRequest)
749 f->present(package, apdu);
751 else if (apdu->which == Z_APDU_scanRequest)
753 f->scan(package, apdu);
759 package.response() = odr.create_close(
760 apdu, Z_Close_protocolError,
761 "unsupported APDU in filter multi");
763 package.session().close();
766 m_p->release_frontend(package);
769 void yp2::filter::Multi::configure(const xmlNode * ptr)
771 for (ptr = ptr->children; ptr; ptr = ptr->next)
773 if (ptr->type != XML_ELEMENT_NODE)
775 if (!strcmp((const char *) ptr->name, "virtual"))
777 std::list<std::string> targets;
779 xmlNode *v_node = ptr->children;
780 for (; v_node; v_node = v_node->next)
782 if (v_node->type != XML_ELEMENT_NODE)
785 if (yp2::xml::is_element_yp2(v_node, "vhost"))
786 vhost = yp2::xml::get_text(v_node);
787 else if (yp2::xml::is_element_yp2(v_node, "target"))
788 targets.push_back(yp2::xml::get_text(v_node));
790 throw yp2::filter::FilterException
792 + std::string((const char *) v_node->name)
793 + " in virtual section"
796 std::string route = yp2::xml::get_route(ptr);
797 add_map_host2hosts(vhost, targets, route);
798 std::list<std::string>::const_iterator it;
799 for (it = targets.begin(); it != targets.end(); it++)
801 std::cout << "Add " << vhost << "->" << *it
802 << "," << route << "\n";
807 throw yp2::filter::FilterException
809 + std::string((const char *) ptr->name)
810 + " in virt_db filter");
815 static yp2::filter::Base* filter_creator()
817 return new yp2::filter::Multi;
821 struct yp2_filter_struct yp2_filter_multi = {
832 * indent-tabs-mode: nil
833 * c-file-style: "stroustrup"
835 * vim: shiftwidth=4 tabstop=8 expandtab