]> ruderich.org/simon Gitweb - coloredstderr/coloredstderr.git/blobdiff - src/coloredstderr.c
Add assert()s.
[coloredstderr/coloredstderr.git] / src / coloredstderr.c
index 44726899e4fb7590345d0890410cc6ee57abf3ca..7c4a5f5010cc42163ca10e8de75a34cb1ea32da1 100644 (file)
 
 #include <config.h>
 
+#include "compiler.h"
+
 /* Must be loaded before the following headers. */
 #include "ldpreload.h"
 
+/* Disable assert()s if not compiled with --enable-debug. */
+#ifndef DEBUG
+# define NDEBUG
+#endif
+
+#include <assert.h>
 #include <errno.h>
 #include <fcntl.h>
 #include <stdarg.h>
 #ifdef HAVE_ERROR_H
 # include <error.h>
 #endif
+#ifdef HAVE_STRUCT__IO_FILE__FILENO
+# include <libio.h>
+#endif
 
 /* Conflicting declaration in glibc. */
 #undef fwrite_unlocked
+/* These functions may be macros when compiling with hardening flags (fortify)
+ * which cause build failures when used in our hook macros below. Observed
+ * with Clang on Debian Wheezy. */
+#undef printf
+#undef fprintf
 
 
 /* Used by various functions, including debug(). */
@@ -51,7 +67,7 @@ static int force_write_to_non_tty;
 
 
 #include "constants.h"
-#ifdef DEBUG
+#ifdef WARNING
 # include "debug.h"
 #endif
 
@@ -60,34 +76,32 @@ static int force_write_to_non_tty;
 
 
 
-/* Should the "action" handler be invoked for this file descriptor? */
-static int check_handle_fd(int fd) {
-    /* Load state from environment. Only necessary once per process. */
-    if (!initialized) {
-        init_from_environment();
-    }
+/* See hookmacros.h for the decision if a function call is colored. */
 
-    /* tracked_fds_find() is most likely faster than calling isatty(),
-     * therefore check if we are tracking this file descriptor first. */
-    if (!tracked_fds_find(fd)) {
-        return 0;
-    }
 
-    /* Never touch anything not going to a terminal - unless we are explicitly
-     * asked to do so. */
-    if (!force_write_to_non_tty && !isatty(fd)) {
-        return 0;
-    }
+/* Prevent inlining into hook functions because it may increase the number of
+ * spilled registers unnecessarily. As it's not called very often accept the
+ * additional call. */
+static int isatty_noinline(int fd) noinline;
+static int isatty_noinline(int fd) {
+    assert(fd >= 0);
 
-    return 1;
+    int saved_errno = errno;
+    int result = isatty(fd);
+    errno = saved_errno;
+
+    return result;
 }
 
+
 static void dup_fd(int oldfd, int newfd) {
 #ifdef DEBUG
     debug("%3d -> %3d\t\t\t[%d]\n", oldfd, newfd, getpid());
 #endif
 
-    if (!initialized) {
+    assert(oldfd >= 0 && newfd >= 0);
+
+    if (unlikely(!initialized)) {
         init_from_environment();
     }
 
@@ -109,7 +123,9 @@ static void close_fd(int fd) {
     debug("%3d ->   .\t\t\t[%d]\n", fd, getpid());
 #endif
 
-    if (!initialized) {
+    assert(fd >= 0);
+
+    if (unlikely(!initialized)) {
         init_from_environment();
     }
 
@@ -119,14 +135,14 @@ static void close_fd(int fd) {
 
 /* "Action" handlers called when a file descriptor is matched. */
 
-static char *pre_string;
+static char const *pre_string;
 static size_t pre_string_size;
-static char *post_string;
+static char const *post_string;
 static size_t post_string_size;
 
 /* Load alternative pre/post strings from the environment if available, fall
  * back to default values. */
-inline static void init_pre_post_string() {
+static void init_pre_post_string(void) {
     pre_string = getenv(ENV_NAME_PRE_STRING);
     if (!pre_string) {
         pre_string = DEFAULT_PRE_STRING;
@@ -140,38 +156,53 @@ inline static void init_pre_post_string() {
     post_string_size = strlen(post_string);
 }
 
-static void handle_fd_pre(int fd, int action) {
-    (void)action;
+/* Don't inline any of the pre/post functions. Keep the hook function as small
+ * as possible for speed reasons. */
+static void handle_fd_pre(int fd) noinline;
+static void handle_fd_post(int fd) noinline;
+static void handle_file_pre(FILE *stream) noinline;
+static void handle_file_post(FILE *stream) noinline;
+
+static void handle_fd_pre(int fd) {
+    int saved_errno = errno;
 
-    if (!pre_string || !post_string) {
+    if (unlikely(!pre_string || !post_string)) {
         init_pre_post_string();
     }
 
     DLSYM_FUNCTION(real_write, "write");
     real_write(fd, pre_string, pre_string_size);
+
+    errno = saved_errno;
 }
-static void handle_fd_post(int fd, int action) {
-    (void)action;
+static void handle_fd_post(int fd) {
+    int saved_errno = errno;
 
     /* write() already loaded above in handle_fd_pre(). */
     real_write(fd, post_string, post_string_size);
+
+    errno = saved_errno;
 }
 
-static void handle_file_pre(FILE *stream, int action) {
-    (void)action;
+static void handle_file_pre(FILE *stream) {
+    int saved_errno = errno;
 
-    if (!pre_string || !post_string) {
+    if (unlikely(!pre_string || !post_string)) {
         init_pre_post_string();
     }
 
     DLSYM_FUNCTION(real_fwrite, "fwrite");
     real_fwrite(pre_string, pre_string_size, 1, stream);
+
+    errno = saved_errno;
 }
-static void handle_file_post(FILE *stream, int action) {
-    (void)action;
+static void handle_file_post(FILE *stream) {
+    int saved_errno = errno;
 
     /* fwrite() already loaded above in handle_file_pre(). */
     real_fwrite(post_string, post_string_size, 1, stream);
+
+    errno = saved_errno;
 }
 
 
@@ -225,8 +256,10 @@ HOOK_FILE2(int, putc_unlocked, stream,
            int, c, FILE *, stream)
 HOOK_FILE1(int, putchar_unlocked, stdout,
            int, c)
-HOOK_FILE1(int, puts_unlocked, stdout,
-           char const *, s)
+/* glibc defines (_IO_)putc_unlocked() to __overflow() in some cases. */
+#ifdef HAVE_STRUCT__IO_FILE__FILENO
+HOOK_FD2(int, __overflow, f->_fileno, _IO_FILE *, f, int, ch)
+#endif
 
 /* perror(3) */
 HOOK_VOID1(void, perror, STDERR_FILENO,
@@ -234,9 +267,9 @@ HOOK_VOID1(void, perror, STDERR_FILENO,
 
 /* error(3) */
 #ifdef HAVE_ERROR_H
-static void  error_vararg(int status, int errnum,
-                   char const *filename, unsigned int linenum,
-                   char const *format, va_list ap) {
+static void error_vararg(int status, int errnum,
+                         char const *filename, unsigned int linenum,
+                         char const *format, va_list ap) {
     static char const *last_filename;
     static unsigned int last_linenum;
 
@@ -313,9 +346,7 @@ int dup(int oldfd) {
 
     newfd = real_dup(oldfd);
     if (newfd != -1) {
-        int saved_errno = errno;
         dup_fd(oldfd, newfd);
-        errno = saved_errno;
     }
 
     return newfd;
@@ -325,9 +356,7 @@ int dup2(int oldfd, int newfd) {
 
     newfd = real_dup2(oldfd, newfd);
     if (newfd != -1) {
-        int saved_errno = errno;
         dup_fd(oldfd, newfd);
-        errno = saved_errno;
     }
 
     return newfd;
@@ -337,9 +366,7 @@ int dup3(int oldfd, int newfd, int flags) {
 
     newfd = real_dup3(oldfd, newfd, flags);
     if (newfd != -1) {
-        int saved_errno = errno;
         dup_fd(oldfd, newfd);
-        errno = saved_errno;
     }
 
     return newfd;
@@ -371,9 +398,7 @@ int fcntl(int fd, int cmd, ...) {
 
     /* We only care about duping fds. */
     if (cmd == F_DUPFD && result != -1) {
-        int saved_errno = errno;
         dup_fd(fd, result);
-        errno = saved_errno;
     }
 
     return result;
@@ -383,14 +408,20 @@ static int (*real_close)(int);
 int close(int fd) {
     DLSYM_FUNCTION(real_close, "close");
 
-    close_fd(fd);
+    if (fd >= 0) {
+        close_fd(fd);
+    }
     return real_close(fd);
 }
 static int (*real_fclose)(FILE *);
 int fclose(FILE *fp) {
+    int fd;
+
     DLSYM_FUNCTION(real_fclose, "fclose");
 
-    close_fd(fileno(fp));
+    if (fp != NULL && (fd = fileno(fp)) >= 0) {
+        close_fd(fd);
+    }
     return real_fclose(fp);
 }
 
@@ -476,7 +507,7 @@ int execve(char const *filename, char * const argv[], char * const env[]) {
     /* Count arguments. */ \
     size_t count = 1; /* arg */ \
     va_start(ap, arg); \
-    while (va_arg(ap, const char *)) { \
+    while (va_arg(ap, char const *)) { \
         count++; \
     } \
     va_end(ap); \
@@ -529,9 +560,19 @@ int execv(char const *path, char * const argv[]) {
 }
 
 static int (*real_execvp)(char const *path, char * const argv[]);
-int execvp(char const *path, char * const argv[]) {
+int execvp(char const *file, char * const argv[]) {
     DLSYM_FUNCTION(real_execvp, "execvp");
 
     update_environment();
-    return real_execvp(path, argv);
+    return real_execvp(file, argv);
 }
+
+#ifdef HAVE_EXECVPE
+extern char **environ;
+int execvpe(char const *file, char * const argv[], char * const envp[]) {
+    /* Fake the environment so we can reuse execvp(). */
+    environ = (char **)envp;
+
+    return execvp(file, argv);
+}
+#endif