trackfds.h

   1 /*
   2  * Utility functions to track file descriptors.
   3  *
   4  * Copyright (C) 2013  Simon Ruderich
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef TRACKFDS_H
  21 #define TRACKFDS_H 1
  22
  23 /* Array of tracked file descriptors. Used for fast lookups for the normally
  24  * used file descriptors (0 <= fd < TRACKFDS_STATIC_COUNT). */
  25 static int tracked_fds[TRACKFDS_STATIC_COUNT];
  26
  27 /* List of tracked file descriptors >= TRACKFDS_STATIC_COUNT. */
  28 static int *tracked_fds_list;
  29 /* Current number of items in the list. */
  30 static size_t tracked_fds_list_count;
  31 /* Allocated items, used to reduce realloc()s. */
  32 static size_t tracked_fds_list_space;
  33
  34
  35 #ifdef DEBUG
  36 static void tracked_fds_debug(void) {
  37     size_t i;
  38
  39     for (i = 0; i < TRACKFDS_STATIC_COUNT; i++) {
  40         if (tracked_fds[i]) {
  41             debug("    tracked_fds[%d]: %d\n", i, tracked_fds[i]);
  42         }
  43     }
  44     debug("    tracked_fds_list: %d/%d\t[%d]\n", tracked_fds_list_count,
  45                                                  tracked_fds_list_space,
  46                                                  getpid());
  47     for (i = 0; i < tracked_fds_list_count; i++) {
  48         debug("    tracked_fds_list[%d]: %d\n", i, tracked_fds_list[i]);
  49     }
  50 }
  51 #endif
  52
  53 static int init_tracked_fds_list(size_t count) {
  54     assert(count > 0);
  55
  56     /* Reduce reallocs. */
  57     count += TRACKFDS_REALLOC_STEP;
  58
  59     tracked_fds_list = malloc(count * sizeof(*tracked_fds_list));
  60     if (!tracked_fds_list) {
  61 #ifdef WARNING
  62         warning("malloc(tracked_fds_list, %d) failed [%d]\n",
  63                 count * sizeof(*tracked_fds_list), getpid());
  64 #endif
  65         return 0;
  66     }
  67
  68     tracked_fds_list_space = count;
  69     return 1;
  70 }
  71
  72 /* Load tracked file descriptors from the environment. The environment is used
  73  * to pass the information to child processes.
  74  *
  75  * ENV_NAME_FDS has the following format: Each descriptor as string followed
  76  * by a comma; there's a trailing comma. Example: "2,4,". */
  77 static void init_from_environment(void) {
  78 #ifdef DEBUG
  79     debug("init_from_environment()\t\t[%d]\n", getpid());
  80 #endif
  81     char const *env;
  82
  83     int saved_errno = errno;
  84
  85     initialized = 1;
  86     tracked_fds_list_count = 0;
  87
  88     /* If ENV_NAME_FORCE_WRITE is set and not empty, allow writes to a non-tty
  89      * device. Use with care! Mainly used for the test suite. */
  90     env = getenv(ENV_NAME_FORCE_WRITE);
  91     if (env && env[0] != '\0') {
  92         force_write_to_non_tty = 1;
  93     }
  94
  95     env = getenv(ENV_NAME_FDS);
  96     if (!env) {
  97         errno = saved_errno;
  98         return;
  99     }
 100 #ifdef DEBUG
 101     debug("  getenv(\"%s\"): \"%s\"\n", ENV_NAME_FDS, env);
 102 #endif
 103     /* Environment is read-only. */
 104     char env_copy[strlen(env) + 1];
 105     strcpy(env_copy, env);
 106
 107     char *x;
 108
 109     size_t count = 0;
 110     for (x = env_copy; *x; x++) {
 111         if (*x == ',') {
 112             count++;
 113         }
 114     }
 115
 116     size_t i = 0;
 117
 118     /* Parse file descriptor numbers from environment string and store them as
 119      * integers in tracked_fds and tracked_fds_list. */
 120     char *last;
 121     for (x = env_copy, last = env_copy; *x; x++) {
 122         if (*x != ',') {
 123             continue;
 124         }
 125         /* ',' at the beginning or double ',' - ignore. */
 126         if (x == last) {
 127             last = x + 1;
 128             continue;
 129         }
 130
 131         if (i == count) {
 132             break;
 133         }
 134
 135         *x = 0;
 136
 137         int fd = atoi(last);
 138         if (fd < TRACKFDS_STATIC_COUNT) {
 139             tracked_fds[fd] = 1;
 140         } else {
 141             if (!tracked_fds_list) {
 142                 /* Pessimistic count estimate, but allocating a few more
 143                  * elements doesn't hurt. */
 144                 if (!init_tracked_fds_list(count)) {
 145                     /* Couldn't allocate memory, skip this entry. */
 146                     goto next;
 147                 }
 148             }
 149             tracked_fds_list[i++] = fd;
 150 #ifdef DEBUG
 151             debug("  large fd: %d\n", fd);
 152 #endif
 153         }
 154
 155 next:
 156         last = x + 1;
 157     }
 158
 159     tracked_fds_list_count = i;
 160
 161 #ifdef DEBUG
 162     tracked_fds_debug();
 163 #endif
 164
 165     errno = saved_errno;
 166 }
 167
 168 static char *update_environment_buffer_entry(char *x, int fd) {
 169     assert(fd >= 0);
 170
 171     int length = snprintf(x, 10 + 1, "%d", fd);
 172     if (length >= 10 + 1) {
 173         /* Integer too big to fit the buffer, skip it. */
 174 #ifdef WARNING
 175         warning("update_environment_buffer_entry(): truncated fd: %d [%d]\n",
 176                 fd, getpid());
 177 #endif
 178         return x;
 179     }
 180
 181     /* Write comma after number. */
 182     x += length;
 183     *x++ = ',';
 184     /* Make sure the string is always zero terminated. */
 185     *x = 0;
 186
 187     return x;
 188 }
 189 static void update_environment_buffer(char *x) {
 190     assert(initialized);
 191
 192     size_t i;
 193     for (i = 0; i < TRACKFDS_STATIC_COUNT; i++) {
 194         if (tracked_fds[i]) {
 195             x = update_environment_buffer_entry(x, (int)i);
 196         }
 197     }
 198     for (i = 0; i < tracked_fds_list_count; i++) {
 199         x = update_environment_buffer_entry(x, tracked_fds_list[i]);
 200     }
 201 }
 202 inline static size_t update_environment_buffer_size(void) {
 203     assert(initialized);
 204
 205     /* Use the maximum count (TRACKFDS_STATIC_COUNT) of used descriptors
 206      * because it's simple and small enough not to be a problem.
 207      *
 208      * An integer (32-bit) has at most 10 digits, + 1 for the comma after each
 209      * number. Bigger file descriptors (which shouldn't occur in reality) are
 210      * skipped. */
 211     return (TRACKFDS_STATIC_COUNT + tracked_fds_list_count)
 212                * (10 + 1) + 1 /* to fit '\0' */;
 213 }
 214 static void update_environment(void) {
 215 #ifdef DEBUG
 216     debug("update_environment()\t\t[%d]\n", getpid());
 217 #endif
 218
 219     /* If we haven't parsed the environment we also haven't modified it - so
 220      * nothing to do. */
 221     if (!initialized) {
 222         return;
 223     }
 224
 225     char env[update_environment_buffer_size()];
 226     env[0] = 0;
 227
 228     update_environment_buffer(env);
 229
 230 #if 0
 231     debug("    setenv(\"%s\", \"%s\", 1)\n", ENV_NAME_FDS, env);
 232 #endif
 233
 234     setenv(ENV_NAME_FDS, env, 1 /* overwrite */);
 235 }
 236
 237
 238
 239 static void tracked_fds_add(int fd) {
 240     assert(fd >= 0);
 241
 242     if (fd < TRACKFDS_STATIC_COUNT) {
 243         tracked_fds[fd] = 1;
 244 #if 0
 245         debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 246         tracked_fds_debug();
 247 #endif
 248         return;
 249     }
 250
 251     if (tracked_fds_list_count >= tracked_fds_list_space) {
 252         int saved_errno = errno;
 253
 254         size_t new_space = tracked_fds_list_space + TRACKFDS_REALLOC_STEP;
 255         int *tmp = realloc(tracked_fds_list,
 256                            sizeof(*tracked_fds_list) * new_space);
 257         if (!tmp) {
 258             /* We can do nothing, just ignore the error. We made sure not to
 259              * destroy our state, so the new descriptor is ignored without any
 260              * other consequences. */
 261 #ifdef WARNING
 262             warning("realloc(tracked_fds_list, %zu) failed! [%d]\n",
 263                     sizeof(*tracked_fds_list) * new_space, getpid());
 264 #endif
 265             errno = saved_errno;
 266             return;
 267         }
 268         errno = saved_errno;
 269
 270         tracked_fds_list = tmp;
 271         tracked_fds_list_space = new_space;
 272     }
 273
 274     tracked_fds_list[tracked_fds_list_count++] = fd;
 275
 276 #ifdef DEBUG
 277     debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 278     tracked_fds_debug();
 279 #endif
 280 }
 281 static int tracked_fds_remove(int fd) {
 282     assert(fd >= 0);
 283
 284     if (fd < TRACKFDS_STATIC_COUNT) {
 285         int old_value = tracked_fds[fd];
 286         tracked_fds[fd] = 0;
 287
 288 #if 0
 289         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 290         tracked_fds_debug();
 291 #endif
 292         return old_value; /* Found vs. not found. */
 293     }
 294
 295     size_t i;
 296     for (i = 0; i < tracked_fds_list_count; i++) {
 297         if (fd != tracked_fds_list[i]) {
 298             continue;
 299         }
 300
 301         memmove(tracked_fds_list + i, tracked_fds_list + i + 1,
 302                 sizeof(*tracked_fds_list) * (tracked_fds_list_count - i - 1));
 303         tracked_fds_list_count--;
 304
 305 #ifdef DEBUG
 306         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 307         tracked_fds_debug();
 308 #endif
 309
 310         /* Found. */
 311         return 1;
 312     }
 313
 314     /* Not found. */
 315     return 0;
 316 }
 317
 318 static int tracked_fds_find_slow(int fd) noinline;
 319 /*
 320  * tracked_fds_find() is called for each hook call and should be as fast as
 321  * possible. As most file descriptors are < TRACKFDS_STATIC_COUNT, force the
 322  * compiler to inline that part which is almost exclusively used.
 323  *
 324  * Inlining tracked_fds_add()/tracked_fds_remove() isn't worth the effort as
 325  * they are not called often enough.
 326  */
 327 inline static int tracked_fds_find(int fd) always_inline;
 328 static int tracked_fds_find(int fd) {
 329     assert(fd >= 0);
 330
 331     if (fd < TRACKFDS_STATIC_COUNT) {
 332         return tracked_fds[fd];
 333     }
 334
 335     return tracked_fds_find_slow(fd);
 336 }
 337 static int tracked_fds_find_slow(int fd) {
 338     assert(initialized);
 339
 340     if (tracked_fds_list_count == 0) {
 341         return 0;
 342     }
 343
 344     size_t i;
 345     for (i = 0; i < tracked_fds_list_count; i++) {
 346         if (fd == tracked_fds_list[i]) {
 347             return 1;
 348         }
 349     }
 350     return 0;
 351 }
 352
 353 #endif