Skip to content

Commit f6f8c92

Browse files
committed
Refactoring framework with C++
1 parent 8d8c382 commit f6f8c92

25 files changed

+10058
-4185
lines changed

.vscode/c_cpp_properties.json

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"configurations": [
3+
{
4+
"name": "Linux",
5+
"includePath": [
6+
"/usr/include/**",
7+
"${workspaceFolder}/**",
8+
],
9+
"defines": [],
10+
"compilerPath": "/usr/bin/gcc",
11+
"cStandard": "c17",
12+
"cppStandard": "c++14",
13+
"intelliSenseMode": "linux-gcc-x64",
14+
"browse": {
15+
"path": ["${workspaceFolder}"],
16+
"limitSymbolsToIncludedHeaders": true,
17+
"databaseFilename": "${workspaceFolder}/.vscode/vc.db"
18+
}
19+
}
20+
],
21+
"version": 4
22+
}

.vscode/settings.json

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"files.associations": {
3+
"array": "cpp",
4+
"bitset": "cpp",
5+
"string_view": "cpp",
6+
"format": "cpp",
7+
"initializer_list": "cpp",
8+
"span": "cpp",
9+
"atomic": "cpp",
10+
"bit": "cpp",
11+
"*.tcc": "cpp",
12+
"cctype": "cpp",
13+
"charconv": "cpp",
14+
"clocale": "cpp",
15+
"cmath": "cpp",
16+
"compare": "cpp",
17+
"concepts": "cpp",
18+
"cstdarg": "cpp",
19+
"cstddef": "cpp",
20+
"cstdint": "cpp",
21+
"cstdio": "cpp",
22+
"cstdlib": "cpp",
23+
"ctime": "cpp",
24+
"cwchar": "cpp",
25+
"cwctype": "cpp",
26+
"deque": "cpp",
27+
"string": "cpp",
28+
"unordered_map": "cpp",
29+
"vector": "cpp",
30+
"exception": "cpp",
31+
"algorithm": "cpp",
32+
"functional": "cpp",
33+
"iterator": "cpp",
34+
"memory": "cpp",
35+
"memory_resource": "cpp",
36+
"numeric": "cpp",
37+
"optional": "cpp",
38+
"random": "cpp",
39+
"system_error": "cpp",
40+
"tuple": "cpp",
41+
"type_traits": "cpp",
42+
"utility": "cpp",
43+
"iosfwd": "cpp",
44+
"iostream": "cpp",
45+
"istream": "cpp",
46+
"limits": "cpp",
47+
"new": "cpp",
48+
"numbers": "cpp",
49+
"ostream": "cpp",
50+
"stdexcept": "cpp",
51+
"streambuf": "cpp",
52+
"text_encoding": "cpp",
53+
"cinttypes": "cpp",
54+
"typeinfo": "cpp",
55+
"variant": "cpp"
56+
}
57+
}

CMakeLists.txt

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
#// Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
2+
#// SPDX-License-Identifier: BSD-3-Clause-Clear
3+
4+
cmake_minimum_required(VERSION 3.21.1)
5+
project(plugins)
6+
7+
string(TOUPPER "${CMAKE_BUILD_TARGET_ARCH}" BUILD_TARGET_ARCH)
8+
add_definitions(-D${BUILD_TARGET_ARCH})
9+
add_definitions(-D__LITTLE_ENDIAN)
10+
set(CMAKE_CXX_STANDARD 14)
11+
set(CMAKE_CXX_STANDARD_REQUIRED True)
12+
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -rdynamic -Wall")
13+
14+
include_directories(.)
15+
include_directories(lib)
16+
17+
set(PLUGIN_SOURCES
18+
plugin.cpp
19+
logger/log.cpp)
20+
21+
if (CMAKE_BUILD_TARGET_ARCH STREQUAL "arm64")
22+
list(APPEND PLUGIN_SOURCES
23+
pagetable/arm/pagetable64.cpp)
24+
elseif(CMAKE_BUILD_TARGET_ARCH STREQUAL "arm")
25+
list(APPEND PLUGIN_SOURCES
26+
pagetable/arm/pagetable32.cpp)
27+
endif()
28+
29+
if(DEFINED BUILD_TARGET_TOGETHER)
30+
add_definitions(-DBUILD_TARGET_TOGETHER)
31+
list(APPEND PLUGIN_SOURCES
32+
plugins.cpp)
33+
add_library(plugins SHARED ${PLUGIN_SOURCES})
34+
set_target_properties(plugins PROPERTIES PREFIX "")
35+
else()
36+
# TODO
37+
endif()

CODE-OF-CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[GitHub.QuIC.CoC](mailto:[email protected]?subject=GitHub%20QuIC%20Code%20of%20Conduct%20Report).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
## Contributing to <REPLACE-ME>
2+
3+
Hi there!
4+
We’re thrilled that you’d like to contribute to this project.
5+
Your help is essential for keeping this project great and for making it better.
6+
7+
## Branching Strategy
8+
9+
In general, contributors should develop on branches based off of `main` and pull requests should be made against `main`.
10+
11+
## Submitting a pull request
12+
13+
1. Please read our [code of conduct](CODE-OF-CONDUCT.md] and [license](LICENSE.txt).
14+
1. [Fork](https://github.com/quic/<REPLACE-ME>/fork) and clone the repository.
15+
16+
```bash
17+
git clone https://github.com/<username>/<REPLACE-ME>.git
18+
```
19+
20+
1. Create a new branch based on `main`:
21+
22+
```bash
23+
git checkout -b <my-branch-name> main
24+
```
25+
26+
1. Create an upstream `remote` to make it easier to keep your branches up-to-date:
27+
28+
```bash
29+
git remote add upstream https://github.com/quic/<REPLACE-ME>.git
30+
```
31+
32+
1. Make your changes, add tests, and make sure the tests still pass.
33+
1. Commit your changes using the [DCO](http://developercertificate.org/). You can attest to the DCO by commiting with the **-s** or **--signoff** options or manually adding the "Signed-off-by":
34+
35+
```bash
36+
git commit -s -m "Really useful commit message"`
37+
```
38+
39+
1. After committing your changes on the topic branch, sync it with the upstream branch:
40+
41+
```bash
42+
git pull --rebase upstream main
43+
```
44+
45+
1. Push to your fork.
46+
47+
```bash
48+
git push -u origin <my-branch-name>
49+
```
50+
51+
The `-u` is shorthand for `--set-upstream`. This will set up the tracking reference so subsequent runs of `git push` or `git pull` can omit the remote and branch.
52+
53+
1. [Submit a pull request](https://github.com/quic/<REPLACE-ME>/pulls) from your branch to `main`.
54+
1. Pat yourself on the back and wait for your pull request to be reviewed.
55+
56+
Here are a few things you can do that will increase the likelihood of your pull request to be accepted:
57+
58+
- Follow the existing style where possible. **INSERT LINK TO STYLE, e.g. PEP8 for python**
59+
- Write tests.
60+
- Keep your change as focused as possible.
61+
If you want to make multiple independent changes, please consider submitting them as separate pull requests.
62+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
63+
- It's a good idea to arrange a discussion with other developers to ensure there is consensus on large features, architecture changes, and other core code changes. PR reviews will go much faster when there are no surprises.

LICENSE.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved.
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6+
7+
2. 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.
8+
9+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
10+
11+
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 HOLDER 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.
12+
13+
SPDX-License-Identifier: BSD-3-Clause

0 commit comments

Comments
 (0)