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.

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

[Bugfix]--address segfaults by catching nullptr attribs and exiting gracefully #1515

Merged
merged 2 commits into from
Oct 6, 2021

Conversation

jturner65
Copy link
Contributor

Motivation and Context

This PR addresses segfaults that would happen if, due to misspelling or other errors, a required or expected attributes necessary for scene building is not found (i.e. queries to MetadataMediator returned nullptr). Now, should these queries fail, a salient message is displayed and the program ends via std::abort.

How Has This Been Tested

C++ and python tests pass locally

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@@ -217,6 +217,14 @@ Simulator::setSceneInstanceAttributes(const std::string& activeSceneName) {

metadata::attributes::SceneAttributes::cptr curSceneInstanceAttributes =
metadataMediator_->getSceneAttributesByName(activeSceneName);
// check if attributes is null - should not happen
CORRADE_ASSERT(
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible to hit any of these by calling from python into Habitat-sim in a certain way, or by calling into Habitat-sim with certain files on the filesystem missing?

If yes, this feels more like an ESP_CHECK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, great point, thanks @eundersander

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Oct 5, 2021
@jturner65 jturner65 merged commit 3d32dbe into facebookresearch:main Oct 6, 2021
@jturner65 jturner65 deleted the Bugfix_nullptrSegFault branch October 6, 2021 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants