mirror of
https://github.com/status-im/OpenXR-Docs.git
synced 2026-08-31 09:41:13 +00:00
Ryan Pavlik
4522df7189
Patch release for the 1.0 series. Updates version to 1.0.2. ### Public issues - Pull request #30 - Fix parameter name typo in XR_MSFT_spatial_anchor ### Internal issues - Enhance xml_consistency script. (Internal MR 1526) - Sync scripts from Vulkan. (Internal MR 1514) - Port the equivalent of Vulkan's internal MR 3319 to OpenXR, affecting empty bitmask generated implicit valid usage. (Internal MR 1513) - Fix error in extension-added function. (Internal MR 1510) - Add Oculus Android extension. (Internal MR 1518) - Reserve additional extension number for Oculus. (Internal MR 1517)
465 lines
20 KiB
Python
Executable File
465 lines
20 KiB
Python
Executable File
#!/usr/bin/python3
|
|
#
|
|
# Copyright (c) 2019 Collabora, Ltd.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
# Author(s): Ryan Pavlik <ryan.pavlik@collabora.com>
|
|
#
|
|
# Purpose: This script checks some "business logic" in the XML registry.
|
|
|
|
import re
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
from check_spec_links import XREntityDatabase as OrigEntityDatabase
|
|
from reg import Registry
|
|
from spec_tools.attributes import LengthEntry
|
|
from spec_tools.consistency_tools import XMLChecker
|
|
from spec_tools.util import findNamedElem, getElemName, getElemType
|
|
from xrconventions import OpenXRConventions as APIConventions
|
|
|
|
INVALID_HANDLE = "XR_ERROR_HANDLE_INVALID"
|
|
UNSUPPORTED = "XR_ERROR_FUNCTION_UNSUPPORTED"
|
|
TWO_CALL_STRING_NAME = "buffer"
|
|
|
|
CAPACITY_INPUT_RE = re.compile(r'(?P<itemname>[a-z]*)CapacityInput')
|
|
COUNT_OUTPUT_RE = re.compile(r'(?P<itemname>[a-z]*)CountOutput')
|
|
|
|
|
|
def get_extension_commands(reg):
|
|
extension_cmds = set()
|
|
for ext in reg.extensions:
|
|
for cmd in ext.findall("./require/command[@name]"):
|
|
extension_cmds.add(cmd.get("name"))
|
|
return extension_cmds
|
|
|
|
|
|
def get_enum_value_names(reg, enum_type):
|
|
names = set()
|
|
result_elem = reg.groupdict[enum_type].elem
|
|
for val in result_elem.findall("./enum[@name]"):
|
|
names.add(val.get("name"))
|
|
return names
|
|
|
|
|
|
DESTROY_PREFIX = "xrDestroy"
|
|
TYPEENUM = "XrStructureType"
|
|
|
|
SPECIFICATION_DIR = Path(__file__).parent.parent
|
|
|
|
EXT_DECOMPOSE_RE = re.compile(r'XR_(?P<tag>[A-Z]+)_(?P<name>[\w_]+)')
|
|
REVISION_RE = re.compile(r' *[*] Revision (?P<num>[1-9][0-9]*),.*')
|
|
|
|
|
|
def get_extension_source(extname):
|
|
match = EXT_DECOMPOSE_RE.match(extname)
|
|
if not match:
|
|
raise RuntimeError("Could not decompose " + extname)
|
|
|
|
lower_tag = match.group('tag').lower()
|
|
lower_name = match.group('name').lower()
|
|
fn = '{}_{}.adoc'.format(lower_tag, lower_name)
|
|
return str(SPECIFICATION_DIR / 'sources' / 'chapters' / 'extensions' / lower_tag / fn)
|
|
|
|
|
|
def pluralize(s):
|
|
if s.endswith('y'):
|
|
return s[:-1] + 'ies'
|
|
return s + 's'
|
|
|
|
|
|
class EntityDatabase(OrigEntityDatabase):
|
|
|
|
def makeRegistry(self):
|
|
try:
|
|
import lxml.etree as etree
|
|
HAS_LXML = True
|
|
except ImportError:
|
|
HAS_LXML = False
|
|
if not HAS_LXML:
|
|
return super().makeRegistry()
|
|
|
|
registryFile = str(SPECIFICATION_DIR / 'registry/xr.xml')
|
|
registry = Registry()
|
|
registry.filename = registryFile
|
|
registry.loadElementTree(etree.parse(registryFile))
|
|
return registry
|
|
|
|
|
|
class Checker(XMLChecker):
|
|
def __init__(self):
|
|
manual_types_to_codes = {
|
|
# These are hard-coded "manual" return codes:
|
|
# the codes of the value (string, list, or tuple)
|
|
# are available for a command if-and-only-if
|
|
# the key type is passed as an input.
|
|
"XrSystemId": "XR_ERROR_SYSTEM_INVALID",
|
|
"XrFormFactor": ("XR_ERROR_FORM_FACTOR_UNSUPPORTED",
|
|
"XR_ERROR_FORM_FACTOR_UNAVAILABLE"),
|
|
"XrInstance": ("XR_ERROR_INSTANCE_LOST"),
|
|
"XrSession":
|
|
("XR_ERROR_SESSION_LOST", "XR_SESSION_LOSS_PENDING"),
|
|
"XrPosef":
|
|
"XR_ERROR_POSE_INVALID",
|
|
"XrViewConfigurationType":
|
|
"XR_ERROR_VIEW_CONFIGURATION_TYPE_UNSUPPORTED",
|
|
"XrEnvironmentBlendMode":
|
|
"XR_ERROR_ENVIRONMENT_BLEND_MODE_UNSUPPORTED",
|
|
"XrCompositionLayerBaseHeader": ("XR_ERROR_LAYER_INVALID"),
|
|
"XrPath": ("XR_ERROR_PATH_INVALID", "XR_ERROR_PATH_UNSUPPORTED"),
|
|
"XrTime": "XR_ERROR_TIME_INVALID"
|
|
}
|
|
forward_only = {
|
|
# Like the above, but these are only valid in the
|
|
# "type implies return code" direction
|
|
}
|
|
reverse_only = {
|
|
# like the above, but these are only valid in the
|
|
# "return code implies type or its descendant" direction
|
|
"XrSession": ("XR_ERROR_SESSION_RUNNING",
|
|
"XR_ERROR_SESSION_NOT_RUNNING",
|
|
"XR_ERROR_SESSION_NOT_READY",
|
|
"XR_ERROR_SESSION_NOT_STOPPING",
|
|
"XR_SESSION_NOT_FOCUSED",
|
|
"XR_FRAME_DISCARDED"),
|
|
"XrReferenceSpaceType": "XR_SPACE_BOUNDS_UNAVAILABLE",
|
|
"XrDuration": "XR_TIMEOUT_EXPIRED"
|
|
}
|
|
|
|
# Some return codes are related in that only one of a set
|
|
# may be returned by a command
|
|
# (eg. XR_ERROR_SESSION_RUNNING and XR_ERROR_SESSION_NOT_RUNNING)
|
|
self.exclusive_return_code_sets = (
|
|
set(("XR_ERROR_SESSION_NOT_RUNNING", "XR_ERROR_SESSION_RUNNING")),
|
|
)
|
|
|
|
# Keys are entity names, values are tuples or lists of message text to suppress.
|
|
suppressions = {
|
|
# path to string can take any path
|
|
"xrPathToString": ("Missing expected return code(s) XR_ERROR_PATH_UNSUPPORTED implied because of input of type XrPath",)
|
|
}
|
|
|
|
conventions = APIConventions()
|
|
db = EntityDatabase()
|
|
|
|
self.extension_cmds = get_extension_commands(db.registry)
|
|
self.return_codes = get_enum_value_names(db.registry, 'XrResult')
|
|
self.structure_types = get_enum_value_names(db.registry, TYPEENUM)
|
|
|
|
# Initialize superclass
|
|
super().__init__(entity_db=db, conventions=conventions,
|
|
manual_types_to_codes=manual_types_to_codes,
|
|
forward_only_types_to_codes=forward_only,
|
|
reverse_only_types_to_codes=reverse_only,
|
|
suppressions=suppressions)
|
|
|
|
def add_extra_codes(self, types_to_codes):
|
|
"""Add any desired entries to the types-to-codes DictOfStringSets
|
|
before performing "ancestor propagation".
|
|
|
|
Passed to compute_type_to_codes as the extra_op."""
|
|
# All handle types can result in an invalid handle error.
|
|
for type_name in self.handle_data.handle_types:
|
|
types_to_codes.add(type_name, INVALID_HANDLE)
|
|
|
|
def get_codes_for_command_and_type(self, cmd_name, type_name):
|
|
"""Return a set of error codes expected due to having
|
|
an input argument of type type_name."""
|
|
codes = super().get_codes_for_command_and_type(cmd_name, type_name)
|
|
|
|
# Filter out any based on the specific command
|
|
if cmd_name.startswith(DESTROY_PREFIX):
|
|
# xrDestroyX can't return XR_ERROR_X_LOST or XR_X_LOSS_PENDING
|
|
# (right?)
|
|
handle = cmd_name[len(DESTROY_PREFIX):].upper()
|
|
codes = codes.copy()
|
|
codes.discard("XR_ERROR_{}_LOST".format(handle))
|
|
codes.discard("XR_{}_LOSS_PENDING".format(handle))
|
|
return codes
|
|
|
|
def check_command_return_codes_basic(self, name, info,
|
|
successcodes, errorcodes):
|
|
"""Check a command's return codes for consistency.
|
|
|
|
Called on every command."""
|
|
# Check that all extension commands can return the code associated
|
|
# with trying to use an extension that wasn't enabled.
|
|
if name in self.extension_cmds and UNSUPPORTED not in errorcodes:
|
|
self.record_error("Missing expected return code",
|
|
UNSUPPORTED,
|
|
"implied due to being an extension command")
|
|
|
|
codes = successcodes.union(errorcodes)
|
|
|
|
# Check that all return codes are recognized.
|
|
unrecognized = codes - self.return_codes
|
|
if unrecognized:
|
|
self.record_error("Unrecognized return code(s):",
|
|
unrecognized)
|
|
|
|
for exclusive_set in self.exclusive_return_code_sets:
|
|
specified_exclusives = exclusive_set.intersection(codes)
|
|
if len(specified_exclusives) > 1:
|
|
self.record_error(
|
|
"Mutually-exclusive return codes specified:",
|
|
specified_exclusives)
|
|
|
|
def check_two_call_capacity_input(self, param_name, param_elem, match):
|
|
"""Check a two-call-idiom command's CapacityInput parameter."""
|
|
param_type = getElemType(param_elem)
|
|
if param_type != 'uint32_t':
|
|
self.record_error('Two-call-idiom call has capacity parameter', param_name,
|
|
'with type', param_type, 'instead of uint32_t')
|
|
optional = param_elem.get('optional')
|
|
if optional != 'true':
|
|
self.record_error('Two-call-idiom call capacity parameter has incorrect "optional" attribute',
|
|
optional, '- expected "true"')
|
|
|
|
prefix = match.group('itemname')
|
|
if prefix.endswith('s'):
|
|
self.record_error('"Item name" part of capacity input parameter name appears to be plural:', prefix)
|
|
|
|
def check_two_call_count_output(self, param_name, param_elem, match):
|
|
"""Check a two-call-idiom command's CountOutput parameter."""
|
|
param_type = getElemType(param_elem)
|
|
if param_type != 'uint32_t':
|
|
self.record_error('Two-call-idiom call has count parameter', param_name,
|
|
'with type', param_type, 'instead of uint32_t')
|
|
type_elem = param_elem.find('type')
|
|
assert(type_elem is not None)
|
|
|
|
tail = type_elem.tail.strip()
|
|
if '*' != tail:
|
|
self.record_error('Two-call-idiom call has count parameter', param_name,
|
|
'that is not a pointer:', type_elem.text, type_elem.tail)
|
|
|
|
optional = param_elem.get('optional')
|
|
if optional is not None:
|
|
self.record_error('Two-call-idiom call count parameter has "optional" attribute, when none should be present:',
|
|
optional)
|
|
|
|
prefix = match.group('itemname')
|
|
if prefix.endswith('s'):
|
|
self.record_error('"Item name" part of count output parameter name appears to be plural:', prefix)
|
|
|
|
def check_two_call_array(self, param_name, param_elem, match):
|
|
"""Check a two-call-idiom command's array output parameter."""
|
|
optional = param_elem.get('optional')
|
|
if optional != 'true':
|
|
self.record_error('Two-call-idiom call array parameter has incorrect "optional" attribute',
|
|
optional, '- expected "true"')
|
|
|
|
type_elem = param_elem.find('type')
|
|
assert(type_elem is not None)
|
|
|
|
tail = type_elem.tail.strip()
|
|
if '*' not in tail:
|
|
self.record_error('Two-call-idiom call has array parameter', param_name,
|
|
'that is not a pointer:', type_elem.text, type_elem.tail)
|
|
|
|
length = LengthEntry.parse_len_from_param(param_elem)
|
|
if not length[0].other_param_name:
|
|
self.record_error('Two-call-idiom call has array parameter', param_name,
|
|
'whose first length is not another parameter:', length[0])
|
|
|
|
# Only valid reason to have more than 1 comma-separated entry in len is for strings,
|
|
# which are named "buffer".
|
|
if len(length) > 2:
|
|
self.record_error('Two-call-idiom call has array parameter', param_name,
|
|
'with too many lengths - should be 1 or 2 comma-separated lengths, not', len(length))
|
|
if len(length) == 2:
|
|
if not length[1].null_terminated:
|
|
self.record_error('Two-call-idiom call has two-length array parameter', param_name,
|
|
'whose second length is not "null-terminated":', length[1])
|
|
|
|
param_type = getElemType(param_elem)
|
|
if param_type != 'char':
|
|
self.record_error('Two-call-idiom call has two-length array parameter', param_name,
|
|
'that is not a string:', param_type)
|
|
|
|
if param_name != TWO_CALL_STRING_NAME:
|
|
self.record_error('Two-call-idiom call has two-length array parameter', param_name,
|
|
'that is not named "buffer"')
|
|
|
|
def check_two_call_command(self, name, info, params):
|
|
"""Check a two-call-idiom command."""
|
|
named_params = [(getElemName(p), p) for p in params]
|
|
|
|
# Find the three important parameters
|
|
capacity_input_param_name = None
|
|
capacity_input_param_match = None
|
|
count_output_param_name = None
|
|
count_output_param_match = None
|
|
array_param_name = None
|
|
for param_name, param_elem in named_params:
|
|
match = CAPACITY_INPUT_RE.match(param_name)
|
|
if match:
|
|
capacity_input_param_name = param_name
|
|
capacity_input_param_match = match
|
|
self.check_two_call_capacity_input(param_name, param_elem, match)
|
|
continue
|
|
match = COUNT_OUTPUT_RE.match(param_name)
|
|
if match:
|
|
count_output_param_name = param_name
|
|
count_output_param_match = match
|
|
self.check_two_call_count_output(param_name, param_elem, match)
|
|
continue
|
|
|
|
# Try detecting the output array using its length field
|
|
if capacity_input_param_name:
|
|
length = LengthEntry.parse_len_from_param(param_elem)
|
|
if length and length[0].other_param_name == capacity_input_param_name:
|
|
array_param_name = param_name
|
|
|
|
if not capacity_input_param_name:
|
|
self.record_error('Apparent two-call-idiom call missing a *CapacityInput parameter')
|
|
|
|
if not count_output_param_name:
|
|
self.record_error('Apparent two-call-idiom call missing a *CountOutput parameter')
|
|
|
|
if not array_param_name:
|
|
self.record_error('Apparent two-call-idiom call missing an array output parameter')
|
|
|
|
if not capacity_input_param_name or \
|
|
not count_output_param_name or \
|
|
not array_param_name:
|
|
# If we're missing at least one, stop checking two-call stuff here.
|
|
return
|
|
|
|
input_prefix = capacity_input_param_match.group('itemname')
|
|
output_prefix = count_output_param_match.group('itemname')
|
|
if input_prefix != output_prefix:
|
|
self.record_error('Two-call-idiom call has "item name" prefixes for input and output names that mismatch:',
|
|
input_prefix, output_prefix)
|
|
|
|
# If not a "buffer", pluralize the item name for the array name.
|
|
if input_prefix == TWO_CALL_STRING_NAME and output_prefix == TWO_CALL_STRING_NAME:
|
|
expected_array_name = TWO_CALL_STRING_NAME
|
|
else:
|
|
expected_array_name = pluralize(input_prefix)
|
|
|
|
if expected_array_name != array_param_name:
|
|
self.record_error('Two-call-idiom call has array parameter with unexpected name: expected',
|
|
expected_array_name, 'got', array_param_name)
|
|
# TODO check order: all other params, then capacity input, count output, and array
|
|
|
|
def check_command(self, name, info):
|
|
"""Check a command's XML data for consistency.
|
|
|
|
Called from check."""
|
|
t = info.elem.find('proto/type')
|
|
if t is None:
|
|
self.record_warning("Got a command without a return type?")
|
|
else:
|
|
return_type = t.text
|
|
if return_type != 'XrResult':
|
|
self.record_error("Got a function that returned", return_type,
|
|
"instead of XrResult - some scripts/software assume all functions return XrResult!")
|
|
params = info.elem.findall('./param')
|
|
for p in params:
|
|
param_name = getElemName(p)
|
|
if COUNT_OUTPUT_RE.match(param_name) or CAPACITY_INPUT_RE.match(param_name):
|
|
self.check_two_call_command(name, info, params)
|
|
break
|
|
super().check_command(name, info)
|
|
|
|
def check_type(self, name, info, category):
|
|
"""Check a type's XML data for consistency.
|
|
|
|
Called from check."""
|
|
|
|
elem = info.elem
|
|
type_elts = [elt
|
|
for elt in elem.findall("member")
|
|
if getElemType(elt) == TYPEENUM]
|
|
if category == 'struct' and type_elts:
|
|
if len(type_elts) > 1:
|
|
self.record_error(
|
|
"Have more than one member of type", TYPEENUM)
|
|
else:
|
|
type_elt = type_elts[0]
|
|
val = type_elt.get('values')
|
|
if val and val not in self.structure_types:
|
|
self.record_error("Unknown structure type constant", val)
|
|
elif category == "bitmask":
|
|
if 'Flags' in name:
|
|
expected_bitvalues = name.replace('Flags', 'FlagBits')
|
|
bitvalues = info.elem.get('bitvalues')
|
|
if expected_bitvalues != bitvalues:
|
|
self.record_error("Unexpected bitvalues attribute value:",
|
|
"got", bitvalues,
|
|
"but expected", expected_bitvalues)
|
|
super().check_type(name, info, category)
|
|
|
|
def check_extension(self, name, info):
|
|
"""Check an extension's XML data for consistency.
|
|
|
|
Called from check."""
|
|
elem = info.elem
|
|
name_upper = name.upper()
|
|
version_name = "{}_SPEC_VERSION".format(name)
|
|
enums = elem.findall('./require/enum[@name]')
|
|
version_elem = findNamedElem(enums, version_name)
|
|
if version_elem is None:
|
|
self.record_error("Missing version enum", version_name)
|
|
else:
|
|
fn = get_extension_source(name)
|
|
revisions = []
|
|
try:
|
|
with open(fn, 'r', encoding='utf-8') as fp:
|
|
for line in fp:
|
|
line = line.rstrip()
|
|
match = REVISION_RE.match(line)
|
|
if match:
|
|
revisions.append(int(match.group('num')))
|
|
ver_from_xml = version_elem.get('value')
|
|
if revisions:
|
|
ver_from_text = str(max(revisions))
|
|
if ver_from_xml != ver_from_text:
|
|
self.record_error("Version enum mismatch: spec text indicates", ver_from_text,
|
|
"but XML says", ver_from_xml)
|
|
else:
|
|
if ver_from_xml == '1':
|
|
self.record_warning(
|
|
"Cannot find version history in spec text - make sure it has lines starting exactly like '* Revision 1, ....'",
|
|
filename=fn)
|
|
else:
|
|
self.record_error("Cannot find version history in spec text, but XML reports a non-1 version number", ver_from_xml,
|
|
" - make sure the spec text has lines starting exactly like '* Revision 1, ....'",
|
|
filename=fn)
|
|
except FileNotFoundError:
|
|
# This is OK: just means we can't check against the spec text.
|
|
pass
|
|
|
|
name_define = "{}_EXTENSION_NAME".format(name_upper)
|
|
name_elem = findNamedElem(enums, name_define)
|
|
if name_elem is None:
|
|
self.record_error("Missing name enum", name_define)
|
|
else:
|
|
# Note: etree handles the XML entities here and turns " back into "
|
|
expected_name = '"{}"'.format(name)
|
|
name_val = name_elem.get('value')
|
|
if name_val != expected_name:
|
|
self.record_error("Incorrect name enum: expected", expected_name,
|
|
"got", name_val)
|
|
|
|
super().check_extension(name, elem)
|
|
|
|
|
|
ckr = Checker()
|
|
ckr.check()
|
|
|
|
if ckr.fail:
|
|
sys.exit(1)
|