fix: Do not leak TFile in Fair{File,Mixed}Source

[ChristianTackeGSI]

• [x] #1442

And refactor into FairFileSourceBase.

---

Checklist:

• [X] Followed the Contributing Guidelines

[coderabbitai[bot]]

Walkthrough

Walkthrough

The modifications in the FairFileSource and FairMixedSource classes involve a significant overhaul in how these classes manage file sources and handle events. By transitioning to smart pointers and reorganizing file handling methods, the changes aim to enhance memory safety, resource management, and the overall structure of event handling within the classes.

Changes

Files	Summary
fairroot/base/source/FairFileSource.cxx fairroot/base/source/FairMixedSource.cxx	Transitioned to std::unique_ptr and custom smart pointers for file handling, alongside constructor updates for enhanced memory safety.
fairroot/base/source/FairFileSource.h fairroot/base/source/FairMixedSource.h	Removed GetRootFile and GetInFile methods, eliminated fRootFile variable, and modified FillEventHeader method in FairMixedSource.h.

Possibly related issues

• FairRootGroup/FairRoot#1418: The changes in this PR could potentially address the issues related to memory management and program crashes mentioned in the issue. The transition to smart pointers and the reorganization of file handling and event header filling methods in the FairFileSource and FairMixedSource classes are likely to contribute to resolving crashes and undefined behavior (UB) by preventing double deletion and improving the deletion sequence of objects.

---

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 1156296ef3511c1af3b419d17d91b499312cb109 and 7f65d22a7e439a39c753453834857101cc452a75.

Files selected for processing (5)

• fairroot/base/source/FairFileSource.cxx (13 hunks)
• fairroot/base/source/FairFileSource.h (4 hunks)
• fairroot/base/source/FairFileSourceBase.h (3 hunks)
• fairroot/base/source/FairMixedSource.cxx (12 hunks)
• fairroot/base/source/FairMixedSource.h (3 hunks)

Additional comments not posted (18)

fairroot/base/source/FairFileSourceBase.h (5)

2-2: Update of copyright year to 2024.

---

12-12: Addition of FairMemory.h include directive.

---

37-38: Introduction of GetInFile() and GetRootFile() methods.

---

44-44: Modification of the constructor to use default initialization.

---

52-52: Addition of fRootFile member variable of type fairroot::detail::maybe_owning_ptr<TFile>.

fairroot/base/source/FairFileSource.h (1)

2-2: Update of copyright year to 2024.

fairroot/base/source/FairMixedSource.h (1)

2-2: Update of copyright year to 2024.

fairroot/base/source/FairFileSource.cxx (6)

45-47: Usage of custom smart pointer wrappers for TFile instances.

---

78-78: Initialization of fRootFile with maybe_owning_ptr and handling of file opening errors.

---

115-115: Initialization of fRootFile with std::unique_ptr and handling of file opening errors.

---

152-152: Similar to previous, initialization of fRootFile with std::unique_ptr for a different constructor.

---

296-296: Handling of SetInTree method to update fRootFile without taking ownership, and reinitialization.

---

577-577: Handling of SetInputFile method to update fRootFile with std::unique_ptr and manage file opening errors.

fairroot/base/source/FairMixedSource.cxx (5)

79-79: Initialization of fRootFile using maybe_owning_ptr is correctly implemented.

---

130-130: Proper use of std::unique_ptr for managing TFile objects enhances memory safety.

---

180-180: Consistent use of std::unique_ptr across constructors ensures robust memory management.

---

418-418: Using std::unique_ptr within SetSignalFile method for local file management is a good practice.

---

468-468: Effective use of std::unique_ptr in AddBackgroundFile method for handling file operations locally.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.