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     /* Reduce reallocs. */
  55     count += TRACKFDS_REALLOC_STEP;
  56
  57     tracked_fds_list = malloc(count * sizeof(*tracked_fds_list));
  58     if (!tracked_fds_list) {
  59 #ifdef WARNING
  60         warning("malloc(tracked_fds_list, %d) failed [%d]\n",
  61                 count * sizeof(*tracked_fds_list), getpid());
  62 #endif
  63         return 0;
  64     }
  65
  66     tracked_fds_list_space = count;
  67     return 1;
  68 }
  69
  70 /* Load tracked file descriptors from the environment. The environment is used
  71  * to pass the information to child processes.
  72  *
  73  * ENV_NAME_FDS has the following format: Each descriptor as string followed
  74  * by a comma; there's a trailing comma. Example: "2,4,". */
  75 static void init_from_environment(void) {
  76 #ifdef DEBUG
  77     debug("init_from_environment()\t\t[%d]\n", getpid());
  78 #endif
  79     char const *env;
  80
  81     int saved_errno = errno;
  82
  83     initialized = 1;
  84     tracked_fds_list_count = 0;
  85
  86     /* If ENV_NAME_FORCE_WRITE is set and not empty, allow writes to a non-tty
  87      * device. Use with care! Mainly used for the test suite. */
  88     env = getenv(ENV_NAME_FORCE_WRITE);
  89     if (env && env[0] != '\0') {
  90         force_write_to_non_tty = 1;
  91     }
  92
  93     env = getenv(ENV_NAME_FDS);
  94     if (!env) {
  95         errno = saved_errno;
  96         return;
  97     }
  98 #ifdef DEBUG
  99     debug("  getenv(\"%s\"): \"%s\"\n", ENV_NAME_FDS, env);
 100 #endif
 101     /* Environment is read-only. */
 102     char env_copy[strlen(env) + 1];
 103     strcpy(env_copy, env);
 104
 105     char *x;
 106
 107     size_t count = 0;
 108     for (x = env_copy; *x; x++) {
 109         if (*x == ',') {
 110             count++;
 111         }
 112     }
 113
 114     size_t i = 0;
 115
 116     /* Parse file descriptor numbers from environment string and store them as
 117      * integers in tracked_fds and tracked_fds_list. */
 118     char *last;
 119     for (x = env_copy, last = env_copy; *x; x++) {
 120         if (*x != ',') {
 121             continue;
 122         }
 123         /* ',' at the beginning or double ',' - ignore. */
 124         if (x == last) {
 125             last = x + 1;
 126             continue;
 127         }
 128
 129         if (i == count) {
 130             break;
 131         }
 132
 133         *x = 0;
 134
 135         int fd = atoi(last);
 136         if (fd < TRACKFDS_STATIC_COUNT) {
 137             tracked_fds[fd] = 1;
 138         } else {
 139             if (!tracked_fds_list) {
 140                 /* Pessimistic count estimate, but allocating a few more
 141                  * elements doesn't hurt. */
 142                 if (!init_tracked_fds_list(count)) {
 143                     /* Couldn't allocate memory, skip this entry. */
 144                     goto next;
 145                 }
 146             }
 147             tracked_fds_list[i++] = fd;
 148 #ifdef DEBUG
 149             debug("  large fd: %d\n", fd);
 150 #endif
 151         }
 152
 153 next:
 154         last = x + 1;
 155     }
 156
 157     tracked_fds_list_count = i;
 158
 159 #ifdef DEBUG
 160     tracked_fds_debug();
 161 #endif
 162
 163     errno = saved_errno;
 164 }
 165
 166 static char *update_environment_buffer_entry(char *x, int fd) {
 167     int length = snprintf(x, 10 + 1, "%d", fd);
 168     if (length >= 10 + 1) {
 169         /* Integer too big to fit the buffer, skip it. */
 170 #ifdef WARNING
 171         warning("update_environment_buffer_entry(): truncated fd: %d [%d]\n",
 172                 fd, getpid());
 173 #endif
 174         return x;
 175     }
 176
 177     /* Write comma after number. */
 178     x += length;
 179     *x++ = ',';
 180     /* Make sure the string is always zero terminated. */
 181     *x = 0;
 182
 183     return x;
 184 }
 185 static void update_environment_buffer(char *x) {
 186     size_t i;
 187     for (i = 0; i < TRACKFDS_STATIC_COUNT; i++) {
 188         if (tracked_fds[i]) {
 189             x = update_environment_buffer_entry(x, (int)i);
 190         }
 191     }
 192     for (i = 0; i < tracked_fds_list_count; i++) {
 193         x = update_environment_buffer_entry(x, tracked_fds_list[i]);
 194     }
 195 }
 196 inline static size_t update_environment_buffer_size(void) {
 197     /* Use the maximum count (TRACKFDS_STATIC_COUNT) of used descriptors
 198      * because it's simple and small enough not to be a problem.
 199      *
 200      * An integer (32-bit) has at most 10 digits, + 1 for the comma after each
 201      * number. Bigger file descriptors (which shouldn't occur in reality) are
 202      * skipped. */
 203     return (TRACKFDS_STATIC_COUNT + tracked_fds_list_count)
 204                * (10 + 1) + 1 /* to fit '\0' */;
 205 }
 206 static void update_environment(void) {
 207 #ifdef DEBUG
 208     debug("update_environment()\t\t[%d]\n", getpid());
 209 #endif
 210
 211     /* If we haven't parsed the environment we also haven't modified it - so
 212      * nothing to do. */
 213     if (!initialized) {
 214         return;
 215     }
 216
 217     char env[update_environment_buffer_size()];
 218     env[0] = 0;
 219
 220     update_environment_buffer(env);
 221
 222 #if 0
 223     debug("    setenv(\"%s\", \"%s\", 1)\n", ENV_NAME_FDS, env);
 224 #endif
 225
 226     setenv(ENV_NAME_FDS, env, 1 /* overwrite */);
 227 }
 228
 229
 230
 231 static void tracked_fds_add(int fd) {
 232     if (fd < TRACKFDS_STATIC_COUNT) {
 233         tracked_fds[fd] = 1;
 234 #if 0
 235         debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 236         tracked_fds_debug();
 237 #endif
 238         return;
 239     }
 240
 241     if (tracked_fds_list_count >= tracked_fds_list_space) {
 242         int saved_errno = errno;
 243
 244         size_t new_space = tracked_fds_list_space + TRACKFDS_REALLOC_STEP;
 245         int *tmp = realloc(tracked_fds_list,
 246                            sizeof(*tracked_fds_list) * new_space);
 247         if (!tmp) {
 248             /* We can do nothing, just ignore the error. We made sure not to
 249              * destroy our state, so the new descriptor is ignored without any
 250              * other consequences. */
 251 #ifdef WARNING
 252             warning("realloc(tracked_fds_list, %zu) failed! [%d]\n",
 253                     sizeof(*tracked_fds_list) * new_space, getpid());
 254 #endif
 255             errno = saved_errno;
 256             return;
 257         }
 258         errno = saved_errno;
 259
 260         tracked_fds_list = tmp;
 261         tracked_fds_list_space = new_space;
 262     }
 263
 264     tracked_fds_list[tracked_fds_list_count++] = fd;
 265
 266 #ifdef DEBUG
 267     debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 268     tracked_fds_debug();
 269 #endif
 270 }
 271 static int tracked_fds_remove(int fd) {
 272     if (fd < TRACKFDS_STATIC_COUNT) {
 273         int old_value = tracked_fds[fd];
 274         tracked_fds[fd] = 0;
 275
 276 #if 0
 277         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 278         tracked_fds_debug();
 279 #endif
 280         return old_value; /* Found vs. not found. */
 281     }
 282
 283     size_t i;
 284     for (i = 0; i < tracked_fds_list_count; i++) {
 285         if (fd != tracked_fds_list[i]) {
 286             continue;
 287         }
 288
 289         memmove(tracked_fds_list + i, tracked_fds_list + i + 1,
 290                 sizeof(*tracked_fds_list) * (tracked_fds_list_count - i - 1));
 291         tracked_fds_list_count--;
 292
 293 #ifdef DEBUG
 294         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 295         tracked_fds_debug();
 296 #endif
 297
 298         /* Found. */
 299         return 1;
 300     }
 301
 302     /* Not found. */
 303     return 0;
 304 }
 305
 306 static int tracked_fds_find_slow(int fd) noinline;
 307 /*
 308  * tracked_fds_find() is called for each hook call and should be as fast as
 309  * possible. As most file descriptors are < TRACKFDS_STATIC_COUNT, force the
 310  * compiler to inline that part which is almost exclusively used.
 311  *
 312  * Inlining tracked_fds_add()/tracked_fds_remove() isn't worth the effort as
 313  * they are not called often enough.
 314  */
 315 inline static int tracked_fds_find(int fd) always_inline;
 316 static int tracked_fds_find(int fd) {
 317     if (fd < TRACKFDS_STATIC_COUNT) {
 318         return tracked_fds[fd];
 319     }
 320
 321     return tracked_fds_find_slow(fd);
 322 }
 323 static int tracked_fds_find_slow(int fd) {
 324     if (tracked_fds_list_count == 0) {
 325         return 0;
 326     }
 327
 328     size_t i;
 329     for (i = 0; i < tracked_fds_list_count; i++) {
 330         if (fd == tracked_fds_list[i]) {
 331             return 1;
 332         }
 333     }
 334     return 0;
 335 }
 336
 337 #endif