src/connection.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2013 Index Data
   3
   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
   7 version.
   8
   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
  12 for more details.
  13
  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
  17
  18 */
  19
  20 /** \file connection.c
  21     \brief Z39.50 connection (low-level client)
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <stdlib.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #if HAVE_SYS_TIME_H
  32 #include <sys/time.h>
  33 #endif
  34 #if HAVE_UNISTD_H
  35 #include <unistd.h>
  36 #endif
  37
  38 #include <signal.h>
  39 #include <assert.h>
  40
  41 #include <yaz/log.h>
  42 #include <yaz/comstack.h>
  43 #include <yaz/tcpip.h>
  44 #include "connection.h"
  45 #include "session.h"
  46 #include "host.h"
  47 #include "client.h"
  48 #include "settings.h"
  49
  50 /* connection counting (1) , disable connection counting (0) */
  51 #if 1
  52 static YAZ_MUTEX g_mutex = 0;
  53 static int no_connections = 0;
  54 static int total_no_connections = 0;
  55
  56 static int connection_use(int delta)
  57 {
  58     int result;
  59     if (!g_mutex)
  60         yaz_mutex_create(&g_mutex);
  61     yaz_mutex_enter(g_mutex);
  62     no_connections += delta;
  63     result = no_connections;
  64     if (delta > 0)
  65         total_no_connections += delta;
  66     yaz_mutex_leave(g_mutex);
  67     if (delta == 0)
  68             return result;
  69     yaz_log(YLOG_LOG, "%s connections=%d", delta > 0 ? "INC" : "DEC",
  70             no_connections);
  71     return result;
  72 }
  73
  74 int connections_count(void)
  75 {
  76     return connection_use(0);
  77 }
  78
  79
  80 #else
  81 #define connection_use(x)
  82 #define connections_count(x) 0
  83 #define connections_count_total(x) 0
  84 #endif
  85
  86
  87 /** \brief Represents a physical, reusable  connection to a remote Z39.50 host
  88  */
  89 struct connection {
  90     IOCHAN iochan;
  91     ZOOM_connection link;
  92     struct host *host;
  93     struct client *client;
  94     char *zproxy;
  95     enum {
  96         Conn_Closed,
  97         Conn_Connecting,
  98         Conn_Open
  99     } state;
 100     int operation_timeout;
 101     int session_timeout;
 102     struct connection *next; // next for same host or next in free list
 103 };
 104
 105 static int connection_connect(struct connection *con, iochan_man_t iochan_man);
 106
 107 static int connection_is_idle(struct connection *co)
 108 {
 109     ZOOM_connection link = co->link;
 110     int event;
 111
 112     if (co->state != Conn_Open || !link)
 113         return 0;
 114
 115     if (!ZOOM_connection_is_idle(link))
 116         return 0;
 117     event = ZOOM_connection_peek_event(link);
 118     if (event == ZOOM_EVENT_NONE)
 119         return 1;
 120     else
 121         return 0;
 122 }
 123
 124 ZOOM_connection connection_get_link(struct connection *co)
 125 {
 126     return co->link;
 127 }
 128
 129 static void remove_connection_from_host(struct connection *con)
 130 {
 131     struct connection **conp = &con->host->connections;
 132     assert(con);
 133     while (*conp)
 134     {
 135         if (*conp == con)
 136         {
 137             *conp = (*conp)->next;
 138             break;
 139         }
 140         conp = &(*conp)->next;
 141     }
 142     yaz_cond_broadcast(con->host->cond_ready);
 143 }
 144
 145 // Close connection and recycle structure
 146 static void connection_destroy(struct connection *co)
 147 {
 148     if (co->link)
 149     {
 150         ZOOM_connection_destroy(co->link);
 151         iochan_destroy(co->iochan);
 152     }
 153     yaz_log(YLOG_DEBUG, "%p Connection destroy %s", co, co->host->url);
 154
 155     if (co->client)
 156     {
 157         client_disconnect(co->client);
 158     }
 159
 160     xfree(co->zproxy);
 161     xfree(co);
 162     connection_use(-1);
 163 }
 164
 165 // Creates a new connection for client, associated with the host of
 166 // client's database
 167 static struct connection *connection_create(struct client *cl,
 168                                             struct host *host,
 169                                             int operation_timeout,
 170                                             int session_timeout,
 171                                             iochan_man_t iochan_man)
 172 {
 173     struct connection *co;
 174
 175     co = xmalloc(sizeof(*co));
 176     co->host = host;
 177
 178     co->client = cl;
 179     co->zproxy = 0;
 180     client_set_connection(cl, co);
 181     co->link = 0;
 182     co->state = Conn_Closed;
 183     co->operation_timeout = operation_timeout;
 184     co->session_timeout = session_timeout;
 185
 186     if (host->ipport)
 187         connection_connect(co, iochan_man);
 188
 189     yaz_mutex_enter(host->mutex);
 190     co->next = co->host->connections;
 191     co->host->connections = co;
 192     yaz_mutex_leave(host->mutex);
 193
 194     connection_use(1);
 195     return co;
 196 }
 197
 198 static void non_block_events_unlocked(struct connection *co)
 199 {
 200     int got_records = 0;
 201     IOCHAN iochan = co->iochan;
 202     ZOOM_connection link = co->link;
 203     while (1)
 204     {
 205         struct client *cl = co->client;
 206         int ev;
 207         int r = ZOOM_event_nonblock(1, &link);
 208         if (!r)
 209             break;
 210         if (!cl)
 211             continue;
 212         ev = ZOOM_connection_last_event(link);
 213
 214 #if 1
 215         yaz_log(YLOG_DEBUG, "%p Connection ZOOM_EVENT_%s", co, ZOOM_get_event_str(ev));
 216 #endif
 217         switch (ev)
 218         {
 219         case ZOOM_EVENT_TIMEOUT:
 220             break;
 221         case ZOOM_EVENT_END:
 222             {
 223                 const char *error, *addinfo;
 224                 int err;
 225                 if ((err = ZOOM_connection_error(link, &error, &addinfo)))
 226                 {
 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);
 231                 }
 232                 else
 233                 {
 234                     iochan_settimeout(iochan, co->session_timeout);
 235                     client_set_state(cl, Client_Idle);
 236                 }
 237                 yaz_cond_broadcast(co->host->cond_ready);
 238             }
 239             break;
 240         case ZOOM_EVENT_SEND_DATA:
 241             break;
 242         case ZOOM_EVENT_RECV_DATA:
 243             break;
 244         case ZOOM_EVENT_UNKNOWN:
 245             break;
 246         case ZOOM_EVENT_SEND_APDU:
 247             client_set_state(co->client, Client_Working);
 248             iochan_settimeout(iochan, co->operation_timeout);
 249             break;
 250         case ZOOM_EVENT_RECV_APDU:
 251             break;
 252         case ZOOM_EVENT_CONNECT:
 253             yaz_log(YLOG_LOG, "Connected to %s", client_get_id(cl));
 254             co->state = Conn_Open;
 255             break;
 256         case ZOOM_EVENT_RECV_SEARCH:
 257             client_search_response(cl);
 258             break;
 259         case ZOOM_EVENT_RECV_RECORD:
 260             client_record_response(cl, &got_records);
 261             break;
 262         default:
 263             yaz_log(YLOG_LOG, "Unhandled event (%d) from %s",
 264                     ev, client_get_id(cl));
 265             break;
 266         }
 267     }
 268     if (got_records)
 269     {
 270         struct client *cl = co->client;
 271         if (cl)
 272         {
 273             client_check_preferred_watch(cl);
 274             client_got_records(cl);
 275         }
 276     }
 277 }
 278
 279 static void non_block_events(struct client *cl, struct connection *co)
 280 {
 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");
 284 }
 285
 286 void connection_continue(struct connection *co)
 287 {
 288     int r = ZOOM_connection_exec_task(co->link);
 289     if (!r)
 290     {
 291         non_block_events_unlocked(co);
 292     }
 293     else
 294     {
 295         iochan_setflags(co->iochan, ZOOM_connection_get_mask(co->link));
 296         iochan_setfd(co->iochan, ZOOM_connection_get_socket(co->link));
 297     }
 298 }
 299
 300 static void connection_handler(IOCHAN iochan, int event)
 301 {
 302     struct connection *co = iochan_getdata(iochan);
 303     struct client *cl;
 304     struct host *host = co->host;
 305
 306     yaz_mutex_enter(host->mutex);
 307     cl = co->client;
 308     if (!cl)
 309     {
 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);
 317     }
 318     else if (event & EVENT_TIMEOUT)
 319     {
 320         ZOOM_connection_fire_event_timeout(co->link);
 321
 322         non_block_events(cl, co);
 323
 324         remove_connection_from_host(co);
 325         yaz_mutex_leave(host->mutex);
 326         connection_destroy(co);
 327     }
 328     else
 329     {
 330         yaz_mutex_leave(host->mutex);
 331
 332         non_block_events(cl, co);
 333
 334         ZOOM_connection_fire_event_socket(co->link, event);
 335
 336         non_block_events(cl, co);
 337
 338         if (co->link)
 339         {
 340             iochan_setflags(iochan, ZOOM_connection_get_mask(co->link));
 341             iochan_setfd(iochan, ZOOM_connection_get_socket(co->link));
 342         }
 343     }
 344 }
 345
 346
 347 // Disassociate connection from client
 348 static void connection_release(struct connection *co)
 349 {
 350     struct client *cl = co->client;
 351
 352     if (!cl)
 353         return;
 354     client_set_connection(cl, 0);
 355     co->client = 0;
 356 }
 357
 358 void connect_resolver_host(struct host *host, iochan_man_t iochan_man)
 359 {
 360     struct connection *con;
 361
 362 start:
 363     yaz_mutex_enter(host->mutex);
 364     con = host->connections;
 365     while (con)
 366     {
 367         if (con->state == Conn_Closed)
 368         {
 369             if (!host->ipport) /* unresolved */
 370             {
 371                 remove_connection_from_host(con);
 372                 yaz_mutex_leave(host->mutex);
 373                 connection_destroy(con);
 374                 goto start;
 375                 /* start all over .. at some point it will be NULL */
 376             }
 377             else if (!con->client)
 378             {
 379                 remove_connection_from_host(con);
 380                 yaz_mutex_leave(host->mutex);
 381                 connection_destroy(con);
 382                 /* start all over .. at some point it will be NULL */
 383                 goto start;
 384             }
 385             else
 386             {
 387                 yaz_mutex_leave(host->mutex);
 388                 connection_connect(con, iochan_man);
 389                 client_start_search(con->client);
 390                 goto start;
 391             }
 392         }
 393         else
 394         {
 395             yaz_log(YLOG_LOG, "connect_resolver_host: state=%d", con->state);
 396             con = con->next;
 397         }
 398     }
 399     yaz_mutex_leave(host->mutex);
 400 }
 401
 402 static struct host *connection_get_host(struct connection *con)
 403 {
 404     return con->host;
 405 }
 406
 407 static int connection_connect(struct connection *con, iochan_man_t iochan_man)
 408 {
 409     struct host *host = connection_get_host(con);
 410     ZOOM_options zoptions = ZOOM_options_create();
 411     const char *auth;
 412     const char *charset;
 413     const char *sru;
 414     const char *sru_version = 0;
 415
 416     struct session_database *sdb = client_get_database(con->client);
 417     const char *apdulog = session_setting_oneval(sdb, PZ_APDULOG);
 418
 419     assert(con);
 420
 421     ZOOM_options_set(zoptions, "async", "1");
 422     ZOOM_options_set(zoptions, "implementationName", PACKAGE_NAME);
 423     ZOOM_options_set(zoptions, "implementationVersion", VERSION);
 424
 425     if ((charset = session_setting_oneval(sdb, PZ_NEGOTIATION_CHARSET)))
 426         ZOOM_options_set(zoptions, "charset", charset);
 427
 428     assert(host->ipport);
 429     if (host->proxy)
 430     {
 431         yaz_log(YLOG_LOG, "proxy=%s", host->ipport);
 432         ZOOM_options_set(zoptions, "proxy", host->ipport);
 433     }
 434     else
 435     {
 436         assert(host->tproxy);
 437         yaz_log(YLOG_LOG, "tproxy=%s", host->ipport);
 438         ZOOM_options_set(zoptions, "tproxy", host->ipport);
 439     }
 440
 441     if (apdulog && *apdulog)
 442         ZOOM_options_set(zoptions, "apdulog", apdulog);
 443
 444     if ((auth = session_setting_oneval(sdb, PZ_AUTHENTICATION)))
 445         ZOOM_options_set(zoptions, "user", auth);
 446     if ((sru = session_setting_oneval(sdb, PZ_SRU)) && *sru)
 447         ZOOM_options_set(zoptions, "sru", sru);
 448     if ((sru_version = session_setting_oneval(sdb, PZ_SRU_VERSION))
 449         && *sru_version)
 450         ZOOM_options_set(zoptions, "sru_version", sru_version);
 451     if (!(con->link = ZOOM_connection_create(zoptions)))
 452     {
 453         yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create ZOOM Connection");
 454         ZOOM_options_destroy(zoptions);
 455         return -1;
 456     }
 457
 458     if (sru && *sru && !strstr(host->url, "://"))
 459     {
 460         WRBUF w = wrbuf_alloc();
 461         wrbuf_puts(w, "http://");
 462         wrbuf_puts(w, host->url);
 463         ZOOM_connection_connect(con->link, wrbuf_cstr(w), 0);
 464         wrbuf_destroy(w);
 465     }
 466     else
 467     {
 468         ZOOM_connection_connect(con->link, host->url, 0);
 469     }
 470     con->iochan = iochan_create(-1, connection_handler, 0, "connection_socket");
 471     con->state = Conn_Connecting;
 472     iochan_settimeout(con->iochan, con->operation_timeout);
 473     iochan_setdata(con->iochan, con);
 474     iochan_add(iochan_man, con->iochan);
 475
 476     client_set_state(con->client, Client_Connecting);
 477     ZOOM_options_destroy(zoptions);
 478     return 0;
 479 }
 480
 481 // Ensure that client has a connection associated
 482 int client_prep_connection(struct client *cl,
 483                            int operation_timeout, int session_timeout,
 484                            iochan_man_t iochan_man,
 485                            const struct timeval *abstime)
 486 {
 487     struct connection *co;
 488     struct session_database *sdb = client_get_database(cl);
 489     const char *zproxy = session_setting_oneval(sdb, PZ_ZPROXY);
 490     const char *url = session_setting_oneval(sdb, PZ_URL);
 491     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 492     struct host *host = 0;
 493     int default_port = *sru ? 80 : 210;
 494
 495     if (zproxy && zproxy[0] == '\0')
 496         zproxy = 0;
 497
 498     if (!url || !*url)
 499         url = sdb->database->id;
 500
 501     host = find_host(client_get_session(cl)->service->server->database_hosts,
 502                      url, zproxy, default_port, iochan_man);
 503
 504     yaz_log(YLOG_DEBUG, "client_prep_connection: target=%s url=%s",
 505             client_get_id(cl), url);
 506     if (!host)
 507         return 0;
 508
 509     co = client_get_connection(cl);
 510
 511     if (co)
 512     {
 513         assert(co->host);
 514         if (co->host == host && client_get_state(cl) == Client_Idle)
 515         {
 516             return 2;
 517         }
 518         client_incref(cl);
 519         connection_release(co);
 520         co = 0;
 521     }
 522     if (!co)
 523     {
 524         int max_connections = 0;
 525         int reuse_connections = 1;
 526         const char *v = session_setting_oneval(client_get_database(cl),
 527                                                PZ_MAX_CONNECTIONS);
 528         if (v && *v)
 529             max_connections = atoi(v);
 530
 531         v = session_setting_oneval(client_get_database(cl),
 532                 PZ_REUSE_CONNECTIONS);
 533         if (v && *v)
 534             reuse_connections = atoi(v);
 535
 536         // See if someone else has an idle connection
 537         // We should look at timestamps here to select the longest-idle connection
 538         yaz_mutex_enter(host->mutex);
 539         while (1)
 540         {
 541             int num_connections = 0;
 542             for (co = host->connections; co; co = co->next)
 543                 num_connections++;
 544             if (reuse_connections)
 545             {
 546                 for (co = host->connections; co; co = co->next)
 547                 {
 548                     if (connection_is_idle(co) &&
 549                         (!co->client || client_get_state(co->client) == Client_Idle) &&
 550                         !strcmp(ZOOM_connection_option_get(co->link, "user"),
 551                                 session_setting_oneval(client_get_database(cl),
 552                                                        PZ_AUTHENTICATION)))
 553                     {
 554                         if (zproxy == 0 && co->zproxy == 0)
 555                             break;
 556                         if (zproxy && co->zproxy && !strcmp(zproxy, co->zproxy))
 557                             break;
 558                     }
 559                 }
 560                 if (co)
 561                 {
 562                     yaz_log(YLOG_LOG, "num_connections = %d (reusing)", num_connections);
 563                     break;
 564                 }
 565             }
 566             if (max_connections <= 0 || num_connections < max_connections)
 567             {
 568                 yaz_log(YLOG_LOG, "num_connections = %d (new); max = %d",
 569                         num_connections, max_connections);
 570                 break;
 571             }
 572             yaz_log(YLOG_LOG, "num_connections = %d (waiting) max = %d",
 573                     num_connections, max_connections);
 574             if (yaz_cond_wait(host->cond_ready, host->mutex, abstime))
 575             {
 576                 yaz_log(YLOG_LOG, "out of connections %s", client_get_id(cl));
 577                 client_set_state(cl, Client_Error);
 578                 yaz_mutex_leave(host->mutex);
 579                 return 0;
 580             }
 581         }
 582         if (co)
 583         {
 584             yaz_log(YLOG_LOG,  "%p Connection reuse. state: %d", co, co->state);
 585             connection_release(co);
 586             client_set_connection(cl, co);
 587             co->client = cl;
 588             /* ensure that connection is only assigned to this client
 589                by marking the client non Idle */
 590             client_set_state(cl, Client_Working);
 591             yaz_mutex_leave(host->mutex);
 592             co->operation_timeout = operation_timeout;
 593             co->session_timeout = session_timeout;
 594             /* tells ZOOM to reconnect if necessary. Disabled becuase
 595                the ZOOM_connection_connect flushes the task queue */
 596             ZOOM_connection_connect(co->link, 0, 0);
 597         }
 598         else
 599         {
 600             yaz_mutex_leave(host->mutex);
 601             co = connection_create(cl, host, operation_timeout, session_timeout,
 602                                    iochan_man);
 603         }
 604         assert(co->host);
 605     }
 606
 607     if (co && co->link)
 608         return 1;
 609     else
 610         return 0;
 611 }
 612
 613 /*
 614  * Local variables:
 615  * c-basic-offset: 4
 616  * c-file-style: "Stroustrup"
 617  * indent-tabs-mode: nil
 618  * End:
 619  * vim: shiftwidth=4 tabstop=8 expandtab
 620  */
 621