Changeset 4b03ff7 in rtems-docs


Ignore:
Timestamp:
Nov 12, 2020, 6:41:18 AM (2 months ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
284e8d0
Parents:
00b3444
git-author:
Sebastian Huber <sebastian.huber@…> (11/12/20 06:41:18)
git-committer:
Sebastian Huber <sebastian.huber@…> (11/27/20 08:16:00)
Message:

eng: Add performance specification items

Add items to specify runtime performance requirements.

Update #3715.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/req/items.rst

    r00b3444 r4b03ff7  
    110110    * :ref:`SpecTypeNonFunctionalRequirementItemType`
    111111
     112      * :ref:`SpecTypeGenericNonFunctionalRequirementItemType`
     113
     114      * :ref:`SpecTypeRuntimePerformanceRequirementItemType`
     115
    112116  * :ref:`SpecTypeRequirementValidationItemType`
     117
     118  * :ref:`SpecTypeRuntimeMeasurementTestItemType`
    113119
    114120  * :ref:`SpecTypeSpecificationItemType`
     
    183189
    184190* :ref:`SpecTypeRequirementValidationItemType`
     191
     192* :ref:`SpecTypeRuntimeMeasurementTestItemType`
    185193
    186194* :ref:`SpecTypeSpecificationItemType`
     
    17301738
    17311739test-context
    1732     The attribute value shall be a list. Each list element shall be an
    1733     :ref:`SpecTypeActionRequirementTestContextMember`.
     1740    The attribute value shall be a list. Each list element shall be a
     1741    :ref:`SpecTypeTestContextMember`.
    17341742
    17351743test-context-support
     
    17591767
    17601768test-setup
    1761     The attribute value shall be an
    1762     :ref:`SpecTypeActionRequirementTestFixtureMethod`.
     1769    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`.
    17631770
    17641771test-stop
    1765     The attribute value shall be an
    1766     :ref:`SpecTypeActionRequirementTestFixtureMethod`.
     1772    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`.
    17671773
    17681774test-support
     
    17761782
    17771783test-teardown
    1778     The attribute value shall be an
    1779     :ref:`SpecTypeActionRequirementTestFixtureMethod`.
     1784    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`.
    17801785
    17811786transition-map
     
    19441949
    19451950non-functional-type
    1946     The attribute value shall be a :ref:`SpecTypeRequirementNonFunctionalType`.
    1947     It shall be the non-functional type of the requirement.
     1951    The attribute value shall be a :ref:`SpecTypeName`. It shall be the
     1952    non-functional type of the requirement.
     1953
     1954This type is refined by the following types:
     1955
     1956* :ref:`SpecTypeGenericNonFunctionalRequirementItemType`
     1957
     1958* :ref:`SpecTypeRuntimePerformanceRequirementItemType`
     1959
     1960.. _SpecTypeGenericNonFunctionalRequirementItemType:
     1961
     1962Generic Non-Functional Requirement Item Type
     1963^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     1964
     1965This type refines the following types:
     1966
     1967* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1968  ``non-functional-type`` attribute if the value is ``build-configuration``
     1969
     1970* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1971  ``non-functional-type`` attribute if the value is ``constraint``
     1972
     1973* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1974  ``non-functional-type`` attribute if the value is ``design``
     1975
     1976* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1977  ``non-functional-type`` attribute if the value is ``documentation``
     1978
     1979* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1980  ``non-functional-type`` attribute if the value is ``interface``
     1981
     1982* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1983  ``non-functional-type`` attribute if the value is ``interface-requirement``
     1984
     1985* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1986  ``non-functional-type`` attribute if the value is ``maintainability``
     1987
     1988* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1989  ``non-functional-type`` attribute if the value is ``performance``
     1990
     1991* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1992  ``non-functional-type`` attribute if the value is ``portability``
     1993
     1994* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1995  ``non-functional-type`` attribute if the value is ``quality``
     1996
     1997* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     1998  ``non-functional-type`` attribute if the value is ``reliability``
     1999
     2000* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     2001  ``non-functional-type`` attribute if the value is ``resource``
     2002
     2003* :ref:`SpecTypeNonFunctionalRequirementItemType` through the
     2004  ``non-functional-type`` attribute if the value is ``safety``
     2005
     2006Items of this type state a non-functional requirement with the non-functional
     2007type defined by the specification type refinement.
     2008
     2009.. _SpecTypeRuntimePerformanceRequirementItemType:
     2010
     2011Runtime Performance Requirement Item Type
     2012^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     2013
     2014This type refines the :ref:`SpecTypeNonFunctionalRequirementItemType` through
     2015the ``non-functional-type`` attribute if the value is ``performance-runtime``.
     2016The item shall have exactly one link with the
     2017:ref:`SpecTypeRuntimeMeasurementRequestLinkRole`.  A requirement text processor
     2018shall support a substitution of ${.:/limit-kind}:
     2019
     2020* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-lower-bound`` or
     2021  ``min-upper-bound``, the substitution of ${.:/limit-kind} shall be
     2022  ``"minimum"``.
     2023
     2024* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``mean-lower-bound`` or
     2025  ``mean-upper-bound``, the substitution of ${.:/limit-kind} shall be
     2026  ``"mean"``.
     2027
     2028* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``max-lower-bound`` or
     2029  ``max-upper-bound``, the substitution of ${.:/limit-kind} shall be
     2030  ``"maximum"``.
     2031
     2032A requirement text processor shall support a substitution of
     2033${.:/limit-condition}:
     2034
     2035* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-lower-bound``,
     2036  ``mean-lower-bound``, or ``max-lower-bound``, the substitution of
     2037  ${.:/limit-condition} shall be ``"greater than or equal to <value>"`` with
     2038  <value> being the value of the corresponding entry in the
     2039  :ref:`SpecTypeRuntimeMeasurementValueTable`.
     2040
     2041* For a :ref:`SpecTypeRuntimeMeasurementValueKind` of ``min-upper-bound``,
     2042  ``mean-upper-bound``, or ``max-upper-bound``, the substitution of
     2043  ${.:/limit-condition} shall be ``"less than or equal to <value>"`` with
     2044  <value> being the value of the corresponding entry in the
     2045  :ref:`SpecTypeRuntimeMeasurementValueTable`.
     2046
     2047A requirement text processor shall support a substitution of ${.:/environment}.
     2048The value of the substitution shall be ``"<environment> environment"`` with
     2049<environment> being the environment of the corresponding entry in the
     2050:ref:`SpecTypeRuntimeMeasurementEnvironmentTable`.
     2051
     2052This set of attributes specifies a runtime performance requirement. Along with
     2053the requirement, the validation test code to execute a measure runtime request
     2054is specified. All explicit attributes shall be specified. The explicit
     2055attributes for this type are:
     2056
     2057limits
     2058    The attribute value shall be a :ref:`SpecTypeRuntimePerformanceLimitTable`.
     2059
     2060params
     2061    The attribute value shall be a
     2062    :ref:`SpecTypeRuntimePerformanceParameterSet`.
     2063
     2064test-body
     2065    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It shall
     2066    provide the code of the measure runtime body handler.  In contrast to other
     2067    methods, this method is mandatory.
     2068
     2069test-cleanup
     2070    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may
     2071    provide the code to clean up the measure runtime request. This method is
     2072    called before the cleanup method of the corresponding
     2073    :ref:`SpecTypeRuntimeMeasurementTestItemType` item and after the request.
     2074
     2075test-prepare
     2076    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may
     2077    provide the code to prepare the measure runtime request.  This method is
     2078    called after the prepare method of the corresponding
     2079    :ref:`SpecTypeRuntimeMeasurementTestItemType` item and before the request.
     2080
     2081test-setup
     2082    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may
     2083    provide the code of the measure runtime setup handler.
     2084
     2085test-teardown
     2086    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. It may
     2087    provide the code of the measure runtime teardown handler.
     2088
     2089Please have a look at the following example:
     2090
     2091.. code-block:: yaml
     2092
     2093    SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
     2094    copyrights:
     2095    - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
     2096    enabled-by: true
     2097    links:
     2098    - role: runtime-measurement-request
     2099      uid: ../val/performance
     2100    limits:
     2101      sparc/leon3:
     2102        DirtyCache:
     2103          max-upper-bound: 0.000005
     2104          mean-upper-bound: 0.000005
     2105        FullCache:
     2106          max-upper-bound: 0.000005
     2107          mean-upper-bound: 0.000005
     2108        HotCache:
     2109          max-upper-bound: 0.000005
     2110          mean-upper-bound: 0.000005
     2111        Load/1:
     2112          max-upper-bound: 0.00001
     2113          mean-upper-bound: 0.00001
     2114        Load/2:
     2115          max-upper-bound: 0.00001
     2116          mean-upper-bound: 0.00001
     2117        Load/3:
     2118          max-upper-bound: 0.00001
     2119          mean-upper-bound: 0.00001
     2120        Load/4:
     2121          max-upper-bound: 0.00001
     2122          mean-upper-bound: 0.00001
     2123    params: {}
     2124    rationale: null
     2125    references: []
     2126    test-body:
     2127      brief: |
     2128        Get a buffer.
     2129      code: |
     2130        ctx->status = rtems_partition_get_buffer( ctx->part_many, &ctx->buffer );
     2131      description: null
     2132    test-cleanup: null
     2133    test-prepare: null
     2134    test-setup: null
     2135    test-teardown:
     2136      brief: |
     2137        Return the buffer.
     2138      code: |
     2139        rtems_status_code sc;
     2140
     2141        T_quiet_rsc_success( ctx->status );
     2142
     2143        sc = rtems_partition_return_buffer( ctx->part_many, ctx->buffer );
     2144        T_quiet_rsc_success( sc );
     2145
     2146        return tic == toc;
     2147      description: null
     2148    text: |
     2149      When a partition has exactly ${../val/performance:/params/buffer-count} free
     2150      buffers, the ${.:limit-kind} runtime of exactly
     2151      ${../val/performance:/params/sample-count} successful calls to
     2152      ${../if/get-buffer:/name} in the ${.:/environment} shall be
     2153      ${.:limit-condition}.
     2154    non-functional-type: performance-runtime
     2155    requirement-type: non-functional
     2156    type: requirement
    19482157
    19492158.. _SpecTypeRequirementValidationItemType:
     
    19752184    * *By review of design*: A rationale shall be provided to demonstrate how
    19762185      the requirement is satisfied implicitly by the software design.
     2186
     2187.. _SpecTypeRuntimeMeasurementTestItemType:
     2188
     2189Runtime Measurement Test Item Type
     2190^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     2191
     2192This type refines the :ref:`SpecTypeRootItemType` through the ``type``
     2193attribute if the value is ``runtime-measurement-test``. This set of attributes
     2194specifies a runtime measurement test case. All explicit attributes shall be
     2195specified. The explicit attributes for this type are:
     2196
     2197params
     2198    The attribute value shall be a
     2199    :ref:`SpecTypeRuntimeMeasurementParameterSet`.
     2200
     2201test-brief
     2202    The attribute value shall be an optional string. If the value is present,
     2203    then it shall be the test case brief description.
     2204
     2205test-cleanup
     2206    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the
     2207    value is present, then it shall be the measure runtime request cleanup
     2208    method.  The method is called after each measure runtime request.
     2209
     2210test-context
     2211    The attribute value shall be a list. Each list element shall be a
     2212    :ref:`SpecTypeTestContextMember`.
     2213
     2214test-context-support
     2215    The attribute value shall be an optional string. If the value is present,
     2216    then it shall be the test context support code.  The context support code
     2217    is placed at file scope before the test context definition.
     2218
     2219test-description
     2220    The attribute value shall be an optional string. If the value is present,
     2221    then it shall be the test case description.
     2222
     2223test-includes
     2224    The attribute value shall be a list of strings. It shall be a list of
     2225    header files included via ``#include <...>``.
     2226
     2227test-local-includes
     2228    The attribute value shall be a list of strings. It shall be a list of
     2229    header files included via ``#include "..."``.
     2230
     2231test-prepare
     2232    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the
     2233    value is present, then it shall be the measure runtime request prepare
     2234    method.  The method is called before each measure runtime request.
     2235
     2236test-setup
     2237    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the
     2238    value is present, then it shall be the test case setup fixture method.
     2239
     2240test-stop
     2241    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the
     2242    value is present, then it shall be the test case stop fixture method.
     2243
     2244test-support
     2245    The attribute value shall be an optional string. If the value is present,
     2246    then it shall be the test case support code. The support code is placed at
     2247    file scope before the test case code.
     2248
     2249test-target
     2250    The attribute value shall be a string. It shall be the path to the
     2251    generated test case source file.
     2252
     2253test-teardown
     2254    The attribute value shall be a :ref:`SpecTypeTestSupportMethod`. If the
     2255    value is present, then it shall be the test case teardown fixture method.
    19772256
    19782257.. _SpecTypeSpecificationItemType:
     
    22092488    test condition preparation or check before the state-specific code.  The
    22102489    code may use a local variable ``ctx`` which points to the test context, see
    2211     :ref:`SpecTypeActionRequirementTestContextMember`.
     2490    :ref:`SpecTypeTestContextMember`.
    22122491
    22132492test-prologue
     
    22162495    test condition preparation or check after the state-specific code.  The
    22172496    code may use a local variable ``ctx`` which points to the test context, see
    2218     :ref:`SpecTypeActionRequirementTestContextMember`.
     2497    :ref:`SpecTypeTestContextMember`.
    22192498
    22202499This type is used by the following types:
     
    22852564    or check the state of the condition.  The code may use a local variable
    22862565    ``ctx`` which points to the test context, see
    2287     :ref:`SpecTypeActionRequirementTestContextMember`.
     2566    :ref:`SpecTypeTestContextMember`.
    22882567
    22892568text
     
    22942573
    22952574* :ref:`SpecTypeActionRequirementCondition`
    2296 
    2297 .. _SpecTypeActionRequirementTestContextMember:
    2298 
    2299 Action Requirement Test Context Member
    2300 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2301 
    2302 A value of this type shall be of one of the following variants:
    2303 
    2304 * The value may be a set of attributes. This set of attributes defines an
    2305   action requirement test context member. All explicit attributes shall be
    2306   specified. The explicit attributes for this type are:
    2307 
    2308   brief
    2309       The attribute value shall be an optional string. It shall be the test
    2310       context member brief description.
    2311 
    2312   description
    2313       The attribute value shall be an optional string. It shall be the test
    2314       context member description.
    2315 
    2316   member
    2317       The attribute value shall be a string. It shall be the test context
    2318       member definition.  It shall be a valid C structure member definition
    2319       without a trailing ``;``.
    2320 
    2321 * There may by be no value (null).
    2322 
    2323 This type is used by the following types:
    2324 
    2325 * :ref:`SpecTypeActionRequirementItemType`
    2326 
    2327 .. _SpecTypeActionRequirementTestFixtureMethod:
    2328 
    2329 Action Requirement Test Fixture Method
    2330 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2331 
    2332 A value of this type shall be of one of the following variants:
    2333 
    2334 * The value may be a set of attributes. This set of attributes defines an
    2335   action requirement test fixture method. All explicit attributes shall be
    2336   specified. The explicit attributes for this type are:
    2337 
    2338   brief
    2339       The attribute value shall be an optional string. It shall be the test
    2340       fixture method brief description.
    2341 
    2342   code
    2343       The attribute value shall be a string. It shall be the test fixture
    2344       method code.  The code may use a local variable ``ctx`` which points to
    2345       the test context, see :ref:`SpecTypeActionRequirementTestContextMember`.
    2346 
    2347   description
    2348       The attribute value shall be an optional string. It shall be the test
    2349       fixture method description.
    2350 
    2351 * There may by be no value (null).
    2352 
    2353 This type is used by the following types:
    2354 
    2355 * :ref:`SpecTypeActionRequirementItemType`
    23562575
    23572576.. _SpecTypeActionRequirementTransition:
     
    39794198* :ref:`SpecTypeRequirementValidationLinkRole`
    39804199
     4200* :ref:`SpecTypeRuntimeMeasurementRequestLinkRole`
     4201
    39814202* :ref:`SpecTypeSpecificationMemberLinkRole`
    39824203
     
    40154236* :ref:`SpecTypeLink`
    40164237
     4238* :ref:`SpecTypeNonFunctionalRequirementItemType`
     4239
    40174240* :ref:`SpecTypeRequirementItemType`
    40184241
    40194242* :ref:`SpecTypeRootItemType`
     4243
     4244* :ref:`SpecTypeRuntimeMeasurementParameterSet`
     4245
     4246* :ref:`SpecTypeRuntimePerformanceParameterSet`
    40204247
    40214248* :ref:`SpecTypeSpecificationAttributeValue`
     
    40524279or a documentation section).
    40534280
    4054 .. _SpecTypeRequirementNonFunctionalType:
    4055 
    4056 Requirement Non-Functional Type
    4057 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    4058 
    4059 The value shall be a string. This type shall be used for non-functional
    4060 requirement types. The value shall be an element of
    4061 
    4062 * "``build-configuration``",
    4063 
    4064 * "``constraint``",
    4065 
    4066 * "``design``",
    4067 
    4068 * "``documentation``",
    4069 
    4070 * "``interface``",
    4071 
    4072 * "``interface-requirement``",
    4073 
    4074 * "``maintainability``",
    4075 
    4076 * "``performance``",
    4077 
    4078 * "``portability``",
    4079 
    4080 * "``quality``",
    4081 
    4082 * "``reliability``",
    4083 
    4084 * "``resource``", and
    4085 
    4086 * "``safety``".
    4087 
    4088 This type is used by the following types:
    4089 
    4090 * :ref:`SpecTypeNonFunctionalRequirementItemType`
    4091 
    40924281.. _SpecTypeRequirementReference:
    40934282
     
    43144503
    43154504* :ref:`SpecTypeRequirementValidationItemType`
     4505
     4506.. _SpecTypeRuntimeMeasurementEnvironment:
     4507
     4508Runtime Measurement Environment
     4509^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4510
     4511The value shall be a string. It specifies the runtime measurement environment.
     4512The value
     4513
     4514* shall be an element of
     4515
     4516  * "``FullCache``",
     4517
     4518  * "``HotCache``", and
     4519
     4520  * "``DirtyCache``",
     4521
     4522* or, shall match with the regular expression "``^Load/[1-9][0-9]*$``".
     4523
     4524This type is used by the following types:
     4525
     4526* :ref:`SpecTypeRuntimeMeasurementEnvironmentTable`
     4527
     4528.. _SpecTypeRuntimeMeasurementEnvironmentTable:
     4529
     4530Runtime Measurement Environment Table
     4531^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4532
     4533This set of attributes provides runtime performance limits for a set of runtime
     4534measurement environments. Generic attributes may be specified. Each generic
     4535attribute key shall be a :ref:`SpecTypeRuntimeMeasurementEnvironment`. Each
     4536generic attribute value shall be a :ref:`SpecTypeRuntimeMeasurementValueTable`.
     4537
     4538This type is used by the following types:
     4539
     4540* :ref:`SpecTypeRuntimePerformanceLimitTable`
     4541
     4542.. _SpecTypeRuntimeMeasurementParameterSet:
     4543
     4544Runtime Measurement Parameter Set
     4545^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4546
     4547This set of attributes defines parameters of the runtime measurement test case.
     4548All explicit attributes shall be specified. The explicit attributes for this
     4549type are:
     4550
     4551sample-count
     4552    The attribute value shall be an integer number. It shall be the sample
     4553    count of the runtime measurement context.
     4554
     4555In addition to the explicit attributes, generic attributes may be specified.
     4556Each generic attribute key shall be a :ref:`SpecTypeName`. The attribute value
     4557may have any type.
     4558
     4559This type is used by the following types:
     4560
     4561* :ref:`SpecTypeRuntimeMeasurementTestItemType`
     4562
     4563.. _SpecTypeRuntimeMeasurementRequestLinkRole:
     4564
     4565Runtime Measurement Request Link Role
     4566^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4567
     4568This type refines the :ref:`SpecTypeLink` through the ``role`` attribute if the
     4569value is ``runtime-measurement-request``. It defines the runtime measurement
     4570request role of links.  The link target shall be a
     4571:ref:`SpecTypeRuntimeMeasurementTestItemType` item.
     4572
     4573.. _SpecTypeRuntimeMeasurementValueKind:
     4574
     4575Runtime Measurement Value Kind
     4576^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4577
     4578The value shall be a string. It specifies the kind of a runtime measurement
     4579value. The value shall be an element of
     4580
     4581* "``max-lower-bound``",
     4582
     4583* "``max-upper-bound``",
     4584
     4585* "``mean-lower-bound``",
     4586
     4587* "``mean-upper-bound``",
     4588
     4589* "``min-lower-bound``", and
     4590
     4591* "``min-upper-bound``".
     4592
     4593This type is used by the following types:
     4594
     4595* :ref:`SpecTypeRuntimeMeasurementValueTable`
     4596
     4597.. _SpecTypeRuntimeMeasurementValueTable:
     4598
     4599Runtime Measurement Value Table
     4600^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4601
     4602This set of attributes provides a set of runtime measurement values each of a
     4603specified kind.  The unit of the values shall be one second. Generic attributes
     4604may be specified. Each generic attribute key shall be a
     4605:ref:`SpecTypeRuntimeMeasurementValueKind`. Each generic attribute value shall
     4606be a floating-point number.
     4607
     4608This type is used by the following types:
     4609
     4610* :ref:`SpecTypeRuntimeMeasurementEnvironmentTable`
     4611
     4612.. _SpecTypeRuntimePerformanceLimitTable:
     4613
     4614Runtime Performance Limit Table
     4615^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4616
     4617This set of attributes provides runtime performance limits for BSP variants
     4618specified by ``"<arch>/<bsp>"`` with <arch> being the architecture of the BSP
     4619and <bsp> being the base name of the BSP. Generic attributes may be specified.
     4620Each generic attribute key shall be a string. Each generic attribute value
     4621shall be a :ref:`SpecTypeRuntimeMeasurementEnvironmentTable`.
     4622
     4623This type is used by the following types:
     4624
     4625* :ref:`SpecTypeRuntimePerformanceRequirementItemType`
     4626
     4627.. _SpecTypeRuntimePerformanceParameterSet:
     4628
     4629Runtime Performance Parameter Set
     4630^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     4631
     4632This set of attributes defines parameters of the runtime performance
     4633requirement. Generic attributes may be specified. Each generic attribute key
     4634shall be a :ref:`SpecTypeName`. The attribute value may have any type.
     4635
     4636This type is used by the following types:
     4637
     4638* :ref:`SpecTypeRuntimePerformanceRequirementItemType`
    43164639
    43174640.. _SpecTypeSPDXLicenseIdentifier:
     
    49345257* :ref:`SpecTypeTestCaseAction`
    49355258
     5259.. _SpecTypeTestContextMember:
     5260
     5261Test Context Member
     5262^^^^^^^^^^^^^^^^^^^
     5263
     5264A value of this type shall be of one of the following variants:
     5265
     5266* The value may be a set of attributes. This set of attributes defines an
     5267  action requirement test context member. All explicit attributes shall be
     5268  specified. The explicit attributes for this type are:
     5269
     5270  brief
     5271      The attribute value shall be an optional string. It shall be the test
     5272      context member brief description.
     5273
     5274  description
     5275      The attribute value shall be an optional string. It shall be the test
     5276      context member description.
     5277
     5278  member
     5279      The attribute value shall be a string. It shall be the test context
     5280      member definition.  It shall be a valid C structure member definition
     5281      without a trailing ``;``.
     5282
     5283* There may by be no value (null).
     5284
     5285This type is used by the following types:
     5286
     5287* :ref:`SpecTypeActionRequirementItemType`
     5288
     5289* :ref:`SpecTypeRuntimeMeasurementTestItemType`
     5290
    49365291.. _SpecTypeTestHeader:
    49375292
     
    49885343this parameter is used in an :ref:`SpecTypeActionRequirementItemType` item,
    49895344then the parameter is also added as a member to the test context, see
    4990 :ref:`SpecTypeActionRequirementTestContextMember`. All explicit attributes
    4991 shall be specified. The explicit attributes for this type are:
     5345:ref:`SpecTypeTestContextMember`. All explicit attributes shall be specified.
     5346The explicit attributes for this type are:
    49925347
    49935348description
     
    50105365* :ref:`SpecTypeTestHeader`
    50115366
     5367.. _SpecTypeTestSupportMethod:
     5368
     5369Test Support Method
     5370^^^^^^^^^^^^^^^^^^^
     5371
     5372A value of this type shall be of one of the following variants:
     5373
     5374* The value may be a set of attributes. This set of attributes defines an
     5375  action requirement test support method. All explicit attributes shall be
     5376  specified. The explicit attributes for this type are:
     5377
     5378  brief
     5379      The attribute value shall be an optional string. It shall be the test
     5380      support method brief description.
     5381
     5382  code
     5383      The attribute value shall be a string. It shall be the test support
     5384      method code.  The code may use a local variable ``ctx`` which points to
     5385      the test context, see :ref:`SpecTypeTestContextMember`.
     5386
     5387  description
     5388      The attribute value shall be an optional string. It shall be the test
     5389      support method description.
     5390
     5391* There may by be no value (null).
     5392
     5393This type is used by the following types:
     5394
     5395* :ref:`SpecTypeActionRequirementItemType`
     5396
     5397* :ref:`SpecTypeRuntimeMeasurementTestItemType`
     5398
     5399* :ref:`SpecTypeRuntimePerformanceRequirementItemType`
     5400
    50125401.. _SpecTypeUID:
    50135402
Note: See TracChangeset for help on using the changeset viewer.