Home

Crashupload Wiki

Welcome to the crashupload project documentation! Crashupload is a robust and efficient crash dump management system designed for RDK (Reference Design Kit) devices across multiple platforms.

📋 Table of Contents

• Overview
• Key Features
• Supported Platforms
• Architecture
• Getting Started
• Documentation
• Contributing

Overview

Crashupload is a critical diagnostic tool that automatically collects, processes, and uploads crash dumps from RDK devices to centralized servers for analysis. It helps development teams identify and resolve stability issues by capturing detailed crash information including:

• Minidumps (.dmp files) - Compact crash dumps from applications
• Coredumps (core.* files) - Full process memory dumps
• Associated log files - Context from breakpad logmapper

The project provides two implementation approaches:

1. Compiled C Code - Modern, optimized, production-ready implementation (v2.0.0+)
2. Shell Script Method - Legacy implementation for compatibility

Key Features

🚀 Performance & Efficiency

• Optimized startup time: 80-100ms (vs 150-200ms in legacy)
• Low memory footprint: 4-6MB during operation
• Small binary size: ~45KB compiled executable
• 37% reduction in decision points (22 vs 35)

🔒 Security & Privacy

• TLS 1.2 encryption for all uploads
• OCSP stapling support for certificate validation
• Privacy opt-out compliance via RFC
• No insecure system() calls in production code
• Stack protection and buffer overflow guards

🎯 Smart Processing

• Type-aware retry logic: Different strategies for minidumps vs coredumps
• Unified rate limiting: 10 uploads per 10 minutes with crashloop detection
• Smart archive compression: Optimal paths with /tmp fallback
• Batch cleanup operations: Efficient single-pass processing
• Network prerequisite checking: Wait for connectivity before upload

📊 Telemetry & Monitoring

• T2 telemetry integration for event reporting
• RFC configuration support for dynamic feature control
• Comprehensive logging via RDK Logger framework
• Upload success/failure tracking

Architecture

Crashupload follows a modular, layered architecture:

┌─────────────────────────────────────────────┐
│          Main Application Entry             │
│        (uploadDumps.sh / main.c)            │
└─────────────────────────────────────────────┘
                    │
        ┌───────────┴───────────┐
        │                       │
┌───────▼─────────┐    ┌────────▼─────────┐
│  Shell Scripts  │    │   C Compiled     │
│   (Legacy)      │    │                  │
└───────┬─────────┘    └────────┬─────────┘
        │                       │
        └───────────┬───────────┘
                    │
┌─────────────────────────────────────────────┐
│           Core Processing Modules           │
│  • Scanner    • Archive   • Upload          │
│  • RateLimit  • Cleanup   • Privacy         │
└─────────────────────────────────────────────┘
                    │
┌─────────────────────────────────────────────┐
│          Integration Interfaces             │
│  • T2 Telemetry  • RFC Config  • Logger     │
└─────────────────────────────────────────────┘

File Structure Overview

crashupload/
├── c_sourcecode/              # Modern C implementation
│   ├── src/
│   │   ├── main.c             # Entry point
│   │   ├── scanner/           # Dump file discovery
│   │   ├── archive/           # Compression & archiving
│   │   ├── upload/            # HTTP/TLS upload logic
│   │   ├── ratelimit/         # Rate limiting & flood control
│   │   ├── config/            # Configuration management
│   │   ├── platform/          # Platform abstraction
│   │   └── utils/             # Utilities (logging, locking, etc.)
│   ├── include/               # Public headers
│   └── common/                # Shared types & constants
│
├── scripts/                   # Legacy shell implementation  
│   ├── uploadDumps.sh         # Main upload orchestrator
│   ├── runDumpUpload.sh       # Legacy script runner (1177 lines)
│   └── uploadDumpsUtils.sh    # Utility functions
│
├── unittest/                  # Unit test suite (GTest)
│   └── *_gtest.cpp            # 69 comprehensive tests
│
├── test/functional-tests/     # L2 functional tests
│
├── .github/workflows/         # CI/CD automation
│   ├── native_full_build.yml  # Build validation
│   ├── L1-Test.yml            # Unit test execution
│   └── L2-Test.yml            # Functional test execution
│
└── docs/migration/            # Migration documentation
    ├── hld/                   # High-level design
    ├── lld/                   # Low-level design
    └── diagrams/              # Architecture diagrams

Getting Started

Prerequisites

• RDK platform environment
• For compiled code: GCC, autotools, libcurl, libcrypto (OpenSSL)
• For testing: GTest framework

Quick Start

Using the compiled binary:

cd c_sourcecode
autoreconf -i
./configure
make
./crashupload <dump_file_path> <type>

Using the shell script:

./uploadDumps.sh <dump_file_path> <type> [secure]

Running tests:

cd unittest
./build_and_test.sh

Documentation

Explore detailed documentation for different aspects:

Page	Description
Crashupload - Compiled Code	In-depth guide to the C implementation, architecture, and optimization techniques
Crashupload - Script Method	Legacy shell script implementation, flow, and usage
Workflows & Actions	CI/CD pipelines, automated testing, and quality gates
Configuration Guide	Device properties, RFC parameters, and runtime configuration
Testing Guide	Unit tests (L1), functional tests (L2), and testing strategies
Troubleshooting	Common issues, debugging tips, and log analysis

Version History

Version	Date	Key Changes
2.0.0	Current	C implementation, rate limit improvements, session sync
1.0.7	Oct 2025	Component log fixes
1.0.6	Sep 2025	Multi-platform federation
1.0.5	Jul 2025	T2 telemetry support
1.0.4	Feb 2025	Script optimization

See CHANGELOG.md for complete history.

Contributing

We welcome contributions! To contribute:

1. Fork the repository
2. Create a feature branch
3. Make your changes with tests
4. Submit a pull request
5. Sign the RDK Contributor License Agreement (CLA)

All PRs automatically trigger:

• ✅ Build validation
• ✅ L1 unit tests (69 test cases)
• ✅ L2 functional tests
• ✅ Code quality checks

License

This project is licensed under the Apache License 2.0. See LICENSE for details.

Support & Contact

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: This wiki

---

Quick Links: Crashupload - Compiled Code | Crashupload - Script Method | Workflows & Actions