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