-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 06 July 2020 13:59
To: Anup Patel <Anup.Patel@...>
Cc: tech-unixplatformspec@...; Andrew Waterman
<andrew@...>; Greg Favor <gfavor@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU
Extension

On Mon, Jul 6, 2020 at 12:35 AM Anup Patel <anup.patel@...> wrote:

Hi All,

We don't have a dedicated RISC-V PMU extension but we do have

HARDWARE

performance counters such as CYCLE CSR, INSTRET CSR, and HPMCOUNTER
CSRs. A RISC-V implementation can support monitoring various HARDWARE
events using limited number of HPMCOUNTER CSRs.

In addition to HARDWARE performance counters, a SBI implementation
(e.g. OpenSBI, Xvisor, KVM, etc) can provide SOFTWARE counters for
events such as number of RFENCEs, number of IPIs, number of misaligned
load/store instructions, number of illegal instructions, etc.

We propose SBI PMU extension which tries to cover CYCLE CSR, INSTRET
CSR, HPMCOUNTER CSRs and SOFTWARE counters provided by SBI

implementation.

To define SBI PMU extension, we first define counter_idx which is a
logical number assigned to a counter and event_idx which is an encoded

Is there more detail about counter_idx? I was wondering that 1. What is the
ordering of logical numbers for HW and SW counters? I think that the logical
numbers are assigned by OpenSBI.

Like mentioned here, counter_idx is a logical index for all available counters
(i.e. HARDWARE and SOFTWARE). The SBI implementation (i.e. OpenSBI,
Xvisor RISC-V, or KVM RISC-V) can assign counter_idx to HARDWARE and
SOFTWARE counters in any order it likes.

2. How to know the logical number of counter_idx of each HW and SW
counters from s-mode? I guess that we need to know the logical numbers of
all counters before we invoke a SBI call.

The SBI_PMU_COUNTER_DESCRIBE call mentioned below will tell us
whether given counter_idx maps to a HARDWARE counter or SOFTWARE
counter based on CSR_Number info returned by SBI_PMU_COUNTER_DESCRIBE
call.

number representing the HARDWARE/SOFTWARE event to be monitored.

The SBI PMU event_idx is a XLEN bits wide number encoded as follows:
event_idx[XLEN-1:16] = info
event_idx[15:12] = type
event_idx[11:0] = code

If event_idx.type == 0x0 then it is HARDWARE event. For HARDWARE
event, the event_idx.info is optional and can be passed zero whereas
the event_idx.code can be one of the following values:
enum sbi_pmu_hw_id {
SBI_PMU_HW_CPU_CYCLES = 0,
SBI_PMU_HW_INSTRUCTIONS = 1,
SBI_PMU_HW_CACHE_REFERENCES = 2,
SBI_PMU_HW_CACHE_MISSES = 3,
SBI_PMU_HW_BRANCH_INSTRUCTIONS = 4,
SBI_PMU_HW_BRANCH_MISSES = 5,
SBI_PMU_HW_BUS_CYCLES = 6,
SBI_PMU_HW_STALLED_CYCLES_FRONTEND = 7,
SBI_PMU_HW_STALLED_CYCLES_BACKEND = 8,
SBI_PMU_HW_REF_CPU_CYCLES = 9,
SBI_PMU_HW_MAX, /* non-ABI */
};
(NOTE: Same as <linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x1 then it is HARDWARE CACHE event. For

HARDWARE

CACHE event, the event_idx.info is optional and can be passed zero
whereas the event_idx.code is encoded as follows:
event_idx.code[11:3] = cache_id
event_idx.code[2:1] = op_id
event_idx.code[0:0] = result_id
enum sbi_pmu_hw_cache_id {
SBI_PMU_HW_CACHE_L1D = 0,
SBI_PMU_HW_CACHE_L1I = 1,
SBI_PMU_HW_CACHE_LL = 2,
SBI_PMU_HW_CACHE_DTLB = 3,
SBI_PMU_HW_CACHE_ITLB = 4,
SBI_PMU_HW_CACHE_BPU = 5,
SBI_PMU_HW_CACHE_NODE = 6,
SBI_PMU_HW_CACHE_MAX, /* non-ABI */ }; enum

sbi_pmu_hw_cache_op_id

{
SBI_PMU_HW_CACHE_OP_READ = 0,
SBI_PMU_HW_CACHE_OP_WRITE = 1,
SBI_PMU_HW_CACHE_OP_PREFETCH = 2,
SBI_PMU_HW_CACHE_OP_MAX, /* non-ABI */
};
enum sbi_pmu_hw_cache_op_result_id {
SBI_PMU_HW_CACHE_RESULT_ACCESS = 0,
SBI_PMU_HW_CACHE_RESULT_MISS = 1,
SBI_PMU_HW_CACHE_RESULT_MAX, /* non-ABI */
};
(NOTE: Same as <linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x2 then it is HARDWARE RAW event. For HARDWARE
RAW event, both event_idx.info and event_idx.code are platform

dependent.

If event_idx.type == 0xf then it is SOFTWARE event. For SOFTWARE
event, event_idx.info is SBI implementation specific and
event_idx.code can be one of the following:
enum sbi_pmu_sw_id {
SBI_PMU_SW_MISALIGNED_LOAD = 0,
SBI_PMU_SW_MISALIGNED_STORE = 1,
SBI_PMU_SW_ILLEGAL_INSN = 2,
SBI_PMU_SW_LOCAL_SET_TIMER = 3,
SBI_PMU_SW_LOCAL_IPI = 4,
SBI_PMU_SW_LOCAL_FENCE_I = 5,
SBI_PMU_SW_LOCAL_SFENCE_VMA = 6,
SBI_PMU_SW_LOCAL_SFENCE_VMA_ASID = 7,
SBI_PMU_SW_LOCAL_HFENCE_GVMA = 8,
SBI_PMU_SW_LOCAL_HFENCE_GVMA_VMID = 9,
SBI_PMU_SW_LOCAL_HFENCE_VVMA = 10,
SBI_PMU_SW_LOCAL_HFENCE_VVMA_ASID = 11,
SBI_PMU_SW_MAX, /* non-ABI */
};

In future, more events can be defined without breaking ABI
compatibility of SBI calls.

Using definition of counter_idx and event_idx, we can potentially have
the following SBI calls:

1. SBI_PMU_NUM_COUNTERS
This call will return the number of COUNTERs

Is it for the SW counters and we get the number of HW counters by DT?
Or does it return the number of HW and SW counters both? If so, how to
distinguish the number of HW and SW?

This call returns total number of counters (i.e. HARDWARE and SOFTWARE both)

The other question is that the number of SW counters is defined by the core
of OpenSBI or platform-dependent?

Number of SW counters are defined by SBI implementation (i.e. OpenSBI,
Xvisor RISC-V, and KVM RISC-V). Most likely SW counters will not include
any platform-dependent SW counters although this is design choice of
SBI implementation.

2. SBI_PMU_COUNTER_DESCRIBE
This call takes two parameters: 1) counter_idx 2) physical address
It will write the description of SBI PMU counter at specified physical
address. The details of the SBI PMU counter written at specified
physical address are as follows:
1. Name (64 bytes)
2. CSR_Number (2 bytes)
(CSR_Number <= 0xfff means counter is a RISC-V CSR)
(CSR_Number > 0xfff means counter is a SBI implementation counter)
(E.g. CSR_Number == 0xC02 imply HPMCOUNTER2 CSR)
3. CSR_Width (2 bytes)
(Number of CSR bits implemented in HW)
4. Event_Count (2 bytes)
(Number of events in Event_List array)
5. Event_List (2 * Event_Count bytes)
(This is an array of 16bit values where each 16bit value is the
supported event_idx.type and event_idx.code combination)

What is the size we should allocate for this physical address? In my
understanding, we need to allocate the pages in s-mode first, then pass the
address of the pages to the second parameter, but we don't know the
event_counter before we allocate the space for it, so it might across the
boundary if event_count is very big.

Theoretically, Event_Count cannot be more than 65535.

I think we should have SBI_PMU_NUM_EVENTS calls which will
return number of events supported by given counter_idx. This will
help S-mode software to determine amount of memory to allocate
for SBI_PMU_COUNTER_DESCRIBE.

3. SBI_PMU_COUNTER_SET_PHYS_ADDR
This call takes two parameters: 1) counter_idx 2) physical address
It will set the physical address of memory location where the SBI
implementation will write the 64bit SOFTWARE counter. This SBI call
is only for counters not mapped to any CSR (i.e. only for counters
with CSR_Number > 0xfff).
4. SBI_PMU_COUNTER_START
This call takes two parameters: 1) counter_idx 2) event_idx
It will inform SBI implementation to configure and start/enable
specified counter on the calling HART to monitor specific event.
This SBI call will fail for counters which are not present and
specified event_idx is not supported by the counter.
5. SBI_PMU_COUNTER_STOP
This call takes one parameter: 1) counter_idx
It will inform SBI implementation to stop/disable specified counters
on the calling HART. This SBI call will fail for counters which are
not present.

From above, the RISC-V PMU driver will use most of the SBI calls at
boot time. Only SBI_PMU_COUNTER_START to be used once before using

the counter.

The reading of counter is by reading CSR (for CSR_Number < 0xfff) OR
by reading memory location (for CSR_Offset >= 0xfff). The counter
overflow handling will have to be done in software by Linux kernel.

Using the SBI PMU extension, the M-mode runtime firmware (or
Hypervisors) can provide a standardized view of HARDWARE/SOFTWARE
counters and events to S-mode (or VS-mode) software.

The M-mode runtime firmware (OpenSBI) will need to know following
platform dependent information:
1. Possible event_idx values allowed (or supported) by a HARDWARE
counter (i.e. HPMCOUNTER)
2. Mapping of event_idx for HARDWARE event to HPMEVENT CSR value 3.
Mapping of event_idx for HARDWARE CACHE event to HPMEVENT CSR

value 4.

Mapping of event_idx for HARDWARE RAW event to HPMEVENT CSR value

5.

Additional platform-specific progamming required by any event_idx

All platform dependent information mentioned above, can be obtained by
M-mode runtime firmware (OpenSBI) from platform specific code. The
DT/ACPI can also be used to described 1), 2), 3), and 4) mentioned
above but 5) will always require platform specific code.

I would update the next version of DT file to describe the points from
1) to 4). Thanks.
As you mentioned before, it would be hard to sync the platform specific code
with the DT of real use.
I prefer to get 1), 2), 3) and 4) from DT first on each platform, and use
platform specific code if DT is unavailable. (generic platform use DT certainly),
then we could maximally reduce the inconsistency.

It should platform's choice on how it wants to describe HARDWARE
events and HARDWARE counters. The OpenSBI generic platform will
tend to use DT based parsing of HARDWARE events and HARDWARE
counters but other platform can do things differently.

The S-mode software (i.e. Linux) should not get HARDWARE events
and HARDWARE counters from DT because DT describes HARDWARE
and DT will not include SOFTWARE events and SOFTWARE counters.
Also, SOFTWARE events and SOFTWARE counters will change for given
platform as OpenSBI continues to improve so it will be hard to keep
the DT in sync.

The best thing for S-mode software would be to depend on one
method of discovering all counters and supported events which
is the SBI_PMU_COUNTER_DESCRIBE call. In other words, no need
for platform driver for Linux RISC-V PMU driver instead depend only
on sbi_probe_extension() to detect SBI PMU extension.

Regards,
Anup

On Tue, Jul 7, 2020 at 12:21 AM Anup Patel <anup.patel@...>
wrote:

-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 06 July 2020 13:59
To: Anup Patel <Anup.Patel@...>
Cc: tech-unixplatformspec@...; Andrew Waterman
<andrew@...>; Greg Favor <gfavor@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI
PMU
Extension

On Mon, Jul 6, 2020 at 12:35 AM Anup Patel <anup.patel@...>
wrote:

Hi All,

We don't have a dedicated RISC-V PMU extension but we do have

HARDWARE

performance counters such as CYCLE CSR, INSTRET CSR, and
HPMCOUNTER
CSRs. A RISC-V implementation can support monitoring various
HARDWARE
events using limited number of HPMCOUNTER CSRs.

In addition to HARDWARE performance counters, a SBI
implementation
(e.g. OpenSBI, Xvisor, KVM, etc) can provide SOFTWARE counters
for
events such as number of RFENCEs, number of IPIs, number of
misaligned
load/store instructions, number of illegal instructions, etc.

We propose SBI PMU extension which tries to cover CYCLE CSR,
INSTRET
CSR, HPMCOUNTER CSRs and SOFTWARE counters provided by SBI

implementation.

To define SBI PMU extension, we first define counter_idx which
is a
logical number assigned to a counter and event_idx which is an
encoded

Is there more detail about counter_idx? I was wondering that 1.
What is the
ordering of logical numbers for HW and SW counters? I think that
the logical
numbers are assigned by OpenSBI.

Like mentioned here, counter_idx is a logical index for all
available counters
(i.e. HARDWARE and SOFTWARE). The SBI implementation (i.e. OpenSBI,
Xvisor RISC-V, or KVM RISC-V) can assign counter_idx to HARDWARE
and
SOFTWARE counters in any order it likes.

2. How to know the logical number of counter_idx of each HW and
SW
counters from s-mode? I guess that we need to know the logical
numbers of
all counters before we invoke a SBI call.

The SBI_PMU_COUNTER_DESCRIBE call mentioned below will tell us
whether given counter_idx maps to a HARDWARE counter or SOFTWARE
counter based on CSR_Number info returned by
SBI_PMU_COUNTER_DESCRIBE
call.

OK, I assume the logical number of counte_idx is sequential and
started from zero here,
so during initialization of s-mode software, we could get the total
number 'N' of counters
by SBI_PMU_NUM_COUNTERS first, then loop the N times to identify
capability of each
counter. Does it align your ideas?

number representing the HARDWARE/SOFTWARE event to be
monitored.

The SBI PMU event_idx is a XLEN bits wide number encoded as
follows:
event_idx[XLEN-1:16] = info
event_idx[15:12] = type
event_idx[11:0] = code

If event_idx.type == 0x0 then it is HARDWARE event. For
HARDWARE
event, the event_idx.info is optional and can be passed zero
whereas
the event_idx.code can be one of the following values:
enum sbi_pmu_hw_id {
SBI_PMU_HW_CPU_CYCLES = 0,
SBI_PMU_HW_INSTRUCTIONS = 1,
SBI_PMU_HW_CACHE_REFERENCES = 2,
SBI_PMU_HW_CACHE_MISSES = 3,
SBI_PMU_HW_BRANCH_INSTRUCTIONS = 4,
SBI_PMU_HW_BRANCH_MISSES = 5,
SBI_PMU_HW_BUS_CYCLES = 6,
SBI_PMU_HW_STALLED_CYCLES_FRONTEND = 7,
SBI_PMU_HW_STALLED_CYCLES_BACKEND = 8,
SBI_PMU_HW_REF_CPU_CYCLES = 9,
SBI_PMU_HW_MAX, /* non-ABI */
};
(NOTE: Same as <linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x1 then it is HARDWARE CACHE event. For

HARDWARE

CACHE event, the event_idx.info is optional and can be passed
zero
whereas the event_idx.code is encoded as follows:
event_idx.code[11:3] = cache_id
event_idx.code[2:1] = op_id
event_idx.code[0:0] = result_id
enum sbi_pmu_hw_cache_id {
SBI_PMU_HW_CACHE_L1D = 0,
SBI_PMU_HW_CACHE_L1I = 1,
SBI_PMU_HW_CACHE_LL = 2,
SBI_PMU_HW_CACHE_DTLB = 3,
SBI_PMU_HW_CACHE_ITLB = 4,
SBI_PMU_HW_CACHE_BPU = 5,
SBI_PMU_HW_CACHE_NODE = 6,
SBI_PMU_HW_CACHE_MAX, /* non-ABI */ }; enum

sbi_pmu_hw_cache_op_id

{
SBI_PMU_HW_CACHE_OP_READ = 0,
SBI_PMU_HW_CACHE_OP_WRITE = 1,
SBI_PMU_HW_CACHE_OP_PREFETCH = 2,
SBI_PMU_HW_CACHE_OP_MAX, /* non-ABI */
};
enum sbi_pmu_hw_cache_op_result_id {
SBI_PMU_HW_CACHE_RESULT_ACCESS = 0,
SBI_PMU_HW_CACHE_RESULT_MISS = 1,
SBI_PMU_HW_CACHE_RESULT_MAX, /* non-ABI */
};
(NOTE: Same as <linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x2 then it is HARDWARE RAW event. For
HARDWARE
RAW event, both event_idx.info and event_idx.code are platform

dependent.

If event_idx.type == 0xf then it is SOFTWARE event. For
SOFTWARE
event, event_idx.info is SBI implementation specific and
event_idx.code can be one of the following:
enum sbi_pmu_sw_id {
SBI_PMU_SW_MISALIGNED_LOAD = 0,
SBI_PMU_SW_MISALIGNED_STORE = 1,
SBI_PMU_SW_ILLEGAL_INSN = 2,
SBI_PMU_SW_LOCAL_SET_TIMER = 3,
SBI_PMU_SW_LOCAL_IPI = 4,
SBI_PMU_SW_LOCAL_FENCE_I = 5,
SBI_PMU_SW_LOCAL_SFENCE_VMA = 6,
SBI_PMU_SW_LOCAL_SFENCE_VMA_ASID = 7,
SBI_PMU_SW_LOCAL_HFENCE_GVMA = 8,
SBI_PMU_SW_LOCAL_HFENCE_GVMA_VMID = 9,
SBI_PMU_SW_LOCAL_HFENCE_VVMA = 10,
SBI_PMU_SW_LOCAL_HFENCE_VVMA_ASID = 11,
SBI_PMU_SW_MAX, /* non-ABI */
};

In future, more events can be defined without breaking ABI
compatibility of SBI calls.

Using definition of counter_idx and event_idx, we can
potentially have
the following SBI calls:

1. SBI_PMU_NUM_COUNTERS
This call will return the number of COUNTERs

Is it for the SW counters and we get the number of HW counters by
DT?
Or does it return the number of HW and SW counters both? If so,
how to
distinguish the number of HW and SW?

This call returns total number of counters (i.e. HARDWARE and
SOFTWARE both)

The other question is that the number of SW counters is defined
by the core
of OpenSBI or platform-dependent?

Number of SW counters are defined by SBI implementation (i.e.
OpenSBI,
Xvisor RISC-V, and KVM RISC-V). Most likely SW counters will not
include
any platform-dependent SW counters although this is design choice
of
SBI implementation.

OK, I got it. It would be enough, thanks.

2. SBI_PMU_COUNTER_DESCRIBE
This call takes two parameters: 1) counter_idx 2) physical
address
It will write the description of SBI PMU counter at
specified physical
address. The details of the SBI PMU counter written at
specified
physical address are as follows:
1. Name (64 bytes)
2. CSR_Number (2 bytes)
(CSR_Number <= 0xfff means counter is a RISC-V CSR)
(CSR_Number > 0xfff means counter is a SBI implementation
counter)
(E.g. CSR_Number == 0xC02 imply HPMCOUNTER2 CSR)
3. CSR_Width (2 bytes)
(Number of CSR bits implemented in HW)
4. Event_Count (2 bytes)
(Number of events in Event_List array)
5. Event_List (2 * Event_Count bytes)
(This is an array of 16bit values where each 16bit value
is the
supported event_idx.type and event_idx.code combination)

What is the size we should allocate for this physical address? In
my
understanding, we need to allocate the pages in s-mode first,
then pass the
address of the pages to the second parameter, but we don't know
the
event_counter before we allocate the space for it, so it might
across the
boundary if event_count is very big.

Theoretically, Event_Count cannot be more than 65535.

I think we should have SBI_PMU_NUM_EVENTS calls which will
return number of events supported by given counter_idx. This will
help S-mode software to determine amount of memory to allocate
for SBI_PMU_COUNTER_DESCRIBE.

Sounds good to me.

3. SBI_PMU_COUNTER_SET_PHYS_ADDR
This call takes two parameters: 1) counter_idx 2) physical
address
It will set the physical address of memory location where
the SBI
implementation will write the 64bit SOFTWARE counter. This
SBI call
is only for counters not mapped to any CSR (i.e. only for
counters
with CSR_Number > 0xfff).
4. SBI_PMU_COUNTER_START
This call takes two parameters: 1) counter_idx 2) event_idx
It will inform SBI implementation to configure and
start/enable
specified counter on the calling HART to monitor specific
event.
This SBI call will fail for counters which are not present
and
specified event_idx is not supported by the counter.
5. SBI_PMU_COUNTER_STOP
This call takes one parameter: 1) counter_idx
It will inform SBI implementation to stop/disable specified
counters
on the calling HART. This SBI call will fail for counters
which are
not present.

From above, the RISC-V PMU driver will use most of the SBI
calls at
boot time. Only SBI_PMU_COUNTER_START to be used once before
using

the counter.

The reading of counter is by reading CSR (for CSR_Number <
0xfff) OR
by reading memory location (for CSR_Offset >= 0xfff). The
counter
overflow handling will have to be done in software by Linux
kernel.

Using the SBI PMU extension, the M-mode runtime firmware (or
Hypervisors) can provide a standardized view of
HARDWARE/SOFTWARE
counters and events to S-mode (or VS-mode) software.

The M-mode runtime firmware (OpenSBI) will need to know
following
platform dependent information:
1. Possible event_idx values allowed (or supported) by a
HARDWARE
counter (i.e. HPMCOUNTER)
2. Mapping of event_idx for HARDWARE event to HPMEVENT CSR
value 3.
Mapping of event_idx for HARDWARE CACHE event to HPMEVENT CSR

value 4.

Mapping of event_idx for HARDWARE RAW event to HPMEVENT CSR
value

5.

Additional platform-specific progamming required by any
event_idx

All platform dependent information mentioned above, can be
obtained by
M-mode runtime firmware (OpenSBI) from platform specific code.
The
DT/ACPI can also be used to described 1), 2), 3), and 4)
mentioned
above but 5) will always require platform specific code.

I would update the next version of DT file to describe the points
from
1) to 4). Thanks.
As you mentioned before, it would be hard to sync the platform
specific code
with the DT of real use.
I prefer to get 1), 2), 3) and 4) from DT first on each platform,
and use
platform specific code if DT is unavailable. (generic platform
use DT certainly),
then we could maximally reduce the inconsistency.

It should platform's choice on how it wants to describe HARDWARE
events and HARDWARE counters. The OpenSBI generic platform will
tend to use DT based parsing of HARDWARE events and HARDWARE
counters but other platform can do things differently.

The S-mode software (i.e. Linux) should not get HARDWARE events
and HARDWARE counters from DT because DT describes HARDWARE
and DT will not include SOFTWARE events and SOFTWARE counters.
Also, SOFTWARE events and SOFTWARE counters will change for given
platform as OpenSBI continues to improve so it will be hard to keep
the DT in sync.

The best thing for S-mode software would be to depend on one
method of discovering all counters and supported events which
is the SBI_PMU_COUNTER_DESCRIBE call. In other words, no need
for platform driver for Linux RISC-V PMU driver instead depend only
on sbi_probe_extension() to detect SBI PMU extension.

OK, make sense.

Regards,
Anup

Hi Atish,

-----Original Message-----
From: Atish Patra <Atish.Patra@...>
Sent: 08 July 2020 00:44
To: zong.li@...; Anup Patel <Anup.Patel@...>
Cc: andrew@...; tech-unixplatformspec@...;
gfavor@...
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU
Extension

On Tue, 2020-07-07 at 11:05 +0800, Zong Li wrote:

On Tue, Jul 7, 2020 at 12:21 AM Anup Patel <anup.patel@...>
wrote:

-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 06 July 2020 13:59
To: Anup Patel <Anup.Patel@...>
Cc: tech-unixplatformspec@...; Andrew Waterman
<andrew@...>; Greg Favor <gfavor@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2:
SBI PMU
Extension

On Mon, Jul 6, 2020 at 12:35 AM Anup Patel <
anup.patel@...>
wrote:

Hi All,

We don't have a dedicated RISC-V PMU extension but we do
have

HARDWARE

performance counters such as CYCLE CSR, INSTRET CSR, and
HPMCOUNTER CSRs. A RISC-V implementation can support

monitoring

various HARDWARE events using limited number of HPMCOUNTER

CSRs.

In addition to HARDWARE performance counters, a SBI
implementation (e.g. OpenSBI, Xvisor, KVM, etc) can provide
SOFTWARE counters for events such as number of RFENCEs,
number
of IPIs, number of misaligned load/store instructions,
number of
illegal instructions, etc.

We propose SBI PMU extension which tries to cover CYCLE
CSR,
INSTRET CSR, HPMCOUNTER CSRs and SOFTWARE counters provided

by

SBI

implementation.

To define SBI PMU extension, we first define counter_idx
which
is a logical number assigned to a counter and event_idx
which is
an encoded

Is there more detail about counter_idx? I was wondering that
1.
What is the
ordering of logical numbers for HW and SW counters? I think
that
the logical numbers are assigned by OpenSBI.

Like mentioned here, counter_idx is a logical index for all
available counters (i.e. HARDWARE and SOFTWARE). The SBI
implementation (i.e. OpenSBI, Xvisor RISC-V, or KVM RISC-V) can
assign counter_idx to HARDWARE and SOFTWARE counters in any
order it
likes.

2. How to know the logical number of counter_idx of each HW
and SW
counters from s-mode? I guess that we need to know the
logical
numbers of all counters before we invoke a SBI call.

The SBI_PMU_COUNTER_DESCRIBE call mentioned below will tell us
whether given counter_idx maps to a HARDWARE counter or
SOFTWARE
counter based on CSR_Number info returned by
SBI_PMU_COUNTER_DESCRIBE call.

OK, I assume the logical number of counte_idx is sequential and
started from zero here, so during initialization of s-mode
software,
we could get the total number 'N' of counters by

SBI_PMU_NUM_COUNTERS

first, then loop the N times to identify capability of each
counter.
Does it align your ideas?

That's what my understanding as well. Assigning continous
counter_idx may
put a restriction on M-mode implementation. How about assigning
some

There is not restriction on M-mode runtime firmware in assigning
counter_idx
to various HARDWARE and SOFTWARE counters. In fact, counter_idx being
logical index helps M-mode software to implement a registration
mechanism.

ranges for software vs hardware counters. May be split the hardware
into
different ranges as well based on event_idx.type.

I had done that initially but it will only increase SBI calls because
we will
need separate SBI calls to determine number of HARDWARE and SOFTWARE
counters.

Also, this makes things difficult if a RISC-V implementation has non-
standard
implementation specific CSR as HARDWARE counter.

This also allows supervisor to know what type of the counter it is
looking at
without parsing the data written by the describe call.

There is no real advantage of knowing type of counter from
counter_idx
over CSR_Number returned by SBI_PMU_COUNTER_DESCRIBE call because
the SBI_PMU_COUNTER_DESCRIBE call will be called only at boot-time
once for each counter and S-mode software can mark counters as
HARDWARE/SOFTWARE at boot-time based on CSR_Number returned
by SBI_PMU_COUNTER_DESCRIBE call.

number representing the HARDWARE/SOFTWARE event to be

monitored.

The SBI PMU event_idx is a XLEN bits wide number encoded as
follows:
event_idx[XLEN-1:16] = info
event_idx[15:12] = type
event_idx[11:0] = code

If event_idx.type == 0x0 then it is HARDWARE event. For
HARDWARE
event, the event_idx.info is optional and can be passed
zero
whereas the event_idx.code can be one of the following
values:
enum sbi_pmu_hw_id {
SBI_PMU_HW_CPU_CYCLES = 0,
SBI_PMU_HW_INSTRUCTIONS = 1,
SBI_PMU_HW_CACHE_REFERENCES = 2,
SBI_PMU_HW_CACHE_MISSES = 3,
SBI_PMU_HW_BRANCH_INSTRUCTIONS = 4,
SBI_PMU_HW_BRANCH_MISSES = 5,
SBI_PMU_HW_BUS_CYCLES = 6,
SBI_PMU_HW_STALLED_CYCLES_FRONTEND = 7,
SBI_PMU_HW_STALLED_CYCLES_BACKEND = 8,
SBI_PMU_HW_REF_CPU_CYCLES = 9,
SBI_PMU_HW_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x1 then it is HARDWARE CACHE event.
For

HARDWARE

CACHE event, the event_idx.info is optional and can be
passed
zero whereas the event_idx.code is encoded as follows:
event_idx.code[11:3] = cache_id
event_idx.code[2:1] = op_id
event_idx.code[0:0] = result_id
enum sbi_pmu_hw_cache_id {
SBI_PMU_HW_CACHE_L1D = 0,
SBI_PMU_HW_CACHE_L1I = 1,
SBI_PMU_HW_CACHE_LL = 2,
SBI_PMU_HW_CACHE_DTLB = 3,
SBI_PMU_HW_CACHE_ITLB = 4,
SBI_PMU_HW_CACHE_BPU = 5,
SBI_PMU_HW_CACHE_NODE = 6,
SBI_PMU_HW_CACHE_MAX, /* non-ABI */ }; enum

sbi_pmu_hw_cache_op_id

{
SBI_PMU_HW_CACHE_OP_READ = 0,
SBI_PMU_HW_CACHE_OP_WRITE = 1,
SBI_PMU_HW_CACHE_OP_PREFETCH = 2,
SBI_PMU_HW_CACHE_OP_MAX, /* non-ABI */
};
enum sbi_pmu_hw_cache_op_result_id {
SBI_PMU_HW_CACHE_RESULT_ACCESS = 0,
SBI_PMU_HW_CACHE_RESULT_MISS = 1,
SBI_PMU_HW_CACHE_RESULT_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x2 then it is HARDWARE RAW event. For
HARDWARE RAW event, both event_idx.info and event_idx.code
are
platform

dependent.

If event_idx.type == 0xf then it is SOFTWARE event. For
SOFTWARE
event, event_idx.info is SBI implementation specific and
event_idx.code can be one of the following:
enum sbi_pmu_sw_id {
SBI_PMU_SW_MISALIGNED_LOAD = 0,
SBI_PMU_SW_MISALIGNED_STORE = 1,
SBI_PMU_SW_ILLEGAL_INSN = 2,
SBI_PMU_SW_LOCAL_SET_TIMER = 3,
SBI_PMU_SW_LOCAL_IPI = 4,
SBI_PMU_SW_LOCAL_FENCE_I = 5,
SBI_PMU_SW_LOCAL_SFENCE_VMA = 6,
SBI_PMU_SW_LOCAL_SFENCE_VMA_ASID = 7,
SBI_PMU_SW_LOCAL_HFENCE_GVMA = 8,
SBI_PMU_SW_LOCAL_HFENCE_GVMA_VMID = 9,
SBI_PMU_SW_LOCAL_HFENCE_VVMA = 10,
SBI_PMU_SW_LOCAL_HFENCE_VVMA_ASID = 11,
SBI_PMU_SW_MAX, /* non-ABI */
};

In future, more events can be defined without breaking ABI
compatibility of SBI calls.

Using definition of counter_idx and event_idx, we can
potentially have the following SBI calls:

1. SBI_PMU_NUM_COUNTERS
This call will return the number of COUNTERs

Is it for the SW counters and we get the number of HW
counters by
DT?
Or does it return the number of HW and SW counters both? If
so,
how to distinguish the number of HW and SW?

This call returns total number of counters (i.e. HARDWARE and
SOFTWARE both)

The other question is that the number of SW counters is
defined by
the core of OpenSBI or platform-dependent?

Number of SW counters are defined by SBI implementation (i.e.
OpenSBI,
Xvisor RISC-V, and KVM RISC-V). Most likely SW counters will
not
include any platform-dependent SW counters although this is
design
choice of SBI implementation.

OK, I got it. It would be enough, thanks.

2. SBI_PMU_COUNTER_DESCRIBE
This call takes two parameters: 1) counter_idx 2)
physical
address
It will write the description of SBI PMU counter at
specified
physical
address. The details of the SBI PMU counter written at
specified
physical address are as follows:
1. Name (64 bytes)
2. CSR_Number (2 bytes)
(CSR_Number <= 0xfff means counter is a RISC-V CSR)
(CSR_Number > 0xfff means counter is a SBI
implementation
counter)
(E.g. CSR_Number == 0xC02 imply HPMCOUNTER2 CSR)
3. CSR_Width (2 bytes)
(Number of CSR bits implemented in HW)
4. Event_Count (2 bytes)
(Number of events in Event_List array)
5. Event_List (2 * Event_Count bytes)
(This is an array of 16bit values where each 16bit
value
is the
supported event_idx.type and event_idx.code
combination)

What is the size we should allocate for this physical
address? In
my understanding, we need to allocate the pages in s-mode
first,
then pass the address of the pages to the second parameter,
but we
don't know the event_counter before we allocate the space for
it,
so it might across the boundary if event_count is very big.

Theoretically, Event_Count cannot be more than 65535.

I think we should have SBI_PMU_NUM_EVENTS calls which will
return
number of events supported by given counter_idx. This will help
S-mode software to determine amount of memory to allocate for
SBI_PMU_COUNTER_DESCRIBE.

Sounds good to me.

3. SBI_PMU_COUNTER_SET_PHYS_ADDR
This call takes two parameters: 1) counter_idx 2)
physical
address
It will set the physical address of memory location
where the
SBI
implementation will write the 64bit SOFTWARE counter.
This
SBI call
is only for counters not mapped to any CSR (i.e. only
for
counters
with CSR_Number > 0xfff).
4. SBI_PMU_COUNTER_START
This call takes two parameters: 1) counter_idx 2)
event_idx
It will inform SBI implementation to configure and
start/enable
specified counter on the calling HART to monitor
specific
event.
This SBI call will fail for counters which are not
present
and
specified event_idx is not supported by the counter.
5. SBI_PMU_COUNTER_STOP
This call takes one parameter: 1) counter_idx
It will inform SBI implementation to stop/disable
specified
counters
on the calling HART. This SBI call will fail for
counters
which are
not present.

From above, the RISC-V PMU driver will use most of the SBI
calls
at boot time. Only SBI_PMU_COUNTER_START to be used once

before

using

the counter.

The reading of counter is by reading CSR (for CSR_Number <
0xfff) OR
by reading memory location (for CSR_Offset >= 0xfff). The
counter overflow handling will have to be done in software
by
Linux kernel.

Using the SBI PMU extension, the M-mode runtime firmware
(or
Hypervisors) can provide a standardized view of
HARDWARE/SOFTWARE counters and events to S-mode (or VS-

mode)

software.

The M-mode runtime firmware (OpenSBI) will need to know
following platform dependent information:
1. Possible event_idx values allowed (or supported) by a
HARDWARE
counter (i.e. HPMCOUNTER)
2. Mapping of event_idx for HARDWARE event to HPMEVENT CSR

value

3.
Mapping of event_idx for HARDWARE CACHE event to HPMEVENT

CSR

value 4.

Mapping of event_idx for HARDWARE RAW event to HPMEVENT CSR
value

5.

Additional platform-specific progamming required by any
event_idx

All platform dependent information mentioned above, can be
obtained by M-mode runtime firmware (OpenSBI) from platform
specific code.
The
DT/ACPI can also be used to described 1), 2), 3), and 4)
mentioned above but 5) will always require platform
specific
code.

I would update the next version of DT file to describe the
points
from
1) to 4). Thanks.
As you mentioned before, it would be hard to sync the
platform
specific code with the DT of real use.
I prefer to get 1), 2), 3) and 4) from DT first on each
platform,
and use platform specific code if DT is unavailable. (generic
platform use DT certainly), then we could maximally reduce
the
inconsistency.

It should platform's choice on how it wants to describe
HARDWARE
events and HARDWARE counters. The OpenSBI generic platform will
tend
to use DT based parsing of HARDWARE events and HARDWARE
counters

but

other platform can do things differently.

The S-mode software (i.e. Linux) should not get HARDWARE events
and
HARDWARE counters from DT because DT describes HARDWARE and DT

will

not include SOFTWARE events and SOFTWARE counters.
Also, SOFTWARE events and SOFTWARE counters will change for
given
platform as OpenSBI continues to improve so it will be hard to
keep
the DT in sync.

The best thing for S-mode software would be to depend on one
method
of discovering all counters and supported events which is the
SBI_PMU_COUNTER_DESCRIBE call. In other words, no need for
platform
driver for Linux RISC-V PMU driver instead depend only on
sbi_probe_extension() to detect SBI PMU extension.

OK, make sense.

Regards,
Anup

--
Regards,
Atish

Regards,
Anup

On Wed, 2020-07-08 at 03:04 +0000, Anup Patel wrote:

Hi Atish,

-----Original Message-----
From: Atish Patra <Atish.Patra@...>
Sent: 08 July 2020 00:44
To: zong.li@...; Anup Patel <Anup.Patel@...>
Cc: andrew@...; tech-unixplatformspec@...;
gfavor@...
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU
Extension

On Tue, 2020-07-07 at 11:05 +0800, Zong Li wrote:

On Tue, Jul 7, 2020 at 12:21 AM Anup Patel <anup.patel@...>
wrote:

-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 06 July 2020 13:59
To: Anup Patel <Anup.Patel@...>
Cc: tech-unixplatformspec@...; Andrew Waterman
<andrew@...>; Greg Favor <gfavor@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2:
SBI PMU
Extension

On Mon, Jul 6, 2020 at 12:35 AM Anup Patel <
anup.patel@...>
wrote:

Hi All,

We don't have a dedicated RISC-V PMU extension but we do
have

HARDWARE

performance counters such as CYCLE CSR, INSTRET CSR, and
HPMCOUNTER CSRs. A RISC-V implementation can support

monitoring

various HARDWARE events using limited number of HPMCOUNTER

CSRs.

In addition to HARDWARE performance counters, a SBI
implementation (e.g. OpenSBI, Xvisor, KVM, etc) can provide
SOFTWARE counters for events such as number of RFENCEs,
number
of IPIs, number of misaligned load/store instructions,
number of
illegal instructions, etc.

We propose SBI PMU extension which tries to cover CYCLE
CSR,
INSTRET CSR, HPMCOUNTER CSRs and SOFTWARE counters provided

by

SBI

implementation.

To define SBI PMU extension, we first define counter_idx
which
is a logical number assigned to a counter and event_idx
which is
an encoded

Is there more detail about counter_idx? I was wondering that
1.
What is the
ordering of logical numbers for HW and SW counters? I think
that
the logical numbers are assigned by OpenSBI.

Like mentioned here, counter_idx is a logical index for all
available counters (i.e. HARDWARE and SOFTWARE). The SBI
implementation (i.e. OpenSBI, Xvisor RISC-V, or KVM RISC-V) can
assign counter_idx to HARDWARE and SOFTWARE counters in any
order it
likes.

2. How to know the logical number of counter_idx of each HW
and SW
counters from s-mode? I guess that we need to know the
logical
numbers of all counters before we invoke a SBI call.

The SBI_PMU_COUNTER_DESCRIBE call mentioned below will tell us
whether given counter_idx maps to a HARDWARE counter or
SOFTWARE
counter based on CSR_Number info returned by
SBI_PMU_COUNTER_DESCRIBE call.

OK, I assume the logical number of counte_idx is sequential and
started from zero here, so during initialization of s-mode
software,
we could get the total number 'N' of counters by

SBI_PMU_NUM_COUNTERS

first, then loop the N times to identify capability of each
counter.
Does it align your ideas?

That's what my understanding as well. Assigning continous
counter_idx may
put a restriction on M-mode implementation. How about assigning
some

There is not restriction on M-mode runtime firmware in assigning
counter_idx
to various HARDWARE and SOFTWARE counters. In fact, counter_idx being
logical index helps M-mode software to implement a registration
mechanism.

ranges for software vs hardware counters. May be split the hardware
into
different ranges as well based on event_idx.type.

I had done that initially but it will only increase SBI calls because
we will
need separate SBI calls to determine number of HARDWARE and SOFTWARE
counters.

I was suggesting to have fixed ranges for both event types.

Also, this makes things difficult if a RISC-V implementation has non-
standard
implementation specific CSR as HARDWARE counter.

But I agree that it gets tricky with non-standard implementation
specific counters.

This also allows supervisor to know what type of the counter it is
looking at
without parsing the data written by the describe call.

There is no real advantage of knowing type of counter from
counter_idx
over CSR_Number returned by SBI_PMU_COUNTER_DESCRIBE call because
the SBI_PMU_COUNTER_DESCRIBE call will be called only at boot-time
once for each counter and S-mode software can mark counters as
HARDWARE/SOFTWARE at boot-time based on CSR_Number returned
by SBI_PMU_COUNTER_DESCRIBE call.

My concern is that it may increase the booting time.
For example, my current x86 desktop has 1679 counters. If a RISC-V
desktop has those many counters (hopefully one day!! :)), there will
be ~2k SBI calls and memory reads just to get perf working. I guess
there will be even more counters in servers.

Moreover, supervisor OS may choose to configure only few basic perf
counter at boot time and defer configuring everything later depending
on the usecase. Having a continous logical counter_idx may prevent
those kind of optimizations. Correct ?

number representing the HARDWARE/SOFTWARE event to be

monitored.

The SBI PMU event_idx is a XLEN bits wide number encoded as
follows:
event_idx[XLEN-1:16] = info
event_idx[15:12] = type
event_idx[11:0] = code

If event_idx.type == 0x0 then it is HARDWARE event. For
HARDWARE
event, the event_idx.info is optional and can be passed
zero
whereas the event_idx.code can be one of the following
values:
enum sbi_pmu_hw_id {
SBI_PMU_HW_CPU_CYCLES = 0,
SBI_PMU_HW_INSTRUCTIONS = 1,
SBI_PMU_HW_CACHE_REFERENCES = 2,
SBI_PMU_HW_CACHE_MISSES = 3,
SBI_PMU_HW_BRANCH_INSTRUCTIONS = 4,
SBI_PMU_HW_BRANCH_MISSES = 5,
SBI_PMU_HW_BUS_CYCLES = 6,
SBI_PMU_HW_STALLED_CYCLES_FRONTEND = 7,
SBI_PMU_HW_STALLED_CYCLES_BACKEND = 8,
SBI_PMU_HW_REF_CPU_CYCLES = 9,
SBI_PMU_HW_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x1 then it is HARDWARE CACHE event.
For

HARDWARE

CACHE event, the event_idx.info is optional and can be
passed
zero whereas the event_idx.code is encoded as follows:
event_idx.code[11:3] = cache_id
event_idx.code[2:1] = op_id
event_idx.code[0:0] = result_id
enum sbi_pmu_hw_cache_id {
SBI_PMU_HW_CACHE_L1D = 0,
SBI_PMU_HW_CACHE_L1I = 1,
SBI_PMU_HW_CACHE_LL = 2,
SBI_PMU_HW_CACHE_DTLB = 3,
SBI_PMU_HW_CACHE_ITLB = 4,
SBI_PMU_HW_CACHE_BPU = 5,
SBI_PMU_HW_CACHE_NODE = 6,
SBI_PMU_HW_CACHE_MAX, /* non-ABI */ }; enum

sbi_pmu_hw_cache_op_id

{
SBI_PMU_HW_CACHE_OP_READ = 0,
SBI_PMU_HW_CACHE_OP_WRITE = 1,
SBI_PMU_HW_CACHE_OP_PREFETCH = 2,
SBI_PMU_HW_CACHE_OP_MAX, /* non-ABI */
};
enum sbi_pmu_hw_cache_op_result_id {
SBI_PMU_HW_CACHE_RESULT_ACCESS = 0,
SBI_PMU_HW_CACHE_RESULT_MISS = 1,
SBI_PMU_HW_CACHE_RESULT_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x2 then it is HARDWARE RAW event. For
HARDWARE RAW event, both event_idx.info and event_idx.code
are
platform

dependent.

If event_idx.type == 0xf then it is SOFTWARE event. For
SOFTWARE
event, event_idx.info is SBI implementation specific and
event_idx.code can be one of the following:
enum sbi_pmu_sw_id {
SBI_PMU_SW_MISALIGNED_LOAD = 0,
SBI_PMU_SW_MISALIGNED_STORE = 1,
SBI_PMU_SW_ILLEGAL_INSN = 2,
SBI_PMU_SW_LOCAL_SET_TIMER = 3,
SBI_PMU_SW_LOCAL_IPI = 4,
SBI_PMU_SW_LOCAL_FENCE_I = 5,
SBI_PMU_SW_LOCAL_SFENCE_VMA = 6,
SBI_PMU_SW_LOCAL_SFENCE_VMA_ASID = 7,
SBI_PMU_SW_LOCAL_HFENCE_GVMA = 8,
SBI_PMU_SW_LOCAL_HFENCE_GVMA_VMID = 9,
SBI_PMU_SW_LOCAL_HFENCE_VVMA = 10,
SBI_PMU_SW_LOCAL_HFENCE_VVMA_ASID = 11,
SBI_PMU_SW_MAX, /* non-ABI */
};

In future, more events can be defined without breaking ABI
compatibility of SBI calls.

Using definition of counter_idx and event_idx, we can
potentially have the following SBI calls:

1. SBI_PMU_NUM_COUNTERS
This call will return the number of COUNTERs

Is it for the SW counters and we get the number of HW
counters by
DT?
Or does it return the number of HW and SW counters both? If
so,
how to distinguish the number of HW and SW?

This call returns total number of counters (i.e. HARDWARE and
SOFTWARE both)

The other question is that the number of SW counters is
defined by
the core of OpenSBI or platform-dependent?

Number of SW counters are defined by SBI implementation (i.e.
OpenSBI,
Xvisor RISC-V, and KVM RISC-V). Most likely SW counters will
not
include any platform-dependent SW counters although this is
design
choice of SBI implementation.

OK, I got it. It would be enough, thanks.

2. SBI_PMU_COUNTER_DESCRIBE
This call takes two parameters: 1) counter_idx 2)
physical
address
It will write the description of SBI PMU counter at
specified
physical
address. The details of the SBI PMU counter written at
specified
physical address are as follows:
1. Name (64 bytes)
2. CSR_Number (2 bytes)
(CSR_Number <= 0xfff means counter is a RISC-V CSR)
(CSR_Number > 0xfff means counter is a SBI
implementation
counter)
(E.g. CSR_Number == 0xC02 imply HPMCOUNTER2 CSR)
3. CSR_Width (2 bytes)
(Number of CSR bits implemented in HW)
4. Event_Count (2 bytes)
(Number of events in Event_List array)
5. Event_List (2 * Event_Count bytes)
(This is an array of 16bit values where each 16bit
value
is the
supported event_idx.type and event_idx.code
combination)

What is the size we should allocate for this physical
address? In
my understanding, we need to allocate the pages in s-mode
first,
then pass the address of the pages to the second parameter,
but we
don't know the event_counter before we allocate the space for
it,
so it might across the boundary if event_count is very big.

Theoretically, Event_Count cannot be more than 65535.

I think we should have SBI_PMU_NUM_EVENTS calls which will
return
number of events supported by given counter_idx. This will help
S-mode software to determine amount of memory to allocate for
SBI_PMU_COUNTER_DESCRIBE.

Sounds good to me.

3. SBI_PMU_COUNTER_SET_PHYS_ADDR
This call takes two parameters: 1) counter_idx 2)
physical
address
It will set the physical address of memory location
where the
SBI
implementation will write the 64bit SOFTWARE counter.
This
SBI call
is only for counters not mapped to any CSR (i.e. only
for
counters
with CSR_Number > 0xfff).
4. SBI_PMU_COUNTER_START
This call takes two parameters: 1) counter_idx 2)
event_idx
It will inform SBI implementation to configure and
start/enable
specified counter on the calling HART to monitor
specific
event.
This SBI call will fail for counters which are not
present
and
specified event_idx is not supported by the counter.
5. SBI_PMU_COUNTER_STOP
This call takes one parameter: 1) counter_idx
It will inform SBI implementation to stop/disable
specified
counters
on the calling HART. This SBI call will fail for
counters
which are
not present.

From above, the RISC-V PMU driver will use most of the SBI
calls
at boot time. Only SBI_PMU_COUNTER_START to be used once

before

using

the counter.

The reading of counter is by reading CSR (for CSR_Number <
0xfff) OR
by reading memory location (for CSR_Offset >= 0xfff). The
counter overflow handling will have to be done in software
by
Linux kernel.

Using the SBI PMU extension, the M-mode runtime firmware
(or
Hypervisors) can provide a standardized view of
HARDWARE/SOFTWARE counters and events to S-mode (or VS-

mode)

software.

The M-mode runtime firmware (OpenSBI) will need to know
following platform dependent information:
1. Possible event_idx values allowed (or supported) by a
HARDWARE
counter (i.e. HPMCOUNTER)
2. Mapping of event_idx for HARDWARE event to HPMEVENT CSR

value

3.
Mapping of event_idx for HARDWARE CACHE event to HPMEVENT

CSR

value 4.

Mapping of event_idx for HARDWARE RAW event to HPMEVENT CSR
value

5.

Additional platform-specific progamming required by any
event_idx

All platform dependent information mentioned above, can be
obtained by M-mode runtime firmware (OpenSBI) from platform
specific code.
The
DT/ACPI can also be used to described 1), 2), 3), and 4)
mentioned above but 5) will always require platform
specific
code.

I would update the next version of DT file to describe the
points
from
1) to 4). Thanks.
As you mentioned before, it would be hard to sync the
platform
specific code with the DT of real use.
I prefer to get 1), 2), 3) and 4) from DT first on each
platform,
and use platform specific code if DT is unavailable. (generic
platform use DT certainly), then we could maximally reduce
the
inconsistency.

It should platform's choice on how it wants to describe
HARDWARE
events and HARDWARE counters. The OpenSBI generic platform will
tend
to use DT based parsing of HARDWARE events and HARDWARE
counters

but

other platform can do things differently.

The S-mode software (i.e. Linux) should not get HARDWARE events
and
HARDWARE counters from DT because DT describes HARDWARE and DT

will

not include SOFTWARE events and SOFTWARE counters.
Also, SOFTWARE events and SOFTWARE counters will change for
given
platform as OpenSBI continues to improve so it will be hard to
keep
the DT in sync.

The best thing for S-mode software would be to depend on one
method
of discovering all counters and supported events which is the
SBI_PMU_COUNTER_DESCRIBE call. In other words, no need for
platform
driver for Linux RISC-V PMU driver instead depend only on
sbi_probe_extension() to detect SBI PMU extension.

OK, make sense.

Regards,
Anup

--
Regards,
Atish

Regards,
Anup

--
Regards,
Atish

-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 08 July 2020 12:21
To: Atish Patra <Atish.Patra@...>
Cc: Anup Patel <Anup.Patel@...>; andrew@...; tech-
unixplatformspec@...; gfavor@...
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU
Extension

On Wed, Jul 8, 2020 at 2:17 PM Atish Patra <atish.patra@...> wrote:

On Wed, 2020-07-08 at 03:04 +0000, Anup Patel wrote:

Hi Atish,

-----Original Message-----
From: Atish Patra <Atish.Patra@...>
Sent: 08 July 2020 00:44
To: zong.li@...; Anup Patel <Anup.Patel@...>
Cc: andrew@...; tech-unixplatformspec@...;
gfavor@...
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU
Extension

On Tue, 2020-07-07 at 11:05 +0800, Zong Li wrote:

On Tue, Jul 7, 2020 at 12:21 AM Anup Patel <anup.patel@...>
wrote:

-----Original Message-----
From: Zong Li <zong.li@...>
Sent: 06 July 2020 13:59
To: Anup Patel <Anup.Patel@...>
Cc: tech-unixplatformspec@...; Andrew Waterman
<andrew@...>; Greg Favor <gfavor@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2:
SBI PMU
Extension

On Mon, Jul 6, 2020 at 12:35 AM Anup Patel <
anup.patel@...>
wrote:

Hi All,

We don't have a dedicated RISC-V PMU extension but we do
have

HARDWARE

performance counters such as CYCLE CSR, INSTRET CSR, and
HPMCOUNTER CSRs. A RISC-V implementation can support

monitoring

various HARDWARE events using limited number of

HPMCOUNTER

CSRs.

In addition to HARDWARE performance counters, a SBI
implementation (e.g. OpenSBI, Xvisor, KVM, etc) can
provide SOFTWARE counters for events such as number of
RFENCEs, number of IPIs, number of misaligned load/store
instructions, number of illegal instructions, etc.

We propose SBI PMU extension which tries to cover CYCLE
CSR, INSTRET CSR, HPMCOUNTER CSRs and SOFTWARE counters
provided

by

SBI

implementation.

To define SBI PMU extension, we first define counter_idx
which is a logical number assigned to a counter and
event_idx which is an encoded

Is there more detail about counter_idx? I was wondering that
1.
What is the
ordering of logical numbers for HW and SW counters? I think
that the logical numbers are assigned by OpenSBI.

Like mentioned here, counter_idx is a logical index for all
available counters (i.e. HARDWARE and SOFTWARE). The SBI
implementation (i.e. OpenSBI, Xvisor RISC-V, or KVM RISC-V)
can assign counter_idx to HARDWARE and SOFTWARE counters in
any order it likes.

2. How to know the logical number of counter_idx of each HW
and SW counters from s-mode? I guess that we need to know
the logical numbers of all counters before we invoke a SBI
call.

The SBI_PMU_COUNTER_DESCRIBE call mentioned below will tell us
whether given counter_idx maps to a HARDWARE counter or
SOFTWARE counter based on CSR_Number info returned by
SBI_PMU_COUNTER_DESCRIBE call.

OK, I assume the logical number of counte_idx is sequential and
started from zero here, so during initialization of s-mode
software, we could get the total number 'N' of counters by

SBI_PMU_NUM_COUNTERS

first, then loop the N times to identify capability of each
counter.
Does it align your ideas?

That's what my understanding as well. Assigning continous
counter_idx may put a restriction on M-mode implementation. How
about assigning some

There is not restriction on M-mode runtime firmware in assigning
counter_idx to various HARDWARE and SOFTWARE counters. In fact,
counter_idx being logical index helps M-mode software to implement a
registration mechanism.

ranges for software vs hardware counters. May be split the
hardware into different ranges as well based on event_idx.type.

I had done that initially but it will only increase SBI calls
because we will need separate SBI calls to determine number of
HARDWARE and SOFTWARE counters.

I was suggesting to have fixed ranges for both event types.

Also, this makes things difficult if a RISC-V implementation has non-
standard
implementation specific CSR as HARDWARE counter.

But I agree that it gets tricky with non-standard implementation
specific counters.

This also allows supervisor to know what type of the counter it is
looking at
without parsing the data written by the describe call.

There is no real advantage of knowing type of counter from
counter_idx
over CSR_Number returned by SBI_PMU_COUNTER_DESCRIBE call

because

the SBI_PMU_COUNTER_DESCRIBE call will be called only at boot-time
once for each counter and S-mode software can mark counters as
HARDWARE/SOFTWARE at boot-time based on CSR_Number returned
by SBI_PMU_COUNTER_DESCRIBE call.

My concern is that it may increase the booting time.
For example, my current x86 desktop has 1679 counters. If a RISC-V
desktop has those many counters (hopefully one day!! :)), there will
be ~2k SBI calls and memory reads just to get perf working. I guess
there will be even more counters in servers.

Moreover, supervisor OS may choose to configure only few basic perf
counter at boot time and defer configuring everything later depending
on the usecase. Having a continous logical counter_idx may prevent
those kind of optimizations. Correct ?

Based on the optimization as you mentioned, it is good to me if we have SBI
call to get the number of HW and SW counters respectively. If s-mode OS
can know the separating numbers, then s-mode OS can lazy assign and query
counters no matter if the counter_idx is continuous or not. If
counter_idx is started
for HW counters, the start countex_idx of the SW counter is the number of
HW
counters.

Like mentioned in previous reply, any optimization possible using fixed
ranges for counter_idx can also be done using logical counter_idx.

The biggest problem with fixed ranges for counter_idx is that it will be
difficult describe HARDWARE counters which map to implementation
specific CSR.

I would suggest that SBI_PMU_NUM_COUNTER can take a parameter to
return
the total number of all counters, the number of SW counters only and
the number of
HW counters only.

This is only required if we go for fixed ranges counter_idx numbering.

Regards,
Anup

number representing the HARDWARE/SOFTWARE event to be

monitored.

The SBI PMU event_idx is a XLEN bits wide number encoded as
follows:
event_idx[XLEN-1:16] = info
event_idx[15:12] = type
event_idx[11:0] = code

If event_idx.type == 0x0 then it is HARDWARE event. For
HARDWARE
event, the event_idx.info is optional and can be passed
zero
whereas the event_idx.code can be one of the following
values:
enum sbi_pmu_hw_id {
SBI_PMU_HW_CPU_CYCLES = 0,
SBI_PMU_HW_INSTRUCTIONS = 1,
SBI_PMU_HW_CACHE_REFERENCES = 2,
SBI_PMU_HW_CACHE_MISSES = 3,
SBI_PMU_HW_BRANCH_INSTRUCTIONS = 4,
SBI_PMU_HW_BRANCH_MISSES = 5,
SBI_PMU_HW_BUS_CYCLES = 6,
SBI_PMU_HW_STALLED_CYCLES_FRONTEND = 7,
SBI_PMU_HW_STALLED_CYCLES_BACKEND = 8,
SBI_PMU_HW_REF_CPU_CYCLES = 9,
SBI_PMU_HW_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x1 then it is HARDWARE CACHE event.
For

HARDWARE

CACHE event, the event_idx.info is optional and can be
passed
zero whereas the event_idx.code is encoded as follows:
event_idx.code[11:3] = cache_id
event_idx.code[2:1] = op_id
event_idx.code[0:0] = result_id
enum sbi_pmu_hw_cache_id {
SBI_PMU_HW_CACHE_L1D = 0,
SBI_PMU_HW_CACHE_L1I = 1,
SBI_PMU_HW_CACHE_LL = 2,
SBI_PMU_HW_CACHE_DTLB = 3,
SBI_PMU_HW_CACHE_ITLB = 4,
SBI_PMU_HW_CACHE_BPU = 5,
SBI_PMU_HW_CACHE_NODE = 6,
SBI_PMU_HW_CACHE_MAX, /* non-ABI */ }; enum

sbi_pmu_hw_cache_op_id

{
SBI_PMU_HW_CACHE_OP_READ = 0,
SBI_PMU_HW_CACHE_OP_WRITE = 1,
SBI_PMU_HW_CACHE_OP_PREFETCH = 2,
SBI_PMU_HW_CACHE_OP_MAX, /* non-ABI */
};
enum sbi_pmu_hw_cache_op_result_id {
SBI_PMU_HW_CACHE_RESULT_ACCESS = 0,
SBI_PMU_HW_CACHE_RESULT_MISS = 1,
SBI_PMU_HW_CACHE_RESULT_MAX, /* non-ABI */
};
(NOTE: Same as
<linux_source>/include/uapi/linux/perf_event.h)

If event_idx.type == 0x2 then it is HARDWARE RAW event. For
HARDWARE RAW event, both event_idx.info and

event_idx.code

are
platform

dependent.

If event_idx.type == 0xf then it is SOFTWARE event. For
SOFTWARE
event, event_idx.info is SBI implementation specific and
event_idx.code can be one of the following:
enum sbi_pmu_sw_id {
SBI_PMU_SW_MISALIGNED_LOAD = 0,
SBI_PMU_SW_MISALIGNED_STORE = 1,
SBI_PMU_SW_ILLEGAL_INSN = 2,
SBI_PMU_SW_LOCAL_SET_TIMER = 3,
SBI_PMU_SW_LOCAL_IPI = 4,
SBI_PMU_SW_LOCAL_FENCE_I = 5,
SBI_PMU_SW_LOCAL_SFENCE_VMA = 6,
SBI_PMU_SW_LOCAL_SFENCE_VMA_ASID = 7,
SBI_PMU_SW_LOCAL_HFENCE_GVMA = 8,
SBI_PMU_SW_LOCAL_HFENCE_GVMA_VMID = 9,
SBI_PMU_SW_LOCAL_HFENCE_VVMA = 10,
SBI_PMU_SW_LOCAL_HFENCE_VVMA_ASID = 11,
SBI_PMU_SW_MAX, /* non-ABI */
};

In future, more events can be defined without breaking ABI
compatibility of SBI calls.

Using definition of counter_idx and event_idx, we can
potentially have the following SBI calls:

1. SBI_PMU_NUM_COUNTERS
This call will return the number of COUNTERs

Is it for the SW counters and we get the number of HW
counters by
DT?
Or does it return the number of HW and SW counters both? If
so,
how to distinguish the number of HW and SW?

This call returns total number of counters (i.e. HARDWARE and
SOFTWARE both)

The other question is that the number of SW counters is
defined by
the core of OpenSBI or platform-dependent?

Number of SW counters are defined by SBI implementation (i.e.
OpenSBI,
Xvisor RISC-V, and KVM RISC-V). Most likely SW counters will
not
include any platform-dependent SW counters although this is
design
choice of SBI implementation.

OK, I got it. It would be enough, thanks.

2. SBI_PMU_COUNTER_DESCRIBE
This call takes two parameters: 1) counter_idx 2)
physical
address
It will write the description of SBI PMU counter at
specified
physical
address. The details of the SBI PMU counter written at
specified
physical address are as follows:
1. Name (64 bytes)
2. CSR_Number (2 bytes)
(CSR_Number <= 0xfff means counter is a RISC-V CSR)
(CSR_Number > 0xfff means counter is a SBI
implementation
counter)
(E.g. CSR_Number == 0xC02 imply HPMCOUNTER2 CSR)
3. CSR_Width (2 bytes)
(Number of CSR bits implemented in HW)
4. Event_Count (2 bytes)
(Number of events in Event_List array)
5. Event_List (2 * Event_Count bytes)
(This is an array of 16bit values where each 16bit
value
is the
supported event_idx.type and event_idx.code
combination)

What is the size we should allocate for this physical
address? In
my understanding, we need to allocate the pages in s-mode
first,
then pass the address of the pages to the second parameter,
but we
don't know the event_counter before we allocate the space for
it,
so it might across the boundary if event_count is very big.

Theoretically, Event_Count cannot be more than 65535.

I think we should have SBI_PMU_NUM_EVENTS calls which will
return
number of events supported by given counter_idx. This will help
S-mode software to determine amount of memory to allocate for
SBI_PMU_COUNTER_DESCRIBE.

Sounds good to me.

3. SBI_PMU_COUNTER_SET_PHYS_ADDR
This call takes two parameters: 1) counter_idx 2)
physical
address
It will set the physical address of memory location
where the
SBI
implementation will write the 64bit SOFTWARE counter.
This
SBI call
is only for counters not mapped to any CSR (i.e. only
for
counters
with CSR_Number > 0xfff).
4. SBI_PMU_COUNTER_START
This call takes two parameters: 1) counter_idx 2)
event_idx
It will inform SBI implementation to configure and
start/enable
specified counter on the calling HART to monitor
specific
event.
This SBI call will fail for counters which are not
present
and
specified event_idx is not supported by the counter.
5. SBI_PMU_COUNTER_STOP
This call takes one parameter: 1) counter_idx
It will inform SBI implementation to stop/disable
specified
counters
on the calling HART. This SBI call will fail for
counters
which are
not present.

From above, the RISC-V PMU driver will use most of the SBI
calls
at boot time. Only SBI_PMU_COUNTER_START to be used once

before

using

the counter.

The reading of counter is by reading CSR (for CSR_Number <
0xfff) OR
by reading memory location (for CSR_Offset >= 0xfff). The
counter overflow handling will have to be done in software
by
Linux kernel.

Using the SBI PMU extension, the M-mode runtime firmware
(or
Hypervisors) can provide a standardized view of
HARDWARE/SOFTWARE counters and events to S-mode (or VS-

mode)

software.

The M-mode runtime firmware (OpenSBI) will need to know
following platform dependent information:
1. Possible event_idx values allowed (or supported) by a
HARDWARE
counter (i.e. HPMCOUNTER)
2. Mapping of event_idx for HARDWARE event to HPMEVENT

CSR

value

3.
Mapping of event_idx for HARDWARE CACHE event to

HPMEVENT

CSR

value 4.

Mapping of event_idx for HARDWARE RAW event to HPMEVENT

CSR

value

5.

Additional platform-specific progamming required by any
event_idx

All platform dependent information mentioned above, can be
obtained by M-mode runtime firmware (OpenSBI) from

platform

specific code.
The
DT/ACPI can also be used to described 1), 2), 3), and 4)
mentioned above but 5) will always require platform
specific
code.

I would update the next version of DT file to describe the
points
from
1) to 4). Thanks.
As you mentioned before, it would be hard to sync the
platform
specific code with the DT of real use.
I prefer to get 1), 2), 3) and 4) from DT first on each
platform,
and use platform specific code if DT is unavailable. (generic
platform use DT certainly), then we could maximally reduce
the
inconsistency.

It should platform's choice on how it wants to describe
HARDWARE
events and HARDWARE counters. The OpenSBI generic platform will
tend
to use DT based parsing of HARDWARE events and HARDWARE
counters

but

other platform can do things differently.

The S-mode software (i.e. Linux) should not get HARDWARE events
and
HARDWARE counters from DT because DT describes HARDWARE

and DT

will

not include SOFTWARE events and SOFTWARE counters.
Also, SOFTWARE events and SOFTWARE counters will change for
given
platform as OpenSBI continues to improve so it will be hard to
keep
the DT in sync.

The best thing for S-mode software would be to depend on one
method
of discovering all counters and supported events which is the
SBI_PMU_COUNTER_DESCRIBE call. In other words, no need for
platform
driver for Linux RISC-V PMU driver instead depend only on
sbi_probe_extension() to detect SBI PMU extension.

OK, make sense.

Regards,
Anup

--
Regards,
Atish

Regards,
Anup

--
Regards,
Atish

For riscv-sbi-doc, we have not finalized mailing list based review OR
Github PR based review so most of usl are sending riscv-sbi-doc
changes as patches to mailing list and Github PR.

Regards,
Anup

From: tech-unixplatformspec@... <
tech-unixplatformspec@...> On Behalf Of Abner Chang
Sent: 21 April 2020 08:26
To: Anup Patel <Anup.Patel@...>; Jonathan Behrens <
behrensj@...>
Cc: Atish Patra <Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V] [software] Add
SBI extension space for firmware code base implementation

We would like to have firmware code base SBI based on OpenSBI
implementation ID, because edk2 is not one of the implementations of
SBI. I saw the patches of overriding SBI implementation ID was also
committed. EDK2 still has chance to override the ID to avoid any
conflicts if it is a case.

BTW, the changes made on riscv-sbi-doc should go through the mail
list for review or PR is good?

From: Anup Patel [mailto:Anup.Patel@...]
Sent: Tuesday, April 14, 2020 1:25 PM
To: Jonathan Behrens <behrensj@...>
Cc: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>;
Atish Patra <Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: RE: [RISC-V] [tech-unixplatformspec] [RISC-V] [software] Add
SBI extension space for firmware code base implementation

As-per my understanding, U-Boot and Coreboot don’t need this SBI
firmware code base extension. Other SBI extensions are sufficient for
these bootloaders.

In my opinion, use of SBI firmware code base extension should be last
resort (when we have no other way) because this extension adds SBI
implementation specific code in S-mode software. The EDK2 developers
want to use SBI firmware code base extension in their own S-mode
booting stage so we are fine in-context of EDK2.

Also, we are certainly fine if EDK2 want their own SBI implementation
ID and to facilitate OpenSBI can provide API to override SBI
implementation ID which EDK2 can use. Finally, it’s EDK2 developer’s
choice.

Regards,
Anup

From: tech-unixplatformspec@... <
tech-unixplatformspec@...> On Behalf Of Jonathan Behrens
Sent: 14 April 2020 09:50
To: Anup Patel <Anup.Patel@...>
Cc: Abner Chang <abner.chang@...>; Atish Patra <
Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V] [software] Add
SBI extension space for firmware code base implementation

Anup wrote:

With EDK2 + OpenSBI running in background, the S-mode software will
see SBI implementation ID of OpenSBI because EDK2 uses unmodified
OpenSBI as library. This means from S-mode perspective the
underlying SBI implementation is still OpenSBI.

But EDK2 can and will register extensions with OpenSBI, meaning that
even identical OpenSBI versions might behave differently with regards
to such extension. So far I think you are right that S-mode won't
actually care about the difference. But I fear that this could end up
like User Agent Strings in web browsers where everybody lies and
claims they're basically the same as OpenSBI so they report the same
implementation ID.

The OpenSBI itself does not need the SBI firmware code base
extension hence I suggested that EDK2 can use ext_id = 0xA000000 +
opensbi_imp_id.

Most of the other bootloaders (U-Boot and Coreboot) use OpenSBI
FW_DYNAMIC firmware. For such bootloaders, the SBI firmware code
extension won’t be available because OpenSBI firmwares will not
implement it.

Are you saying that you are or aren't OK with U-Boot or Coreboot
hypothetically using ext_id = 0xA000000 + opensbi_imp_id to design
their own incompatible extensions? As Abner points out below, it
would probably be fine even if there were incompatible extensions
with the same ID, but I'm trying to understand if that's what you
intend. (My own opinion is that with 2^32 possible IDs it would be
preferable to try to keep them distinct)

Apart from bootloaders, the SBI firmware code base extension space
can be used hypervisors to provide hypervisor specific SBI calls.

Agreed. I think this reservation will prove to be very useful going
forward.

Jonathan

Regards,
Anup

From: Jonathan Behrens <behrensj@...>
Sent: 14 April 2020 08:42
To: Anup Patel <Anup.Patel@...>
Cc: Abner Chang <abner.chang@...>; Atish Patra <
Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V] [software]
Add SBI extension space for firmware code base implementation

Anup, are you saying that EDK2's extension would be the only use of
ext_id = 0xA000000 + opensbi_imp_id or that any firmware that uses
OpenSBI is free to make a (potentially incompatible) extension
using that ID?

Jonathan

On Mon, Apr 13, 2020 at 2:26 AM Anup Patel <Anup.Patel@...>
wrote:

Hi Abner,

Yes, your understanding is correct.

The 0xA000000 + opensbi_imp_id is the SBI Firmware code base
extension meant to be used by OpenSBI.

Now EDK2 uses unmodified OpenSBI as library/submodule so
underlying SBI implementation in-case of EDK2 is indeed OpenSBI
itself.

From OpenSBI perspective, we don’t see any OpenSBI specific SBI
calls being implemented in-future because previous and next
booting stages are totally black-box for OpenSBI. This means SBI
Firmware code base extension will be never used by OpenSBI hence
EDK2 can certainly register custom SBI extension for ext_id =
0xA000000 + opensbi_imp_id (Note: EDK2 can use
sbi_ecall_register_extension() API for this from platform
final_init() callback).

Apart from above, I do see SBI firmware code base extension
useful to some of the hypervisors (such as Xvisor, Xen, etc) but
this is in totally different context.

Regards,
Anup

From: tech-unixplatformspec@... <
tech-unixplatformspec@...> On Behalf Of Abner Chang
Sent: 13 April 2020 08:45
To: Jonathan Behrens <behrensj@...>
Cc: Anup Patel <Anup.Patel@...>; Atish Patra <
Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V] [software]
Add SBI extension space for firmware code base implementation



From: Jonathan Behrens [mailto:behrensj@...]
Sent: Monday, April 13, 2020 10:49 AM
To: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>
Cc: Anup Patel <Anup.Patel@...>; Atish Patra <
Atish.Patra@...>; Schaefer, Daniel (DualStudy) <
daniel.schaefer@...>; tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V] [software]
Add SBI extension space for firmware code base implementation

Also respond to Anup’s reply, 0xA000000+opensbi_imp_id is the
best and simple solution for now.

That is fine, just realize that if you are using OpenSBI's
implementation ID then you need to get approval from them before
defining the extension.
[Abner] I suppose the intention of reserving 0xa000000 is to let
firmware defines its own SBI functions. SBI spec won’t touch or
specify anything in this range as it doesn’t touch vendor
extension. To have 0xa000000 + opensbi_imp_id means the firmware
code base extension is defined base on OpenSBI SBI
implementation.

Anup, is my understanding correct?
Abner


Jonathan

On Sun, Apr 12, 2020 at 8:57 PM Abner Chang via lists.riscv.org <
abner.chang=hpe.com@...> wrote:

Basically OpenSBI is a git submodule of edk2 and we don’t make
any modification on it, we just build OpenSBI on edk2 build
environment.
Yes, edk2 will have its own control of extensions for those
firmware code base specific functions. One think we concern
about is the conflict of extension ID with vendor extension.

Also respond to Anup’s reply, 0xA000000+opensbi_imp_id is the
best and simple solution for now. We don’t have to add edk2 as
one of SBI implementation and this can also prevent from
extension ID conflict with vendor’s ones.
We can just take #1 opinion.

Any other comments?

Will let you know if we miss something later. Thanks to all for
supporting ekd2.
Abner

From: Jonathan Behrens [mailto:behrensj@...]
Sent: Sunday, April 12, 2020 10:19 PM
To: Anup Patel <Anup.Patel@...>
Cc: Chang, Abner (HPS SW/FW Technologist) <abner.chang@...>
; Atish Patra <Atish.Patra@...>; Schaefer, Daniel
(DualStudy) <daniel.schaefer@...>;
tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V]
[software] Add SBI extension space for firmware code base
implementation

Is the code for the extension you want to add going to live in
the OpenSBI repository or in the EDK2 repository? If I
understand correctly, it would live in the EDK2 repository,
meaning that your implementation would actually be downstream
from OpenSBI and should have its own implementation ID. If you
did this then it seems like everything else would fall out
nicely: you could decide on version numbers independently of
OpenSBI, there'd be no need for a separate set of firmware IDs,
and you'd have full control over all the details of your
extension.

Jonathan

On Sun, Apr 12, 2020 at 8:18 AM Anup Patel <Anup.Patel@...>
wrote:

Hi Abner,

We have two options here:
EDK2 can use 0xA000000 + <opensbi_imp_id> as SBI Extension
OpenSBI provides a way to EDK2 for overriding SBI
implementation ID (preferably using some API)

If we go with Option1 above then we don’t need separate SBI
implementation ID for EDK2.

Let us know what you guys think in this context.

Regards,
Anup

From: Chang, Abner (HPS SW/FW Technologist) <
abner.chang@...>
Sent: 12 April 2020 14:50
To: Chang, Abner (HPS SW/FW Technologist) <
abner.chang@...>; Anup Patel <Anup.Patel@...>;
Jonathan Behrens <behrensj@...>
Cc: Atish Patra <Atish.Patra@...>; Schaefer, Daniel
(DualStudy) <daniel.schaefer@...>;
tech-unixplatformspec@...
Subject: RE: [RISC-V] [tech-unixplatformspec] [RISC-V]
[software] Add SBI extension space for firmware code base
implementation

This is the PR according to the discussion we had in mail
thread. However you may see some confusions from this change.
https://github.com/riscv/riscv-sbi-doc/pull/43/commits/e208f23c64f7a6a4be47d6d0ca852433107f6cf4

EDK2 is a SBI implementation? Actually edk2 is not one of
the SBI implementations, edk2 fully compliant with OpenSBI
and additionally provides the firmware code base SBI
extension.
We can explain this in the external Firmware code base SBI
extension spec (edk2 RISC-V OpenSBI spec), says edk2 SBI
implementation actually goes alone with SBI OpenSBI
implementation.

What is the SBI implementation version associated with EDK2
SBI implementation? This is another confusion because the
major SBI implementation is OpenSBI.
We also can explain this in the external Firmware code base
SBI extension spec, says edk2 SBI implementation version is
the version of SBI OpenSBI implementation.



Apart from the above proposal, can we have more clear
definitions for Firmware code base SBI extension in SBI spec
instead of fixing those confusions in the extern spec? The
below proposal makes more sense?
Define another table for firmware code base, e.g. SBI
Firmware Code Base ID. In the table we can have edk2, uboot,
Coreboot and etc..
Create a new SBI Base function,
sbi_get_firmware_code_base_id() which returns the SBI
Firmware Code Base ID.
Create a new SBI Base function,
sbi_get_firmware_code_base_version() for the version control
of firmware code base SBI extension
Firmware code base SBI extension is from 0xA000000 to
0xAffffff with Firmware Code Base ID in low bits.


I feel the later one makes more sense and clear, how do you
think?
Abner



From: tech-unixplatformspec@... [mailto:
tech-unixplatformspec@...] On Behalf Of Abner
Chang
Sent: Saturday, April 11, 2020 12:08 AM
To: Anup Patel <Anup.Patel@...>; Jonathan Behrens <
behrensj@...>
Cc: Atish Patra <Atish.Patra@...>; Schaefer, Daniel
(DualStudy) <daniel.schaefer@...>;
tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V]
[software] Add SBI extension space for firmware code base
implementation

Cool. This works for edk2. I will have another PR for this.

For edk2, we will request a new SBI implementation ID (4) and
register firmware code base extension SBI in edk2 SEC phase.


From: Anup Patel [mailto:Anup.Patel@...]
Sent: Friday, April 10, 2020 11:14 PM
To: Chang, Abner (HPS SW/FW Technologist) <
abner.chang@...>; Jonathan Behrens <behrensj@...>
Cc: Atish Patra <Atish.Patra@...>; Schaefer, Daniel
(DualStudy) <daniel.schaefer@...>;
tech-unixplatformspec@...
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V]
[software] Add SBI extension space for firmware code base
implementation

I agree with Jonathan's proposal. Let's have SBI FW extension
ID depend on SBI implementation ID.

We can target this for SBI v0.3 spec along with System Reboot
extension.

Regards,
Anup

Sent from Outlook Mobile

From: tech-unixplatformspec@... <
tech-unixplatformspec@...> on behalf of Jonathan
Behrens <behrensj@...>
Sent: Friday, April 10, 2020 7:14:45 PM
To: Chang, Abner (HPS SW/FW Technologist) <
abner.chang@...>
Cc: Atish Patra <Atish.Patra@...>; Schaefer, Daniel
(DualStudy) <daniel.schaefer@...>;
tech-unixplatformspec@... <
tech-unixplatformspec@...>; Anup Patel <
Anup.Patel@...>
Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V]
[software] Add SBI extension space for firmware code base
implementation

What I was suggesting is something like:

Implementation specific SBI extension Space, Extension IDs

0x0A000000 through 0x0AFFFFFF. Low bits from SBI
Implementation ID.

In this scheme, each SBI implementation would have one
extension reserved for it: BBL gets 0x0A000000, OpenSBI gets
0x0A000001, Xvisor gets 0x0A000002, KVM gets 0x0A000003, etc.
That might not seem like a lot of space, but each extension
can have up to 2^32 different functions (including ones for
version number discovery, etc.) so it shouldn't actually be
limiting.

As a side note, I don't think edk2 has an SBI Implementation
ID assigned yet. You should just be able to ask for one and
get it.

Jonathan

On Fri, Apr 10, 2020 at 2:23 AM Chang, Abner (HPS SW/FW
Technologist) <abner.chang@...> wrote:

-----Original Message-----
From: tech-unixplatformspec@... [mailto:tech-
unixplatformspec@...] On Behalf Of Atish

Patra

Sent: Friday, April 10, 2020 11:32 AM
To: Chang, Abner (HPS SW/FW Technologist) <

abner.chang@...>;

behrensj@...
Cc: Schaefer, Daniel (DualStudy) <daniel.schaefer@...
; tech-
unixplatformspec@...; Anup Patel <

Anup.Patel@...>

Subject: Re: [RISC-V] [tech-unixplatformspec] [RISC-V]

[software] Add SBI

extension space for firmware code base implementation

On Fri, 2020-04-10 at 01:08 +0000, Chang, Abner (HPS

SW/FW

Technologist) wrote:

Got it, Software ML removed.

Johnathan, do you mean to define it as below?
Firmware Base Extension, Extension ID: 0xxxxxxxxx

(FWBE) , and the

SBI functions definition is firmware code base

implementation-

specific.

I prefer this one as well. But you should pick any value

within experimental

range.

Not quite follow this, why pick up one from experimental
range? The extension ID must be in the range of 0x0800000-
0x08ffffff?

I am not sure about the purpose of the extension but if it
has the

potential to be a generic SBI extension for firmwares,

you should propose it

to the Unix Platform working group. We can add it to the

official spec.
For those SBI extension which is generic to all firmware
code bases, then we should just propose it to the official
SBI spec and don’t not have to go with Firmware Base
Extension.
Firmware Base Extension is classified to those firmware
code base specific SBI, for example to load an edk2 driver
into M-mode managed memory and executed in M-mode which is
behaved as secured system manage mode driver. So the detail
Firmware Base Extension would be defined in the separate
spec and not part of official sbi spec. Occupied an SBI
extension ID is to avoid conflicts.

This also works for me and better than to reserve a

range of IDs.

Thanks
Abner

From: software@... [mailto:

software@...] On

Behalf Of Jonathan Behrens
Sent: Friday, April 10, 2020 12:39 AM
To: Chang, Abner (HPS SW/FW Technologist) <

abner.chang@...>

Cc: Atish Patra <Atish.Patra@...>; Anup Patel

<anup.patel@...

; Schaefer, Daniel (DualStudy) <

daniel.schaefer@...>;

software@...;

tech-unixplatformspec@...

Subject: Re: [RISC-V] [software] Add SBI extension

space for firmware

code base implementation

I think tech-unixplatformspec@... might be

the right list?

To address the PR itself, I'd personally prefer to have

this space

allocated based on SBI implementation IDs analogously

to how the

vendor space is allocated. It also probably makes sense

to pick a

different address range so experimental extension space

doesn't have

to move.

Jonathan

On Thu, Apr 9, 2020 at 4:39 AM Abner Chang via

lists.riscv.org <

abner.chang=hpe.com@...> wrote:

Seems opensbi ML is no longer exist? Use

software@...

insrtead.

From: Chang, Abner (HPS SW/FW Technologist)
Sent: Thursday, April 9, 2020 4:23 PM
To: Atish Patra <Atish.Patra@...>; Anup Patel <
anup.patel@...>
Cc: opensbi@...; Schaefer, Daniel

(DualStudy) <

daniel.schaefer@...>
Subject: Add SBI extension space for firmware code

base

implementation

Hi Atish and Anup,
We are working on some edk2-specific SBI extension

which intends to

be used by upper layer edk2 drivers. We originally

consider to use

Vendor Extension space however vendor may have its

own proprietary

SBI extension as well. In order to prevent from the

conflicts of SBI

extension space, we propose to have a range for

firmware code base.

The changes look like the PR below,

https://github.com/riscv/riscv-sbi-doc/pull/43

How do you think?
Thanks
Abner

--
Regards,
Atish

Would there be a raw style interface to access all the SBI-unaware events, like perf's rNNN support?

How would this work on a multicore system -- would the SBI calls only handle the current hart's counters? That seems easiest to deal with.

Brian

Based on my previous reply…



To monitor RAW event 0x12345678, user-space perf tool will create user space perf RAW event (i.e. perf_event_attr.type == 4 and perf_event_attr.config = = 0x12345678). The Linux RISC-V PMU driver will allocate and map matching HARDWARE counter which supports specified corrosponding SBI RAW event (event_idx.type = 2, event_idx.code = 0x678 and event_idx.info = 0x12345). Finally, the SBI_PMU_COUNTER_START call implemented by OpenSBI will write 0x12345678 (or some platform specific translated value of 0x12345678) to appropriate mhpmeventX CSR).



(Note: above we assume mhpmcounterX supports monitoring RAW event 0x12345678 and OpenSBI is aware of this)

Regards,

Anup





From: Brian Grayson <brian.grayson@...>
Sent: 09 July 2020 12:35
To: Zong Li <zong.li@...>
Cc: Anup Patel <Anup.Patel@...>; Atish Patra <Atish.Patra@...>; andrew@...; tech-unixplatformspec@...; gfavor@...
Subject: Re: [RISC-V] [tech-unixplatformspec] Proposal v2: SBI PMU Extension



My question is, let's say I know that putting the value 0x12345678 into the mhpmevent3 register gets me the event I want, and there is no support for that event in the SBI spec/API. Will this API allow me to program such an event, basically bypassing the usual mapping functionality? perf basically allows you to say "I know this event number is not one you know about, but it's the value I want placed directly into the hardware." I want to ensure that the full capabilities of the hardware will still be accessible through the SBI spec in some sort of "raw" mode, and I didn't see a way for that to happen right now. We don't want to restrict users to the lowest common denominator of functionality.



Brian





On Wed, Jul 8, 2020 at 10:27 PM Zong Li <zong.li@...> wrote:

On Thu, Jul 9, 2020 at 1:06 AM Brian Grayson <brian.grayson@...> wrote:

Would there be a raw style interface to access all the SBI-unaware events, like perf's rNNN support?

Follow this question, in our current proposal, s-mode software only
knows the event_idx, and m-mode firmware takes care of the mapping, my
question is that s-mode software doesn't seem to understand the
meaning of each event_idx, that means, it just get the array of all
supported event_idx, but couldn't know which one is for what. This
also happened on u-mode program, for rNNN interface, normally, we
should refer to the processor specific documentation for getting these
details, and now, users won't know what value they should give. Please
correct me if I miss something. Thanks.

How would this work on a multicore system -- would the SBI calls only handle the current hart's counters? That seems easiest to deal with.

Brian