1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 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_unlocked(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, &got_records);
263 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
264 ev, client_get_id(cl));
270 struct client *cl = co->client;
273 client_check_preferred_watch(cl);
274 client_got_records(cl);
279 static void non_block_events(struct client *cl, struct connection *co)
281 session_enter_rw(client_get_session(cl), "non_block_events");
282 non_block_events_unlocked(co);
283 session_leave_rw(client_get_session(cl), "non_block_events");
286 void connection_continue(struct connection *co)
288 int r = ZOOM_connection_exec_task(co->link);
291 non_block_events_unlocked(co);
295 iochan_setflags(co->iochan, ZOOM_connection_get_mask(co->link));
296 iochan_setfd(co->iochan, ZOOM_connection_get_socket(co->link));
300 static void connection_handler(IOCHAN iochan, int event)
302 struct connection *co = iochan_getdata(iochan);
304 struct host *host = co->host;
306 yaz_mutex_enter(host->mutex);
310 /* no client associated with it.. We are probably getting
311 a closed connection from the target.. Or, perhaps, an unexpected
312 package.. We will just close the connection */
313 yaz_log(YLOG_LOG, "timeout connection %p event=%d", co, event);
314 remove_connection_from_host(co);
315 yaz_mutex_leave(host->mutex);
316 connection_destroy(co);
318 else if (event & EVENT_TIMEOUT)
320 ZOOM_connection_fire_event_timeout(co->link);
322 remove_connection_from_host(co);
323 yaz_mutex_leave(host->mutex);
324 connection_destroy(co);
328 yaz_mutex_leave(host->mutex);
330 non_block_events(cl, co);
332 ZOOM_connection_fire_event_socket(co->link, event);
334 non_block_events(cl, co);
338 iochan_setflags(iochan, ZOOM_connection_get_mask(co->link));
339 iochan_setfd(iochan, ZOOM_connection_get_socket(co->link));
345 // Disassociate connection from client
346 static void connection_release(struct connection *co)
348 struct client *cl = co->client;
352 client_set_connection(cl, 0);
356 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
358 struct connection *con;
361 yaz_mutex_enter(host->mutex);
362 con = host->connections;
365 if (con->state == Conn_Closed)
367 if (!host->ipport) /* unresolved */
369 remove_connection_from_host(con);
370 yaz_mutex_leave(host->mutex);
371 connection_destroy(con);
373 /* start all over .. at some point it will be NULL */
375 else if (!con->client)
377 remove_connection_from_host(con);
378 yaz_mutex_leave(host->mutex);
379 connection_destroy(con);
380 /* start all over .. at some point it will be NULL */
385 yaz_mutex_leave(host->mutex);
386 connection_connect(con, iochan_man);
387 client_start_search(con->client);
393 yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
397 yaz_mutex_leave(host->mutex);
400 static struct host *connection_get_host(struct connection *con)
405 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
407 struct host *host = connection_get_host(con);
408 ZOOM_options zoptions = ZOOM_options_create();
412 const char *sru_version = 0;
414 struct session_database *sdb = client_get_database(con->client);
415 const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
419 ZOOM_options_set(zoptions, "async", "1");
420 ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
421 ZOOM_options_set(zoptions, "implementationVersion", VERSION);
423 if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
424 ZOOM_options_set(zoptions, "charset", charset);
426 assert(host->ipport);
429 yaz_log(YLOG_LOG, "proxy=%s", host->ipport);
430 ZOOM_options_set(zoptions, "proxy", host->ipport);
434 assert(host->tproxy);
435 yaz_log(YLOG_LOG, "tproxy=%s", host->ipport);
436 ZOOM_options_set(zoptions, "tproxy", host->ipport);
439 if (apdulog && *apdulog)
440 ZOOM_options_set(zoptions, "apdulog", apdulog);
442 if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
443 ZOOM_options_set(zoptions, "user", auth);
444 if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
445 ZOOM_options_set(zoptions, "sru", sru);
446 if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
448 ZOOM_options_set(zoptions, "sru_version", sru_version);
449 if (!(con->link = ZOOM_connection_create(zoptions)))
451 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
452 ZOOM_options_destroy(zoptions);
456 if (sru && *sru && !strstr(host->url, "://"))
458 WRBUF w = wrbuf_alloc();
459 wrbuf_puts(w, "http://");
460 wrbuf_puts(w, host->url);
461 ZOOM_connection_connect(con->link, wrbuf_cstr(w), 0);
466 ZOOM_connection_connect(con->link, host->url, 0);
468 con->iochan = iochan_create(-1, connection_handler, 0, "connection_socket");
469 con->state = Conn_Connecting;
470 iochan_settimeout(con->iochan, con->operation_timeout);
471 iochan_setdata(con->iochan, con);
472 iochan_add(iochan_man, con->iochan);
474 client_set_state(con->client, Client_Connecting);
475 ZOOM_options_destroy(zoptions);
479 // Ensure that client has a connection associated
480 int client_prep_connection(struct client *cl,
481 int operation_timeout, int session_timeout,
482 iochan_man_t iochan_man,
483 const struct timeval *abstime)
485 struct connection *co;
486 struct session_database *sdb = client_get_database(cl);
487 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
488 const char *url = session_setting_oneval(sdb, PZ_URL);
489 const char *sru = session_setting_oneval(sdb, PZ_SRU);
490 struct host *host = 0;
491 int default_port = *sru ? 80 : 210;
493 if (zproxy && zproxy[0] == '\0')
497 url = sdb->database->id;
499 host = find_host(client_get_session(cl)->service->server->database_hosts,
500 url, zproxy, default_port, iochan_man);
502 yaz_log(YLOG_DEBUG, "client_prep_connection: target=%s url=%s",
503 client_get_id(cl), url);
507 co = client_get_connection(cl);
512 if (co->host == host && client_get_state(cl) == Client_Idle)
517 connection_release(co);
522 int max_connections = 0;
523 int reuse_connections = 1;
524 const char *v = session_setting_oneval(client_get_database(cl),
527 max_connections = atoi(v);
529 v = session_setting_oneval(client_get_database(cl),
530 PZ_REUSE_CONNECTIONS);
532 reuse_connections = atoi(v);
534 // See if someone else has an idle connection
535 // We should look at timestamps here to select the longest-idle connection
536 yaz_mutex_enter(host->mutex);
539 int num_connections = 0;
540 for (co = host->connections; co; co = co->next)
542 if (reuse_connections)
544 for (co = host->connections; co; co = co->next)
546 if (connection_is_idle(co) &&
547 (!co->client || client_get_state(co->client) == Client_Idle) &&
548 !strcmp(ZOOM_connection_option_get(co->link, "user"),
549 session_setting_oneval(client_get_database(cl),
552 if (zproxy == 0 && co->zproxy == 0)
554 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
560 yaz_log(YLOG_LOG, "num_connections = %d (reusing)", num_connections);
564 if (max_connections <= 0 || num_connections < max_connections)
566 yaz_log(YLOG_LOG, "num_connections = %d (new); max = %d",
567 num_connections, max_connections);
570 yaz_log(YLOG_LOG, "num_connections = %d (waiting) max = %d",
571 num_connections, max_connections);
572 if (yaz_cond_wait(host->cond_ready, host->mutex, abstime))
574 yaz_log(YLOG_LOG, "out of connections %s", client_get_id(cl));
575 client_set_state(cl, Client_Error);
576 yaz_mutex_leave(host->mutex);
582 yaz_log(YLOG_LOG, "%p Connection reuse. state: %d", co, co->state);
583 connection_release(co);
584 client_set_connection(cl, co);
586 /* ensure that connection is only assigned to this client
587 by marking the client non Idle */
588 client_set_state(cl, Client_Working);
589 yaz_mutex_leave(host->mutex);
590 co->operation_timeout = operation_timeout;
591 co->session_timeout = session_timeout;
592 /* tells ZOOM to reconnect if necessary. Disabled becuase
593 the ZOOM_connection_connect flushes the task queue */
594 ZOOM_connection_connect(co->link, 0, 0);
598 yaz_mutex_leave(host->mutex);
599 co = connection_create(cl, host, operation_timeout, session_timeout,
614 * c-file-style: "Stroustrup"
615 * indent-tabs-mode: nil
617 * vim: shiftwidth=4 tabstop=8 expandtab