Commit 1571a23c authored by Peter Maydell's avatar Peter Maydell
Browse files

Merge remote-tracking branch 'remotes/stefanha/tags/tracing-pull-request' into staging 



Pull request

 * Trace TCG atomic memory accesses
 * Document that trace event arguments cannot be floating point

# gpg: Signature made Wed 27 Jun 2018 13:57:40 BST
# gpg:                using RSA key 9CA4ABB381AB73C8
# gpg: Good signature from "Stefan Hajnoczi <stefanha@redhat.com>"
# gpg:                 aka "Stefan Hajnoczi <stefanha@gmail.com>"
# Primary key fingerprint: 8695 A8BF D3F9 7CDA AC35  775A 9CA4 ABB3 81AB 73C8

* remotes/stefanha/tags/tracing-pull-request:
  trace: forbid floating point types
  trace: enable tracing of TCG atomics
  trace: add trace_mem_build_info_no_se_be/le
  trace: expand mem_info:size_shift to 3 bits
  trace: simplify trace_mem functions
  trace: fix misreporting of TCG access sizes for user-space

Signed-off-by: default avatarPeter Maydell <peter.maydell@linaro.org>
parents 00928a42 ec09f877

accel/tcg/atomic_template.h

+81 −6
Original line number Diff line number Diff line
@@ -18,30 +18,37 @@ 
 * License along with this library; if not, see <http://www.gnu.org/licenses/>.

 */



#include "trace/mem.h"



#if DATA_SIZE == 16

# define SUFFIX     o

# define DATA_TYPE  Int128

# define BSWAP      bswap128

# define SHIFT      4

#elif DATA_SIZE == 8

# define SUFFIX     q

# define DATA_TYPE  uint64_t

# define SDATA_TYPE int64_t

# define BSWAP      bswap64

# define SHIFT      3

#elif DATA_SIZE == 4

# define SUFFIX     l

# define DATA_TYPE  uint32_t

# define SDATA_TYPE int32_t

# define BSWAP      bswap32

# define SHIFT      2

#elif DATA_SIZE == 2

# define SUFFIX     w

# define DATA_TYPE  uint16_t

# define SDATA_TYPE int16_t

# define BSWAP      bswap16

# define SHIFT      1

#elif DATA_SIZE == 1

# define SUFFIX     b

# define DATA_TYPE  uint8_t

# define SDATA_TYPE int8_t

# define BSWAP

# define SHIFT      0

#else

# error unsupported data size

#endif
@@ -52,14 +59,37 @@ 
# define ABI_TYPE  uint32_t

#endif



#define ATOMIC_TRACE_RMW do {                                           \

        uint8_t info = glue(trace_mem_build_info_no_se, MEND)(SHIFT, false); \

                                                                        \

        trace_guest_mem_before_exec(ENV_GET_CPU(env), addr, info);      \

        trace_guest_mem_before_exec(ENV_GET_CPU(env), addr,             \

                                    info | TRACE_MEM_ST);               \

    } while (0)



#define ATOMIC_TRACE_LD do {                                            \

        uint8_t info = glue(trace_mem_build_info_no_se, MEND)(SHIFT, false); \

                                                                        \

        trace_guest_mem_before_exec(ENV_GET_CPU(env), addr, info);      \

    } while (0)



# define ATOMIC_TRACE_ST do {                                           \

        uint8_t info = glue(trace_mem_build_info_no_se, MEND)(SHIFT, true); \

                                                                        \

        trace_guest_mem_before_exec(ENV_GET_CPU(env), addr, info);      \

    } while (0)



/* Define host-endian atomic operations.  Note that END is used within

   the ATOMIC_NAME macro, and redefined below.  */

#if DATA_SIZE == 1

# define END

# define MEND _be /* either le or be would be fine */

#elif defined(HOST_WORDS_BIGENDIAN)

# define END  _be

# define MEND _be

#else

# define END  _le

# define MEND _le

#endif



ABI_TYPE ATOMIC_NAME(cmpxchg)(CPUArchState *env, target_ulong addr,
@@ -67,7 +97,10 @@ ABI_TYPE ATOMIC_NAME(cmpxchg)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;

    DATA_TYPE ret = atomic_cmpxchg__nocheck(haddr, cmpv, newv);

    DATA_TYPE ret;



    ATOMIC_TRACE_RMW;

    ret = atomic_cmpxchg__nocheck(haddr, cmpv, newv);

    ATOMIC_MMU_CLEANUP;

    return ret;

}
@@ -77,6 +110,8 @@ ABI_TYPE ATOMIC_NAME(ld)(CPUArchState *env, target_ulong addr EXTRA_ARGS) 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE val, *haddr = ATOMIC_MMU_LOOKUP;



    ATOMIC_TRACE_LD;

    __atomic_load(haddr, &val, __ATOMIC_RELAXED);

    ATOMIC_MMU_CLEANUP;

    return val;
@@ -87,6 +122,8 @@ void ATOMIC_NAME(st)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;



    ATOMIC_TRACE_ST;

    __atomic_store(haddr, &val, __ATOMIC_RELAXED);

    ATOMIC_MMU_CLEANUP;

}
@@ -96,7 +133,10 @@ ABI_TYPE ATOMIC_NAME(xchg)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;

    DATA_TYPE ret = atomic_xchg__nocheck(haddr, val);

    DATA_TYPE ret;



    ATOMIC_TRACE_RMW;

    ret = atomic_xchg__nocheck(haddr, val);

    ATOMIC_MMU_CLEANUP;

    return ret;

}
@@ -107,7 +147,10 @@ ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr, \ 
{                                                                   \

    ATOMIC_MMU_DECLS;                                               \

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;                           \

    DATA_TYPE ret = atomic_##X(haddr, val);                         \

    DATA_TYPE ret;                                                  \

                                                                    \

    ATOMIC_TRACE_RMW;                                               \

    ret = atomic_##X(haddr, val);                                   \

    ATOMIC_MMU_CLEANUP;                                             \

    return ret;                                                     \

}
@@ -126,6 +169,9 @@ GEN_ATOMIC_HELPER(xor_fetch) 
/* These helpers are, as a whole, full barriers.  Within the helper,

 * the leading barrier is explicit and the trailing barrier is within

 * cmpxchg primitive.

 *

 * Trace this load + RMW loop as a single RMW op. This way, regardless

 * of CF_PARALLEL's value, we'll trace just a read and a write.

 */

#define GEN_ATOMIC_HELPER_FN(X, FN, XDATA_TYPE, RET)                \

ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr,       \
@@ -134,6 +180,8 @@ ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr, \ 
    ATOMIC_MMU_DECLS;                                               \

    XDATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;                          \

    XDATA_TYPE cmp, old, new, val = xval;                           \

                                                                    \

    ATOMIC_TRACE_RMW;                                               \

    smp_mb();                                                       \

    cmp = atomic_read__nocheck(haddr);                              \

    do {                                                            \
@@ -158,6 +206,7 @@ GEN_ATOMIC_HELPER_FN(umax_fetch, MAX, DATA_TYPE, new) 
#endif /* DATA SIZE >= 16 */



#undef END

#undef MEND



#if DATA_SIZE > 1
@@ -165,8 +214,10 @@ GEN_ATOMIC_HELPER_FN(umax_fetch, MAX, DATA_TYPE, new) 
   within the ATOMIC_NAME macro.  */

#ifdef HOST_WORDS_BIGENDIAN

# define END  _le

# define MEND _le

#else

# define END  _be

# define MEND _be

#endif



ABI_TYPE ATOMIC_NAME(cmpxchg)(CPUArchState *env, target_ulong addr,
@@ -174,7 +225,10 @@ ABI_TYPE ATOMIC_NAME(cmpxchg)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;

    DATA_TYPE ret = atomic_cmpxchg__nocheck(haddr, BSWAP(cmpv), BSWAP(newv));

    DATA_TYPE ret;



    ATOMIC_TRACE_RMW;

    ret = atomic_cmpxchg__nocheck(haddr, BSWAP(cmpv), BSWAP(newv));

    ATOMIC_MMU_CLEANUP;

    return BSWAP(ret);

}
@@ -184,6 +238,8 @@ ABI_TYPE ATOMIC_NAME(ld)(CPUArchState *env, target_ulong addr EXTRA_ARGS) 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE val, *haddr = ATOMIC_MMU_LOOKUP;



    ATOMIC_TRACE_LD;

    __atomic_load(haddr, &val, __ATOMIC_RELAXED);

    ATOMIC_MMU_CLEANUP;

    return BSWAP(val);
@@ -194,6 +250,8 @@ void ATOMIC_NAME(st)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;



    ATOMIC_TRACE_ST;

    val = BSWAP(val);

    __atomic_store(haddr, &val, __ATOMIC_RELAXED);

    ATOMIC_MMU_CLEANUP;
@@ -204,7 +262,10 @@ ABI_TYPE ATOMIC_NAME(xchg)(CPUArchState *env, target_ulong addr, 
{

    ATOMIC_MMU_DECLS;

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;

    ABI_TYPE ret = atomic_xchg__nocheck(haddr, BSWAP(val));

    ABI_TYPE ret;



    ATOMIC_TRACE_RMW;

    ret = atomic_xchg__nocheck(haddr, BSWAP(val));

    ATOMIC_MMU_CLEANUP;

    return BSWAP(ret);

}
@@ -215,7 +276,10 @@ ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr, \ 
{                                                                   \

    ATOMIC_MMU_DECLS;                                               \

    DATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;                           \

    DATA_TYPE ret = atomic_##X(haddr, BSWAP(val));                  \

    DATA_TYPE ret;                                                  \

                                                                    \

    ATOMIC_TRACE_RMW;                                               \

    ret = atomic_##X(haddr, BSWAP(val));                            \

    ATOMIC_MMU_CLEANUP;                                             \

    return BSWAP(ret);                                              \

}
@@ -232,6 +296,9 @@ GEN_ATOMIC_HELPER(xor_fetch) 
/* These helpers are, as a whole, full barriers.  Within the helper,

 * the leading barrier is explicit and the trailing barrier is within

 * cmpxchg primitive.

 *

 * Trace this load + RMW loop as a single RMW op. This way, regardless

 * of CF_PARALLEL's value, we'll trace just a read and a write.

 */

#define GEN_ATOMIC_HELPER_FN(X, FN, XDATA_TYPE, RET)                \

ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr,       \
@@ -240,6 +307,8 @@ ABI_TYPE ATOMIC_NAME(X)(CPUArchState *env, target_ulong addr, \ 
    ATOMIC_MMU_DECLS;                                               \

    XDATA_TYPE *haddr = ATOMIC_MMU_LOOKUP;                          \

    XDATA_TYPE ldo, ldn, old, new, val = xval;                      \

                                                                    \

    ATOMIC_TRACE_RMW;                                               \

    smp_mb();                                                       \

    ldn = atomic_read__nocheck(haddr);                              \

    do {                                                            \
@@ -271,11 +340,17 @@ GEN_ATOMIC_HELPER_FN(add_fetch, ADD, DATA_TYPE, new) 
#endif /* DATA_SIZE >= 16 */



#undef END

#undef MEND

#endif /* DATA_SIZE > 1 */



#undef ATOMIC_TRACE_ST

#undef ATOMIC_TRACE_LD

#undef ATOMIC_TRACE_RMW



#undef BSWAP

#undef ABI_TYPE

#undef DATA_TYPE

#undef SDATA_TYPE

#undef SUFFIX

#undef DATA_SIZE

#undef SHIFT

docs/devel/tracing.txt

+5 −0
Original line number Diff line number Diff line
@@ -104,6 +104,11 @@ Trace events should use types as follows: 
 * For everything else, use primitive scalar types (char, int, long) with the

   appropriate signedness.



 * Avoid floating point types (float and double) because SystemTap does not

   support them.  In most cases it is possible to round to an integer type

   instead.  This may require scaling the value first by multiplying it by 1000

   or the like when digits after the decimal point need to be preserved.



Format strings should reflect the types defined in the trace event.  Take

special care to use PRId64 and PRIu64 for int64_t and uint64_t types,

respectively.  This ensures portability between 32- and 64-bit platforms.

include/exec/cpu_ldst_useronly_template.h

+8 −3
Original line number Diff line number Diff line
@@ -33,20 +33,24 @@ 
#define SUFFIX q

#define USUFFIX q

#define DATA_TYPE uint64_t

#define SHIFT 3

#elif DATA_SIZE == 4

#define SUFFIX l

#define USUFFIX l

#define DATA_TYPE uint32_t

#define SHIFT 2

#elif DATA_SIZE == 2

#define SUFFIX w

#define USUFFIX uw

#define DATA_TYPE uint16_t

#define DATA_STYPE int16_t

#define SHIFT 1

#elif DATA_SIZE == 1

#define SUFFIX b

#define USUFFIX ub

#define DATA_TYPE uint8_t

#define DATA_STYPE int8_t

#define SHIFT 0

#else

#error unsupported data size

#endif
@@ -63,7 +67,7 @@ glue(glue(cpu_ld, USUFFIX), MEMSUFFIX)(CPUArchState *env, target_ulong ptr) 
#if !defined(CODE_ACCESS)

    trace_guest_mem_before_exec(

        ENV_GET_CPU(env), ptr,

        trace_mem_build_info(DATA_SIZE, false, MO_TE, false));

        trace_mem_build_info(SHIFT, false, MO_TE, false));

#endif

    return glue(glue(ld, USUFFIX), _p)(g2h(ptr));

}
@@ -87,7 +91,7 @@ glue(glue(cpu_lds, SUFFIX), MEMSUFFIX)(CPUArchState *env, target_ulong ptr) 
#if !defined(CODE_ACCESS)

    trace_guest_mem_before_exec(

        ENV_GET_CPU(env), ptr,

        trace_mem_build_info(DATA_SIZE, true, MO_TE, false));

        trace_mem_build_info(SHIFT, true, MO_TE, false));

#endif

    return glue(glue(lds, SUFFIX), _p)(g2h(ptr));

}
@@ -113,7 +117,7 @@ glue(glue(cpu_st, SUFFIX), MEMSUFFIX)(CPUArchState *env, target_ulong ptr, 
#if !defined(CODE_ACCESS)

    trace_guest_mem_before_exec(

        ENV_GET_CPU(env), ptr,

        trace_mem_build_info(DATA_SIZE, false, MO_TE, true));

        trace_mem_build_info(SHIFT, false, MO_TE, true));

#endif

    glue(glue(st, SUFFIX), _p)(g2h(ptr), v);

}
@@ -136,3 +140,4 @@ glue(glue(glue(cpu_st, SUFFIX), MEMSUFFIX), _ra)(CPUArchState *env, 
#undef SUFFIX

#undef USUFFIX

#undef DATA_SIZE

#undef SHIFT

migration/trace-events

+1 −1
Original line number Diff line number Diff line
@@ -133,7 +133,7 @@ migrate_global_state_post_load(const char *state) "loaded state: %s" 
migrate_global_state_pre_save(const char *state) "saved state: %s"

migration_thread_low_pending(uint64_t pending) "%" PRIu64

migrate_state_too_big(void) ""

migrate_transferred(uint64_t tranferred, uint64_t time_spent, double bandwidth, uint64_t size) "transferred %" PRIu64 " time_spent %" PRIu64 " bandwidth %g max_size %" PRId64

migrate_transferred(uint64_t tranferred, uint64_t time_spent, uint64_t bandwidth, uint64_t size) "transferred %" PRIu64 " time_spent %" PRIu64 " bandwidth %" PRIu64 " max_size %" PRId64

process_incoming_migration_co_end(int ret, int ps) "ret=%d postcopy-state=%d"

process_incoming_migration_co_postcopy_end_main(void) ""

migration_set_incoming_channel(void *ioc, const char *ioctype) "ioc=%p ioctype=%s"

qapi/trace-events

+1 −1
Original line number Diff line number Diff line
@@ -29,6 +29,6 @@ visit_type_int64(void *v, const char *name, int64_t *obj) "v=%p name=%s obj=%p" 
visit_type_size(void *v, const char *name, uint64_t *obj) "v=%p name=%s obj=%p"

visit_type_bool(void *v, const char *name, bool *obj) "v=%p name=%s obj=%p"

visit_type_str(void *v, const char *name, char **obj) "v=%p name=%s obj=%p"

visit_type_number(void *v, const char *name, double *obj) "v=%p name=%s obj=%p"

visit_type_number(void *v, const char *name, void *obj) "v=%p name=%s obj=%p"

visit_type_any(void *v, const char *name, void *obj) "v=%p name=%s obj=%p"

visit_type_null(void *v, const char *name, void *obj) "v=%p name=%s obj=%p"