Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DAOS-16365 client: intercept dlsym() and zeInit() to avoid nested calls #15446

Merged
merged 1 commit into from
Nov 6, 2024
Merged

DAOS-16365 client: intercept dlsym() and zeInit() to avoid nested calls #15446

merged 1 commit into from
Nov 6, 2024

Conversation

wiliamhuang
Copy link
Contributor

libfabric loads libze_loader.so which calls zeInit(). We observed deadlock due to nested calls when daos_init() is called inside zeInit(). We intercept dlsym() and zeInit() to avoid calling daos_init() inside zeInit(). dlsym(RTLD_NEXT, ) checks returning address to determine caller's module. To maintain expected behavior of dlsym(RTLD_NEXT, ) with our interception, new_dlsym() is implemented with assembly code to use jmp instruction instead of call. dlsym() has been moved from libdl.so to libc.so since version 2.34.

Before requesting gatekeeper:

  • Two review approvals and any prior change requests have been resolved.
  • Testing is complete and all tests passed or there is a reason documented in the PR why it should be force landed and forced-landing tag is set.
  • Features: (or Test-tag*) commit pragma was used or there is a reason documented that there are no appropriate tags for this PR.
  • Commit messages follows the guidelines outlined here.
  • Any tests skipped by the ticket being addressed have been run and passed in the PR.

Gatekeeper:

  • You are the appropriate gatekeeper to be landing the patch.
  • The PR has 2 reviews by people familiar with the code, including appropriate owners.
  • Githooks were used. If not, request that user install them and check copyright dates.
  • Checkpatch issues are resolved. Pay particular attention to ones that will show up on future PRs.
  • All builds have passed. Check non-required builds for any new compiler warnings.
  • Sufficient testing is done. Check feature pragmas and test tags and that tests skipped for the ticket are run and now pass with the changes.
  • If applicable, the PR has addressed any potential version compatibility issues.
  • Check the target branch. If it is master branch, should the PR go to a feature branch? If it is a release branch, does it have merge approval in the JIRA ticket.
  • Extra checks if forced landing is requested
    • Review comments are sufficiently resolved, particularly by prior reviewers that requested changes.
    • No new NLT or valgrind warnings. Check the classic view.
    • Quick-build or Quick-functional is not used.
  • Fix the commit message upon landing. Check the standard here. Edit it to create a single commit. If necessary, ask submitter for a new summary.

@wiliamhuang
DAOS-16365 client: intercept dlsym() and zeInit() to avoid nested call (
47a0d33 
#14932)

libfabric loads libze_loader.so which calls zeInit(). We observed deadlock due to nested calls when daos_init() is called inside zeInit(). We intercept dlsym() and zeInit() to avoid calling daos_init() inside zeInit(). dlsym(RTLD_NEXT, ) checks returning address to determine caller's module. To maintain expected behavior of dlsym(RTLD_NEXT, ) with our interception, new_dlsym() is implemented with assembly code to use jmp instruction instead of call. dlsym() has been moved from libdl.so to libc.so since version 2.34.

Signed-off-by: Lei Huang <[email protected]>
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 5, 2024

Ticket title is 'deadlock in MPI application on Aurora with libpil4dfs'
Status is 'Resolved'
Labels: 'intercept_lib,scrubbed_2.8'
Job should run at elevated priority (1)
https://daosio.atlassian.net/browse/DAOS-16365

@github-actions github-actions bot added the priority Ticket has high priority (automatically managed) label Nov 5, 2024
@wiliamhuang wiliamhuang added the clean-cherry-pick Cherry-pick from another branch that did not require additional edits label Nov 5, 2024
@phender phender marked this pull request as ready for review November 5, 2024 20:45
@phender phender requested review from a team as code owners November 5, 2024 20:45
@dinghwah dinghwah self-requested a review November 5, 2024 20:53
tanabarr
tanabarr approved these changes Nov 5, 2024
View reviewed changes
Copy link
Contributor

@tanabarr tanabarr left a comment

Choose a reason for hiding this comment

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

LGTM, nice work

src/client/dfuse/pil4dfs/int_dfs.c
_Pragma("GCC diagnostic push")
_Pragma("GCC diagnostic ignored \"-Wunused-function\"")
_Pragma("GCC diagnostic ignored \"-Wunused-variable\"")

Copy link
Contributor

Choose a reason for hiding this comment

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

nit: unnecessary newline?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok. I will remove the newline here in a follow-up PR. Thank you!

src/client/dfuse/pil4dfs/int_dfs.c
static int
is_hook_enabled(void)
{
return (d_hook_enabled ? (1) : (0));
Copy link
Contributor

Choose a reason for hiding this comment

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

does this not work without the inner parentheses?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. The inner parentheses are not necessary. I will remove them in a follow-up PR later. Thank you!

src/client/dfuse/pil4dfs/int_dfs.c
{
if (!d_hook_enabled)
goto org_dlsym;
printf("Inside my dlsym().\n");
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this debug that should be removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. This line was planed to be removed in a follow-up PR.
This line of code is only compiled under non-x86_64 platform. It should be fine for now.

@phender phender merged commit cf2a8b9 into release/2.6 Nov 6, 2024
53 of 54 checks passed
@phender phender deleted the lei/DAOS-16365_2.6 branch November 6, 2024 02:12
@mjmac mjmac mentioned this pull request Nov 6, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@knard-intel knard-intel knard-intel approved these changes

@tanabarr tanabarr tanabarr approved these changes

@mchaarawi mchaarawi Awaiting requested review from mchaarawi

@dinghwah dinghwah Awaiting requested review from dinghwah

Assignees
No one assigned
Labels
clean-cherry-pick Cherry-pick from another branch that did not require additional edits priority Ticket has high priority (automatically managed)
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@wiliamhuang @tanabarr @dinghwah @knard-intel @phender