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 /* List of tracked file descriptors. */
  24 static int *tracked_fds_list;
  25 /* Current number of items in the list. */
  26 static size_t tracked_fds_list_count;
  27 /* Allocated items, used to reduce realloc()s. */
  28 static size_t tracked_fds_list_space;
  29
  30
  31 #ifdef DEBUG
  32 static void tracked_fds_debug(void) {
  33     debug("    tracked_fds_list: %d/%d\t\t[%d]\n", tracked_fds_list_count,
  34                                                    tracked_fds_list_space,
  35                                                    getpid());
  36     size_t i;
  37     for (i = 0; i < tracked_fds_list_count; i++) {
  38         debug("    tracked_fds_list[%d]: %d\n", i, tracked_fds_list[i]);
  39     }
  40 }
  41 #endif
  42
  43 /* Load tracked file descriptors from the environment. The environment is used
  44  * to pass the information to child processes.
  45  *
  46  * ENV_NAME_FDS has the following format: Each descriptor as string followed
  47  * by a comma; there's a trailing comma. Example: "2,4,". */
  48 static void init_from_environment(void) {
  49 #ifdef DEBUG
  50     debug("init_from_environment()\t\t[%d]\n", getpid());
  51 #endif
  52     const char *env;
  53
  54     initialized = 1;
  55     tracked_fds_list_count = 0;
  56
  57     /* If ENV_NAME_FORCE_WRITE is set and not empty, allow writes to a non-tty
  58      * device. Use with care! Mainly used for the test suite. */
  59     env = getenv(ENV_NAME_FORCE_WRITE);
  60     if (env && env[0] != '\0') {
  61         force_write_to_non_tty = 1;
  62     }
  63
  64     env = getenv(ENV_NAME_FDS);
  65     if (!env) {
  66         return;
  67     }
  68     /* Environment is read-only. */
  69     char env_copy[strlen(env) + 1];
  70     strcpy(env_copy, env);
  71
  72     char *x;
  73
  74     size_t count = 0;
  75     for (x = env_copy; *x; x++) {
  76         if (*x == ',') {
  77             count++;
  78         }
  79     }
  80     tracked_fds_list_space = count + TRACKFDS_REALLOC_STEP;
  81
  82     tracked_fds_list = malloc(tracked_fds_list_space * sizeof(*tracked_fds_list));
  83     if (!tracked_fds_list) {
  84         return;
  85     }
  86
  87     size_t i = 0;
  88
  89     /* Parse file descriptor numbers from environment string and store them as
  90      * integers in tracked_fds_list. */
  91     char *last;
  92     for (x = env_copy, last = env_copy; *x; x++) {
  93         if (*x != ',') {
  94             continue;
  95         }
  96         /* ',' at the beginning or double ',' - ignore. */
  97         if (x == last) {
  98             last = x + 1;
  99             continue;
 100         }
 101
 102         if (i == count) {
 103             break;
 104         }
 105
 106         *x = 0;
 107         tracked_fds_list[i++] = atoi(last);
 108
 109         last = x + 1;
 110     }
 111
 112     tracked_fds_list_count = count;
 113
 114 #ifdef DEBUG
 115     tracked_fds_debug();
 116 #endif
 117 }
 118
 119 static void update_environment_buffer(char *x) {
 120     size_t i;
 121     for (i = 0; i < tracked_fds_list_count; i++) {
 122         int length = snprintf(x, 10 + 1, "%d", tracked_fds_list[i]);
 123         if (length >= 10 + 1) {
 124             /* Integer too big to fit the buffer, skip it. */
 125             continue;
 126         }
 127
 128         /* Write comma after number. */
 129         x += length;
 130         *x++ = ',';
 131         /* Make sure the string is always zero terminated. */
 132         *x = 0;
 133     }
 134 }
 135 inline static size_t update_environment_buffer_size(void) {
 136     /* An integer (32-bit) has at most 10 digits, + 1 for the comma after each
 137      * number. Bigger file descriptors (which shouldn't occur in reality) are
 138      * skipped. */
 139     return tracked_fds_list_count * (10 + 1) + 1 /* to fit '\0' */;
 140 }
 141 static void update_environment(void) {
 142 #ifdef DEBUG
 143     debug("update_environment()\t\t[%d]\n", getpid());
 144 #endif
 145
 146     /* If we haven't parsed the environment we also haven't modified it - so
 147      * nothing to do. */
 148     if (!initialized) {
 149         return;
 150     }
 151
 152     char env[update_environment_buffer_size()];
 153     env[0] = 0;
 154
 155     update_environment_buffer(env);
 156
 157 #if 0
 158     debug("    setenv('%s', '%s', 1)\n", ENV_NAME_FDS, env);
 159 #endif
 160
 161     setenv(ENV_NAME_FDS, env, 1 /* overwrite */);
 162 }
 163
 164
 165
 166 static void tracked_fds_add(int fd) {
 167     if (tracked_fds_list_count >= tracked_fds_list_space) {
 168         size_t new_space = tracked_fds_list_space + TRACKFDS_REALLOC_STEP;
 169         int *tmp = realloc(tracked_fds_list, sizeof(*tracked_fds_list) * new_space);
 170         if (!tmp) {
 171             /* We can do nothing, just ignore the error. We made sure not to
 172              * destroy our state, so the new descriptor is ignored without any
 173              * other consequences. */
 174 #ifdef DEBUG
 175             debug("realloc(tracked_fds_list, %zu) failed! [%d]\n",
 176                   sizeof(*tracked_fds_list) * new_space, getpid());
 177 #endif
 178             return;
 179         }
 180         tracked_fds_list = tmp;
 181         tracked_fds_list_space = new_space;
 182     }
 183
 184     tracked_fds_list[tracked_fds_list_count++] = fd;
 185
 186 #ifdef DEBUG
 187     debug("tracked_fds_add(): %-3d\t\t[%d]\n", fd, getpid());
 188     tracked_fds_debug();
 189 #endif
 190 }
 191 static int tracked_fds_remove(int fd) {
 192     size_t i;
 193     for (i = 0; i < tracked_fds_list_count; i++) {
 194         if (fd != tracked_fds_list[i]) {
 195             continue;
 196         }
 197
 198         memmove(tracked_fds_list + i, tracked_fds_list + i + 1,
 199                 sizeof(*tracked_fds_list) * (tracked_fds_list_count - i - 1));
 200         tracked_fds_list_count--;
 201
 202 #ifdef DEBUG
 203         debug("tracked_fds_remove(): %-3d\t[%d]\n", fd, getpid());
 204         tracked_fds_debug();
 205 #endif
 206
 207         /* Found. */
 208         return 1;
 209     }
 210
 211     /* Not found. */
 212     return 0;
 213 }
 214 static int tracked_fds_find(int fd) {
 215     size_t i;
 216     for (i = 0; i < tracked_fds_list_count; i++) {
 217         if (fd == tracked_fds_list[i]) {
 218             return 1;
 219         }
 220     }
 221     return 0;
 222 }
 223
 224 #endif