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-2019 The strace developers.
   4  * All rights reserved.
   5  *
   6  * SPDX-License-Identifier: LGPL-2.1-or-later
   7  */
   8
   9 #ifndef STRACE_PRINT_FIELDS_H
  10 # define STRACE_PRINT_FIELDS_H
  11
  12 /*
  13  * The printf-like function to use in header files
  14  * shared between strace and its tests.
  15  */
  16 # ifndef STRACE_PRINTF
  17 #  define STRACE_PRINTF tprintf
  18 # endif
  19
  20 # define PRINT_FIELD_D(prefix_, where_, field_)                         \
  21         STRACE_PRINTF("%s%s=%lld", (prefix_), #field_,                  \
  22                       sign_extend_unsigned_to_ll((where_).field_))
  23
  24 # define PRINT_FIELD_U(prefix_, where_, field_)                         \
  25         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  26                       zero_extend_signed_to_ull((where_).field_))
  27
  28 # define PRINT_FIELD_U_CAST(prefix_, where_, field_, type_)             \
  29         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  30                       zero_extend_signed_to_ull((type_) (where_).field_))
  31
  32 # define PRINT_FIELD_X(prefix_, where_, field_)                         \
  33         STRACE_PRINTF("%s%s=%#llx", (prefix_), #field_,                 \
  34                       zero_extend_signed_to_ull((where_).field_))
  35
  36 # define PRINT_FIELD_ADDR(prefix_, where_, field_)                      \
  37         do {                                                            \
  38                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  39                 printaddr((where_).field_);                             \
  40         } while (0)
  41
  42 # define PRINT_FIELD_ADDR64(prefix_, where_, field_)                    \
  43         do {                                                            \
  44                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  45                 printaddr64((where_).field_);                           \
  46         } while (0)
  47
  48 # define PRINT_FIELD_0X(prefix_, where_, field_)                                \
  49         STRACE_PRINTF("%s%s=%#0*llx", (prefix_), #field_,               \
  50                       (int) sizeof((where_).field_) * 2,                \
  51                       zero_extend_signed_to_ull((where_).field_))
  52
  53 # define PRINT_FIELD_COOKIE(prefix_, where_, field_)                    \
  54         STRACE_PRINTF("%s%s=[%llu, %llu]", (prefix_), #field_,          \
  55                       zero_extend_signed_to_ull((where_).field_[0]),    \
  56                       zero_extend_signed_to_ull((where_).field_[1]))
  57
  58 # define PRINT_FIELD_FLAGS(prefix_, where_, field_, xlat_, dflt_)       \
  59         do {                                                            \
  60                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  61                 printflags64((xlat_),                                   \
  62                              zero_extend_signed_to_ull((where_).field_),\
  63                              (dflt_));                                  \
  64         } while (0)
  65
  66 # define PRINT_FIELD_XVAL(prefix_, where_, field_, xlat_, dflt_)                \
  67         do {                                                            \
  68                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  69                 printxval64((xlat_),                                    \
  70                             zero_extend_signed_to_ull((where_).field_), \
  71                             (dflt_));           \
  72         } while (0)
  73
  74 # define PRINT_FIELD_XVAL_U(prefix_, where_, field_, xlat_, dflt_)      \
  75         do {                                                            \
  76                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  77                 printxvals_ex(zero_extend_signed_to_ull((where_).field_), \
  78                               (dflt_), XLAT_STYLE_FMT_U,                \
  79                               (xlat_), NULL);                           \
  80         } while (0)
  81
  82 # define PRINT_FIELD_ERR_D(prefix_, where_, field_)                     \
  83         do {                                                            \
  84                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  85                 print_err(sign_extend_unsigned_to_ll((where_).field_),  \
  86                           true);                                        \
  87         } while (0)
  88
  89 # define PRINT_FIELD_ERR_U(prefix_, where_, field_)                     \
  90         do {                                                            \
  91                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  92                 print_err(zero_extend_signed_to_ull((where_).field_),   \
  93                           false);                                       \
  94         } while (0)
  95
  96 /*
  97  * Generic "ID" printing. ID is considered unsigned except for the special value
  98  * of -1.
  99  */
 100 # define PRINT_FIELD_ID(prefix_, where_, field_)                                        \
 101         do {                                                                            \
 102                 if (sign_extend_unsigned_to_ll((where_).field_) == -1LL)                \
 103                         STRACE_PRINTF("%s%s=-1", (prefix_), #field_);                   \
 104                 else                                                                    \
 105                         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
 106                                       zero_extend_signed_to_ull((where_).field_));      \
 107         } while (0)
 108
 109 # define PRINT_FIELD_UID PRINT_FIELD_ID
 110
 111 # define PRINT_FIELD_UUID(prefix_, where_, field_)                      \
 112         do {                                                            \
 113                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 114                 print_uuid((const unsigned char *) ((where_).field_));  \
 115         } while (0)
 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_u(UINT64_MAX);                                       \
 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_AX25_ADDR(prefix_, where_, field_)                 \
 166         do {                                                            \
 167                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 168                 print_ax25_addr(&(where_).field_);                      \
 169         } while (0)
 170
 171 # define PRINT_FIELD_X25_ADDR(prefix_, where_, field_)                  \
 172         do {                                                            \
 173                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 174                 print_x25_addr(&(where_).field_);                       \
 175         } while (0)
 176
 177 # define PRINT_FIELD_NET_PORT(prefix_, where_, field_)                  \
 178         do {                                                            \
 179                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 180                                                                         \
 181                 if (xlat_verbose(xlat_verbosity) != XLAT_STYLE_ABBREV)  \
 182                         print_quoted_string((const char *)              \
 183                                         &(where_).field_,               \
 184                                         sizeof((where_).field_),        \
 185                                         QUOTE_FORCE_HEX);               \
 186                                                                         \
 187                 if (xlat_verbose(xlat_verbosity) == XLAT_STYLE_RAW)     \
 188                         break;                                          \
 189                                                                         \
 190                 if (xlat_verbose(xlat_verbosity)                        \
 191                                 == XLAT_STYLE_VERBOSE)                  \
 192                         STRACE_PRINTF(" /* ");                          \
 193                                                                         \
 194                 STRACE_PRINTF("htons(%u)", ntohs((where_).field_));     \
 195                                                                         \
 196                 if (xlat_verbose(xlat_verbosity)                        \
 197                                 == XLAT_STYLE_VERBOSE)                  \
 198                         STRACE_PRINTF(" */");                           \
 199         } while (0)
 200
 201 # define PRINT_FIELD_IFINDEX(prefix_, where_, field_)                   \
 202         do {                                                            \
 203                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 204                 print_ifindex((where_).field_);                         \
 205         } while (0)
 206
 207 # define PRINT_FIELD_SOCKADDR(prefix_, where_, field_)                  \
 208         do {                                                            \
 209                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 210                 print_sockaddr(&(where_).field_,                        \
 211                                sizeof((where_).field_));                \
 212         } while (0)
 213
 214 # define PRINT_FIELD_DEV(prefix_, where_, field_)                       \
 215         do {                                                            \
 216                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 217                 print_dev_t((where_).field_);                           \
 218         } while (0)
 219
 220 # define PRINT_FIELD_PTR(prefix_, where_, field_)                       \
 221         do {                                                            \
 222                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 223                 printaddr((mpers_ptr_t) (where_).field_);               \
 224         } while (0)
 225
 226 # define PRINT_FIELD_FD(prefix_, where_, field_, tcp_)                  \
 227         do {                                                            \
 228                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 229                 printfd((tcp_), (where_).field_);                       \
 230         } while (0)
 231
 232 # define PRINT_FIELD_STRN(prefix_, where_, field_, len_, tcp_)          \
 233         do {                                                            \
 234                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 235                 printstrn((tcp_), (where_).field_, (len_));             \
 236         } while (0)
 237
 238
 239 # define PRINT_FIELD_STR(prefix_, where_, field_, tcp_)                 \
 240         do {                                                            \
 241                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 242                 printstr((tcp_), (where_).field_);                      \
 243         } while (0)
 244
 245 # define PRINT_FIELD_PATH(prefix_, where_, field_, tcp_)                        \
 246         do {                                                            \
 247                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 248                 printpath((tcp_), (where_).field_);                     \
 249         } while (0)
 250
 251 # define PRINT_FIELD_MAC(prefix_, where_, field_)                       \
 252         PRINT_FIELD_MAC_SZ((prefix_), (where_), field_,                 \
 253                            ARRAY_SIZE((where_).field_))
 254
 255 # define PRINT_FIELD_MAC_SZ(prefix_, where_, field_, size_)             \
 256         do {                                                            \
 257                 static_assert(sizeof(((where_).field_)[0]) == 1,        \
 258                               "MAC address is not a byte array");       \
 259                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 260                 print_mac_addr("", (const uint8_t *) ((where_).field_), \
 261                                (size_));                                \
 262         } while (0)
 263
 264 # define PRINT_FIELD_HWADDR_SZ(prefix_, where_, field_, size_, hwtype_) \
 265         do {                                                            \
 266                 static_assert(sizeof(((where_).field_)[0]) == 1,        \
 267                               "hwaddress is not a byte array"); \
 268                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 269                 print_hwaddr("", (const uint8_t *) ((where_).field_),   \
 270                                (size_), (hwtype_));                     \
 271         } while (0)
 272
 273 #endif /* !STRACE_PRINT_FIELDS_H */