src/yaz-socket-manager.cpp

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