src/coloredstderr.c

   1 /*
   2  * Hook output functions (like printf(3)) with LD_PRELOAD to color stderr (or
   3  * other file descriptors).
   4  *
   5  * Copyright (C) 2013  Simon Ruderich
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <config.h>
  22
  23 /* Must be loaded before the following headers. */
  24 #include "ldpreload.h"
  25
  26 #include <errno.h>
  27 #include <fcntl.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <string.h>
  31 #include <unistd.h>
  32
  33 #ifdef HAVE_ERROR_H
  34 # include <error.h>
  35 #endif
  36
  37 /* Conflicting declaration in glibc. */
  38 #undef fwrite_unlocked
  39
  40
  41 /* Used by various functions, including debug(). */
  42 static ssize_t (*real_write)(int, void const *, size_t);
  43 static int (*real_close)(int);
  44 static size_t (*real_fwrite)(void const *, size_t, size_t, FILE *);
  45
  46 /* Did we already (try to) parse the environment and setup the necessary
  47  * variables? */
  48 static int initialized;
  49 /* Force hooked writes even when not writing to a tty. Used for tests. */
  50 static int force_write_to_non_tty;
  51
  52
  53 #include "constants.h"
  54 #ifdef DEBUG
  55 # include "debug.h"
  56 #endif
  57
  58 #include "hookmacros.h"
  59 #include "trackfds.h"
  60
  61
  62
  63 /* Should the "action" handler be invoked for this file descriptor? */
  64 static int check_handle_fd(int fd) {
  65     /* Load state from environment. Only necessary once per process. */
  66     if (!initialized) {
  67         init_from_environment();
  68     }
  69
  70     /* tracked_fds_find() is most likely faster than calling isatty(),
  71      * therefore check if we are tracking this file descriptor first. */
  72     if (!tracked_fds_find(fd)) {
  73         return 0;
  74     }
  75
  76     /* Never touch anything not going to a terminal - unless we are explicitly
  77      * asked to do so. */
  78     if (!force_write_to_non_tty && !isatty(fd)) {
  79         return 0;
  80     }
  81
  82     return 1;
  83 }
  84
  85 static void dup_fd(int oldfd, int newfd) {
  86 #ifdef DEBUG
  87     debug("%3d -> %3d\t\t\t[%d]\n", oldfd, newfd, getpid());
  88 #endif
  89
  90     if (!initialized) {
  91         init_from_environment();
  92     }
  93
  94     /* We are already tracking this file descriptor, add newfd to the list as
  95      * it will reference the same descriptor. */
  96     if (tracked_fds_find(oldfd)) {
  97         if (!tracked_fds_find(newfd)) {
  98             tracked_fds_add(newfd);
  99         }
 100     /* We are not tracking this file descriptor, remove newfd from the list
 101      * (if present). */
 102     } else {
 103         tracked_fds_remove(newfd);
 104     }
 105 }
 106
 107 static void close_fd(int fd) {
 108 #ifdef DEBUG
 109     debug("%3d ->   .\t\t\t[%d]\n", fd, getpid());
 110 #endif
 111
 112     if (!initialized) {
 113         init_from_environment();
 114     }
 115
 116     tracked_fds_remove(fd);
 117 }
 118
 119
 120 /* "Action" handlers called when a file descriptor is matched. */
 121
 122 static char const *pre_string;
 123 static size_t pre_string_size;
 124 static char const *post_string;
 125 static size_t post_string_size;
 126
 127 /* Load alternative pre/post strings from the environment if available, fall
 128  * back to default values. */
 129 inline static void init_pre_post_string(void) {
 130     pre_string = getenv(ENV_NAME_PRE_STRING);
 131     if (!pre_string) {
 132         pre_string = DEFAULT_PRE_STRING;
 133     }
 134     pre_string_size = strlen(pre_string);
 135
 136     post_string = getenv(ENV_NAME_POST_STRING);
 137     if (!post_string) {
 138         post_string = DEFAULT_POST_STRING;
 139     }
 140     post_string_size = strlen(post_string);
 141 }
 142
 143 static void handle_fd_pre(int fd, int action) {
 144     (void)action;
 145
 146     if (!pre_string || !post_string) {
 147         init_pre_post_string();
 148     }
 149
 150     DLSYM_FUNCTION(real_write, "write");
 151     real_write(fd, pre_string, pre_string_size);
 152 }
 153 static void handle_fd_post(int fd, int action) {
 154     (void)action;
 155
 156     /* write() already loaded above in handle_fd_pre(). */
 157     real_write(fd, post_string, post_string_size);
 158 }
 159
 160 static void handle_file_pre(FILE *stream, int action) {
 161     (void)action;
 162
 163     if (!pre_string || !post_string) {
 164         init_pre_post_string();
 165     }
 166
 167     DLSYM_FUNCTION(real_fwrite, "fwrite");
 168     real_fwrite(pre_string, pre_string_size, 1, stream);
 169 }
 170 static void handle_file_post(FILE *stream, int action) {
 171     (void)action;
 172
 173     /* fwrite() already loaded above in handle_file_pre(). */
 174     real_fwrite(post_string, post_string_size, 1, stream);
 175 }
 176
 177
 178
 179 /* Hook all important output functions to manipulate their output. */
 180
 181 HOOK_FD3(ssize_t, write, fd,
 182          int, fd, void const *, buf, size_t, count)
 183 HOOK_FILE4(size_t, fwrite, stream,
 184            void const *, ptr, size_t, size, size_t, nmemb, FILE *, stream)
 185
 186 /* puts(3) */
 187 HOOK_FILE2(int, fputs, stream,
 188            char const *, s, FILE *, stream)
 189 HOOK_FILE2(int, fputc, stream,
 190            int, c, FILE *, stream)
 191 HOOK_FILE2(int, putc, stream,
 192            int, c, FILE *, stream)
 193 HOOK_FILE1(int, putchar, stdout,
 194            int, c)
 195 HOOK_FILE1(int, puts, stdout,
 196            char const *, s)
 197
 198 /* printf(3), excluding all s*() and vs*() functions (no output) */
 199 HOOK_VAR_FILE1(int, printf, stdout, vprintf,
 200                char const *, format)
 201 HOOK_VAR_FILE2(int, fprintf, stream, vfprintf,
 202                FILE *, stream, char const *, format)
 203 HOOK_FILE2(int, vprintf, stdout,
 204            char const *, format, va_list, ap)
 205 HOOK_FILE3(int, vfprintf, stream,
 206            FILE *, stream, char const *, format, va_list, ap)
 207 /* Hardening functions (-D_FORTIFY_SOURCE=2), only functions from above */
 208 HOOK_VAR_FILE2(int, __printf_chk, stdout, __vprintf_chk,
 209                int, flag, char const *, format)
 210 HOOK_VAR_FILE3(int, __fprintf_chk, fp, __vfprintf_chk,
 211                FILE *, fp, int, flag, char const *, format)
 212 HOOK_FILE3(int, __vprintf_chk, stdout,
 213            int, flag, char const *, format, va_list, ap)
 214 HOOK_FILE4(int, __vfprintf_chk, stream,
 215            FILE *, stream, int, flag, char const *, format, va_list, ap)
 216
 217 /* unlocked_stdio(3), only functions from above are hooked */
 218 HOOK_FILE4(size_t, fwrite_unlocked, stream,
 219            void const *, ptr, size_t, size, size_t, nmemb, FILE *, stream)
 220 HOOK_FILE2(int, fputs_unlocked, stream,
 221            char const *, s, FILE *, stream)
 222 HOOK_FILE2(int, fputc_unlocked, stream,
 223            int, c, FILE *, stream)
 224 HOOK_FILE2(int, putc_unlocked, stream,
 225            int, c, FILE *, stream)
 226 HOOK_FILE1(int, putchar_unlocked, stdout,
 227            int, c)
 228
 229 /* perror(3) */
 230 HOOK_VOID1(void, perror, STDERR_FILENO,
 231            char const *, s)
 232
 233 /* error(3) */
 234 #ifdef HAVE_ERROR_H
 235 static void  error_vararg(int status, int errnum,
 236                    char const *filename, unsigned int linenum,
 237                    char const *format, va_list ap) {
 238     static char const *last_filename;
 239     static unsigned int last_linenum;
 240
 241     /* Skip this error message if requested and if there was already an error
 242      * in the same file/line. */
 243     if (error_one_per_line
 244             && filename != NULL && linenum != 0
 245             && filename == last_filename && linenum == last_linenum) {
 246         return;
 247     }
 248     last_filename = filename;
 249     last_linenum  = linenum;
 250
 251     error_message_count++;
 252
 253     fflush(stdout);
 254
 255     if (error_print_progname) {
 256         error_print_progname();
 257     } else {
 258         fprintf(stderr, "%s:", program_invocation_name);
 259     }
 260     if (filename != NULL && linenum != 0) {
 261         fprintf(stderr, "%s:%u:", filename, linenum);
 262         if (error_print_progname) {
 263             fprintf(stderr, " ");
 264         }
 265     }
 266     if (!error_print_progname) {
 267         fprintf(stderr, " ");
 268     }
 269
 270
 271     vfprintf(stderr, format, ap);
 272
 273     if (errnum != 0) {
 274         fprintf(stderr, ": %s", strerror(errnum));
 275     }
 276
 277     fprintf(stderr, "\n");
 278
 279     if (status != 0) {
 280         exit(status);
 281     }
 282 }
 283 void error_at_line(int status, int errnum,
 284                    char const *filename, unsigned int linenum,
 285                    char const *format, ...) {
 286     va_list ap;
 287
 288     va_start(ap, format);
 289     error_vararg(status, errnum, filename, linenum, format, ap);
 290     va_end(ap);
 291 }
 292 void error(int status, int errnum, char const *format, ...) {
 293     va_list ap;
 294
 295     va_start(ap, format);
 296     error_vararg(status, errnum, NULL, 0, format, ap);
 297     va_end(ap);
 298 }
 299 #endif
 300
 301
 302 /* Hook functions which duplicate file descriptors to track them. */
 303
 304 static int (*real_dup)(int);
 305 static int (*real_dup2)(int, int);
 306 static int (*real_dup3)(int, int, int);
 307 int dup(int oldfd) {
 308     int newfd;
 309
 310     DLSYM_FUNCTION(real_dup, "dup");
 311
 312     newfd = real_dup(oldfd);
 313     if (newfd != -1) {
 314         int saved_errno = errno;
 315         dup_fd(oldfd, newfd);
 316         errno = saved_errno;
 317     }
 318
 319     return newfd;
 320 }
 321 int dup2(int oldfd, int newfd) {
 322     DLSYM_FUNCTION(real_dup2, "dup2");
 323
 324     newfd = real_dup2(oldfd, newfd);
 325     if (newfd != -1) {
 326         int saved_errno = errno;
 327         dup_fd(oldfd, newfd);
 328         errno = saved_errno;
 329     }
 330
 331     return newfd;
 332 }
 333 int dup3(int oldfd, int newfd, int flags) {
 334     DLSYM_FUNCTION(real_dup3, "dup3");
 335
 336     newfd = real_dup3(oldfd, newfd, flags);
 337     if (newfd != -1) {
 338         int saved_errno = errno;
 339         dup_fd(oldfd, newfd);
 340         errno = saved_errno;
 341     }
 342
 343     return newfd;
 344 }
 345
 346 static int (*real_fcntl)(int, int, ...);
 347 int fcntl(int fd, int cmd, ...) {
 348     int result;
 349     va_list ap;
 350
 351     DLSYM_FUNCTION(real_fcntl, "fcntl");
 352
 353     /* fcntl() takes different types of arguments depending on the cmd type
 354      * (int, void and pointers are used at the moment). Handling these
 355      * arguments for different systems and with possible changes in the future
 356      * is error prone.
 357      *
 358      * Therefore always retrieve a void-pointer from our arguments (even if it
 359      * wasn't there) and pass it to real_fcntl(). This shouldn't cause any
 360      * problems because a void-pointer is most-likely bigger than an int
 361      * (something which is not true in reverse) and shouldn't cause
 362      * truncation. For register based calling conventions an invalid register
 363      * content is passed, but ignored by real_fcntl(). Not perfect, but should
 364      * work fine.
 365      */
 366     va_start(ap, cmd);
 367     result = real_fcntl(fd, cmd, va_arg(ap, void *));
 368     va_end(ap);
 369
 370     /* We only care about duping fds. */
 371     if (cmd == F_DUPFD && result != -1) {
 372         int saved_errno = errno;
 373         dup_fd(fd, result);
 374         errno = saved_errno;
 375     }
 376
 377     return result;
 378 }
 379
 380 static int (*real_close)(int);
 381 int close(int fd) {
 382     DLSYM_FUNCTION(real_close, "close");
 383
 384     close_fd(fd);
 385     return real_close(fd);
 386 }
 387 static int (*real_fclose)(FILE *);
 388 int fclose(FILE *fp) {
 389     DLSYM_FUNCTION(real_fclose, "fclose");
 390
 391     close_fd(fileno(fp));
 392     return real_fclose(fp);
 393 }
 394
 395
 396 /* Hook functions which are necessary for correct tracking. */
 397
 398 #if defined(HAVE_VFORK) && defined(HAVE_FORK)
 399 pid_t vfork(void) {
 400     /* vfork() is similar to fork() but the address space is shared between
 401      * father and child. It's designed for fork()/exec() usage because it's
 402      * faster than fork(). However according to the POSIX standard the "child"
 403      * isn't allowed to perform any memory-modifications before the exec()
 404      * (except the pid_t result variable of vfork()).
 405      *
 406      * As some programs don't adhere to the standard (e.g. the "child" closes
 407      * or dups a descriptor before the exec()) and this breaks our tracking of
 408      * file descriptors (e.g. it gets closed in the parent as well), we just
 409      * fork() instead. This is in compliance with the POSIX standard and as
 410      * most systems use copy-on-write anyway not a performance issue. */
 411     return fork();
 412 }
 413 #endif
 414
 415
 416 /* Hook execve() and the other exec*() functions. Some shells use exec*() with
 417  * a custom environment which doesn't necessarily contain our updates to
 418  * ENV_NAME_FDS. It's also faster to update the environment only when
 419  * necessary, right before the exec() to pass it to the new process. */
 420
 421 static int (*real_execve)(char const *filename, char * const argv[], char * const env[]);
 422 int execve(char const *filename, char * const argv[], char * const env[]) {
 423     DLSYM_FUNCTION(real_execve, "execve");
 424
 425     int found = 0;
 426     size_t index = 0;
 427
 428     /* Count arguments and search for existing ENV_NAME_FDS environment
 429      * variable. */
 430     size_t count = 0;
 431     char * const *x = env;
 432     while (*x) {
 433         if (!strncmp(*x, ENV_NAME_FDS "=", strlen(ENV_NAME_FDS) + 1)) {
 434             found = 1;
 435             index = count;
 436         }
 437
 438         x++;
 439         count++;
 440     }
 441     /* Terminating NULL. */
 442     count++;
 443
 444     char *env_copy[count + 1 /* space for our new entry if necessary */];
 445     memcpy(env_copy, env, count * sizeof(char *));
 446
 447     /* Make sure the information from the environment is loaded. We can't just
 448      * do nothing (like update_environment()) because the caller might pass a
 449      * different environment which doesn't include any of our settings. */
 450     if (!initialized) {
 451         init_from_environment();
 452     }
 453
 454     char fds_env[strlen(ENV_NAME_FDS) + 1 + update_environment_buffer_size()];
 455     strcpy(fds_env, ENV_NAME_FDS "=");
 456     update_environment_buffer(fds_env + strlen(ENV_NAME_FDS) + 1);
 457
 458     if (found) {
 459         env_copy[index] = fds_env;
 460     } else {
 461         /* If the process removed ENV_NAME_FDS from the environment, re-add
 462          * it. */
 463         env_copy[count-1] = fds_env;
 464         env_copy[count] = NULL;
 465     }
 466
 467     return real_execve(filename, argv, env_copy);
 468 }
 469
 470 #define EXECL_COPY_VARARGS_START(args) \
 471     va_list ap; \
 472     char *x; \
 473     \
 474     /* Count arguments. */ \
 475     size_t count = 1; /* arg */ \
 476     va_start(ap, arg); \
 477     while (va_arg(ap, char const *)) { \
 478         count++; \
 479     } \
 480     va_end(ap); \
 481     \
 482     /* Copy varargs. */ \
 483     char *args[count + 1 /* terminating NULL */]; \
 484     args[0] = (char *)arg; \
 485     \
 486     size_t i = 1; \
 487     va_start(ap, arg); \
 488     while ((x = va_arg(ap, char *))) { \
 489         args[i++] = x; \
 490     } \
 491     args[i] = NULL;
 492 #define EXECL_COPY_VARARGS_END(args) \
 493     va_end(ap);
 494 #define EXECL_COPY_VARARGS(args) \
 495     EXECL_COPY_VARARGS_START(args); \
 496     EXECL_COPY_VARARGS_END(args);
 497
 498 int execl(char const *path, char const *arg, ...) {
 499     EXECL_COPY_VARARGS(args);
 500
 501     update_environment();
 502     return execv(path, args);
 503 }
 504
 505 int execlp(char const *file, char const *arg, ...) {
 506     EXECL_COPY_VARARGS(args);
 507
 508     update_environment();
 509     return execvp(file, args);
 510 }
 511
 512 int execle(char const *path, char const *arg, ... /*, char * const envp[] */) {
 513     EXECL_COPY_VARARGS_START(args);
 514     /* Get envp[] located after arguments. */
 515     char * const *envp = va_arg(ap, char * const *);
 516     EXECL_COPY_VARARGS_END(args);
 517
 518     return execve(path, args, envp);
 519 }
 520
 521 static int (*real_execv)(char const *path, char * const argv[]);
 522 int execv(char const *path, char * const argv[]) {
 523     DLSYM_FUNCTION(real_execv, "execv");
 524
 525     update_environment();
 526     return real_execv(path, argv);
 527 }
 528
 529 static int (*real_execvp)(char const *path, char * const argv[]);
 530 int execvp(char const *path, char * const argv[]) {
 531     DLSYM_FUNCTION(real_execvp, "execvp");
 532
 533     update_environment();
 534     return real_execvp(path, argv);
 535 }