granicus.if.org Git - strace/blob - print_fields.h

   1 /*
   2  * Copyright (c) 2016-2017 Dmitry V. Levin <ldv@altlinux.org>
   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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef STRACE_PRINT_FIELDS_H
  29 #define STRACE_PRINT_FIELDS_H
  30
  31 /*
  32  * The printf-like function to use in header files
  33  * shared between strace and its tests.
  34  */
  35 #ifndef STRACE_PRINTF
  36 # define STRACE_PRINTF tprintf
  37 #endif
  38
  39 #define PRINT_FIELD_D(prefix_, where_, field_)                          \
  40         STRACE_PRINTF("%s%s=%lld", (prefix_), #field_,                  \
  41                       sign_extend_unsigned_to_ll((where_).field_))
  42
  43 #define PRINT_FIELD_U(prefix_, where_, field_)                          \
  44         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  45                       zero_extend_signed_to_ull((where_).field_))
  46
  47 #define PRINT_FIELD_U_CAST(prefix_, where_, field_, type_)              \
  48         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  49                       zero_extend_signed_to_ull((type_) (where_).field_))
  50
  51 #define PRINT_FIELD_X(prefix_, where_, field_)                          \
  52         STRACE_PRINTF("%s%s=%#llx", (prefix_), #field_,                 \
  53                       zero_extend_signed_to_ull((where_).field_))
  54
  55 #define PRINT_FIELD_0X(prefix_, where_, field_)                         \
  56         STRACE_PRINTF("%s%s=%#0*llx", (prefix_), #field_,               \
  57                       (int) sizeof((where_).field_) * 2,                \
  58                       zero_extend_signed_to_ull((where_).field_))
  59
  60 #define PRINT_FIELD_COOKIE(prefix_, where_, field_)                     \
  61         STRACE_PRINTF("%s%s=[%llu, %llu]", (prefix_), #field_,          \
  62                       zero_extend_signed_to_ull((where_).field_[0]),    \
  63                       zero_extend_signed_to_ull((where_).field_[1]))
  64
  65 #define PRINT_FIELD_FLAGS(prefix_, where_, field_, xlat_, dflt_)        \
  66         do {                                                            \
  67                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  68                 printflags64((xlat_),                                   \
  69                              zero_extend_signed_to_ull((where_).field_),\
  70                              (dflt_));                                  \
  71         } while (0)
  72
  73 #define PRINT_FIELD_XVAL(prefix_, where_, field_, xlat_, dflt_)         \
  74         do {                                                            \
  75                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  76                 printxval64((xlat_),                                    \
  77                             zero_extend_signed_to_ull((where_).field_), \
  78                             (dflt_));           \
  79         } while (0)
  80
  81 /*
  82  * Generic "ID" printing. ID is considered unsigned except for the special value
  83  * of -1.
  84  */
  85 #define PRINT_FIELD_ID(prefix_, where_, field_)                                 \
  86         do {                                                                            \
  87                 if (sign_extend_unsigned_to_ll((where_).field_) == -1LL)                \
  88                         STRACE_PRINTF("%s%s=-1", (prefix_), #field_);                   \
  89                 else                                                                    \
  90                         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  91                                       zero_extend_signed_to_ull((where_).field_));      \
  92         } while (0)
  93
  94 #define PRINT_FIELD_UID PRINT_FIELD_ID
  95
  96 #define PRINT_FIELD_STRING(prefix_, where_, field_, len_, style_)       \
  97         do {                                                            \
  98                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  99                 print_quoted_string((const char *)(where_).field_,      \
 100                                     (len_), (style_));                  \
 101         } while (0)
 102
 103 #define PRINT_FIELD_CSTRING(prefix_, where_, field_)                    \
 104         do {                                                            \
 105                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 106                 print_quoted_cstring((const char *)(where_).field_,     \
 107                                      sizeof((where_).field_));          \
 108         } while (0)
 109
 110 #define PRINT_FIELD_INET_ADDR(prefix_, where_, field_, af_)             \
 111         do {                                                            \
 112                 STRACE_PRINTF(prefix_);                                 \
 113                 print_inet_addr((af_), &(where_).field_,                \
 114                                 sizeof((where_).field_), #field_);      \
 115         } while (0)
 116
 117 #define PRINT_FIELD_INET4_ADDR(prefix_, where_, field_)                 \
 118         STRACE_PRINTF("%s%s=inet_addr(\"%s\")", (prefix_), #field_,     \
 119                       inet_ntoa((where_).field_))
 120
 121 #define PRINT_FIELD_NET_PORT(prefix_, where_, field_)                   \
 122         STRACE_PRINTF("%s%s=htons(%u)", (prefix_), #field_,             \
 123                       ntohs((where_).field_))
 124
 125 #define PRINT_FIELD_IFINDEX(prefix_, where_, field_)                    \
 126         do {                                                            \
 127                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 128                 print_ifindex((where_).field_);                         \
 129         } while (0)
 130
 131 #define PRINT_FIELD_SOCKADDR(prefix_, where_, field_)                   \
 132         do {                                                            \
 133                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 134                 print_sockaddr(&(where_).field_,                        \
 135                                sizeof((where_).field_));                \
 136         } while (0)
 137
 138 #define PRINT_FIELD_DEV(prefix_, where_, field_)                        \
 139         do {                                                            \
 140                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 141                 print_dev_t((where_).field_);                           \
 142         } while (0)
 143
 144 #define PRINT_FIELD_PTR(prefix_, where_, field_)                        \
 145         do {                                                            \
 146                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 147                 printaddr((mpers_ptr_t) (where_).field_);               \
 148         } while (0)
 149
 150 #define PRINT_FIELD_FD(prefix_, where_, field_, tcp_)                   \
 151         do {                                                            \
 152                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 153                 printfd((tcp_), (where_).field_);                       \
 154         } while (0)
 155
 156 #define PRINT_FIELD_STRN(prefix_, where_, field_, len_, tcp_)           \
 157         do {                                                            \
 158                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 159                 printstrn((tcp_), (where_).field_, (len_));             \
 160         } while (0)
 161
 162
 163 #define PRINT_FIELD_STR(prefix_, where_, field_, tcp_)                  \
 164         do {                                                            \
 165                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 166                 printstr((tcp_), (where_).field_);                      \
 167         } while (0)
 168
 169 #define PRINT_FIELD_PATH(prefix_, where_, field_, tcp_)                 \
 170         do {                                                            \
 171                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 172                 printpath((tcp_), (where_).field_);                     \
 173         } while (0)
 174
 175 #endif /* !STRACE_PRINT_FIELDS_H */