src/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 must be treated 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             goto next;
 128         }
 129
 130         if (i == count) {
 131             break;
 132         }
 133
 134         /* Replace ',' to null-terminate number for atoi(). */
 135         *x = 0;
 136
 137         int fd = atoi(last);
 138         if (fd < 0) {
 139             goto next;
 140
 141         } else if (fd < TRACKFDS_STATIC_COUNT) {
 142             tracked_fds[fd] = 1;
 143         } else {
 144             if (!tracked_fds_list) {
 145                 /* Pessimistic count estimate, but allocating a few more
 146                  * elements doesn't hurt. */
 147                 if (!init_tracked_fds_list(count)) {
 148                     /* Couldn't allocate memory, skip this entry. */
 149                     goto next;
 150                 }
 151             }
 152             tracked_fds_list[i++] = fd;
 153 #ifdef DEBUG
 154             debug("  large fd: %d\n", fd);
 155 #endif
 156         }
 157
 158 next:
 159         last = x + 1;
 160     }
 161
 162     tracked_fds_list_count = i;
 163
 164 #ifdef DEBUG
 165     tracked_fds_debug();
 166 #endif
 167
 168     errno = saved_errno;
 169 }
 170
 171 static char *update_environment_buffer_entry(char *x, int fd) {
 172     assert(fd >= 0);
 173
 174     int length = snprintf(x, 10 + 1, "%d", fd);
 175     if (length >= 10 + 1 || length <= 0 /* shouldn't happen */) {
 176         /* Integer too big to fit the buffer, skip it. */
 177 #ifdef WARNING
 178         warning("update_environment_buffer_entry(): truncated fd: %d [%d]\n",
 179                 fd, getpid());
 180 #endif
 181         return x;
 182     }
 183
 184     /* Write comma after number. */
 185     x += length;
 186     *x++ = ',';
 187     /* Make sure the string is always null-terminated. */
 188     *x = 0;
 189
 190     return x;
 191 }
 192 static void update_environment_buffer(char *x) {
 193     assert(initialized);
 194
 195     size_t i;
 196     for (i = 0; i < TRACKFDS_STATIC_COUNT; i++) {
 197         if (tracked_fds[i]) {
 198             x = update_environment_buffer_entry(x, (int)i);
 199         }
 200     }
 201     for (i = 0; i < tracked_fds_list_count; i++) {
 202         x = update_environment_buffer_entry(x, tracked_fds_list[i]);
 203     }
 204 }
 205 inline static size_t update_environment_buffer_size(void) {
 206     assert(initialized);
 207
 208     /* Use the maximum count (TRACKFDS_STATIC_COUNT) of used descriptors
 209      * because it's simple and small enough not to be a problem.
 210      *
 211      * An integer (32-bit) has at most 10 digits, + 1 for the comma after each
 212      * number. Bigger file descriptors (which shouldn't occur in reality) are
 213      * skipped. */
 214     return (TRACKFDS_STATIC_COUNT + tracked_fds_list_count)
 215                * (10 + 1) + 1 /* to fit '\0' */;
 216 }
 217 static void update_environment(void) {
 218 #ifdef DEBUG
 219     debug("update_environment()\t\t[%d]\n", getpid());
 220 #endif
 221
 222     /* If we haven't parsed the environment we also haven't modified it - so
 223      * nothing to do. */
 224     if (!initialized) {
 225         return;
 226     }
 227
 228     char env[update_environment_buffer_size()];
 229     env[0] = 0;
 230
 231     update_environment_buffer(env);
 232
 233 #if 0
 234     debug("    setenv(\"%s\", \"%s\", 1)\n", ENV_NAME_FDS, env);
 235 #endif
 236
 237     setenv(ENV_NAME_FDS, env, 1 /* overwrite */);
 238 }
 239
 240
 241
 242 static void tracked_fds_add(int fd) {
 243     assert(fd >= 0);
 244
 245     if (fd < TRACKFDS_STATIC_COUNT) {
 246         tracked_fds[fd] = 1;
 247 #if 0
 248         debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 249         tracked_fds_debug();
 250 #endif
 251         return;
 252     }
 253
 254     if (tracked_fds_list_count >= tracked_fds_list_space) {
 255         int saved_errno = errno;
 256
 257         size_t new_space = tracked_fds_list_space + TRACKFDS_REALLOC_STEP;
 258         int *tmp = realloc(tracked_fds_list,
 259                            sizeof(*tracked_fds_list) * new_space);
 260         if (!tmp) {
 261             /* We can do nothing, just ignore the error. We made sure not to
 262              * destroy our state, so the new descriptor is ignored without any
 263              * other consequences. */
 264 #ifdef WARNING
 265             warning("realloc(tracked_fds_list, %zu) failed! [%d]\n",
 266                     sizeof(*tracked_fds_list) * new_space, getpid());
 267 #endif
 268             errno = saved_errno;
 269             return;
 270         }
 271         errno = saved_errno;
 272
 273         tracked_fds_list = tmp;
 274         tracked_fds_list_space = new_space;
 275     }
 276
 277     tracked_fds_list[tracked_fds_list_count++] = fd;
 278
 279 #ifdef DEBUG
 280     debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 281     tracked_fds_debug();
 282 #endif
 283 }
 284 static int tracked_fds_remove(int fd) {
 285     assert(fd >= 0);
 286
 287     if (fd < TRACKFDS_STATIC_COUNT) {
 288         int old_value = tracked_fds[fd];
 289         tracked_fds[fd] = 0;
 290
 291 #if 0
 292         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 293         tracked_fds_debug();
 294 #endif
 295         return old_value; /* Found vs. not found. */
 296     }
 297
 298     size_t i;
 299     for (i = 0; i < tracked_fds_list_count; i++) {
 300         if (fd != tracked_fds_list[i]) {
 301             continue;
 302         }
 303
 304         memmove(tracked_fds_list + i, tracked_fds_list + i + 1,
 305                 sizeof(*tracked_fds_list) * (tracked_fds_list_count - i - 1));
 306         tracked_fds_list_count--;
 307
 308 #ifdef DEBUG
 309         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 310         tracked_fds_debug();
 311 #endif
 312
 313         /* Found. */
 314         return 1;
 315     }
 316
 317     /* Not found. */
 318     return 0;
 319 }
 320
 321 static int tracked_fds_find_slow(int fd) noinline;
 322 /*
 323  * tracked_fds_find() is called for each hook call and should be as fast as
 324  * possible. As most file descriptors are < TRACKFDS_STATIC_COUNT, force the
 325  * compiler to inline that part which is almost exclusively used.
 326  *
 327  * Inlining tracked_fds_add()/tracked_fds_remove() isn't worth the effort as
 328  * they are not called often enough.
 329  */
 330 inline static int tracked_fds_find(int fd) always_inline;
 331 inline static int tracked_fds_find(int fd) {
 332     assert(fd >= 0);
 333
 334     if (fd < TRACKFDS_STATIC_COUNT) {
 335         return tracked_fds[fd];
 336     }
 337
 338     return tracked_fds_find_slow(fd);
 339 }
 340 static int tracked_fds_find_slow(int fd) {
 341     assert(initialized);
 342
 343     if (tracked_fds_list_count == 0) {
 344         return 0;
 345     }
 346
 347     size_t i;
 348     for (i = 0; i < tracked_fds_list_count; i++) {
 349         if (fd == tracked_fds_list[i]) {
 350             return 1;
 351         }
 352     }
 353     return 0;
 354 }
 355
 356 #endif