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 #include "compiler.h"
  24
  25 /* Must be loaded before the following headers. */
  26 #include "ldpreload.h"
  27
  28 /* Disable assert()s if not compiled with --enable-debug. */
  29 #ifndef DEBUG
  30 # define NDEBUG
  31 #endif
  32
  33 #include <assert.h>
  34 #include <errno.h>
  35 #include <fcntl.h>
  36 #include <stdarg.h>
  37 #include <stdio.h>
  38 #include <string.h>
  39 #include <sys/stat.h>
  40 #include <unistd.h>
  41
  42 #ifdef HAVE_ERR_H
  43 # include <err.h>
  44 #endif
  45 #ifdef HAVE_ERROR_H
  46 # include <error.h>
  47 #endif
  48 #ifdef HAVE_STRUCT__IO_FILE__FILENO
  49 # include <libio.h>
  50 #endif
  51
  52 /* The following functions may be macros. Undefine them or they cause build
  53  * failures when used in our hook macros below. */
  54
  55 /* In glibc, real fwrite_unlocked() is called in macro. */
  56 #ifdef HAVE_FWRITE_UNLOCKED
  57 # undef fwrite_unlocked
  58 #endif
  59 /* In Clang when compiling with hardening flags (fortify) on Debian Wheezy. */
  60 #undef printf
  61 #undef fprintf
  62 /* On FreeBSD (9.1), __swbuf() is used instead of these macros. */
  63 #ifdef HAVE___SWBUF
  64 # undef putc
  65 # undef putc_unlocked
  66 # undef putchar
  67 # undef putchar_unlocked
  68 #endif
  69
  70
  71 /* Used by various functions, including debug(). */
  72 static ssize_t (*real_write)(int, void const *, size_t);
  73 static int (*real_close)(int);
  74 static size_t (*real_fwrite)(void const *, size_t, size_t, FILE *);
  75
  76 /* Did we already (try to) parse the environment and setup the necessary
  77  * variables? */
  78 static int initialized;
  79 /* Force hooked writes even when not writing to a tty. Used for tests. */
  80 static int force_write_to_non_tty;
  81 /* Was ENV_NAME_FDS found and used when init_from_environment() was called?
  82  * This is not true if the process set it manually after initialization. */
  83 static int used_fds_set_by_user;
  84
  85
  86 #include "constants.h"
  87 #ifdef WARNING
  88 # include "debug.h"
  89 #endif
  90
  91 #include "hookmacros.h"
  92 #include "trackfds.h"
  93
  94
  95
  96 /* See hookmacros.h for the decision if a function call is colored. */
  97
  98
  99 /* Prevent inlining into hook functions because it may increase the number of
 100  * spilled registers unnecessarily. As it's not called very often accept the
 101  * additional call. */
 102 static int isatty_noinline(int fd) noinline;
 103 static int isatty_noinline(int fd) {
 104     assert(fd >= 0);
 105
 106     int saved_errno = errno;
 107     int result = isatty(fd);
 108     errno = saved_errno;
 109
 110     return result;
 111 }
 112
 113
 114 static void dup_fd(int oldfd, int newfd) {
 115 #ifdef DEBUG
 116     debug("%3d -> %3d\t\t\t[%d]\n", oldfd, newfd, getpid());
 117 #endif
 118
 119     assert(oldfd >= 0 && newfd >= 0);
 120
 121     if (unlikely(!initialized)) {
 122         init_from_environment();
 123     }
 124
 125     /* We are already tracking this file descriptor, add newfd to the list as
 126      * it will reference the same descriptor. */
 127     if (tracked_fds_find(oldfd)) {
 128         if (!tracked_fds_find(newfd)) {
 129             tracked_fds_add(newfd);
 130         }
 131     /* We are not tracking this file descriptor, remove newfd from the list
 132      * (if present). */
 133     } else {
 134         tracked_fds_remove(newfd);
 135     }
 136 }
 137
 138 static void close_fd(int fd) {
 139 #ifdef DEBUG
 140     debug("%3d ->   .\t\t\t[%d]\n", fd, getpid());
 141 #endif
 142
 143     assert(fd >= 0);
 144
 145     if (unlikely(!initialized)) {
 146         init_from_environment();
 147     }
 148
 149     tracked_fds_remove(fd);
 150 }
 151
 152
 153 /* "Action" handlers called when a file descriptor is matched. */
 154
 155 static char const *pre_string;
 156 static size_t pre_string_size;
 157 static char const *post_string;
 158 static size_t post_string_size;
 159
 160 /* Load alternative pre/post strings from the environment if available, fall
 161  * back to default values. */
 162 static void init_pre_post_string(void) {
 163     pre_string = getenv(ENV_NAME_PRE_STRING);
 164     if (!pre_string) {
 165         pre_string = DEFAULT_PRE_STRING;
 166     }
 167     pre_string_size = strlen(pre_string);
 168
 169     post_string = getenv(ENV_NAME_POST_STRING);
 170     if (!post_string) {
 171         post_string = DEFAULT_POST_STRING;
 172     }
 173     post_string_size = strlen(post_string);
 174 }
 175
 176 /* Don't inline any of the pre/post functions. Keep the hook function as small
 177  * as possible for speed reasons. */
 178 static void handle_fd_pre(int fd) noinline;
 179 static void handle_fd_post(int fd) noinline;
 180 static void handle_file_pre(FILE *stream) noinline;
 181 static void handle_file_post(FILE *stream) noinline;
 182
 183 static void handle_fd_pre(int fd) {
 184     int saved_errno = errno;
 185
 186     if (unlikely(!pre_string || !post_string)) {
 187         init_pre_post_string();
 188     }
 189
 190     DLSYM_FUNCTION(real_write, "write");
 191     real_write(fd, pre_string, pre_string_size);
 192
 193     errno = saved_errno;
 194 }
 195 static void handle_fd_post(int fd) {
 196     int saved_errno = errno;
 197
 198     /* write() already loaded above in handle_fd_pre(). */
 199     real_write(fd, post_string, post_string_size);
 200
 201     errno = saved_errno;
 202 }
 203
 204 static void handle_file_pre(FILE *stream) {
 205     int saved_errno = errno;
 206
 207     if (unlikely(!pre_string || !post_string)) {
 208         init_pre_post_string();
 209     }
 210
 211     DLSYM_FUNCTION(real_fwrite, "fwrite");
 212     real_fwrite(pre_string, pre_string_size, 1, stream);
 213
 214     errno = saved_errno;
 215 }
 216 static void handle_file_post(FILE *stream) {
 217     int saved_errno = errno;
 218
 219     /* fwrite() already loaded above in handle_file_pre(). */
 220     real_fwrite(post_string, post_string_size, 1, stream);
 221
 222     errno = saved_errno;
 223 }
 224
 225
 226
 227 /* Hook all important output functions to manipulate their output. */
 228
 229 HOOK_FD3(ssize_t, write, fd,
 230          int, fd, void const *, buf, size_t, count)
 231 HOOK_FILE4(size_t, fwrite, stream,
 232            void const *, ptr, size_t, size, size_t, nmemb, FILE *, stream)
 233
 234 /* puts(3) */
 235 HOOK_FILE2(int, fputs, stream,
 236            char const *, s, FILE *, stream)
 237 HOOK_FILE2(int, fputc, stream,
 238            int, c, FILE *, stream)
 239 HOOK_FILE2(int, putc, stream,
 240            int, c, FILE *, stream)
 241 HOOK_FILE1(int, putchar, stdout,
 242            int, c)
 243 HOOK_FILE1(int, puts, stdout,
 244            char const *, s)
 245
 246 /* printf(3), excluding all s*() and vs*() functions (no output) */
 247 HOOK_VAR_FILE1(int, printf, stdout, vprintf,
 248                char const *, format)
 249 HOOK_VAR_FILE2(int, fprintf, stream, vfprintf,
 250                FILE *, stream, char const *, format)
 251 HOOK_FILE2(int, vprintf, stdout,
 252            char const *, format, va_list, ap)
 253 HOOK_FILE3(int, vfprintf, stream,
 254            FILE *, stream, char const *, format, va_list, ap)
 255 /* Hardening functions (-D_FORTIFY_SOURCE=2), only functions from above */
 256 HOOK_VAR_FILE2(int, __printf_chk, stdout, __vprintf_chk,
 257                int, flag, char const *, format)
 258 HOOK_VAR_FILE3(int, __fprintf_chk, fp, __vfprintf_chk,
 259                FILE *, fp, int, flag, char const *, format)
 260 HOOK_FILE3(int, __vprintf_chk, stdout,
 261            int, flag, char const *, format, va_list, ap)
 262 HOOK_FILE4(int, __vfprintf_chk, stream,
 263            FILE *, stream, int, flag, char const *, format, va_list, ap)
 264
 265 /* unlocked_stdio(3), only functions from above are hooked */
 266 #ifdef HAVE_FWRITE_UNLOCKED
 267 HOOK_FILE4(size_t, fwrite_unlocked, stream,
 268            void const *, ptr, size_t, size, size_t, nmemb, FILE *, stream)
 269 #endif
 270 #ifdef HAVE_FPUTS_UNLOCKED
 271 HOOK_FILE2(int, fputs_unlocked, stream,
 272            char const *, s, FILE *, stream)
 273 #endif
 274 #ifdef HAVE_FPUTC_UNLOCKED
 275 HOOK_FILE2(int, fputc_unlocked, stream,
 276            int, c, FILE *, stream)
 277 #endif
 278 HOOK_FILE2(int, putc_unlocked, stream,
 279            int, c, FILE *, stream)
 280 HOOK_FILE1(int, putchar_unlocked, stdout,
 281            int, c)
 282 /* glibc defines (_IO_)putc_unlocked() to a macro which either updates the
 283  * output buffer or calls __overflow(). As this code is inlined we can't
 284  * handle the first case, but if __overflow() is called we can color that
 285  * part. As writes to stderr are never buffered, __overflow() is always called
 286  * and everything works fine. This is only a problem if stdout is dupped to
 287  * stderr (which shouldn't be the case too often). */
 288 #if defined(HAVE_STRUCT__IO_FILE__FILENO) && defined(HAVE___OVERFLOW)
 289 /* _IO_FILE is glibc's representation of FILE. */
 290 HOOK_FILE2(int, __overflow, f, _IO_FILE *, f, int, ch)
 291 #endif
 292 /* Same for FreeBSD's libc. However it's more aggressive: The inline writing
 293  * and __swbuf() are also used for normal output (e.g. putc()). Writing to
 294  * stderr is still fine; it always calls __swbuf() as stderr is always
 295  * unbufferd. */
 296 #ifdef HAVE___SWBUF
 297 HOOK_FILE2(int, __swbuf, f, int, c, FILE *, f)
 298 #endif
 299
 300 /* perror(3) */
 301 HOOK_VOID1(void, perror, STDERR_FILENO,
 302            char const *, s)
 303
 304 /* err(3), non standard BSD extension */
 305 #ifdef HAVE_ERR_H
 306 HOOK_VAR_VOID2(void, err, STDERR_FILENO, verr,
 307                int, eval, char const *, fmt)
 308 HOOK_VAR_VOID2(void, errx, STDERR_FILENO, verrx,
 309                int, eval, char const *, fmt)
 310 HOOK_VAR_VOID1(void, warn, STDERR_FILENO, vwarn,
 311                char const *, fmt)
 312 HOOK_VAR_VOID1(void, warnx, STDERR_FILENO, vwarnx,
 313                char const *, fmt)
 314 HOOK_FUNC_SIMPLE3(void, verr, int, eval, const char *, fmt, va_list, args) {
 315     /* Can't use verr() directly as it terminates the process which prevents
 316      * the post string from being printed. */
 317     vwarn(fmt, args);
 318     exit(eval);
 319 }
 320 HOOK_FUNC_SIMPLE3(void, verrx, int, eval, const char *, fmt, va_list, args) {
 321     /* See verr(). */
 322     vwarnx(fmt, args);
 323     exit(eval);
 324 }
 325 HOOK_VOID2(void, vwarn, STDERR_FILENO,
 326            char const *, fmt, va_list, args)
 327 HOOK_VOID2(void, vwarnx, STDERR_FILENO,
 328            char const *, fmt, va_list, args)
 329 #endif
 330
 331 /* error(3), non-standard GNU extension */
 332 #ifdef HAVE_ERROR_H
 333 static void error_vararg(int status, int errnum,
 334                          char const *filename, unsigned int linenum,
 335                          char const *format, va_list ap) {
 336     static char const *last_filename;
 337     static unsigned int last_linenum;
 338
 339     /* Skip this error message if requested and if there was already an error
 340      * in the same file/line. */
 341     if (error_one_per_line
 342             && filename != NULL && linenum != 0
 343             && filename == last_filename && linenum == last_linenum) {
 344         return;
 345     }
 346     last_filename = filename;
 347     last_linenum  = linenum;
 348
 349     error_message_count++;
 350
 351     fflush(stdout);
 352
 353     if (error_print_progname) {
 354         error_print_progname();
 355     } else {
 356         fprintf(stderr, "%s:", program_invocation_name);
 357     }
 358     if (filename != NULL && linenum != 0) {
 359         fprintf(stderr, "%s:%u:", filename, linenum);
 360         if (error_print_progname) {
 361             fprintf(stderr, " ");
 362         }
 363     }
 364     if (!error_print_progname) {
 365         fprintf(stderr, " ");
 366     }
 367
 368
 369     vfprintf(stderr, format, ap);
 370
 371     if (errnum != 0) {
 372         fprintf(stderr, ": %s", strerror(errnum));
 373     }
 374
 375     fprintf(stderr, "\n");
 376
 377     if (status != 0) {
 378         exit(status);
 379     }
 380 }
 381 void error_at_line(int status, int errnum,
 382                    char const *filename, unsigned int linenum,
 383                    char const *format, ...) {
 384     va_list ap;
 385
 386     va_start(ap, format);
 387     error_vararg(status, errnum, filename, linenum, format, ap);
 388     va_end(ap);
 389 }
 390 void error(int status, int errnum, char const *format, ...) {
 391     va_list ap;
 392
 393     va_start(ap, format);
 394     error_vararg(status, errnum, NULL, 0, format, ap);
 395     va_end(ap);
 396 }
 397 #endif
 398
 399
 400 /* Hook functions which duplicate file descriptors to track them. */
 401
 402 /* int dup(int) */
 403 HOOK_FUNC_DEF1(int, dup, int, oldfd) {
 404     int newfd;
 405
 406     DLSYM_FUNCTION(real_dup, "dup");
 407
 408     newfd = real_dup(oldfd);
 409     if (newfd > -1) {
 410         dup_fd(oldfd, newfd);
 411     }
 412
 413     return newfd;
 414 }
 415 /* int dup2(int, int) */
 416 HOOK_FUNC_DEF2(int, dup2, int, oldfd, int, newfd) {
 417     DLSYM_FUNCTION(real_dup2, "dup2");
 418
 419     newfd = real_dup2(oldfd, newfd);
 420     if (newfd > -1) {
 421         dup_fd(oldfd, newfd);
 422     }
 423
 424     return newfd;
 425 }
 426 /* int dup3(int, int, int) */
 427 HOOK_FUNC_DEF3(int, dup3, int, oldfd, int, newfd, int, flags) {
 428     DLSYM_FUNCTION(real_dup3, "dup3");
 429
 430     newfd = real_dup3(oldfd, newfd, flags);
 431     if (newfd > -1) {
 432         dup_fd(oldfd, newfd);
 433     }
 434
 435     return newfd;
 436 }
 437
 438 /* int fcntl(int, int, ...) */
 439 HOOK_FUNC_VAR_DEF2(int, fcntl, int, fd, int, cmd /*, ... */) {
 440     int result;
 441     va_list ap;
 442
 443     DLSYM_FUNCTION(real_fcntl, "fcntl");
 444
 445     /* fcntl() takes different types of arguments depending on the cmd type
 446      * (int, void and pointers are used at the moment). Handling these
 447      * arguments for different systems and with possible changes in the future
 448      * is error prone.
 449      *
 450      * Therefore always retrieve a void-pointer from our arguments (even if it
 451      * wasn't there) and pass it to real_fcntl(). This shouldn't cause any
 452      * problems because a void-pointer is most-likely bigger than an int
 453      * (something which is not true in reverse) and shouldn't cause
 454      * truncation. For register based calling conventions an invalid register
 455      * content is passed, but ignored by real_fcntl(). Not perfect, but should
 456      * work fine.
 457      */
 458     va_start(ap, cmd);
 459     result = real_fcntl(fd, cmd, va_arg(ap, void *));
 460     va_end(ap);
 461
 462     /* We only care about duping fds. */
 463     if (cmd == F_DUPFD && result > -1) {
 464         dup_fd(fd, result);
 465     }
 466
 467     return result;
 468 }
 469
 470 /* int close(int) */
 471 HOOK_FUNC_DEF1(int, close, int, fd) {
 472     DLSYM_FUNCTION(real_close, "close");
 473
 474     if (fd >= 0) {
 475         close_fd(fd);
 476     }
 477     return real_close(fd);
 478 }
 479 /* int fclose(FILE *) */
 480 HOOK_FUNC_DEF1(int, fclose, FILE *, fp) {
 481     int fd;
 482
 483     DLSYM_FUNCTION(real_fclose, "fclose");
 484
 485     if (fp != NULL && (fd = fileno(fp)) >= 0) {
 486         close_fd(fd);
 487     }
 488     return real_fclose(fp);
 489 }
 490
 491
 492 /* Hook functions which are necessary for correct tracking. */
 493
 494 #if defined(HAVE_VFORK) && defined(HAVE_FORK)
 495 pid_t vfork(void) {
 496     /* vfork() is similar to fork() but the address space is shared between
 497      * father and child. It's designed for fork()/exec() usage because it's
 498      * faster than fork(). However according to the POSIX standard the "child"
 499      * isn't allowed to perform any memory-modifications before the exec()
 500      * (except the pid_t result variable of vfork()).
 501      *
 502      * As some programs don't adhere to the standard (e.g. the "child" closes
 503      * or dups a descriptor before the exec()) and this breaks our tracking of
 504      * file descriptors (e.g. it gets closed in the parent as well), we just
 505      * fork() instead. This is in compliance with the POSIX standard and as
 506      * most systems use copy-on-write anyway not a performance issue. */
 507     return fork();
 508 }
 509 #endif
 510
 511
 512 /* Hook execve() and the other exec*() functions. Some shells use exec*() with
 513  * a custom environment which doesn't necessarily contain our updates to
 514  * ENV_NAME_PRIVATE_FDS. It's also faster to update the environment only when
 515  * necessary, right before the exec(), to pass it to the new program. */
 516
 517 /* int execve(char const *, char * const [], char * const []) */
 518 HOOK_FUNC_DEF3(int, execve, char const *, filename, char * const *, argv, char * const *, env) {
 519     DLSYM_FUNCTION(real_execve, "execve");
 520
 521     /* Count environment variables. */
 522     size_t count = 0;
 523     char * const *x = env;
 524     while (*x++) {
 525         count++;
 526     }
 527     /* Terminating NULL. */
 528     count++;
 529
 530     char *env_copy[count + 1 /* space for our new entry if necessary */];
 531
 532     /* Make sure the information from the environment is loaded. We can't just
 533      * do nothing (like update_environment()) because the caller might pass a
 534      * different environment which doesn't include any of our settings. */
 535     if (!initialized) {
 536         init_from_environment();
 537     }
 538
 539     char fds_env[strlen(ENV_NAME_PRIVATE_FDS)
 540                  + 1 + update_environment_buffer_size()];
 541     strcpy(fds_env, ENV_NAME_PRIVATE_FDS "=");
 542     update_environment_buffer(fds_env + strlen(ENV_NAME_PRIVATE_FDS) + 1);
 543
 544     int found = 0;
 545     char **x_copy = env_copy;
 546
 547     /* Copy the environment manually; allows skipping elements. */
 548     x = env;
 549     while ((*x_copy = *x)) {
 550         /* Remove ENV_NAME_FDS if we've already used its value. The new
 551          * program must use the updated list from ENV_NAME_PRIVATE_FDS. */
 552         if (used_fds_set_by_user
 553                 && !strncmp(*x, ENV_NAME_FDS "=", strlen(ENV_NAME_FDS) + 1)) {
 554             x++;
 555             continue;
 556         /* Update ENV_NAME_PRIVATE_FDS. */
 557         } else if (!strncmp(*x, ENV_NAME_PRIVATE_FDS "=",
 558                             strlen(ENV_NAME_PRIVATE_FDS) + 1)) {
 559             *x_copy = fds_env;
 560             found = 1;
 561         }
 562
 563         x++;
 564         x_copy++;
 565     }
 566     /* The loop "condition" NULL-terminates env_copy. */
 567
 568     if (!found) {
 569         /* If the process removed ENV_NAME_PRIVATE_FDS from the environment,
 570          * re-add it. */
 571         *x_copy++ = fds_env;
 572         *x_copy++ = NULL;
 573     }
 574
 575     return real_execve(filename, argv, env_copy);
 576 }
 577
 578 #define EXECL_COPY_VARARGS_START(args) \
 579     va_list ap; \
 580     char *x; \
 581     \
 582     /* Count arguments. */ \
 583     size_t count = 1; /* arg */ \
 584     va_start(ap, arg); \
 585     while (va_arg(ap, char *)) { \
 586         count++; \
 587     } \
 588     va_end(ap); \
 589     \
 590     /* Copy varargs. */ \
 591     char *args[count + 1 /* terminating NULL */]; \
 592     args[0] = (char *)arg; /* there's no other way around the cast */ \
 593     \
 594     size_t i = 1; \
 595     va_start(ap, arg); \
 596     while ((x = va_arg(ap, char *))) { \
 597         args[i++] = x; \
 598     } \
 599     args[i] = NULL;
 600 #define EXECL_COPY_VARARGS_END(args) \
 601     va_end(ap);
 602 #define EXECL_COPY_VARARGS(args) \
 603     EXECL_COPY_VARARGS_START(args); \
 604     EXECL_COPY_VARARGS_END(args);
 605
 606 int execl(char const *path, char const *arg, ...) {
 607     EXECL_COPY_VARARGS(args);
 608
 609     /* execv() updates the environment. */
 610     return execv(path, args);
 611 }
 612 int execlp(char const *file, char const *arg, ...) {
 613     EXECL_COPY_VARARGS(args);
 614
 615     /* execvp() updates the environment. */
 616     return execvp(file, args);
 617 }
 618 int execle(char const *path, char const *arg, ... /*, char * const envp[] */) {
 619     char * const *envp;
 620
 621     EXECL_COPY_VARARGS_START(args);
 622     /* Get envp[] located after arguments. */
 623     envp = va_arg(ap, char * const *);
 624     EXECL_COPY_VARARGS_END(args);
 625
 626     /* execve() updates the environment. */
 627     return execve(path, args, envp);
 628 }
 629
 630 /* int execv(char const *, char * const []) */
 631 HOOK_FUNC_DEF2(int, execv, char const *, path, char * const *, argv) {
 632     DLSYM_FUNCTION(real_execv, "execv");
 633
 634     update_environment();
 635     return real_execv(path, argv);
 636 }
 637
 638 /* int execvp(char const *, char * const []) */
 639 HOOK_FUNC_DEF2(int, execvp, char const *, file, char * const *, argv) {
 640     DLSYM_FUNCTION(real_execvp, "execvp");
 641
 642     update_environment();
 643     return real_execvp(file, argv);
 644 }
 645
 646 #ifdef HAVE_EXECVPE
 647 extern char **environ;
 648 int execvpe(char const *file, char * const argv[], char * const envp[]) {
 649     int result;
 650     char **old_environ = environ;
 651
 652     /* Fake the environment so we can reuse execvp(). */
 653     environ = (char **)envp;
 654
 655     /* execvp() updates the environment. */
 656     result = execvp(file, argv);
 657
 658     environ = old_environ;
 659     return result;
 660 }
 661 #endif