Make read_critical_section::lock mutable in debug builds

[laurynas-biveinis]

This reflects usage and allows making try_read_unlock and check methods
unconditionally const instead of const-in-release-build-only.

This, in turn allows making the cs argument to olc_art.cpp:UNLOCK const, fixing
a cppcheck error [1]. At the same time rename UNLOCK to unlock_to_return, mark
the function nodiscard and noexcept.

[1]:

olc_art.cpp:97:67: style: Parameter 'cs' can be declared as reference to const [constParameterReference]
inline bool UNLOCK(unodb::optimistic_lock::read_critical_section &cs,
^

Summary by CodeRabbit

• Code Improvements

  • Updated function signatures for improved const-correctness
  • Refined method implementations with better error handling
  • Updated copyright notice to reflect current contributors

• Performance Optimization

  • Enhanced control flow for unlock operations
  • Added performance-focused attributes to function declarations

• Maintenance

  • Renamed and refactored internal unlock method
  • Adjusted mutable class member for non-debug builds

[coderabbitai]

Walkthrough

The pull request introduces modifications to two files, olc_art.cpp and optimistic_lock.hpp, focusing on function renaming, signature updates, and const-correctness improvements. The changes include renaming the UNLOCK function to unlock_and_return with enhanced error handling, updating method signatures in the read_critical_section class, and adjusting the copyright notice. The modifications aim to improve code clarity, safety, and maintainability.

Changes

File	Changes
olc_art.cpp	- Renamed UNLOCK function to unlock_and_return - Added [[nodiscard]] and noexcept specifiers - Updated function implementation with UNODB_DETAIL_LIKELY macro
optimistic_lock.hpp	- Updated copyright notice to "UnoDB contributors" (2019-2025) - Removed UNODB_DETAIL_RELEASE_CONST from method signatures - Added mutable qualifier to lock member variable (conditional on NDEBUG)

Possibly related PRs

• Removes an unused operator==() implementation and adds some documentation #637: Changes related to method signature modifications in the read_critical_section class

Poem

🐰 Unlock the code with grace and might,
Const-correctness shining bright!
Refactoring with rabbit's care,
Optimistic locks beyond compare.
A dance of functions, clean and light! 🔒

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c8177ce and d4ea2df.

📒 Files selected for processing (2)

• olc_art.cpp (4 hunks)
• optimistic_lock.hpp (4 hunks)

🔇 Additional comments (3)

optimistic_lock.hpp (2)

Line range hint 245-250: LGTM! Improved const-correctness of method signatures.

The changes to make try_read_unlock() and check() unconditionally const improve the API's const-correctness while maintaining the same functionality.

Also applies to: 272-279

---

310-314: LGTM! Appropriate use of mutable qualifier in debug builds.

The addition of the mutable qualifier to the lock member in debug builds enables const methods to modify it while maintaining const-correctness in the public API. The conditional compilation ensures this only applies in debug builds.

olc_art.cpp (1)

97-100: LGTM! Improved function naming and attributes.

The changes improve code quality by:

1. Renaming UNLOCK to the more descriptive unlock_and_return
2. Adding appropriate [[nodiscard]] and noexcept attributes
3. Consistently updating all call sites

Also applies to: 1722-1745

Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud