]> ruderich.org/simon Gitweb - coloredstderr/coloredstderr.git/blobdiff - src/trackfds.h
tests/example_exec.c: Sort environment variables.
[coloredstderr/coloredstderr.git] / src / trackfds.h
index 9b2aaa6701c854f6c3c7ae3c570b4984ebf1b289..30693f47d1a07888bb578c665227f2ae3afc36d6 100644 (file)
@@ -51,12 +51,14 @@ static void tracked_fds_debug(void) {
 #endif
 
 static int init_tracked_fds_list(size_t count) {
+    assert(count > 0);
+
     /* Reduce reallocs. */
     count += TRACKFDS_REALLOC_STEP;
 
     tracked_fds_list = malloc(count * sizeof(*tracked_fds_list));
     if (!tracked_fds_list) {
-#ifdef DEBUG
+#ifdef WARNING
         warning("malloc(tracked_fds_list, %d) failed [%d]\n",
                 count * sizeof(*tracked_fds_list), getpid());
 #endif
@@ -70,8 +72,9 @@ static int init_tracked_fds_list(size_t count) {
 /* Load tracked file descriptors from the environment. The environment is used
  * to pass the information to child processes.
  *
- * ENV_NAME_FDS has the following format: Each descriptor as string followed
- * by a comma; there's a trailing comma. Example: "2,4,". */
+ * ENV_NAME_FDS and ENV_NAME_PRIVATE_FDS have the following format: Each
+ * descriptor as string followed by a comma; there's a trailing comma.
+ * Example: "2,4,". */
 static void init_from_environment(void) {
 #ifdef DEBUG
     debug("init_from_environment()\t\t[%d]\n", getpid());
@@ -90,12 +93,24 @@ static void init_from_environment(void) {
         force_write_to_non_tty = 1;
     }
 
+    /* Prefer user defined list of file descriptors, fall back to file
+     * descriptors passed through the environment from the parent process. */
     env = getenv(ENV_NAME_FDS);
+    if (env) {
+        used_fds_set_by_user = 1;
+    } else {
+        env = getenv(ENV_NAME_PRIVATE_FDS);
+    }
     if (!env) {
         errno = saved_errno;
         return;
     }
-    /* Environment is read-only. */
+#ifdef DEBUG
+    debug("  getenv(\"%s\"): \"%s\"\n", ENV_NAME_FDS, env);
+    debug("  getenv(\"%s\"): \"%s\"\n", ENV_NAME_PRIVATE_FDS, env);
+#endif
+
+    /* Environment must be treated read-only. */
     char env_copy[strlen(env) + 1];
     strcpy(env_copy, env);
 
@@ -119,18 +134,21 @@ static void init_from_environment(void) {
         }
         /* ',' at the beginning or double ',' - ignore. */
         if (x == last) {
-            last = x + 1;
-            continue;
+            goto next;
         }
 
         if (i == count) {
             break;
         }
 
+        /* Replace ',' to null-terminate number for atoi(). */
         *x = 0;
 
         int fd = atoi(last);
-        if (fd < TRACKFDS_STATIC_COUNT) {
+        if (fd < 0) {
+            goto next;
+
+        } else if (fd < TRACKFDS_STATIC_COUNT) {
             tracked_fds[fd] = 1;
         } else {
             if (!tracked_fds_list) {
@@ -161,10 +179,12 @@ next:
 }
 
 static char *update_environment_buffer_entry(char *x, int fd) {
+    assert(fd >= 0);
+
     int length = snprintf(x, 10 + 1, "%d", fd);
-    if (length >= 10 + 1) {
+    if (length >= 10 + 1 || length <= 0 /* shouldn't happen */) {
         /* Integer too big to fit the buffer, skip it. */
-#ifdef DEBUG
+#ifdef WARNING
         warning("update_environment_buffer_entry(): truncated fd: %d [%d]\n",
                 fd, getpid());
 #endif
@@ -174,12 +194,14 @@ static char *update_environment_buffer_entry(char *x, int fd) {
     /* Write comma after number. */
     x += length;
     *x++ = ',';
-    /* Make sure the string is always zero terminated. */
+    /* Make sure the string is always null-terminated. */
     *x = 0;
 
     return x;
 }
 static void update_environment_buffer(char *x) {
+    assert(initialized);
+
     size_t i;
     for (i = 0; i < TRACKFDS_STATIC_COUNT; i++) {
         if (tracked_fds[i]) {
@@ -191,6 +213,8 @@ static void update_environment_buffer(char *x) {
     }
 }
 inline static size_t update_environment_buffer_size(void) {
+    assert(initialized);
+
     /* Use the maximum count (TRACKFDS_STATIC_COUNT) of used descriptors
      * because it's simple and small enough not to be a problem.
      *
@@ -211,21 +235,36 @@ static void update_environment(void) {
         return;
     }
 
+    int saved_errno = errno;
+
     char env[update_environment_buffer_size()];
     env[0] = 0;
 
     update_environment_buffer(env);
 
 #if 0
-    debug("    setenv('%s', '%s', 1)\n", ENV_NAME_FDS, env);
+    debug("    setenv(\"%s\", \"%s\", 1)\n", ENV_NAME_PRIVATE_FDS, env);
 #endif
+    setenv(ENV_NAME_PRIVATE_FDS, env, 1 /* overwrite */);
 
-    setenv(ENV_NAME_FDS, env, 1 /* overwrite */);
+    /* Child processes must use ENV_NAME_PRIVATE_FDS to get the updated list
+     * of tracked file descriptors, not the static list provided by the user
+     * in ENV_NAME_FDS.
+     *
+     * But only remove it if the static list in ENV_NAME_FDS was loaded by
+     * init_from_environment() and merged into ENV_NAME_PRIVATE_FDS. */
+    if (used_fds_set_by_user) {
+        unsetenv(ENV_NAME_FDS);
+    }
+
+    errno = saved_errno;
 }
 
 
 
 static void tracked_fds_add(int fd) {
+    assert(fd >= 0);
+
     if (fd < TRACKFDS_STATIC_COUNT) {
         tracked_fds[fd] = 1;
 #if 0
@@ -245,7 +284,7 @@ static void tracked_fds_add(int fd) {
             /* We can do nothing, just ignore the error. We made sure not to
              * destroy our state, so the new descriptor is ignored without any
              * other consequences. */
-#ifdef DEBUG
+#ifdef WARNING
             warning("realloc(tracked_fds_list, %zu) failed! [%d]\n",
                     sizeof(*tracked_fds_list) * new_space, getpid());
 #endif
@@ -266,6 +305,8 @@ static void tracked_fds_add(int fd) {
 #endif
 }
 static int tracked_fds_remove(int fd) {
+    assert(fd >= 0);
+
     if (fd < TRACKFDS_STATIC_COUNT) {
         int old_value = tracked_fds[fd];
         tracked_fds[fd] = 0;
@@ -299,10 +340,34 @@ static int tracked_fds_remove(int fd) {
     /* Not found. */
     return 0;
 }
-static int tracked_fds_find(int fd) {
+
+static int tracked_fds_find_slow(int fd) noinline;
+/*
+ * tracked_fds_find() is called for each hook call and should be as fast as
+ * possible. As most file descriptors are < TRACKFDS_STATIC_COUNT, force the
+ * compiler to inline that part which is almost exclusively used.
+ *
+ * Inlining tracked_fds_add()/tracked_fds_remove() isn't worth the effort as
+ * they are not called often enough.
+ */
+inline static int tracked_fds_find(int fd) always_inline;
+inline static int tracked_fds_find(int fd) {
+    /* Invalid file descriptor. No assert() as we're called from the hooked
+     * macro. */
+    if (unlikely(fd < 0)) {
+        return 0;
+    }
+
     if (fd < TRACKFDS_STATIC_COUNT) {
         return tracked_fds[fd];
     }
+
+    return tracked_fds_find_slow(fd);
+}
+static int tracked_fds_find_slow(int fd) {
+    assert(initialized);
+    assert(fd >= 0);
+
     if (tracked_fds_list_count == 0) {
         return 0;
     }