Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Added docs for CWE-833, updated main Readme #13

Merged
merged 3 commits into from
May 15, 2024
Merged

Added docs for CWE-833, updated main Readme #13

merged 3 commits into from
May 15, 2024

Conversation

myteron
Copy link
Contributor

@myteron myteron commented May 7, 2024

No description provided.

CWE-664/CWE-833/README.md Outdated Show resolved Hide resolved
CWE-664/CWE-833/README.md Outdated Show resolved Hide resolved
CWE-833: Deadlock
====================

The number of threads that can simultaneously run within a `ThreadPoolExecutor` is limited by the `_max_workers` parameter. Submitting tasks whose execution is dependent on other tasks submitted to the same `ThreadPoolExecutor` may result in a *thread-starvation* deadlock. An example of this type of deadlock is shown in the following article [Brownlee, 2021], which describes it as "Deadlock 1: Submit and Wait for a Task Within a Task". Submitting a task will add it to an internal `ThreadPoolExecutor` queue. The task will be removed from the queue when one of the worker threads becomes available, i.e., after finishing its current task. If all workers are busy and all their current tasks are waiting for results from tasks that are waiting in the queue, the program will run indefinitely as no worker will be able to complete its task and take one of the blocking tasks from the queue.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use footnotes to create a bibliography. See https://www.markdownguide.org/extended-syntax/#footnotes

For a preview, see the C/C++ guide: https://best.openssf.org/Compiler-Hardening-Guides/Compiler-Options-Hardening-Guide-for-C-and-C++ Just as an example.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well our original decision was to use the Citing and referencing material - Harvard referencing quick guide - LibGuides at Dundalk Institute of Technology
https://dkit.ie.libguides.com/harvard/citing-referencing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @gkunz, talked to the team. We like to get this solved but not at this time as it would delay publishing the content. Are you ok if we continue as is without a solution? This will all become much easier to fix once we have everything in github.

Some limitations I like to avoid fixing atm:
Inline <br/> in tables
Forced min width in tables
Quotations as per https://dkit.ie.libguides.com/harvard/citing-referencing
@myteron myteron merged commit 4da87c4 into main May 15, 2024
1 check passed
@myteron myteron deleted the CWE-833-doc branch May 15, 2024 10:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants