uspace/lib/pcut/src/assert.c

   1 /*
   2  * Copyright (c) 2012-2013 Vojtech Horky
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * - Redistributions of source code must retain the above copyright
  10  *   notice, this list of conditions and the following disclaimer.
  11  * - Redistributions in binary form must reproduce the above copyright
  12  *   notice, this list of conditions and the following disclaimer in the
  13  *   documentation and/or other materials provided with the distribution.
  14  * - The name of the author may not be used to endorse or promote products
  15  *   derived from this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  */
  28
  29 /**
  30  * @file
  31  * Formatting and processing of failed assertion messages.
  32  *
  33  * We are using static buffers to prevent any calls to malloc()/free()
  34  * by the testing framework.
  35  */
  36
  37 /*
  38  * We need _BSD_SOURCE because of vsnprintf() when compiling under C89.
  39  * In newer versions of features.h, _DEFAULT_SOURCE must be defined as well.
  40  */
  41 #define _BSD_SOURCE
  42 #define _DEFAULT_SOURCE
  43
  44 #include "internal.h"
  45
  46 #pragma warning(push, 0)
  47 #include <setjmp.h>
  48 #include <stdarg.h>
  49 #include <stdio.h>
  50 #pragma warning(pop)
  51
  52
  53 /** Maximum length of failed-assert message. */
  54 #define MAX_MESSAGE_LENGTH 256
  55
  56 /** How many assertion messages we need to keep in memory at once. */
  57 #define MESSAGE_BUFFER_COUNT 2
  58
  59 /** Assertion message buffers. */
  60 static char message_buffer[MESSAGE_BUFFER_COUNT][MAX_MESSAGE_LENGTH + 1];
  61
  62 /** Currently active assertion buffer. */
  63 static int message_buffer_index = 0;
  64
  65 void pcut_failed_assertion_fmt(const char *filename, int line, const char *fmt, ...) {
  66         va_list args;
  67         char *current_buffer = message_buffer[message_buffer_index];
  68         size_t offset = 0;
  69         message_buffer_index = (message_buffer_index + 1) % MESSAGE_BUFFER_COUNT;
  70
  71         pcut_snprintf(current_buffer, MAX_MESSAGE_LENGTH, "%s:%d: ", filename, line);
  72         offset = pcut_str_size(current_buffer);
  73
  74         if (offset + 1 < MAX_MESSAGE_LENGTH) {
  75                 va_start(args, fmt);
  76                 vsnprintf(current_buffer + offset, MAX_MESSAGE_LENGTH - offset, fmt, args);
  77                 va_end(args);
  78         }
  79
  80         pcut_failed_assertion(current_buffer);
  81 }