1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 Index Data
4 Pazpar2 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 Pazpar2 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
20 /** \file connection.c
21 \brief Z39.50 connection (low-level client)
42 #include <yaz/comstack.h>
43 #include <yaz/tcpip.h>
44 #include "connection.h"
50 /* connection counting (1) , disable connection counting (0) */
52 static YAZ_MUTEX g_mutex = 0;
53 static int no_connections = 0;
54 static int total_no_connections = 0;
56 static int connection_use(int delta)
60 yaz_mutex_create(&g_mutex);
61 yaz_mutex_enter(g_mutex);
62 no_connections += delta;
63 result = no_connections;
65 total_no_connections += delta;
66 yaz_mutex_leave(g_mutex);
69 yaz_log(YLOG_LOG, "%s connections=%d", delta > 0 ? "INC" : "DEC",
74 int connections_count(void)
76 return connection_use(0);
81 #define connection_use(x)
82 #define connections_count(x) 0
83 #define connections_count_total(x) 0
87 /** \brief Represents a physical, reusable connection to a remote Z39.50 host
93 struct client *client;
100 int operation_timeout;
102 struct connection *next; // next for same host or next in free list
105 static int connection_connect(struct connection *con, iochan_man_t iochan_man);
107 static int connection_is_idle(struct connection *co)
109 ZOOM_connection link = co->link;
112 if (co->state != Conn_Open || !link)
115 if (!ZOOM_connection_is_idle(link))
117 event = ZOOM_connection_peek_event(link);
118 if (event == ZOOM_EVENT_NONE)
124 ZOOM_connection connection_get_link(struct connection *co)
129 static void remove_connection_from_host(struct connection *con)
131 struct connection **conp = &con->host->connections;
137 *conp = (*conp)->next;
140 conp = &(*conp)->next;
142 yaz_cond_broadcast(con->host->cond_ready);
145 // Close connection and recycle structure
146 static void connection_destroy(struct connection *co)
150 ZOOM_connection_destroy(co->link);
151 iochan_destroy(co->iochan);
153 yaz_log(YLOG_DEBUG, "%p Connection destroy %s", co, co->host->url);
157 client_disconnect(co->client);
165 // Creates a new connection for client, associated with the host of
167 static struct connection *connection_create(struct client *cl,
169 int operation_timeout,
171 iochan_man_t iochan_man)
173 struct connection *co;
175 co = xmalloc(sizeof(*co));
180 client_set_connection(cl, co);
182 co->state = Conn_Closed;
183 co->operation_timeout = operation_timeout;
184 co->session_timeout = session_timeout;
187 connection_connect(co, iochan_man);
189 yaz_mutex_enter(host->mutex);
190 co->next = co->host->connections;
191 co->host->connections = co;
192 yaz_mutex_leave(host->mutex);
198 static void non_block_events(struct connection *co)
201 IOCHAN iochan = co->iochan;
202 ZOOM_connection link = co->link;
205 struct client *cl = co->client;
207 int r = ZOOM_event_nonblock(1, &link);
212 ev = ZOOM_connection_last_event(link);
215 yaz_log(YLOG_DEBUG, "%p Connection ZOOM_EVENT_%s", co, ZOOM_get_event_str(ev));
219 case ZOOM_EVENT_TIMEOUT:
223 const char *error, *addinfo;
225 if ((err = ZOOM_connection_error(link, &error, &addinfo)))
227 yaz_log(YLOG_LOG, "Error %s from %s",
228 error, client_get_id(cl));
229 client_set_diagnostic(cl, err, error, addinfo);
230 client_set_state(cl, Client_Error);
234 iochan_settimeout(iochan, co->session_timeout);
235 client_set_state(cl, Client_Idle);
237 yaz_cond_broadcast(co->host->cond_ready);
240 case ZOOM_EVENT_SEND_DATA:
242 case ZOOM_EVENT_RECV_DATA:
244 case ZOOM_EVENT_UNKNOWN:
246 case ZOOM_EVENT_SEND_APDU:
247 client_set_state(co->client, Client_Working);
248 iochan_settimeout(iochan, co->operation_timeout);
250 case ZOOM_EVENT_RECV_APDU:
252 case ZOOM_EVENT_CONNECT:
253 yaz_log(YLOG_LOG, "Connected to %s", client_get_id(cl));
254 co->state = Conn_Open;
256 case ZOOM_EVENT_RECV_SEARCH:
257 client_search_response(cl);
259 case ZOOM_EVENT_RECV_RECORD:
260 client_record_response(cl);
264 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
265 ev, client_get_id(cl));
271 struct client *cl = co->client;
274 client_check_preferred_watch(cl);
275 client_got_records(cl);
280 void connection_continue(struct connection *co)
282 int r = ZOOM_connection_exec_task(co->link);
285 const char *error, *addinfo;
287 if ((err = ZOOM_connection_error(co->link, &error, &addinfo)))
291 yaz_log(YLOG_LOG, "Error %s from %s",
292 error, client_get_id(co->client));
293 client_set_diagnostic(co->client, err, error, addinfo);
294 client_set_state_nb(co->client, Client_Error);
300 iochan_setflags(co->iochan, ZOOM_connection_get_mask(co->link));
301 iochan_setfd(co->iochan, ZOOM_connection_get_socket(co->link));
305 static void connection_handler(IOCHAN iochan, int event)
307 struct connection *co = iochan_getdata(iochan);
309 struct host *host = co->host;
311 yaz_mutex_enter(host->mutex);
315 /* no client associated with it.. We are probably getting
316 a closed connection from the target.. Or, perhaps, an unexpected
317 package.. We will just close the connection */
318 yaz_log(YLOG_LOG, "timeout connection %p event=%d", co, event);
319 remove_connection_from_host(co);
320 yaz_mutex_leave(host->mutex);
321 connection_destroy(co);
323 else if (event & EVENT_TIMEOUT)
325 ZOOM_connection_fire_event_timeout(co->link);
327 non_block_events(co);
330 remove_connection_from_host(co);
331 yaz_mutex_leave(host->mutex);
332 connection_destroy(co);
336 yaz_mutex_leave(host->mutex);
339 non_block_events(co);
341 ZOOM_connection_fire_event_socket(co->link, event);
343 non_block_events(co);
348 iochan_setflags(iochan, ZOOM_connection_get_mask(co->link));
349 iochan_setfd(iochan, ZOOM_connection_get_socket(co->link));
355 // Disassociate connection from client
356 static void connection_release(struct connection *co)
358 struct client *cl = co->client;
362 client_set_connection(cl, 0);
366 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
368 struct connection *con;
371 yaz_mutex_enter(host->mutex);
372 con = host->connections;
375 if (con->state == Conn_Closed)
377 if (!host->ipport) /* unresolved */
379 remove_connection_from_host(con);
380 yaz_mutex_leave(host->mutex);
381 connection_destroy(con);
383 /* start all over .. at some point it will be NULL */
385 else if (!con->client)
387 remove_connection_from_host(con);
388 yaz_mutex_leave(host->mutex);
389 connection_destroy(con);
390 /* start all over .. at some point it will be NULL */
395 yaz_mutex_leave(host->mutex);
396 connection_connect(con, iochan_man);
397 client_start_search(con->client);
403 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
407 yaz_mutex_leave(host->mutex);
410 static struct host *connection_get_host(struct connection *con)
415 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
417 struct host *host = connection_get_host(con);
418 ZOOM_options zoptions = ZOOM_options_create();
422 const char *sru_version = 0;
424 struct session_database *sdb = client_get_database(con->client);
425 const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
429 ZOOM_options_set(zoptions, "async", "1");
430 ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
431 ZOOM_options_set(zoptions, "implementationVersion", VERSION);
433 if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
434 ZOOM_options_set(zoptions, "charset", charset);
436 assert(host->ipport);
439 yaz_log(YLOG_LOG, "proxy=%s", host->ipport);
440 ZOOM_options_set(zoptions, "proxy", host->ipport);
444 assert(host->tproxy);
445 yaz_log(YLOG_LOG, "tproxy=%s", host->ipport);
446 ZOOM_options_set(zoptions, "tproxy", host->ipport);
449 if (apdulog && *apdulog)
450 ZOOM_options_set(zoptions, "apdulog", apdulog);
452 if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
453 ZOOM_options_set(zoptions, "user", auth);
454 if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
455 ZOOM_options_set(zoptions, "sru", sru);
456 if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
458 ZOOM_options_set(zoptions, "sru_version", sru_version);
459 if (!(con->link = ZOOM_connection_create(zoptions)))
461 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
462 ZOOM_options_destroy(zoptions);
468 char http_hostport[512];
469 strcpy(http_hostport, "http://");
470 strcat(http_hostport, host->url);
471 yaz_log(YLOG_LOG, "SRU connect to : %s", http_hostport);
472 ZOOM_connection_connect(con->link, http_hostport, 0);
476 ZOOM_connection_connect(con->link, host->url, 0);
478 con->iochan = iochan_create(-1, connection_handler, 0, "connection_socket");
479 con->state = Conn_Connecting;
480 iochan_settimeout(con->iochan, con->operation_timeout);
481 iochan_setdata(con->iochan, con);
482 iochan_add(iochan_man, con->iochan);
484 client_set_state(con->client, Client_Connecting);
485 ZOOM_options_destroy(zoptions);
489 // Ensure that client has a connection associated
490 int client_prep_connection(struct client *cl,
491 int operation_timeout, int session_timeout,
492 iochan_man_t iochan_man,
493 const struct timeval *abstime)
495 struct connection *co;
496 struct session_database *sdb = client_get_database(cl);
497 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
498 const char *url = session_setting_oneval(sdb, PZ_URL);
499 const char *sru = session_setting_oneval(sdb, PZ_SRU);
500 struct host *host = 0;
501 int default_port = *sru ? 80 : 210;
503 if (zproxy && zproxy[0] == '\0')
507 url = sdb->database->id;
509 host = find_host(client_get_session(cl)->service->server->database_hosts,
510 url, zproxy, default_port, iochan_man);
512 yaz_log(YLOG_DEBUG, "client_prep_connection: target=%s url=%s",
513 client_get_id(cl), url);
517 co = client_get_connection(cl);
522 if (co->host == host && client_get_state(cl) == Client_Idle)
527 connection_release(co);
532 int max_connections = 0;
533 int reuse_connections = 1;
534 const char *v = session_setting_oneval(client_get_database(cl),
537 max_connections = atoi(v);
539 v = session_setting_oneval(client_get_database(cl),
540 PZ_REUSE_CONNECTIONS);
542 reuse_connections = atoi(v);
544 // See if someone else has an idle connection
545 // We should look at timestamps here to select the longest-idle connection
546 yaz_mutex_enter(host->mutex);
549 int num_connections = 0;
550 for (co = host->connections; co; co = co->next)
552 if (reuse_connections)
554 for (co = host->connections; co; co = co->next)
556 if (connection_is_idle(co) &&
557 (!co->client || client_get_state(co->client) == Client_Idle) &&
558 !strcmp(ZOOM_connection_option_get(co->link, "user"),
559 session_setting_oneval(client_get_database(cl),
562 if (zproxy == 0 && co->zproxy == 0)
564 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
570 yaz_log(YLOG_LOG, "num_connections = %d (reusing)", num_connections);
574 if (max_connections <= 0 || num_connections < max_connections)
576 yaz_log(YLOG_LOG, "num_connections = %d (new); max = %d",
577 num_connections, max_connections);
580 yaz_log(YLOG_LOG, "num_connections = %d (waiting) max = %d",
581 num_connections, max_connections);
582 if (yaz_cond_wait(host->cond_ready, host->mutex, abstime))
584 yaz_log(YLOG_LOG, "out of connections %s", client_get_id(cl));
585 client_set_state(cl, Client_Error);
586 yaz_mutex_leave(host->mutex);
592 yaz_log(YLOG_LOG, "%p Connection reuse. state: %d", co, co->state);
593 connection_release(co);
594 client_set_connection(cl, co);
596 /* ensure that connection is only assigned to this client
597 by marking the client non Idle */
598 client_set_state(cl, Client_Working);
599 yaz_mutex_leave(host->mutex);
600 co->operation_timeout = operation_timeout;
601 co->session_timeout = session_timeout;
602 /* tells ZOOM to reconnect if necessary. Disabled becuase
603 the ZOOM_connection_connect flushes the task queue */
604 ZOOM_connection_connect(co->link, 0, 0);
608 yaz_mutex_leave(host->mutex);
609 co = connection_create(cl, host, operation_timeout, session_timeout,
624 * c-file-style: "Stroustrup"
625 * indent-tabs-mode: nil
627 * vim: shiftwidth=4 tabstop=8 expandtab