src/connection.c

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