1 /* $Id: filter_multi.cpp,v 1.4 2006-01-17 13:34:51 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 {
62 yp2::Session m_session;
65 std::list<BackendPtr> m_backend_list;
66 std::map<std::string,Multi::FrontendSet> m_sets;
68 void multi_move(std::list<BackendPtr> &blist);
69 void init(Package &package, Z_GDU *gdu);
70 void close(Package &package);
71 void search(Package &package, Z_APDU *apdu);
72 void present(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);
328 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
329 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
330 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
332 b->m_package->request() = init_apdu;
334 b->m_package->copy_filter(package);
336 multi_move(m_backend_list);
338 // create the frontend init response based on each backend init response
341 Z_APDU *f_apdu = odr.create_initResponse(gdu->u.z3950, 0, 0);
342 Z_InitResponse *f_resp = f_apdu->u.initResponse;
344 ODR_MASK_SET(f_resp->options, Z_Options_search);
345 ODR_MASK_SET(f_resp->options, Z_Options_present);
346 ODR_MASK_SET(f_resp->options, Z_Options_namedResultSets);
348 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_1);
349 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_2);
350 ODR_MASK_SET(f_resp->protocolVersion, Z_ProtocolVersion_3);
352 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
354 PackagePtr p = (*bit)->m_package;
356 if (p->session().is_closed()) // if any backend closes, close frontend
357 package.session().close();
358 Z_GDU *gdu = p->response().get();
359 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
363 Z_APDU *b_apdu = gdu->u.z3950;
364 Z_InitResponse *b_resp = b_apdu->u.initResponse;
366 // common options for all backends
367 for (i = 0; i <= Z_Options_stringSchema; i++)
369 if (!ODR_MASK_GET(b_resp->options, i))
370 ODR_MASK_CLEAR(f_resp->options, i);
372 // common protocol version
373 for (i = 0; i <= Z_ProtocolVersion_3; i++)
374 if (!ODR_MASK_GET(b_resp->protocolVersion, i))
375 ODR_MASK_CLEAR(f_resp->protocolVersion, i);
376 // reject if any of the backends reject
377 if (!*b_resp->result)
382 // if any target does not return init return that (close or
384 package.response() = p->response();
388 package.response() = f_apdu;
391 void yf::Multi::Frontend::search(Package &package, Z_APDU *apdu_req)
393 // create search request
394 Z_SearchRequest *req = apdu_req->u.searchRequest;
396 // deal with piggy back (for now disable)
397 *req->smallSetUpperBound = 0;
398 *req->largeSetLowerBound = 1;
399 *req->mediumSetPresentNumber = 1;
401 int default_num_db = req->num_databaseNames;
402 char **default_db = req->databaseNames;
404 std::list<BackendPtr>::const_iterator bit;
405 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
407 PackagePtr p = (*bit)->m_package;
410 if (!yp2::util::set_databases_from_zurl(odr, (*bit)->m_vhost,
411 &req->num_databaseNames,
412 &req->databaseNames))
414 req->num_databaseNames = default_num_db;
415 req->databaseNames = default_db;
417 p->request() = apdu_req;
418 p->copy_filter(package);
420 multi_move(m_backend_list);
422 // look at each response
423 FrontendSet resultSet(std::string(req->resultSetName));
426 Z_Records *z_records_diag = 0; // no diagnostics (yet)
427 for (bit = m_backend_list.begin(); bit != m_backend_list.end(); bit++)
429 PackagePtr p = (*bit)->m_package;
431 if (p->session().is_closed()) // if any backend closes, close frontend
432 package.session().close();
434 Z_GDU *gdu = p->response().get();
435 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
436 Z_APDU_searchResponse)
438 Z_APDU *b_apdu = gdu->u.z3950;
439 Z_SearchResponse *b_resp = b_apdu->u.searchResponse;
441 // see we get any errors (AKA diagnstics)
444 if (b_resp->records->which == Z_Records_NSD
445 || b_resp->records->which == Z_Records_multipleNSD)
446 z_records_diag = b_resp->records;
447 // we may set this multiple times (TOO BAD!)
449 BackendSet backendSet;
450 backendSet.m_backend = *bit;
451 backendSet.m_count = *b_resp->resultCount;
452 total_count += *b_resp->resultCount;
453 resultSet.m_backend_sets.push_back(backendSet);
457 // if any target does not return search response - return that
458 package.response() = p->response();
464 Z_APDU *f_apdu = odr.create_searchResponse(apdu_req, 0, 0);
465 Z_SearchResponse *f_resp = f_apdu->u.searchResponse;
470 f_resp->records = z_records_diag;
474 m_sets[resultSet.m_setname] = resultSet;
476 *f_resp->resultCount = total_count;
478 package.response() = f_apdu;
481 void yf::Multi::Frontend::present(Package &package, Z_APDU *apdu_req)
483 // create present request
484 Z_PresentRequest *req = apdu_req->u.presentRequest;
487 it = m_sets.find(std::string(req->resultSetId));
488 if (it == m_sets.end())
492 odr.create_presentResponse(
494 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
496 package.response() = apdu;
499 std::list<Multi::FrontendSet::PresentJob> jobs;
500 int start = *req->resultSetStartPoint;
501 int number = *req->numberOfRecordsRequested;
502 it->second.round_robin(start, number, jobs);
504 std::list<BackendPtr> present_backend_list;
506 std::list<BackendSet>::const_iterator bsit;
507 bsit = it->second.m_backend_sets.begin();
508 for (; bsit != it->second.m_backend_sets.end(); bsit++)
510 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
514 for (jit = jobs.begin(); jit != jobs.end(); jit++)
516 if (jit->m_backend == bsit->m_backend)
518 if (start == -1 || jit->m_pos < start)
520 if (end == -1 || jit->m_pos > end)
526 PackagePtr p = bsit->m_backend->m_package;
528 *req->resultSetStartPoint = start;
529 *req->numberOfRecordsRequested = end - start + 1;
531 p->request() = apdu_req;
532 p->copy_filter(package);
534 present_backend_list.push_back(bsit->m_backend);
537 multi_move(present_backend_list);
539 // look at each response
540 Z_Records *z_records_diag = 0;
542 std::list<BackendPtr>::const_iterator pbit = present_backend_list.begin();
543 for (; pbit != present_backend_list.end(); pbit++)
545 PackagePtr p = (*pbit)->m_package;
547 if (p->session().is_closed()) // if any backend closes, close frontend
548 package.session().close();
550 Z_GDU *gdu = p->response().get();
551 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
552 Z_APDU_presentResponse)
554 Z_APDU *b_apdu = gdu->u.z3950;
555 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
557 // see we get any errors (AKA diagnstics)
560 if (b_resp->records->which != Z_Records_DBOSD)
561 z_records_diag = b_resp->records;
562 // we may set this multiple times (TOO BAD!)
567 // if any target does not return present response - return that
568 package.response() = p->response();
574 Z_APDU *f_apdu = odr.create_presentResponse(apdu_req, 0, 0);
575 Z_PresentResponse *f_resp = f_apdu->u.presentResponse;
579 f_resp->records = z_records_diag;
580 *f_resp->presentStatus = Z_PresentStatus_failure;
584 f_resp->records = (Z_Records *) odr_malloc(odr, sizeof(Z_Records));
585 Z_Records * records = f_resp->records;
586 records->which = Z_Records_DBOSD;
587 records->u.databaseOrSurDiagnostics =
588 (Z_NamePlusRecordList *)
589 odr_malloc(odr, sizeof(Z_NamePlusRecordList));
590 Z_NamePlusRecordList *nprl = records->u.databaseOrSurDiagnostics;
591 nprl->num_records = jobs.size();
592 nprl->records = (Z_NamePlusRecord**)
593 odr_malloc(odr, sizeof(Z_NamePlusRecord *) * nprl->num_records);
595 std::list<Multi::FrontendSet::PresentJob>::const_iterator jit;
596 for (jit = jobs.begin(); jit != jobs.end(); jit++)
598 PackagePtr p = jit->m_backend->m_package;
600 Z_GDU *gdu = p->response().get();
601 Z_APDU *b_apdu = gdu->u.z3950;
602 Z_PresentResponse *b_resp = b_apdu->u.presentResponse;
605 b_resp->records->u.databaseOrSurDiagnostics->
606 records[jit->m_inside_pos];
608 *f_resp->nextResultSetPosition = start + i;
609 *f_resp->numberOfRecordsReturned = i;
611 package.response() = f_apdu;
614 void yf::Multi::process(Package &package) const
616 FrontendPtr f = m_p->get_frontend(package);
618 Z_GDU *gdu = package.request().get();
620 if (gdu && gdu->which == Z_GDU_Z3950 && gdu->u.z3950->which ==
621 Z_APDU_initRequest && !f->m_is_multi)
623 f->init(package, gdu);
625 else if (!f->m_is_multi)
627 else if (gdu && gdu->which == Z_GDU_Z3950)
629 Z_APDU *apdu = gdu->u.z3950;
630 if (apdu->which == Z_APDU_initRequest)
634 package.response() = odr.create_close(
636 Z_Close_protocolError,
639 package.session().close();
641 else if (apdu->which == Z_APDU_searchRequest)
643 f->search(package, apdu);
645 else if (apdu->which == Z_APDU_presentRequest)
647 f->present(package, apdu);
653 package.response() = odr.create_close(
654 apdu, Z_Close_protocolError,
655 "unsupported APDU in filter multi");
657 package.session().close();
660 m_p->release_frontend(package);
663 void yp2::filter::Multi::configure(const xmlNode * ptr)
665 for (ptr = ptr->children; ptr; ptr = ptr->next)
667 if (ptr->type != XML_ELEMENT_NODE)
669 if (!strcmp((const char *) ptr->name, "virtual"))
671 std::list<std::string> targets;
673 xmlNode *v_node = ptr->children;
674 for (; v_node; v_node = v_node->next)
676 if (v_node->type != XML_ELEMENT_NODE)
679 if (yp2::xml::is_element_yp2(v_node, "vhost"))
680 vhost = yp2::xml::get_text(v_node);
681 else if (yp2::xml::is_element_yp2(v_node, "target"))
682 targets.push_back(yp2::xml::get_text(v_node));
684 throw yp2::filter::FilterException
686 + std::string((const char *) v_node->name)
687 + " in virtual section"
690 std::string route = yp2::xml::get_route(ptr);
691 add_map_host2hosts(vhost, targets, route);
692 std::list<std::string>::const_iterator it;
693 for (it = targets.begin(); it != targets.end(); it++)
695 std::cout << "Add " << vhost << "->" << *it
696 << "," << route << "\n";
701 throw yp2::filter::FilterException
703 + std::string((const char *) ptr->name)
704 + " in virt_db filter");
709 static yp2::filter::Base* filter_creator()
711 return new yp2::filter::Multi;
715 struct yp2_filter_struct yp2_filter_multi = {
726 * indent-tabs-mode: nil
727 * c-file-style: "stroustrup"
729 * vim: shiftwidth=4 tabstop=8 expandtab