CHERIoT-Platform/llvm-project

LLD QOI: Warn if an export name matches a non-exported symbol

Open

#55 opened on Dec 4, 2024

View on GitHub
 (8 comments) (0 reactions) (1 assignee)LLVM (15 forks)auto 404
good first issue

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

Export symbols are of the form export{compartment name}{mangled symbol name}. If we fail to resolve one of these, it would be nice to see if any of the input files has a private symbol that matches {mangled symbol name} and provide a diagnostic. This can happen if you have failed to mark a function with the __cher_compartment macro in the definition, but you did in a declaration that was visible to the caller.

Contributor guide

Research direction
Locate the export symbol resolution code in LLD. When a symbol of the form export {compartment} {mangled name} cannot be resolved, iterate over input object files to find a non exported symbol with the same mangled name. If found, emit a warning suggesting that the definition may be missing the cheri compartment macro.
Tech stack
ccpp
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++LLVM linker basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50