src/yaz-socket-manager.cpp

   1 /* This file is part of the yazpp toolkit.
   2  * Copyright (C) 1998-2012 Index Data and Mike Taylor
   3  * See the file LICENSE for details.
   4  */
   5
   6 #if HAVE_CONFIG_H
   7 #include <config.h>
   8 #endif
   9 #if HAVE_SYS_TIME_H
  10 #include <sys/time.h>
  11 #endif
  12 #if HAVE_SYS_TYPES_H
  13 #include <sys/types.h>
  14 #endif
  15 #if HAVE_UNISTD_H
  16 #include <unistd.h>
  17 #endif
  18
  19 #include <errno.h>
  20 #include <string.h>
  21 #include <assert.h>
  22 #include <stdlib.h>
  23
  24 #include <yaz/log.h>
  25
  26 #include <yazpp/socket-manager.h>
  27 #include <yaz/poll.h>
  28
  29 using namespace yazpp_1;
  30
  31 SocketManager::SocketEntry **SocketManager::lookupObserver(
  32     ISocketObserver *observer)
  33 {
  34     SocketEntry **se;
  35
  36     for (se = &m_observers; *se; se = &(*se)->next)
  37         if ((*se)->observer == observer)
  38             break;
  39     return se;
  40 }
  41
  42 int SocketManager::getNumberOfObservers()
  43 {
  44     int i = 0;
  45     SocketEntry *se;
  46     for (se = m_observers; se; se = se->next, i++)
  47         ;
  48     return i;
  49 }
  50
  51 void SocketManager::addObserver(int fd, ISocketObserver *observer)
  52 {
  53     SocketEntry *se;
  54
  55     se = *lookupObserver(observer);
  56     if (!se)
  57     {
  58         se = new SocketEntry;
  59         se->next= m_observers;
  60         m_observers = se;
  61         se->observer = observer;
  62     }
  63     se->fd = fd;
  64     se->mask = 0;
  65     se->last_activity = 0;
  66     se->timeout = -1;
  67 }
  68
  69 void SocketManager::deleteObserver(ISocketObserver *observer)
  70 {
  71     SocketEntry **se = lookupObserver(observer);
  72     if (*se)
  73     {
  74         removeEvent (observer);
  75         SocketEntry *se_tmp = *se;
  76         *se = (*se)->next;
  77         delete se_tmp;
  78     }
  79 }
  80
  81 void SocketManager::deleteObservers()
  82 {
  83     SocketEntry *se = m_observers;
  84
  85     while (se)
  86     {
  87         SocketEntry *se_next = se->next;
  88         delete se;
  89         se = se_next;
  90     }
  91     m_observers = 0;
  92 }
  93
  94 void SocketManager::maskObserver(ISocketObserver *observer, int mask)
  95 {
  96     SocketEntry *se;
  97
  98     yaz_log(m_log, "obs=%p read=%d write=%d except=%d", observer,
  99                     mask & SOCKET_OBSERVE_READ,
 100                     mask & SOCKET_OBSERVE_WRITE,
 101                     mask & SOCKET_OBSERVE_EXCEPT);
 102
 103     se = *lookupObserver(observer);
 104     if (se)
 105         se->mask = mask;
 106 }
 107
 108 void SocketManager::timeoutObserver(ISocketObserver *observer,
 109                                         int timeout)
 110 {
 111     SocketEntry *se;
 112
 113     se = *lookupObserver(observer);
 114     if (se)
 115         se->timeout = timeout;
 116 }
 117
 118
 119 void SocketManager::inspect_poll_result(int res, struct yaz_poll_fd *fds,
 120                                         int no_fds, int timeout)
 121
 122 {
 123     yaz_log(m_log, "yaz_poll returned res=%d", res);
 124     time_t now = time(0);
 125     int i;
 126     int no_put_events = 0;
 127     int no_lost_observers = 0;
 128
 129     for (i = 0; i < no_fds; i++)
 130     {
 131         SocketEntry *p;
 132         for (p = m_observers; p; p = p->next)
 133             if (p->fd == fds[i].fd)
 134                 break;
 135         if (!p)
 136         {
 137             // m_observers list changed since poll started
 138             no_lost_observers++;
 139             continue;
 140         }
 141
 142         enum yaz_poll_mask output_mask = fds[i].output_mask;
 143
 144         int mask = 0;
 145         if (output_mask & yaz_poll_read)
 146             mask |= SOCKET_OBSERVE_READ;
 147
 148         if (output_mask & yaz_poll_write)
 149             mask |= SOCKET_OBSERVE_WRITE;
 150
 151         if (output_mask & yaz_poll_except)
 152             mask |= SOCKET_OBSERVE_EXCEPT;
 153
 154         if (mask)
 155         {
 156             SocketEvent *event = new SocketEvent;
 157             p->last_activity = now;
 158             event->observer = p->observer;
 159             event->event = mask;
 160             putEvent (event);
 161             no_put_events++;
 162             yaz_log (m_log, "putEvent I/O mask=%d", mask);
 163         }
 164         else if (res == 0 && p->timeout_this == timeout)
 165         {
 166             SocketEvent *event = new SocketEvent;
 167             assert (p->last_activity);
 168             yaz_log (m_log, "putEvent timeout fd=%d, now = %ld last_activity=%ld timeout=%d",
 169                      p->fd, now, p->last_activity, p->timeout);
 170             p->last_activity = now;
 171             event->observer = p->observer;
 172             event->event = SOCKET_OBSERVE_TIMEOUT;
 173             putEvent (event);
 174             no_put_events++;
 175
 176         }
 177     }
 178     SocketEvent *event = getEvent();
 179     if (event)
 180     {
 181         event->observer->socketNotify(event->event);
 182         delete event;
 183     }
 184     else
 185     {
 186         if (no_lost_observers == 0)
 187         {
 188             // bug #2035
 189             yaz_log(YLOG_WARN, "unhandled socket event. yaz_poll returned %d",
 190                     res);
 191             yaz_log(YLOG_WARN, "no_put_events=%d no_fds=%d i=%d timeout=%d",
 192                     no_put_events, no_fds, i, timeout);
 193         }
 194     }
 195 }
 196
 197 int SocketManager::processEvent()
 198 {
 199     SocketEntry *p;
 200     SocketEvent *event = getEvent();
 201     int timeout = -1;
 202     yaz_log (m_log, "SocketManager::processEvent manager=%p", this);
 203     if (event)
 204     {
 205         event->observer->socketNotify(event->event);
 206         delete event;
 207         return 1;
 208     }
 209
 210     int res;
 211     time_t now = time(0);
 212     int i;
 213     int no_fds = 0;
 214     for (p = m_observers; p; p = p->next)
 215         no_fds++;
 216
 217     if (!no_fds)
 218         return 0;
 219     struct yaz_poll_fd *fds = new yaz_poll_fd [no_fds];
 220     for (i = 0, p = m_observers; p; p = p->next, i++)
 221     {
 222         fds[i].fd = p->fd;
 223         int input_mask = 0;
 224         if (p->mask & SOCKET_OBSERVE_READ)
 225             input_mask += yaz_poll_read;
 226         if (p->mask & SOCKET_OBSERVE_WRITE)
 227             input_mask += yaz_poll_write;
 228         if (p->mask & SOCKET_OBSERVE_EXCEPT)
 229             input_mask += yaz_poll_except;
 230         if (p->timeout > 0 ||
 231             (p->timeout == 0 && (p->mask & SOCKET_OBSERVE_WRITE) == 0))
 232         {
 233             int timeout_this;
 234             timeout_this = p->timeout;
 235             if (p->last_activity)
 236                 timeout_this -= now - p->last_activity;
 237             else
 238                 p->last_activity = now;
 239             if (timeout_this < 0 || timeout_this > 2147483646)
 240                 timeout_this = 0;
 241             if (timeout == -1 || timeout_this < timeout)
 242                 timeout = timeout_this;
 243             p->timeout_this = timeout_this;
 244             yaz_log (m_log, "SocketManager::select timeout_this=%d",
 245                      p->timeout_this);
 246         }
 247         else
 248             p->timeout_this = -1;
 249         fds[i].input_mask = (enum yaz_poll_mask) input_mask;
 250     }
 251
 252     int pass = 0;
 253     while ((res = yaz_poll(fds, no_fds, timeout, 0)) < 0 && pass < 10)
 254     {
 255         if (errno == EINTR)
 256         {
 257             delete [] fds;
 258             return 1;
 259         }
 260         yaz_log(YLOG_ERRNO|YLOG_WARN, "yaz_poll");
 261         yaz_log(YLOG_WARN, "errno=%d timeout=%d", errno, timeout);
 262     }
 263
 264     if (res >= 0)
 265         inspect_poll_result(res, fds, no_fds, timeout);
 266
 267     delete [] fds;
 268     return res >= 0 ? 1 : -1;
 269 }
 270
 271
 272 //    n p    n p  ......   n p    n p
 273 //   front                        back
 274
 275 void SocketManager::putEvent(SocketEvent *event)
 276 {
 277     // put in back of queue
 278     if (m_queue_back)
 279     {
 280         m_queue_back->prev = event;
 281         assert (m_queue_front);
 282     }
 283     else
 284     {
 285         assert (!m_queue_front);
 286         m_queue_front = event;
 287     }
 288     event->next = m_queue_back;
 289     event->prev = 0;
 290     m_queue_back = event;
 291 }
 292
 293 SocketManager::SocketEvent *SocketManager::getEvent()
 294 {
 295     // get from front of queue
 296     SocketEvent *event = m_queue_front;
 297     if (!event)
 298         return 0;
 299     assert (m_queue_back);
 300     m_queue_front = event->prev;
 301     if (m_queue_front)
 302     {
 303         assert (m_queue_back);
 304         m_queue_front->next = 0;
 305     }
 306     else
 307         m_queue_back = 0;
 308     return event;
 309 }
 310
 311 void SocketManager::removeEvent(ISocketObserver *observer)
 312 {
 313     SocketEvent *ev = m_queue_back;
 314     while (ev)
 315     {
 316         SocketEvent *ev_next = ev->next;
 317         if (observer == ev->observer)
 318         {
 319             if (ev->prev)
 320                 ev->prev->next = ev->next;
 321             else
 322                 m_queue_back = ev->next;
 323             if (ev->next)
 324                 ev->next->prev = ev->prev;
 325             else
 326                 m_queue_front = ev->prev;
 327             delete ev;
 328         }
 329         ev = ev_next;
 330     }
 331 }
 332
 333 SocketManager::SocketManager()
 334 {
 335     m_observers = 0;
 336     m_queue_front = 0;
 337     m_queue_back = 0;
 338     m_log = YLOG_DEBUG;
 339 }
 340
 341 SocketManager::~SocketManager()
 342 {
 343     deleteObservers();
 344 }
 345 /*
 346  * Local variables:
 347  * c-basic-offset: 4
 348  * c-file-style: "Stroustrup"
 349  * indent-tabs-mode: nil
 350  * End:
 351  * vim: shiftwidth=4 tabstop=8 expandtab
 352  */
 353