src/common/compat/poll.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _LTT_POLL_H
  19 #define _LTT_POLL_H
  20
  21 #include <assert.h>
  22 #include <string.h>
  23 #include <unistd.h>
  24
  25 #include <common/common.h>
  26
  27 /*
  28  * Maximum number of fd we can monitor.
  29  *
  30  * For epoll(7), /proc/sys/fs/epoll/max_user_watches (since Linux 2.6.28) will
  31  * be used for the maximum size of the poll set. If this interface is not
  32  * available, according to the manpage, the max_user_watches value is 1/25 (4%)
  33  * of the available low memory divided by the registration cost in bytes which
  34  * is 90 bytes on a 32-bit kernel and 160 bytes on a 64-bit kernel.
  35  *
  36  * For poll(2), the max fds must not exceed RLIMIT_NOFILE given by
  37  * getrlimit(2).
  38  */
  39 extern unsigned int poll_max_size;
  40
  41 /*
  42  * Used by lttng_poll_clean to free the events structure in a lttng_poll_event.
  43  */
  44 static inline void __lttng_poll_free(void *events)
  45 {
  46         free(events);
  47 }
  48
  49 /*
  50  * epoll(7) implementation.
  51  */
  52 #ifdef HAVE_EPOLL
  53 #include <sys/epoll.h>
  54 #include <stdio.h>
  55 #include <features.h>
  56 #include <common/compat/fcntl.h>
  57
  58 /* See man epoll(7) for this define path */
  59 #define COMPAT_EPOLL_PROC_PATH "/proc/sys/fs/epoll/max_user_watches"
  60
  61 enum {
  62         /* Polling variables compatibility for epoll */
  63         LPOLLIN = EPOLLIN,
  64         LPOLLPRI = EPOLLPRI,
  65         LPOLLOUT = EPOLLOUT,
  66         LPOLLRDNORM = EPOLLRDNORM,
  67         LPOLLRDBAND = EPOLLRDBAND,
  68         LPOLLWRNORM = EPOLLWRNORM,
  69         LPOLLWRBAND = EPOLLWRBAND,
  70         LPOLLMSG = EPOLLMSG,
  71         LPOLLERR = EPOLLERR,
  72         LPOLLHUP = EPOLLHUP,
  73         LPOLLNVAL = EPOLLHUP,
  74         LPOLLRDHUP = EPOLLRDHUP,
  75         /* Close on exec feature of epoll */
  76 #if defined(HAVE_EPOLL_CREATE1) && defined(EPOLL_CLOEXEC)
  77         LTTNG_CLOEXEC = EPOLL_CLOEXEC,
  78 #else
  79         /*
  80          * EPOLL_CLOEXEC was added in glibc 2.8 (usually used in conjunction with
  81          * epoll_create1(..)), but since neither EPOLL_CLOEXEC exists nor
  82          * epoll_create1(..), we set it to FD_CLOEXEC so that we can pass it
  83          * directly to fcntl(..) instead.
  84          */
  85         LTTNG_CLOEXEC = FD_CLOEXEC,
  86 #endif
  87 };
  88
  89 struct compat_epoll_event {
  90         int epfd;
  91         uint32_t nb_fd;       /* Current number of fd in events */
  92         uint32_t alloc_size; /* Size of events array */
  93         uint32_t init_size;     /* Initial size of events array */
  94         struct epoll_event *events;
  95 };
  96 #define lttng_poll_event compat_epoll_event
  97
  98 static inline int __lttng_epoll_get_prev_fd(struct lttng_poll_event *events,
  99                 int index, uint32_t nb_fd)
 100 {
 101         assert(events);
 102         assert(index != nb_fd);
 103
 104         if (index == 0 || nb_fd == 0) {
 105                 return -1;
 106         } else {
 107                 return events->events[index - 1].data.fd;
 108         }
 109 }
 110
 111 /*
 112  * For the following calls, consider 'e' to be a lttng_poll_event pointer and i
 113  * being the index of the events array.
 114  */
 115 #define LTTNG_POLL_GETFD(e, i) LTTNG_REF(e)->events[i].data.fd
 116 #define LTTNG_POLL_GETEV(e, i) LTTNG_REF(e)->events[i].events
 117 #define LTTNG_POLL_GETNB(e) LTTNG_REF(e)->nb_fd
 118 #define LTTNG_POLL_GETSZ(e) LTTNG_REF(e)->events_size
 119 #define LTTNG_POLL_GET_PREV_FD(e, i, nb_fd) \
 120         __lttng_epoll_get_prev_fd(LTTNG_REF(e), i, nb_fd)
 121
 122 /* Create the epoll set. */
 123 extern int compat_epoll_create(struct lttng_poll_event *events,
 124                 int size, int flags);
 125 #define lttng_poll_create(events, size, flags) \
 126         compat_epoll_create(events, size, flags)
 127
 128 #if defined(HAVE_EPOLL_CREATE1) && defined(EPOLL_CLOEXEC)
 129 static inline int compat_glibc_epoll_create(int size __attribute__((unused)),
 130                 int flags)
 131 {
 132         return epoll_create1(flags);
 133 }
 134 #else
 135 static inline int compat_glibc_epoll_create(int size, int flags)
 136 {
 137         /*
 138          * epoll_create1 was added in glibc 2.9, but unfortunatly reverting to
 139          * epoll_create(..) also means that we lose the possibility to
 140          * directly set the EPOLL_CLOEXEC, so try and do it anyway but through
 141          * fcntl(..).
 142          */
 143         int efd = epoll_create(size);
 144         assert(fcntl(efd, F_SETFD, flags) != -1);
 145         return efd;
 146 }
 147 #endif
 148
 149 /*
 150  * Wait on epoll set with the number of fd registered to the lttng_poll_event
 151  * data structure (events).
 152  */
 153 extern int compat_epoll_wait(struct lttng_poll_event *events, int timeout);
 154 #define lttng_poll_wait(events, timeout) \
 155         compat_epoll_wait(events, timeout)
 156
 157 /*
 158  * Add a fd to the epoll set and resize the epoll_event structure if needed.
 159  */
 160 extern int compat_epoll_add(struct lttng_poll_event *events,
 161                 int fd, uint32_t req_events);
 162 #define lttng_poll_add(events, fd, req_events) \
 163         compat_epoll_add(events, fd, req_events)
 164
 165 /*
 166  * Remove a fd from the epoll set.
 167  */
 168 extern int compat_epoll_del(struct lttng_poll_event *events, int fd);
 169 #define lttng_poll_del(events, fd) \
 170         compat_epoll_del(events, fd)
 171
 172 /*
 173  * Modify an fd's events in the epoll set.
 174  */
 175 extern int compat_epoll_mod(struct lttng_poll_event *events,
 176                 int fd, uint32_t req_events);
 177 #define lttng_poll_mod(events, fd, req_events) \
 178         compat_epoll_mod(events, fd, req_events)
 179
 180 /*
 181  * Set up the poll set limits variable poll_max_size
 182  */
 183 extern int compat_epoll_set_max_size(void);
 184 #define lttng_poll_set_max_size() \
 185         compat_epoll_set_max_size()
 186
 187 /*
 188  * This function memset with zero the structure since it can be reused at each
 189  * round of a main loop. Being in a loop and using a non static number of fds,
 190  * this function must be called to insure coherent events with associted fds.
 191  */
 192 static inline void lttng_poll_reset(struct lttng_poll_event *events)
 193 {
 194         if (events && events->events) {
 195                 memset(events->events, 0,
 196                                 events->nb_fd * sizeof(struct epoll_event));
 197         }
 198 }
 199
 200 /*
 201  * Initialize an already allocated poll event data structure. For epoll(), the
 202  * epfd is set to -1 to indicate that it's not usable.
 203  */
 204 static inline void lttng_poll_init(struct lttng_poll_event *events)
 205 {
 206         memset(events, 0, sizeof(struct lttng_poll_event));
 207         /* Set fd to -1 so if clean before created, we don't close 0. */
 208         events->epfd = -1;
 209 }
 210
 211 /*
 212  * Clean the events structure of a lttng_poll_event. It's the caller
 213  * responsability to free the lttng_poll_event memory.
 214  */
 215 static inline void lttng_poll_clean(struct lttng_poll_event *events)
 216 {
 217         int ret;
 218
 219         if (!events) {
 220                 return;
 221         }
 222
 223         if (events->epfd >= 0) {
 224                 ret = close(events->epfd);
 225                 if (ret) {
 226                         PERROR("close");
 227                 }
 228         }
 229
 230         __lttng_poll_free((void *) events->events);
 231 }
 232
 233 #else   /* HAVE_EPOLL */
 234 /*
 235  * Fallback on poll(2) API
 236  */
 237
 238 /* Needed for some poll event values */
 239 #ifndef __USE_XOPEN
 240 #define __USE_XOPEN
 241 #endif
 242
 243 /* Needed for some poll event values */
 244 #ifndef __USE_GNU
 245 #define __USE_GNU
 246 #endif
 247
 248 #include <poll.h>
 249 #include <stdint.h>
 250
 251 enum {
 252         /* Polling variables compatibility for poll */
 253         LPOLLIN = POLLIN,
 254         LPOLLPRI = POLLPRI,
 255         LPOLLOUT = POLLOUT,
 256         LPOLLRDNORM = POLLRDNORM,
 257         LPOLLRDBAND = POLLRDBAND,
 258         LPOLLWRNORM = POLLWRNORM,
 259         LPOLLWRBAND = POLLWRBAND,
 260 #if __linux__
 261         LPOLLMSG = POLLMSG,
 262         LPOLLRDHUP = POLLRDHUP,
 263 #elif (defined(__FreeBSD__) || defined(__CYGWIN__) || defined(__sun__) || defined(__APPLE__))
 264         LPOLLMSG = 0,
 265         LPOLLRDHUP = 0,
 266 #else
 267 #error "Please add support for your OS."
 268 #endif /* __linux__ */
 269         LPOLLERR = POLLERR,
 270         LPOLLHUP = POLLHUP | POLLNVAL,
 271         /* Close on exec feature does not exist for poll(2) */
 272         LTTNG_CLOEXEC = 0xdead,
 273 };
 274
 275 struct compat_poll_event_array {
 276         uint32_t nb_fd;       /* Current number of fd in events */
 277         uint32_t alloc_size; /* Size of events array */
 278         /* Initial size of the pollset. We never shrink below that. */
 279         uint32_t init_size;
 280         struct pollfd *events;
 281 };
 282
 283 struct compat_poll_event {
 284         /*
 285          * Modified by the wait action. Updated using current fields if the
 286          * need_update flag is set.
 287          */
 288         struct compat_poll_event_array wait;
 289         /*
 290          * This is modified by add/del actions being the _current_ flow of
 291          * execution before a poll wait is done.
 292          */
 293         struct compat_poll_event_array current;
 294
 295         /* Indicate if wait.events need to be updated from current. */
 296         int need_update:1;
 297 };
 298 #define lttng_poll_event compat_poll_event
 299
 300 static inline int __lttng_poll_get_prev_fd(struct lttng_poll_event *events,
 301                 int index, uint32_t nb_fd)
 302 {
 303         assert(events);
 304         assert(index != nb_fd);
 305
 306         if (index == 0 || nb_fd == 0) {
 307                 return -1;
 308         } else {
 309                 return events->current.events[index - 1].fd;
 310         }
 311 }
 312
 313 /*
 314  * For the following calls, consider 'e' to be a lttng_poll_event pointer and i
 315  * being the index of the events array.
 316  * LTTNG_POLL_GETNB is always used after lttng_poll_wait, thus we can use the
 317  * current list for test compatibility purposes.
 318  */
 319 #define LTTNG_POLL_GETFD(e, i) LTTNG_REF(e)->wait.events[i].fd
 320 #define LTTNG_POLL_GETEV(e, i) LTTNG_REF(e)->wait.events[i].revents
 321 #define LTTNG_POLL_GETNB(e) LTTNG_REF(e)->current.nb_fd
 322 #define LTTNG_POLL_GETSZ(e) LTTNG_REF(e)->wait.events_size
 323 #define LTTNG_POLL_GET_PREV_FD(e, i, nb_fd) \
 324         __lttng_poll_get_prev_fd(LTTNG_REF(e), i, nb_fd)
 325
 326 /*
 327  * Create a pollfd structure of size 'size'.
 328  */
 329 extern int compat_poll_create(struct lttng_poll_event *events, int size);
 330 #define lttng_poll_create(events, size, flags) \
 331         compat_poll_create(events, size)
 332
 333 /*
 334  * Wait on poll(2) event with nb_fd registered to the lttng_poll_event data
 335  * structure.
 336  */
 337 extern int compat_poll_wait(struct lttng_poll_event *events, int timeout);
 338 #define lttng_poll_wait(events, timeout) \
 339         compat_poll_wait(events, timeout)
 340
 341 /*
 342  * Add the fd to the pollfd structure. Resize if needed.
 343  */
 344 extern int compat_poll_add(struct lttng_poll_event *events,
 345                 int fd, uint32_t req_events);
 346 #define lttng_poll_add(events, fd, req_events) \
 347         compat_poll_add(events, fd, req_events)
 348
 349 /*
 350  * Remove the fd from the pollfd. Memory allocation is done to recreate a new
 351  * pollfd, data is copied from the old pollfd to the new and, finally, the old
 352  * one is freed().
 353  */
 354 extern int compat_poll_del(struct lttng_poll_event *events, int fd);
 355 #define lttng_poll_del(events, fd) \
 356         compat_poll_del(events, fd)
 357
 358 /*
 359  * Modify an fd's events in the poll set.
 360  */
 361 extern int compat_poll_mod(struct lttng_poll_event *events,
 362                 int fd, uint32_t req_events);
 363 #define lttng_poll_mod(events, fd, req_events) \
 364         compat_poll_mod(events, fd, req_events)
 365
 366 /*
 367  * Set up the poll set limits variable poll_max_size
 368  */
 369 extern int compat_poll_set_max_size(void);
 370 #define lttng_poll_set_max_size() \
 371         compat_poll_set_max_size()
 372
 373 /*
 374  * No need to reset a pollfd structure for poll(2)
 375  */
 376 static inline void lttng_poll_reset(struct lttng_poll_event *events)
 377 {}
 378
 379 /*
 380  * Initialize an already allocated poll event data structure.
 381  */
 382 static inline void lttng_poll_init(struct lttng_poll_event *events)
 383 {
 384         memset(events, 0, sizeof(struct lttng_poll_event));
 385 }
 386
 387 /*
 388  * Clean the events structure of a lttng_poll_event. It's the caller
 389  * responsability to free the lttng_poll_event memory.
 390  */
 391 static inline void lttng_poll_clean(struct lttng_poll_event *events)
 392 {
 393         if (events) {
 394                 __lttng_poll_free((void *) events->wait.events);
 395                 __lttng_poll_free((void *) events->current.events);
 396         }
 397 }
 398
 399 #endif /* HAVE_EPOLL */
 400
 401 #endif /* _LTT_POLL_H */