Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

This document describes first phase of WindowsPerf GUI design and implementation.

...

User Story

Description / TODO

GUI-01

n/a

GUI-02

Building widget to select host (IP/URL/port) to connect to.

GUI-03

Listing all available events and metrics (wperf list) - for example separate tab.

GUI-04

Listing of wperf version number (wperf -version -json).

  • For example in modal window “about” and

  • in bottom status bar.

GUI-05

Listing additional data about host (wperf test) - for example separate tab.

GUI-06

Building widget to save/load host information.

GUI-07

Building widget to connect to host. This may include indicator if we are connected to host For example small “traffic lights” icon indicating if we are connected, connecting or disconnected).

GUI-08

n/a

GUI-09

Separate text window with scroll option to see consecutive outputs from wperf console.

GUI-10

Building widget to prepare list of events and event groups for wperf stat command line option -e <events>

  • Build list of CORE events and event groups.

  • [Nice-to-have]Widget would also prepare list of DSU and DMC events.

  • Groups are marked with events inside curly braces { }, see example below.

  • Make sure events and groups are sent to relay (as protocol payload) in the same order as defined by user. Please note that group numbers are assigned by wperf from left to right. For example:

    • -e {inst_spec,vfp_spec},ase_spec,{dp_spec,ld_spec,st_spec},br_immed_spec,crypto_spec

      • group 0 (g0) is {inst_spec,vfp_spec}

      • group 1 (g1) is {dp_spec,ld_spec,st_spec}

  • Note: GUI may synthesize <events> as string compatible with wperf CLI.

  • Please note that maximum number of events user can specify will be available with wperf via CLI-02.

  • List of all events: CORE, DSU and DMC are available with GUI-03.

GUI-11

Building widget to prepare list of metrics wperf stat command line option -m <metrics>

  • Note: GUI may synthesize <metrics> as string compatible with wperf CLI.

  • List of all metrics are available with GUI-03.

GUI-12

  • User can specify list of cores: from 0 to MAX-1. List can be:

    • empty - implies all cores.

    • one core.

    • comma separated list of cores. Cores should be unique and sorted in increasing manner. For example 0,3,16,17

  • Number of cores for host is available with GUI-05.

GUI-13

  • Support visualization (table) of output of wperf stat -e <events> -m <metrics> -c <cpu_list> sleep <N>.

  • Building widget which will “send” counting command to relay and wait for response.

  • Building widget which will display table with counting results.

GUI-14

Widget which will show error messages from relay.

This may include messages after each response from relay to GUI.

It may be a widget, modal window etc.

...

  • Building initial GUI (wperf-gui).

    • Building widget to select host (IP/URL/port) to connect to.

    • Building widget to save/load host information.

    • Building widget to prepare list of events and event groups for wperf stat command line option -e <events>

      • Build list of CORE events and event groups.

      • [Nice-to-have]Widget would also prepare list of DSU and DMC events.

      • Make sure events and groups are sent to relay (as protocol payload) in the same order as defined by user. Please note that group numbers are assigned by wperf from left to right. For example:

        • -e {inst_spec,vfp_spec},ase_spec,{dp_spec,ld_spec,st_spec},br_immed_spec,crypto_spec

          • group 0 (g0) is {inst_spec,vfp_spec}

          • group 1 (g1) is {dp_spec,ld_spec,st_spec}

    • Building widget to prepare list of metrics wperf stat command line option -m <metrics>

    • Listing all available events and metrics (wperf list) - for example separate tab.

    • Listing additional data about host (wperf test) - for example separate tab.

    • Listing of wperf version number (wperf -version -json).

      • For example in modal window “about” and

      • in bottom status bar.

    • Support visualization (table) of output of wperf stat -e <events> -m <metrics> -c <cpu_list> sleep <N>.

  • Support counting model (wperf pov) JSON output for (below all done):

    • wperf stat -e <events>

    • wperf stat -m <metrics>

    • wperf stat -e <events> -m <metrics>

    • Command line option -c <cpu_list>

    • Command line option sleep <N>

  • Establishing common protocol between relay and GUI.

    • Event and metrics list fetch. Output from wperf list -json.

    • Host system and wperf application configuration. Output from wperf test -json.

    • Counting with wperf stat ... -json.

    • Basic “real time” wperf stdout logging in GUI.

      • We would like to see wperf screen output in GUI during counting execution.

  • Basic error handling by relay and GUI.

    • Relay-GUI protocol must be able to send error information to GUI.

    • Relay-GUI protocol must provide “busy” state to GUI from relay.

    • GUI should report errors but is not responsible to error recovery of the relay and wperf.

    • Note: relay will execute and have control over wperf process and will be responsible for executing, stopping and error handling wperf.

...