Re: [Qemu-arm] [PATCH v9 08/14] hw/arm/smmuv3: Event queue recording helper

[Auger Eric <eric.auger@redhat.com>]

Hi Peter,

On 08/03/18 19:39, Peter Maydell wrote:
> On 17 February 2018 at 18:46, Eric Auger <eric.auger@redhat.com> wrote:
>> Let's introduce a helper function aiming at recording an
>> event in the event queue.
>>
>> Signed-off-by: Eric Auger <eric.auger@redhat.com>
>>
>> ---
>>
>> v8 -> v9:
>> - add SMMU_EVENT_STRING
>>
>> v7 -> v8:
>> - use dma_addr_t instead of hwaddr in smmuv3_record_event()
>> - introduce struct SMMUEventInfo
>> - add event_stringify + helpers for all fields
>> ---
>>  hw/arm/smmuv3-internal.h | 140 ++++++++++++++++++++++++++++++++++++++++++++++-
>>  hw/arm/smmuv3.c          |  91 +++++++++++++++++++++++++++++-
>>  hw/arm/trace-events      |   1 +
>>  3 files changed, 229 insertions(+), 3 deletions(-)
>>
>> diff --git a/hw/arm/smmuv3-internal.h b/hw/arm/smmuv3-internal.h
>> index 5af97ae..3929f69 100644
>> --- a/hw/arm/smmuv3-internal.h
>> +++ b/hw/arm/smmuv3-internal.h
>> @@ -226,8 +226,6 @@ static inline void smmu_write_cmdq_err(SMMUv3State *s, uint32_t err_type)
>>      s->cmdq.cons = FIELD_DP32(s->cmdq.cons, CMDQ_CONS, ERR, err_type);
>>  }
>>
>> -void smmuv3_write_eventq(SMMUv3State *s, Evt *evt);
>> -
>>  /* Commands */
>>
>>  enum {
>> @@ -326,4 +324,142 @@ enum { /* Command completion notification */
>>              addr;                                             \
>>          })
>>
>> +/* Events */
>> +
>> +typedef enum SMMUEventType {
>> +    SMMU_EVT_OK                 = 0x00,
>> +    SMMU_EVT_F_UUT              = 0x01,
>> +    SMMU_EVT_C_BAD_STREAMID     = 0x02,
>> +    SMMU_EVT_F_STE_FETCH        = 0x03,
>> +    SMMU_EVT_C_BAD_STE          = 0x04,
>> +    SMMU_EVT_F_BAD_ATS_TREQ     = 0x05,
>> +    SMMU_EVT_F_STREAM_DISABLED  = 0x06,
>> +    SMMU_EVT_F_TRANS_FORBIDDEN  = 0x07,
>> +    SMMU_EVT_C_BAD_SUBSTREAMID  = 0x08,
>> +    SMMU_EVT_F_CD_FETCH         = 0x09,
>> +    SMMU_EVT_C_BAD_CD           = 0x0a,
>> +    SMMU_EVT_F_WALK_EABT        = 0x0b,
>> +    SMMU_EVT_F_TRANSLATION      = 0x10,
>> +    SMMU_EVT_F_ADDR_SIZE        = 0x11,
>> +    SMMU_EVT_F_ACCESS           = 0x12,
>> +    SMMU_EVT_F_PERMISSION       = 0x13,
>> +    SMMU_EVT_F_TLB_CONFLICT     = 0x20,
>> +    SMMU_EVT_F_CFG_CONFLICT     = 0x21,
>> +    SMMU_EVT_E_PAGE_REQ         = 0x24,
>> +} SMMUEventType;
>> +
>> +static const char *event_stringify[] = {
>> +    [SMMU_EVT_OK]                       = "SMMU_EVT_OK",
>> +    [SMMU_EVT_F_UUT]                    = "SMMU_EVT_F_UUT",
>> +    [SMMU_EVT_C_BAD_STREAMID]           = "SMMU_EVT_C_BAD_STREAMID",
>> +    [SMMU_EVT_F_STE_FETCH]              = "SMMU_EVT_F_STE_FETCH",
>> +    [SMMU_EVT_C_BAD_STE]                = "SMMU_EVT_C_BAD_STE",
>> +    [SMMU_EVT_F_BAD_ATS_TREQ]           = "SMMU_EVT_F_BAD_ATS_TREQ",
>> +    [SMMU_EVT_F_STREAM_DISABLED]        = "SMMU_EVT_F_STREAM_DISABLED",
>> +    [SMMU_EVT_F_TRANS_FORBIDDEN]        = "SMMU_EVT_F_TRANS_FORBIDDEN",
>> +    [SMMU_EVT_C_BAD_SUBSTREAMID]        = "SMMU_EVT_C_BAD_SUBSTREAMID",
>> +    [SMMU_EVT_F_CD_FETCH]               = "SMMU_EVT_F_CD_FETCH",
>> +    [SMMU_EVT_C_BAD_CD]                 = "SMMU_EVT_C_BAD_CD",
>> +    [SMMU_EVT_F_WALK_EABT]              = "SMMU_EVT_F_WALK_EABT",
>> +    [SMMU_EVT_F_TRANSLATION]            = "SMMU_EVT_F_TRANSLATION",
>> +    [SMMU_EVT_F_ADDR_SIZE]              = "SMMU_EVT_F_ADDR_SIZE",
>> +    [SMMU_EVT_F_ACCESS]                 = "SMMU_EVT_F_ACCESS",
>> +    [SMMU_EVT_F_PERMISSION]             = "SMMU_EVT_F_PERMISSION",
>> +    [SMMU_EVT_F_TLB_CONFLICT]           = "SMMU_EVT_F_TLB_CONFLICT",
>> +    [SMMU_EVT_F_CFG_CONFLICT]           = "SMMU_EVT_F_CFG_CONFLICT",
>> +    [SMMU_EVT_E_PAGE_REQ]               = "SMMU_EVT_E_PAGE_REQ",
>> +};
>> +
>> +#define SMMU_EVENT_STRING(event) (                                         \
>> +(event < ARRAY_SIZE(event_stringify)) ? event_stringify[event] : "UNKNOWN" \
>> +)
> 
> Same remarks as for the other value-to-string helper.
OK
> 
>> +
>> +typedef struct SMMUEventInfo {
> 
> This struct could use a comment summmarizing what it's for.
OK
> 
>> +    SMMUEventType type;
>> +    uint32_t sid;
>> +    bool recorded;
>> +    bool record_trans_faults;
>> +    union {
>> +        struct {
>> +            uint32_t ssid;
>> +            bool ssv;
>> +            dma_addr_t addr;
>> +            bool rnw;
>> +            bool pnu;
>> +            bool ind;
>> +       } f_uut;
>> +       struct ssid_info {
>> +            uint32_t ssid;
>> +            bool ssv;
>> +       } c_bad_streamid;
>> +       struct ssid_addr_info {
>> +            uint32_t ssid;
>> +            bool ssv;
>> +            dma_addr_t addr;
>> +       } f_ste_fetch;
>> +       struct ssid_info c_bad_ste;
>> +       struct {
>> +            dma_addr_t addr;
>> +            bool rnw;
>> +       } f_transl_forbidden;
>> +       struct {
>> +            uint32_t ssid;
>> +       } c_bad_substream;
>> +       struct ssid_addr_info f_cd_fetch;
>> +       struct ssid_info c_bad_cd;
>> +       struct full_info {
>> +            bool stall;
>> +            uint16_t stag;
>> +            uint32_t ssid;
>> +            bool ssv;
>> +            bool s2;
>> +            dma_addr_t addr;
>> +            bool rnw;
>> +            bool pnu;
>> +            bool ind;
>> +            uint8_t class;
>> +            dma_addr_t addr2;
>> +       } f_walk_eabt;
>> +       struct full_info f_translation;
>> +       struct full_info f_addr_size;
>> +       struct full_info f_access;
>> +       struct full_info f_permission;
>> +       struct ssid_info f_cfg_conflict;
>> +       /**
>> +        * not supported yet:
>> +        * F_BAD_ATS_TREQ
>> +        * F_BAD_ATS_TREQ
>> +        * F_TLB_CONFLICT
>> +        * E_PAGE_REQUEST
>> +        * IMPDEF_EVENTn
>> +        */
>> +    } u;
>> +} SMMUEventInfo;
>> +
>> +/* EVTQ fields */
>> +
>> +#define EVT_Q_OVERFLOW        (1 << 31)
>> +
>> +#define EVT_SET_TYPE(x, v)              deposit32((x)->word[0], 0 , 8 ,  v)
>> +#define EVT_SET_SSV(x, v)               deposit32((x)->word[0], 11, 1 ,  v)
>> +#define EVT_SET_SSID(x, v)              deposit32((x)->word[0], 12, 20, v)
>> +#define EVT_SET_SID(x, v)               ((x)->word[1] =  v)
>> +#define EVT_SET_STAG(x, v)              deposit32((x)->word[2], 0 , 16, v)
>> +#define EVT_SET_STALL(x, v)             deposit32((x)->word[2], 31, 1 , v)
>> +#define EVT_SET_PNU(x, v)               deposit32((x)->word[3], 1 , 1 , v)
>> +#define EVT_SET_IND(x, v)               deposit32((x)->word[3], 2 , 1 , v)
>> +#define EVT_SET_RNW(x, v)               deposit32((x)->word[3], 3 , 1 , v)
>> +#define EVT_SET_S2(x, v)                deposit32((x)->word[3], 7 , 1 , v)
>> +#define EVT_SET_CLASS(x, v)             deposit32((x)->word[3], 8 , 2 , v)
>> +#define EVT_SET_ADDR(x, addr) ({                    \
>> +            (x)->word[5] = (uint32_t)(addr >> 32);        \
>> +            (x)->word[4] = (uint32_t)(addr & 0xffffffff); \
>> +        })
>> +#define EVT_SET_ADDR2(x, addr) ({                    \
>> +            deposit32((x)->word[7], 3, 29, addr >> 16);        \
>> +            deposit32((x)->word[7], 0, 16, addr & 0xffff); \
>> +        })
>> +
>> +void smmuv3_record_event(SMMUv3State *s, SMMUEventInfo *event);
>> +
>>  #endif
>> diff --git a/hw/arm/smmuv3.c b/hw/arm/smmuv3.c
>> index fcfdbb0..0adfe53 100644
>> --- a/hw/arm/smmuv3.c
>> +++ b/hw/arm/smmuv3.c
>> @@ -140,7 +140,7 @@ static void queue_write(SMMUQueue *q, void *data)
>>      queue_prod_incr(q);
>>  }
>>
>> -void smmuv3_write_eventq(SMMUv3State *s, Evt *evt)
>> +static void smmuv3_write_eventq(SMMUv3State *s, Evt *evt)
>>  {
>>      SMMUQueue *q = &s->eventq;
>>      bool q_empty = Q_EMPTY(q);
>> @@ -161,6 +161,95 @@ void smmuv3_write_eventq(SMMUv3State *s, Evt *evt)
>>      }
>>  }
>>
>> +void smmuv3_record_event(SMMUv3State *s, SMMUEventInfo *info)
>> +{
>> +    Evt evt;
>> +
>> +    if (!SMMUV3_EVENTQ_ENABLED(s)) {
>> +        return;
>> +    }
>> +
>> +    EVT_SET_TYPE(&evt, info->type);
>> +    EVT_SET_SID(&evt, info->sid);
>> +
>> +    switch (info->type) {
>> +    case SMMU_EVT_OK:
>> +        return;
>> +    case SMMU_EVT_F_UUT:
>> +        EVT_SET_SSID(&evt, info->u.f_uut.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.f_uut.ssv);
>> +        EVT_SET_ADDR(&evt, info->u.f_uut.addr);
>> +        EVT_SET_RNW(&evt,  info->u.f_uut.rnw);
>> +        EVT_SET_PNU(&evt,  info->u.f_uut.pnu);
>> +        EVT_SET_IND(&evt,  info->u.f_uut.ind);
>> +        break;
>> +    case SMMU_EVT_C_BAD_STREAMID:
>> +        EVT_SET_SSID(&evt, info->u.c_bad_streamid.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.c_bad_streamid.ssv);
>> +        break;
>> +    case SMMU_EVT_F_STE_FETCH:
>> +        EVT_SET_SSID(&evt, info->u.f_ste_fetch.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.f_ste_fetch.ssv);
>> +        EVT_SET_ADDR(&evt, info->u.f_ste_fetch.addr);
>> +        break;
>> +    case SMMU_EVT_C_BAD_STE:
>> +        EVT_SET_SSID(&evt, info->u.c_bad_ste.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.c_bad_ste.ssv);
>> +        break;
>> +    case SMMU_EVT_F_STREAM_DISABLED:
>> +        break;
>> +    case SMMU_EVT_F_TRANS_FORBIDDEN:
>> +        EVT_SET_ADDR(&evt, info->u.f_transl_forbidden.addr);
>> +        EVT_SET_RNW(&evt, info->u.f_transl_forbidden.rnw);
>> +        break;
>> +    case SMMU_EVT_C_BAD_SUBSTREAMID:
>> +        EVT_SET_SSID(&evt, info->u.c_bad_substream.ssid);
>> +        break;
>> +    case SMMU_EVT_F_CD_FETCH:
>> +        EVT_SET_SSID(&evt, info->u.f_cd_fetch.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.f_cd_fetch.ssv);
>> +        EVT_SET_ADDR(&evt, info->u.f_cd_fetch.addr);
>> +        break;
>> +    case SMMU_EVT_C_BAD_CD:
>> +        EVT_SET_SSID(&evt, info->u.c_bad_cd.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.c_bad_cd.ssv);
>> +        break;
>> +    case SMMU_EVT_F_WALK_EABT:
>> +    case SMMU_EVT_F_TRANSLATION:
>> +    case SMMU_EVT_F_ADDR_SIZE:
>> +    case SMMU_EVT_F_ACCESS:
>> +    case SMMU_EVT_F_PERMISSION:
>> +        EVT_SET_STALL(&evt, info->u.f_walk_eabt.stall);
>> +        EVT_SET_STAG(&evt, info->u.f_walk_eabt.stag);
>> +        EVT_SET_SSID(&evt, info->u.f_walk_eabt.ssid);
>> +        EVT_SET_SSV(&evt, info->u.f_walk_eabt.ssv);
>> +        EVT_SET_S2(&evt, info->u.f_walk_eabt.s2);
>> +        EVT_SET_ADDR(&evt, info->u.f_walk_eabt.addr);
>> +        EVT_SET_RNW(&evt, info->u.f_walk_eabt.rnw);
>> +        EVT_SET_PNU(&evt, info->u.f_walk_eabt.pnu);
>> +        EVT_SET_IND(&evt, info->u.f_walk_eabt.ind);
>> +        EVT_SET_CLASS(&evt, info->u.f_walk_eabt.class);
>> +        EVT_SET_ADDR2(&evt, info->u.f_walk_eabt.addr2);
>> +        break;
>> +    case SMMU_EVT_F_CFG_CONFLICT:
>> +        EVT_SET_SSID(&evt, info->u.f_cfg_conflict.ssid);
>> +        EVT_SET_SSV(&evt,  info->u.f_cfg_conflict.ssv);
>> +        break;
>> +    /* rest is not implemented */
>> +    case SMMU_EVT_F_BAD_ATS_TREQ:
>> +    case SMMU_EVT_F_TLB_CONFLICT:
>> +    case SMMU_EVT_E_PAGE_REQ:
>> +    default:
>> +        error_report("%s event %d not supported", __func__,
>> +                     info->type);
> 
> Not error_report, please.
replaced by g_assert_not_reached();
> 
>> +        return;
>> +    }
>> +
>> +    trace_smmuv3_record_event(SMMU_EVENT_STRING(info->type), info->sid);
>> +    smmuv3_write_eventq(s, &evt);
> 
> This should be handling the "oops, the write to memory failed" case.
OK

Thanks

Eric
> 
>> +    info->recorded = true;
>> +}
>> +
>>  static void smmuv3_init_regs(SMMUv3State *s)
>>  {
>>      /**
>> diff --git a/hw/arm/trace-events b/hw/arm/trace-events
>> index ed5dce0..c79c15e 100644
>> --- a/hw/arm/trace-events
>> +++ b/hw/arm/trace-events
>> @@ -28,3 +28,4 @@ smmuv3_write_mmio(hwaddr addr, uint64_t val, unsigned size) "addr: 0x%"PRIx64" v
>>  smmuv3_write_mmio_idr(hwaddr addr, uint64_t val) "write to RO/Unimpl reg 0x%lx val64:0x%lx"
>>  smmuv3_write_mmio_evtq_cons_bef_clear(uint32_t prod, uint32_t cons, uint8_t prod_wrap, uint8_t cons_wrap) "Before clearing interrupt prod:0x%x cons:0x%x prod.w:%d cons.w:%d"
>>  smmuv3_write_mmio_evtq_cons_after_clear(uint32_t prod, uint32_t cons, uint8_t prod_wrap, uint8_t cons_wrap) "after clearing interrupt prod:0x%x cons:0x%x prod.w:%d cons.w:%d"
>> +smmuv3_record_event(const char *type, uint32_t sid) "%s sid=%d"
>> --
> 
> thanks
> -- PMM
>