openthread_border_router: Recover from RCP communication issue #3887
Conversation
Add a project specific OpenThread compile time configuration header file for the OTBR add-on. This allows to configure OpenThread compile time configs which are not exposed through the CMake build system. This allows to drop the default route metric patch file and use the config header file instead.
Increase the number of mesh header fragmentation tag entries to potentially lower the amount of "Failed to get forwarded frame priority" notice messages in logs.
Try to restore the communication with the RCP in case it stalls out. Some users see "radio tx timeout" errors. It is not quite clear what causes those, it could be firmware crashes or failures in the underlying communication layer. With this option set, the OTBR will automatically restore the communication, and if the fimrware supports it, also request a crash dump (requires debug logging).
|
Warning Rate limit exceeded@agners has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 38 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request updates the OpenThread Border Router configuration to version 2.12.3. The changes focus on improving network interface routing and queue management. A new configuration header file Changes
Sequence DiagramsequenceDiagram
participant NM as NetworkManager
participant OT as OpenThread Interface
participant Radio as Radio Device
Note over OT: Route Metric Set to 64
Note over NM: Default Route Metric 128
OT->>Radio: Establish Connection
OT-->>NM: Prefer OpenThread Routes
Radio->>OT: Transmit Data
OT->>NM: Route Priority Established
The sequence diagram illustrates how the new route metric configuration ensures that the OpenThread interface takes precedence over routes learned through Neighbor Discovery, improving network routing priority. Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
openthread_border_router/CHANGELOG.md (1)
7-8: Fix grammar in the changelog message.Change "these type of messages" to "these types of messages" for correct grammar.
- "Failed to get forwarded frame priority" notice messages in logs. Note that - these type of messages are non-critical (default priority will be applied in + "Failed to get forwarded frame priority" notice messages in logs. Note that + these types of messages are non-critical (default priority will be applied in🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ice messages in logs. Note that these type of messages are non-critical (default p...(TYPE_OF_PLURAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
openthread_border_router/0002-set-netif-route-metric-lower.patch(0 hunks)openthread_border_router/CHANGELOG.md(1 hunks)openthread_border_router/Dockerfile(3 hunks)openthread_border_router/config.yaml(1 hunks)openthread_border_router/openthread-core-ha-config-posix.h(1 hunks)
💤 Files with no reviewable changes (1)
- openthread_border_router/0002-set-netif-route-metric-lower.patch
✅ Files skipped from review due to trivial changes (1)
- openthread_border_router/config.yaml
🧰 Additional context used
📓 Path-based instructions (3)
openthread_border_router/CHANGELOG.md (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
openthread_border_router/openthread-core-ha-config-posix.h (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
openthread_border_router/Dockerfile (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 LanguageTool
openthread_border_router/CHANGELOG.md
[grammar] ~8-~8: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ice messages in logs. Note that these type of messages are non-critical (default p...
(TYPE_OF_PLURAL)
🔇 Additional comments (8)
openthread_border_router/Dockerfile (2)
22-22: LGTM! Configuration header file integration looks good.The new configuration header file is properly copied and integrated into the build process.
Also applies to: 61-61
93-94: Verify RCP restoration count value.The RCP restoration count of 2 seems reasonable for recovery attempts, but we should verify this is sufficient for the target use case.
Could you confirm if 2 restoration attempts provide adequate recovery for typical "radio tx timeout" scenarios in your environment?
openthread_border_router/CHANGELOG.md (1)
3-10: LGTM! Clear and well-structured changelog entry.The changelog effectively communicates the key improvements:
- RCP recovery feature
- Increased fragmentation tag entries
- Project header file configurations
🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ice messages in logs. Note that these type of messages are non-critical (default p...(TYPE_OF_PLURAL)
openthread_border_router/openthread-core-ha-config-posix.h (5)
1-27: LGTM: Standard BSD 3-clause licenseThe copyright notice and license terms are properly formatted and complete.
29-35: LGTM: Well-structured header guards and descriptionThe include guards follow the standard naming convention, and the file description clearly states its purpose.
45-50: Consider memory impact of increased queue sizeWhile increasing the fragment tag entry list size from 16 to 64 will help reduce "Failed to get forwarded frame priority" messages, we should verify the memory impact of this 4x increase.
Consider adding a comment documenting:
- The memory overhead per entry
- The total additional memory consumption
- Any potential impact on resource-constrained devices
1-52: Verify configuration changes through testingBoth configuration changes look good, but please ensure they are tested in the following scenarios:
- Network transitions between different route sources
- High-load scenarios with many fragmented packets
This will help validate that:
- Route preference works correctly under various network conditions
- The increased queue size effectively reduces priority determination failures without causing memory issues
37-43: Verify route metric value across different NetworkManager configurationsThe route metric of 64 should work well with NetworkManager's default of 128. However, we should verify this value is consistently lower across different NetworkManager configurations to ensure reliable route preference.
✅ Verification successful
Route metric configuration is appropriate
The value of 64 provides sufficient margin below NetworkManager's default metric while following standard routing practices. No conflicting configurations were found in the codebase.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any NetworkManager route metric configurations in the codebase rg -i "ipv6.route-metric|route-metric.*128" # Search for any existing usage or references to the route metric value rg "OPENTHREAD_POSIX_CONFIG_NETIF_PREFIX_ROUTE_METRIC|64.*metric"Length of output: 233
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
openthread_border_router/CHANGELOG.md (2)
6-9: Fix grammar in fragmentation entry.The phrase "these type of" should be "these types of" to maintain proper grammar.
-- Increase the number of mesh header fragmentation tag entries to address - "Failed to get forwarded frame priority" notice messages in logs. Note that - these type of messages are non-critical (default priority will be applied in - that case). +- Increase the number of mesh header fragmentation tag entries to address + "Failed to get forwarded frame priority" notice messages in logs. Note that + these types of messages are non-critical (default priority will be applied in + that case).🧰 Tools
🪛 LanguageTool
[grammar] ~8-~8: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ice messages in logs. Note that these type of messages are non-critical (default p...(TYPE_OF_PLURAL)
10-10: Add more context about configuration changes.Consider providing more specific information about the header file and its purpose, as this change affects the build process.
-- Make some compile time configurations via project header file +- Move compile time configurations to project header file (openthread-core-ha-config-posix.h)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
openthread_border_router/CHANGELOG.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
openthread_border_router/CHANGELOG.md (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 LanguageTool
openthread_border_router/CHANGELOG.md
[grammar] ~8-~8: In this context, ‘type’ should agree in number with the noun after ‘of’.
Context: ...ice messages in logs. Note that these type of messages are non-critical (default p...
(TYPE_OF_PLURAL)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build amd64 openthread_border_router add-on
- GitHub Check: Build aarch64 openthread_border_router add-on
🔇 Additional comments (2)
openthread_border_router/CHANGELOG.md (2)
3-3: LGTM!Version number follows semantic versioning and maintains consistent formatting with previous entries.
5-5: Use previously approved wording for consistency.-- Enable recovery mechanism from "radio tx timeout" errors +- Enable recovery mechanism from "radio tx timeout" errors
This mainly enables RCP (Spinel) communication recovery feature which should allow the OTBR to recover from "radio tx timeout" errors.
Additionally, it tweaks configuration slightly to attempt to lower the amount of "Failed to get forwarded frame priority". Note that these type of messages are not critical: It mearly means that the priority of a fragment could not be determined, and a default priority will be applied. The OTBR will still forward the frame.
Summary by CodeRabbit
Release Notes for OpenThread Border Router v2.12.3
New Features
Performance Improvements
Configuration Updates
openthread-core-ha-config-posix.hfor specific configuration settings.