82587ce71b
This patch includes several changes to the gem5 tools interface to the gem5-resources infrastructure. These are: * The old download and JSON query functions have been removed from the downloader module. These functions were used for directly downloading and inspecting the resource JSON file, hosted at https://resources.gem5.org/resources. This information is now obtained via `gem5.client`. If a resources JSON file is specified as a client, it should conform to the new schema: https//resources.gem5.org/gem5-resources-schema.json. The old schema (pre-v23.0) is no longer valid. Tests have been updated to reflect this change. Those which tested these old functions have been removed. * Unused imports have been removed. * For the resource query functions, and those tasked with obtaining the resources, the parameter `gem5_version` has been added. In all cases it does the same thing: * It will filter results based on compatibility to the `gem5_version` specified. If no resources are compatible the latest version of that resource is chosen (though a warning is thrown). * By default it is set to the current gem5 version. * It is optional. If `None`, this filtering functionality is not carried out. * Tests have been updated to fix the version to “develop” so the they do not break between versions. * The `gem5_version` parameters will filter using a logic which will base compatibility on the specificity of the gem5-version specified in a resource’s data. If a resource has a compatible gem5-version of “v18.4” it will be compatible with any minor/hotfix version within the v18.4 release (this can be seen as matching on “v18.4.*.*”.) Likewise, if a resource has a compatible gem5-version of “v18.4.1” then it’s only compatible with the v18.4.1 release but any of it’s hot fix releases (“v18.4.1.*”). * The ‘list_resources’ function has been updated to use the “gem5.client” APIs to get resource information from the clients (MongoDB or a JSON file). This has been designed to remain backwards compatible to as much as is possible, though, due to schema changes, the function does search across all versions of gem5. * `get_resources` function was added to the `AbstractClient`. This is a more general function than `get_resource_by_id`. It was primarily created to handle the `list_resources` update but is a useful update to the API. The `get_resource_by_id` function has been altered to function as a wrapped to the `get_resources` function. * Removed “GEM5_RESOURCE_JSON” code has been removed. This is no longer used. * Tests have been cleaned up a little bit to be easier to read. * Some docstrings have been updated. Things that are left TODO with this code: * The client_wrapper/client/abstract_client abstractions are rather pointless. In particular the client_wrapper and client classes could be merged. * The downloader module no longer does much and should have its functions merged into other modules. * With the addition of the `get_resources` function, much of the code in the `AbstractClient` could be simplified. Change-Id: I0ce48e88b93a2b9db53d4749861fa0b5f9472053 Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/71506 Reviewed-by: Kunal Pai <kunpai@ucdavis.edu> Maintainer: Jason Lowe-Power <power.jg@gmail.com> Tested-by: kokoro <noreply+kokoro@google.com>
89 lines
3.6 KiB
Python
89 lines
3.6 KiB
Python
# Copyright (c) 2023 The Regents of the University of California
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without
|
|
# modification, are permitted provided that the following conditions are
|
|
# met: redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer;
|
|
# redistributions in binary form must reproduce the above copyright
|
|
# notice, this list of conditions and the following disclaimer in the
|
|
# documentation and/or other materials provided with the distribution;
|
|
# neither the name of the copyright holders nor the names of its
|
|
# contributors may be used to endorse or promote products derived from
|
|
# this software without specific prior written permission.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
import json
|
|
from pathlib import Path
|
|
from urllib import request
|
|
from typing import Optional, Dict, Union, Type, Tuple, List, Any
|
|
from .abstract_client import AbstractClient
|
|
from urllib.error import URLError
|
|
from m5.util import warn
|
|
|
|
|
|
class JSONClient(AbstractClient):
|
|
def __init__(self, path: str):
|
|
"""
|
|
Initializes a JSON client.
|
|
:param path: The path to the Resource, either URL or local.
|
|
"""
|
|
self.path = path
|
|
self.resources = []
|
|
|
|
if Path(self.path).is_file():
|
|
self.resources = json.load(open(self.path))
|
|
elif not self._url_validator(self.path):
|
|
raise Exception(
|
|
f"Resources location '{self.path}' is not a valid path or URL."
|
|
)
|
|
else:
|
|
req = request.Request(self.path)
|
|
try:
|
|
response = request.urlopen(req)
|
|
except URLError as e:
|
|
raise Exception(
|
|
f"Unable to open Resources location '{self.path}': {e}"
|
|
)
|
|
self.resources = json.loads(response.read().decode("utf-8"))
|
|
|
|
def get_resources_json(self) -> List[Dict[str, Any]]:
|
|
"""Returns a JSON representation of the resources."""
|
|
return self.resources
|
|
|
|
def get_resources(
|
|
self,
|
|
resource_id: Optional[str] = None,
|
|
resource_version: Optional[str] = None,
|
|
gem5_version: Optional[str] = None,
|
|
) -> List[Dict[str, Any]]:
|
|
filter = self.resources # Unfiltered.
|
|
if resource_id:
|
|
filter = [ # Filter by resource_id.
|
|
resource
|
|
for resource in filter
|
|
if resource["id"] == resource_id
|
|
]
|
|
if resource_version:
|
|
filter = [ # Filter by resource_version.
|
|
resource
|
|
for resource in filter
|
|
if resource["resource_version"] == resource_version
|
|
]
|
|
|
|
# Filter by gem5_version.
|
|
return self.filter_incompatible_resources(
|
|
resources_to_filter=filter, gem5_version=gem5_version
|
|
)
|