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(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 = -1;
  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, int fd)
 126 {
 127     SocketEntry *se;
 128
 129     yaz_log(m_p->log, "obs=%p read=%d write=%d except=%d fd=%d", observer,
 130             mask & SOCKET_OBSERVE_READ,
 131             mask & SOCKET_OBSERVE_WRITE,
 132             mask & SOCKET_OBSERVE_EXCEPT, fd);
 133
 134     se = *m_p->lookupObserver(observer);
 135     if (se)
 136     {
 137         se->mask = mask;
 138         se->fd = fd;
 139     }
 140 }
 141
 142 void SocketManager::timeoutObserver(ISocketObserver *observer,
 143                                         int timeout)
 144 {
 145     SocketEntry *se;
 146
 147     se = *m_p->lookupObserver(observer);
 148     if (se)
 149         se->timeout = timeout;
 150 }
 151
 152 void SocketManager::Rep::inspect_poll_result(int res, struct yaz_poll_fd *fds,
 153                                              int no_fds, int timeout)
 154
 155 {
 156     yaz_log(log, "yaz_poll returned res=%d", res);
 157     time_t now = time(0);
 158     int i;
 159     int no_put_events = 0;
 160     int no_lost_observers = 0;
 161
 162     for (i = 0; i < no_fds; i++)
 163     {
 164         SocketEntry *p;
 165         for (p = observers; p; p = p->next)
 166             if (p->fd == fds[i].fd)
 167                 break;
 168         if (!p)
 169         {
 170             // m_p->observers list changed since poll started
 171             no_lost_observers++;
 172             continue;
 173         }
 174
 175         enum yaz_poll_mask output_mask = fds[i].output_mask;
 176
 177         int mask = 0;
 178         if (output_mask & yaz_poll_read)
 179             mask |= SOCKET_OBSERVE_READ;
 180
 181         if (output_mask & yaz_poll_write)
 182             mask |= SOCKET_OBSERVE_WRITE;
 183
 184         if (output_mask & yaz_poll_except)
 185             mask |= SOCKET_OBSERVE_EXCEPT;
 186
 187         if (mask)
 188         {
 189             SocketEvent *event = new SocketEvent;
 190             p->last_activity = now;
 191             event->observer = p->observer;
 192             event->event = mask;
 193             putEvent(event);
 194             no_put_events++;
 195             yaz_log(log, "putEvent I/O mask=%d", mask);
 196         }
 197         else if (res == 0 && p->timeout_this == timeout)
 198         {
 199             SocketEvent *event = new SocketEvent;
 200             assert(p->last_activity);
 201             yaz_log(log, "putEvent timeout fd=%d, now = %ld "
 202                     "last_activity=%ld timeout=%d",
 203                     p->fd, now, p->last_activity, p->timeout);
 204             p->last_activity = now;
 205             event->observer = p->observer;
 206             event->event = SOCKET_OBSERVE_TIMEOUT;
 207             putEvent(event);
 208             no_put_events++;
 209
 210         }
 211     }
 212     SocketEvent *event = getEvent();
 213     if (event)
 214     {
 215         event->observer->socketNotify(event->event);
 216         delete event;
 217     }
 218     else
 219     {
 220         if (no_lost_observers == 0)
 221         {
 222             // bug #2035
 223             yaz_log(YLOG_WARN, "unhandled socket event. yaz_poll returned %d",
 224                     res);
 225             yaz_log(YLOG_WARN, "no_put_events=%d no_fds=%d i=%d timeout=%d",
 226                     no_put_events, no_fds, i, timeout);
 227         }
 228     }
 229 }
 230
 231 int SocketManager::processEvent()
 232 {
 233     SocketEntry *p;
 234     SocketEvent *event = m_p->getEvent();
 235     int timeout = -1;
 236     yaz_log(m_p->log, "SocketManager::processEvent manager=%p", this);
 237     if (event)
 238     {
 239         event->observer->socketNotify(event->event);
 240         delete event;
 241         return 1;
 242     }
 243
 244     int res;
 245     time_t now = time(0);
 246     int i;
 247     int no_fds = 0;
 248     for (p = m_p->observers; p; p = p->next)
 249         no_fds++;
 250
 251     if (!no_fds)
 252         return 0;
 253     struct yaz_poll_fd *fds = new yaz_poll_fd [no_fds];
 254     for (i = 0, p = m_p->observers; p; p = p->next, i++)
 255     {
 256         fds[i].fd = p->fd;
 257         int input_mask = 0;
 258         if (p->mask & SOCKET_OBSERVE_READ)
 259             input_mask += yaz_poll_read;
 260         if (p->mask & SOCKET_OBSERVE_WRITE)
 261             input_mask += yaz_poll_write;
 262         if (p->mask & SOCKET_OBSERVE_EXCEPT)
 263             input_mask += yaz_poll_except;
 264         if (p->timeout > 0 ||
 265             (p->timeout == 0 && (p->mask & SOCKET_OBSERVE_WRITE) == 0))
 266         {
 267             int timeout_this;
 268             timeout_this = p->timeout;
 269             if (p->last_activity)
 270                 timeout_this -= now - p->last_activity;
 271             else
 272                 p->last_activity = now;
 273             if (timeout_this < 0 || timeout_this > 2147483646)
 274                 timeout_this = 0;
 275             if (timeout == -1 || timeout_this < timeout)
 276                 timeout = timeout_this;
 277             p->timeout_this = timeout_this;
 278             yaz_log(m_p->log, "SocketManager::select timeout_this=%d",
 279                     p->timeout_this);
 280         }
 281         else
 282             p->timeout_this = -1;
 283         fds[i].input_mask = (enum yaz_poll_mask) input_mask;
 284     }
 285
 286     int pass = 0;
 287     while ((res = yaz_poll(fds, no_fds, timeout, 0)) < 0 && pass < 10)
 288     {
 289         if (errno == EINTR)
 290         {
 291             delete [] fds;
 292             return 1;
 293         }
 294         yaz_log(YLOG_ERRNO|YLOG_WARN, "yaz_poll");
 295         yaz_log(YLOG_WARN, "errno=%d timeout=%d", errno, timeout);
 296     }
 297
 298     if (res >= 0)
 299         m_p->inspect_poll_result(res, fds, no_fds, timeout);
 300
 301     delete [] fds;
 302     return res >= 0 ? 1 : -1;
 303 }
 304
 305 //    n p    n p  ......   n p    n p
 306 //   front                        back
 307
 308 void SocketManager::Rep::putEvent(SocketEvent *event)
 309 {
 310     // put in back of queue
 311     if (queue_back)
 312     {
 313         queue_back->prev = event;
 314         assert(queue_front);
 315     }
 316     else
 317     {
 318         assert(!queue_front);
 319         queue_front = event;
 320     }
 321     event->next = queue_back;
 322     event->prev = 0;
 323     queue_back = event;
 324 }
 325
 326 SocketManager::SocketEvent *SocketManager::Rep::getEvent()
 327 {
 328     // get from front of queue
 329     SocketEvent *event = queue_front;
 330     if (!event)
 331         return 0;
 332     assert(queue_back);
 333     queue_front = event->prev;
 334     if (queue_front)
 335     {
 336         assert(queue_back);
 337         queue_front->next = 0;
 338     }
 339     else
 340         queue_back = 0;
 341     return event;
 342 }
 343
 344 void SocketManager::Rep::removeEvent(ISocketObserver *observer)
 345 {
 346     SocketEvent *ev = queue_back;
 347     while (ev)
 348     {
 349         SocketEvent *ev_next = ev->next;
 350         if (observer == ev->observer)
 351         {
 352             if (ev->prev)
 353                 ev->prev->next = ev->next;
 354             else
 355                 queue_back = ev->next;
 356             if (ev->next)
 357                 ev->next->prev = ev->prev;
 358             else
 359                 queue_front = ev->prev;
 360             delete ev;
 361         }
 362         ev = ev_next;
 363     }
 364 }
 365
 366 SocketManager::SocketManager()
 367 {
 368     m_p = new Rep;
 369     m_p->observers = 0;
 370     m_p->queue_front = 0;
 371     m_p->queue_back = 0;
 372     m_p->log = YLOG_DEBUG;
 373 }
 374
 375 SocketManager::~SocketManager()
 376 {
 377     deleteObservers();
 378     delete m_p;
 379 }
 380 /*
 381  * Local variables:
 382  * c-basic-offset: 4
 383  * c-file-style: "Stroustrup"
 384  * indent-tabs-mode: nil
 385  * End:
 386  * vim: shiftwidth=4 tabstop=8 expandtab
 387  */
 388