KhronosGroup / KhronosGroup/KSCAF_DocGuidelines

EGL: types of parameters

Open
#37 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
CSS
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

For example, ‘eglGetConfigs’ function takes input parameter ‘EGLConfig* configs,’ which is an arbitrary memory address supplied by the caller of the function. There is nothing preventing the caller 1) from supplying incorrect address, such as incorrectly aligned address or address in restricted memory space, or 2) from supplying correct but detrimental address, such as address within memory space occupied by the implementation i.e. executable library itself. In the first case, result would typically be a segmentation fault, while in the second case it is hard to predict outcome. A solution that would detect and prevent the above cases would likely be complex.

For reference, general issue "EGL" is defined as issue #35.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the referenced general EGL issue #35 and the eglGetConfigs example. Determine what guidance the project should provide for caller-supplied pointer parameters, including invalid, misaligned, restricted, or implementation-overlapping addresses; done requires an agreed approach rather than an isolated code change.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.