1 /* This file is part of Pazpar2.
2 Copyright (C) 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;
101 int operation_timeout;
103 struct connection *next; // next for same host or next in free list
106 static int connection_connect(struct connection *con, iochan_man_t iochan_man);
108 static int connection_is_idle(struct connection *co)
110 ZOOM_connection link = co->link;
113 if (co->state != Conn_Open || !link)
116 if (!ZOOM_connection_is_idle(link))
118 event = ZOOM_connection_peek_event(link);
119 if (event == ZOOM_EVENT_NONE)
125 ZOOM_connection connection_get_link(struct connection *co)
130 static void remove_connection_from_host(struct connection *con)
132 struct connection **conp = &con->host->connections;
138 *conp = (*conp)->next;
141 conp = &(*conp)->next;
143 yaz_cond_broadcast(con->host->cond_ready);
146 // Close connection and recycle structure
147 static void connection_destroy(struct connection *co)
151 ZOOM_connection_destroy(co->link);
152 iochan_destroy(co->iochan);
154 yaz_log(YLOG_DEBUG, "%p Connection destroy %s", co, co->url);
158 client_disconnect(co->client);
167 // Creates a new connection for client, associated with the host of
169 static struct connection *connection_create(struct client *cl,
172 int operation_timeout,
174 iochan_man_t iochan_man)
176 struct connection *co;
178 co = xmalloc(sizeof(*co));
182 co->url = xstrdup(url);
184 client_set_connection(cl, co);
186 co->state = Conn_Closed;
187 co->operation_timeout = operation_timeout;
188 co->session_timeout = session_timeout;
191 connection_connect(co, iochan_man);
193 yaz_mutex_enter(host->mutex);
194 co->next = co->host->connections;
195 co->host->connections = co;
196 yaz_mutex_leave(host->mutex);
202 static void non_block_events(struct connection *co)
205 IOCHAN iochan = co->iochan;
206 ZOOM_connection link = co->link;
209 struct client *cl = co->client;
211 int r = ZOOM_event_nonblock(1, &link);
216 ev = ZOOM_connection_last_event(link);
219 yaz_log(YLOG_DEBUG, "%p Connection ZOOM_EVENT_%s", co, ZOOM_get_event_str(ev));
223 case ZOOM_EVENT_TIMEOUT:
227 const char *error, *addinfo;
229 if ((err = ZOOM_connection_error(link, &error, &addinfo)))
231 struct session *se = client_get_session(cl);
233 session_log(se, YLOG_WARN, "%s: Error %s (%s)",
234 client_get_id(cl), error, addinfo);
235 client_set_diagnostic(cl, err, error, addinfo);
236 client_set_state(cl, Client_Error);
240 iochan_settimeout(iochan, co->session_timeout);
241 client_set_state(cl, Client_Idle);
243 yaz_cond_broadcast(co->host->cond_ready);
246 case ZOOM_EVENT_SEND_DATA:
248 case ZOOM_EVENT_RECV_DATA:
250 case ZOOM_EVENT_UNKNOWN:
252 case ZOOM_EVENT_SEND_APDU:
253 client_set_state(co->client, Client_Working);
254 iochan_settimeout(iochan, co->operation_timeout);
256 case ZOOM_EVENT_RECV_APDU:
258 case ZOOM_EVENT_CONNECT:
259 co->state = Conn_Open;
261 case ZOOM_EVENT_RECV_SEARCH:
262 client_search_response(cl);
264 case ZOOM_EVENT_RECV_RECORD:
265 client_record_response(cl, &got_records);
268 yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
269 ev, client_get_id(cl));
275 struct client *cl = co->client;
278 client_check_preferred_watch(cl);
279 client_got_records(cl);
284 void connection_continue(struct connection *co)
286 int r = ZOOM_connection_exec_task(co->link);
289 struct client *cl = co->client;
292 non_block_events(co);
297 iochan_setflags(co->iochan, ZOOM_connection_get_mask(co->link));
298 iochan_setfd(co->iochan, ZOOM_connection_get_socket(co->link));
302 static void connection_handler(IOCHAN iochan, int event)
304 struct connection *co = iochan_getdata(iochan);
306 struct host *host = co->host;
308 yaz_mutex_enter(host->mutex);
312 /* no client associated with it.. We are probably getting
313 a closed connection from the target.. Or, perhaps, an unexpected
314 package.. We will just close the connection */
315 yaz_log(YLOG_LOG, "timeout connection %p event=%d", co, event);
316 remove_connection_from_host(co);
317 yaz_mutex_leave(host->mutex);
318 connection_destroy(co);
320 else if (event & EVENT_TIMEOUT)
322 ZOOM_connection_fire_event_timeout(co->link);
324 non_block_events(co);
327 remove_connection_from_host(co);
328 yaz_mutex_leave(host->mutex);
329 connection_destroy(co);
333 yaz_mutex_leave(host->mutex);
336 non_block_events(co);
338 ZOOM_connection_fire_event_socket(co->link, event);
340 non_block_events(co);
345 iochan_setflags(iochan, ZOOM_connection_get_mask(co->link));
346 iochan_setfd(iochan, ZOOM_connection_get_socket(co->link));
352 // Disassociate connection from client
353 static void connection_release(struct connection *co)
355 struct client *cl = co->client;
359 client_set_connection(cl, 0);
363 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
365 struct connection *con;
367 yaz_mutex_enter(host->mutex);
368 con = host->connections;
371 if (con->state == Conn_Closed)
373 struct client *cl = con->client;
374 if (!host->ipport || !cl) /* unresolved or no client */
376 remove_connection_from_host(con);
377 yaz_mutex_leave(host->mutex);
378 connection_destroy(con);
382 struct session_database *sdb = client_get_database(cl);
383 struct session *se = client_get_session(cl);
386 yaz_mutex_leave(host->mutex);
387 client_start_search(cl);
391 remove_connection_from_host(con);
392 yaz_mutex_leave(host->mutex);
393 connection_destroy(con);
396 /* start all over .. at some point it will be NULL */
397 yaz_mutex_enter(host->mutex);
398 con = host->connections;
405 yaz_mutex_leave(host->mutex);
408 static struct host *connection_get_host(struct connection *con)
413 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
415 struct host *host = connection_get_host(con);
416 ZOOM_options zoptions = ZOOM_options_create();
420 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);
426 const char *memcached = session_setting_oneval(sdb, PZ_MEMCACHED);
427 const char *redis = session_setting_oneval(sdb, PZ_REDIS);
431 ZOOM_options_set(zoptions, "async", "1");
432 ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
433 ZOOM_options_set(zoptions, "implementationVersion", VERSION);
435 if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
436 ZOOM_options_set(zoptions, "charset", charset);
437 if (memcached && *memcached)
438 ZOOM_options_set(zoptions, "memcached", memcached);
440 ZOOM_options_set(zoptions, "redis", redis);
442 assert(host->ipport);
445 yaz_log(YLOG_LOG, "proxy=%s", host->ipport);
446 ZOOM_options_set(zoptions, "proxy", host->ipport);
450 assert(host->tproxy);
451 yaz_log(YLOG_LOG, "tproxy=%s", host->ipport);
452 ZOOM_options_set(zoptions, "tproxy", host->ipport);
455 if (apdulog && *apdulog)
456 ZOOM_options_set(zoptions, "apdulog", apdulog);
459 if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
460 ZOOM_options_set(zoptions, "sru", sru);
461 if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
463 ZOOM_options_set(zoptions, "sru_version", sru_version);
465 if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
467 /* allow splitting user and reset with a blank always */
468 const char *cp1 = strchr(auth, ' ');
469 if (!cp1 && sru && *sru)
470 cp1 = strchr(auth, '/');
473 /* Z39.50 user/password style, or no password for SRU */
474 ZOOM_options_set(zoptions, "user", auth);
478 /* now consider group as well */
479 const char *cp2 = strchr(cp1 + 1, ' ');
481 ZOOM_options_setl(zoptions, "user", auth, cp1 - auth);
483 ZOOM_options_set(zoptions, "password", cp1 + 1);
486 ZOOM_options_setl(zoptions, "group", cp1 + 1, cp2 - cp1 - 1);
487 ZOOM_options_set(zoptions, "password", cp2 + 1);
492 value = session_setting_oneval(sdb, PZ_AUTHENTICATION_MODE);
494 ZOOM_options_set(zoptions, "authenticationMode", value);
496 if (!(con->link = ZOOM_connection_create(zoptions)))
498 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
499 ZOOM_options_destroy(zoptions);
504 if (sru && *sru && !strstr(con->url, "://"))
505 wrbuf_puts(w, "http://");
506 if (strchr(con->url, '#'))
508 const char *cp = strchr(con->url, '#');
509 wrbuf_write(w, con->url, cp - con->url);
512 wrbuf_puts(w, con->url);
514 ZOOM_connection_connect(con->link, wrbuf_cstr(w), 0);
516 con->iochan = iochan_create(-1, connection_handler, 0, "connection_socket");
517 con->state = Conn_Connecting;
518 iochan_settimeout(con->iochan, con->operation_timeout);
519 iochan_setdata(con->iochan, con);
520 iochan_add(iochan_man, con->iochan);
522 client_set_state(con->client, Client_Connecting);
523 ZOOM_options_destroy(zoptions);
528 // Ensure that client has a connection associated
529 int client_prep_connection(struct client *cl,
530 int operation_timeout, int session_timeout,
531 iochan_man_t iochan_man,
532 const struct timeval *abstime)
534 struct connection *co;
535 struct session_database *sdb = client_get_database(cl);
536 const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
537 const char *url = session_setting_oneval(sdb, PZ_URL);
538 const char *sru = session_setting_oneval(sdb, PZ_SRU);
539 struct host *host = 0;
540 int default_port = *sru ? 80 : 210;
542 if (zproxy && zproxy[0] == '\0')
546 url = sdb->database->id;
548 host = find_host(client_get_session(cl)->service->server->database_hosts,
549 url, zproxy, default_port, iochan_man);
551 yaz_log(YLOG_DEBUG, "client_prep_connection: target=%s url=%s",
552 client_get_id(cl), url);
556 co = client_get_connection(cl);
560 if (co->host == host && client_get_state(cl) == Client_Idle)
564 connection_release(co);
569 int max_connections = 0;
570 int reuse_connections = 1;
571 const char *v = session_setting_oneval(client_get_database(cl),
574 max_connections = atoi(v);
576 v = session_setting_oneval(client_get_database(cl),
577 PZ_REUSE_CONNECTIONS);
579 reuse_connections = atoi(v);
581 // See if someone else has an idle connection
582 // We should look at timestamps here to select the longest-idle connection
583 yaz_mutex_enter(host->mutex);
586 int num_connections = 0;
587 for (co = host->connections; co; co = co->next)
589 if (reuse_connections)
591 for (co = host->connections; co; co = co->next)
593 if (connection_is_idle(co) &&
594 !strcmp(url, co->url) &&
595 (!co->client || client_get_state(co->client) == Client_Idle) &&
596 !strcmp(ZOOM_connection_option_get(co->link, "user"),
597 session_setting_oneval(client_get_database(cl),
600 if (zproxy == 0 && co->zproxy == 0)
602 if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
608 yaz_log(YLOG_LOG, "num_connections = %d (reusing)", num_connections);
612 if (max_connections <= 0 || num_connections < max_connections)
614 yaz_log(YLOG_LOG, "num_connections = %d (new); max = %d",
615 num_connections, max_connections);
618 yaz_log(YLOG_LOG, "num_connections = %d (waiting) max = %d",
619 num_connections, max_connections);
620 if (yaz_cond_wait(host->cond_ready, host->mutex, abstime))
622 yaz_log(YLOG_LOG, "out of connections %s", client_get_id(cl));
623 client_set_state(cl, Client_Error);
624 yaz_mutex_leave(host->mutex);
630 yaz_log(YLOG_LOG, "%p Connection reuse. state: %d", co, co->state);
631 connection_release(co);
632 client_set_connection(cl, co);
634 /* ensure that connection is only assigned to this client
635 by marking the client non Idle */
636 client_set_state(cl, Client_Working);
637 yaz_mutex_leave(host->mutex);
638 co->operation_timeout = operation_timeout;
639 co->session_timeout = session_timeout;
640 /* tells ZOOM to reconnect if necessary. Disabled becuase
641 the ZOOM_connection_connect flushes the task queue */
642 ZOOM_connection_connect(co->link, 0, 0);
646 yaz_mutex_leave(host->mutex);
647 co = connection_create(cl, url, host,
648 operation_timeout, session_timeout,
663 * c-file-style: "Stroustrup"
664 * indent-tabs-mode: nil
666 * vim: shiftwidth=4 tabstop=8 expandtab