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

   1 /*
   2  * Copyright (c) 2016-2017 Dmitry V. Levin <ldv@altlinux.org>
   3  * Copyright (c) 2017-2018 The strace developers.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. 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  * 3. 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 #ifndef STRACE_PRINT_FIELDS_H
  30 #define STRACE_PRINT_FIELDS_H
  31
  32 /*
  33  * The printf-like function to use in header files
  34  * shared between strace and its tests.
  35  */
  36 #ifndef STRACE_PRINTF
  37 # define STRACE_PRINTF tprintf
  38 #endif
  39
  40 #define PRINT_FIELD_D(prefix_, where_, field_)                          \
  41         STRACE_PRINTF("%s%s=%lld", (prefix_), #field_,                  \
  42                       sign_extend_unsigned_to_ll((where_).field_))
  43
  44 #define PRINT_FIELD_U(prefix_, where_, field_)                          \
  45         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  46                       zero_extend_signed_to_ull((where_).field_))
  47
  48 #define PRINT_FIELD_U_CAST(prefix_, where_, field_, type_)              \
  49         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  50                       zero_extend_signed_to_ull((type_) (where_).field_))
  51
  52 #define PRINT_FIELD_X(prefix_, where_, field_)                          \
  53         STRACE_PRINTF("%s%s=%#llx", (prefix_), #field_,                 \
  54                       zero_extend_signed_to_ull((where_).field_))
  55
  56 #define PRINT_FIELD_ADDR(prefix_, where_, field_)                       \
  57         do {                                                            \
  58                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  59                 printaddr((where_).field_);                             \
  60         } while (0)
  61
  62 #define PRINT_FIELD_ADDR64(prefix_, where_, field_)                     \
  63         do {                                                            \
  64                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  65                 printaddr64((where_).field_);                           \
  66         } while (0)
  67
  68 #define PRINT_FIELD_0X(prefix_, where_, field_)                         \
  69         STRACE_PRINTF("%s%s=%#0*llx", (prefix_), #field_,               \
  70                       (int) sizeof((where_).field_) * 2,                \
  71                       zero_extend_signed_to_ull((where_).field_))
  72
  73 #define PRINT_FIELD_COOKIE(prefix_, where_, field_)                     \
  74         STRACE_PRINTF("%s%s=[%llu, %llu]", (prefix_), #field_,          \
  75                       zero_extend_signed_to_ull((where_).field_[0]),    \
  76                       zero_extend_signed_to_ull((where_).field_[1]))
  77
  78 #define PRINT_FIELD_FLAGS(prefix_, where_, field_, xlat_, dflt_)        \
  79         do {                                                            \
  80                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  81                 printflags64((xlat_),                                   \
  82                              zero_extend_signed_to_ull((where_).field_),\
  83                              (dflt_));                                  \
  84         } while (0)
  85
  86 #define PRINT_FIELD_XVAL(prefix_, where_, field_, xlat_, dflt_)         \
  87         do {                                                            \
  88                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  89                 printxval64((xlat_),                                    \
  90                             zero_extend_signed_to_ull((where_).field_), \
  91                             (dflt_));           \
  92         } while (0)
  93
  94 #define PRINT_FIELD_XVAL_U(prefix_, where_, field_, xlat_, dflt_)       \
  95         do {                                                            \
  96                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  97                 printxvals_ex(zero_extend_signed_to_ull((where_).field_), \
  98                               (dflt_), XLAT_STYLE_FMT_U,                \
  99                               (xlat_), NULL);                           \
 100         } while (0)
 101
 102 /*
 103  * Generic "ID" printing. ID is considered unsigned except for the special value
 104  * of -1.
 105  */
 106 #define PRINT_FIELD_ID(prefix_, where_, field_)                                 \
 107         do {                                                                            \
 108                 if (sign_extend_unsigned_to_ll((where_).field_) == -1LL)                \
 109                         STRACE_PRINTF("%s%s=-1", (prefix_), #field_);                   \
 110                 else                                                                    \
 111                         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
 112                                       zero_extend_signed_to_ull((where_).field_));      \
 113         } while (0)
 114
 115 #define PRINT_FIELD_UID PRINT_FIELD_ID
 116
 117 #define PRINT_FIELD_U64(prefix_, where_, field_)                                        \
 118         do {                                                                            \
 119                 STRACE_PRINTF("%s%s=", (prefix_), #field_);                             \
 120                 if (zero_extend_signed_to_ull((where_).field_) == UINT64_MAX)           \
 121                         print_xlat_ex(UINT64_MAX, "UINT64_MAX", XLAT_STYLE_FMT_U);      \
 122                 else                                                                    \
 123                         STRACE_PRINTF("%llu",                                           \
 124                                       zero_extend_signed_to_ull((where_).field_));      \
 125         } while (0)
 126
 127 #define PRINT_FIELD_STRING(prefix_, where_, field_, len_, style_)       \
 128         do {                                                            \
 129                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 130                 print_quoted_string((const char *)(where_).field_,      \
 131                                     (len_), (style_));                  \
 132         } while (0)
 133
 134 #define PRINT_FIELD_CSTRING(prefix_, where_, field_)                    \
 135         do {                                                            \
 136                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 137                 print_quoted_cstring((const char *) (where_).field_,    \
 138                                      sizeof((where_).field_) +          \
 139                                         MUST_BE_ARRAY((where_).field_)); \
 140         } while (0)
 141
 142 #define PRINT_FIELD_CSTRING_SZ(prefix_, where_, field_, size_)          \
 143         do {                                                            \
 144                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 145                 print_quoted_cstring((const char *) (where_).field_,    \
 146                                      (size_));                          \
 147         } while (0)
 148
 149 #define PRINT_FIELD_HEX_ARRAY(prefix_, where_, field_)                  \
 150         do {                                                            \
 151                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 152                 print_quoted_string((const char *)(where_).field_,      \
 153                                     sizeof((where_).field_) +           \
 154                                             MUST_BE_ARRAY((where_).field_), \
 155                                     QUOTE_FORCE_HEX); \
 156         } while (0)
 157
 158 #define PRINT_FIELD_INET_ADDR(prefix_, where_, field_, af_)             \
 159         do {                                                            \
 160                 STRACE_PRINTF(prefix_);                                 \
 161                 print_inet_addr((af_), &(where_).field_,                \
 162                                 sizeof((where_).field_), #field_);      \
 163         } while (0)
 164
 165 #define PRINT_FIELD_INET4_ADDR(prefix_, where_, field_)                 \
 166         STRACE_PRINTF("%s%s=inet_addr(\"%s\")", (prefix_), #field_,     \
 167                       inet_ntoa((where_).field_))
 168
 169 #define PRINT_FIELD_NET_PORT(prefix_, where_, field_)                   \
 170         STRACE_PRINTF("%s%s=htons(%u)", (prefix_), #field_,             \
 171                       ntohs((where_).field_))
 172
 173 #define PRINT_FIELD_IFINDEX(prefix_, where_, field_)                    \
 174         do {                                                            \
 175                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 176                 print_ifindex((where_).field_);                         \
 177         } while (0)
 178
 179 #define PRINT_FIELD_SOCKADDR(prefix_, where_, field_)                   \
 180         do {                                                            \
 181                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 182                 print_sockaddr(&(where_).field_,                        \
 183                                sizeof((where_).field_));                \
 184         } while (0)
 185
 186 #define PRINT_FIELD_DEV(prefix_, where_, field_)                        \
 187         do {                                                            \
 188                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 189                 print_dev_t((where_).field_);                           \
 190         } while (0)
 191
 192 #define PRINT_FIELD_PTR(prefix_, where_, field_)                        \
 193         do {                                                            \
 194                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 195                 printaddr((mpers_ptr_t) (where_).field_);               \
 196         } while (0)
 197
 198 #define PRINT_FIELD_FD(prefix_, where_, field_, tcp_)                   \
 199         do {                                                            \
 200                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 201                 printfd((tcp_), (where_).field_);                       \
 202         } while (0)
 203
 204 #define PRINT_FIELD_STRN(prefix_, where_, field_, len_, tcp_)           \
 205         do {                                                            \
 206                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 207                 printstrn((tcp_), (where_).field_, (len_));             \
 208         } while (0)
 209
 210
 211 #define PRINT_FIELD_STR(prefix_, where_, field_, tcp_)                  \
 212         do {                                                            \
 213                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 214                 printstr((tcp_), (where_).field_);                      \
 215         } while (0)
 216
 217 #define PRINT_FIELD_PATH(prefix_, where_, field_, tcp_)                 \
 218         do {                                                            \
 219                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 220                 printpath((tcp_), (where_).field_);                     \
 221         } while (0)
 222
 223 #endif /* !STRACE_PRINT_FIELDS_H */