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_0X(prefix_, where_, field_)                         \
  57         STRACE_PRINTF("%s%s=%#0*llx", (prefix_), #field_,               \
  58                       (int) sizeof((where_).field_) * 2,                \
  59                       zero_extend_signed_to_ull((where_).field_))
  60
  61 #define PRINT_FIELD_COOKIE(prefix_, where_, field_)                     \
  62         STRACE_PRINTF("%s%s=[%llu, %llu]", (prefix_), #field_,          \
  63                       zero_extend_signed_to_ull((where_).field_[0]),    \
  64                       zero_extend_signed_to_ull((where_).field_[1]))
  65
  66 #define PRINT_FIELD_FLAGS(prefix_, where_, field_, xlat_, dflt_)        \
  67         do {                                                            \
  68                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  69                 printflags64((xlat_),                                   \
  70                              zero_extend_signed_to_ull((where_).field_),\
  71                              (dflt_));                                  \
  72         } while (0)
  73
  74 #define PRINT_FIELD_XVAL(prefix_, where_, field_, xlat_, dflt_)         \
  75         do {                                                            \
  76                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
  77                 printxval64((xlat_),                                    \
  78                             zero_extend_signed_to_ull((where_).field_), \
  79                             (dflt_));           \
  80         } while (0)
  81
  82 /*
  83  * Generic "ID" printing. ID is considered unsigned except for the special value
  84  * of -1.
  85  */
  86 #define PRINT_FIELD_ID(prefix_, where_, field_)                                 \
  87         do {                                                                            \
  88                 if (sign_extend_unsigned_to_ll((where_).field_) == -1LL)                \
  89                         STRACE_PRINTF("%s%s=-1", (prefix_), #field_);                   \
  90                 else                                                                    \
  91                         STRACE_PRINTF("%s%s=%llu", (prefix_), #field_,                  \
  92                                       zero_extend_signed_to_ull((where_).field_));      \
  93         } while (0)
  94
  95 #define PRINT_FIELD_UID PRINT_FIELD_ID
  96
  97 #define PRINT_FIELD_STRING(prefix_, where_, field_, len_, style_)       \
  98         do {                                                            \
  99                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 100                 print_quoted_string((const char *)(where_).field_,      \
 101                                     (len_), (style_));                  \
 102         } while (0)
 103
 104 #define PRINT_FIELD_CSTRING(prefix_, where_, field_)                    \
 105         do {                                                            \
 106                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 107                 print_quoted_cstring((const char *)(where_).field_,     \
 108                                      sizeof((where_).field_));          \
 109         } while (0)
 110
 111 #define PRINT_FIELD_HEX_ARRAY(prefix_, where_, field_)                  \
 112         do {                                                            \
 113                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 114                 print_quoted_string((const char *)(where_).field_,      \
 115                                      sizeof((where_).field_) +          \
 116                                             MUST_BE_ARRAY((where_).field_), \
 117                                     QUOTE_FORCE_HEX); \
 118         } while (0)
 119
 120 #define PRINT_FIELD_INET_ADDR(prefix_, where_, field_, af_)             \
 121         do {                                                            \
 122                 STRACE_PRINTF(prefix_);                                 \
 123                 print_inet_addr((af_), &(where_).field_,                \
 124                                 sizeof((where_).field_), #field_);      \
 125         } while (0)
 126
 127 #define PRINT_FIELD_INET4_ADDR(prefix_, where_, field_)                 \
 128         STRACE_PRINTF("%s%s=inet_addr(\"%s\")", (prefix_), #field_,     \
 129                       inet_ntoa((where_).field_))
 130
 131 #define PRINT_FIELD_NET_PORT(prefix_, where_, field_)                   \
 132         STRACE_PRINTF("%s%s=htons(%u)", (prefix_), #field_,             \
 133                       ntohs((where_).field_))
 134
 135 #define PRINT_FIELD_IFINDEX(prefix_, where_, field_)                    \
 136         do {                                                            \
 137                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 138                 print_ifindex((where_).field_);                         \
 139         } while (0)
 140
 141 #define PRINT_FIELD_SOCKADDR(prefix_, where_, field_)                   \
 142         do {                                                            \
 143                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 144                 print_sockaddr(&(where_).field_,                        \
 145                                sizeof((where_).field_));                \
 146         } while (0)
 147
 148 #define PRINT_FIELD_DEV(prefix_, where_, field_)                        \
 149         do {                                                            \
 150                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 151                 print_dev_t((where_).field_);                           \
 152         } while (0)
 153
 154 #define PRINT_FIELD_PTR(prefix_, where_, field_)                        \
 155         do {                                                            \
 156                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 157                 printaddr((mpers_ptr_t) (where_).field_);               \
 158         } while (0)
 159
 160 #define PRINT_FIELD_FD(prefix_, where_, field_, tcp_)                   \
 161         do {                                                            \
 162                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 163                 printfd((tcp_), (where_).field_);                       \
 164         } while (0)
 165
 166 #define PRINT_FIELD_STRN(prefix_, where_, field_, len_, tcp_)           \
 167         do {                                                            \
 168                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 169                 printstrn((tcp_), (where_).field_, (len_));             \
 170         } while (0)
 171
 172
 173 #define PRINT_FIELD_STR(prefix_, where_, field_, tcp_)                  \
 174         do {                                                            \
 175                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 176                 printstr((tcp_), (where_).field_);                      \
 177         } while (0)
 178
 179 #define PRINT_FIELD_PATH(prefix_, where_, field_, tcp_)                 \
 180         do {                                                            \
 181                 STRACE_PRINTF("%s%s=", (prefix_), #field_);             \
 182                 printpath((tcp_), (where_).field_);                     \
 183         } while (0)
 184
 185 #endif /* !STRACE_PRINT_FIELDS_H */