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

Fix crash when using String::move on empty string (#10938) #10940

Closed
wants to merge 3 commits into from

Conversation

TD-er
Copy link
Contributor

@TD-er TD-er commented Feb 6, 2025

Description of Change

memmove should not be called on a nullptr or size of 0.
See: https://en.cppreference.com/w/cpp/string/byte/memmove

When an empty string was handed over to move, the application would crash.
The change is just adding an extra check to see if there is something to move.

Related links

Fixes: #10938

Copy link
Contributor

github-actions bot commented Feb 6, 2025

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Fix crash when using String::move on empty string (#10938)":
    • summary looks empty
    • type/action looks empty
  • the commit message "Keep allocated memory when rhs fits":
    • summary looks empty
    • type/action looks empty
  • the commit message "No need to move 0-termination char in String::move":
    • summary looks empty
    • type/action looks empty

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 10 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

👋 Hello TD-er, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against d024bea

@TD-er TD-er marked this pull request as draft February 6, 2025 10:51
Copy link
Contributor

github-actions bot commented Feb 6, 2025

Test Results

 62 files   62 suites   5m 39s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
153 runs  153 ✅ 0 💤 0 ❌

Results for commit d024bea.

♻️ This comment has been updated with latest results.

Use case: Appending to a String with pre-allocated memory (e.g. from `reserve()`)
@TD-er TD-er marked this pull request as ready for review February 6, 2025 11:01
Copy link
Contributor

github-actions bot commented Feb 6, 2025

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32P4💚 -14⚠️ +800.00⚠️ +0.01000.000.00
ESP32S3💚 -12‼️ +5K0.00⚠️ +0.500⚠️ +4960.00⚠️ +0.83
ESP32S2💚 -16‼️ +4K0.00⚠️ +0.400⚠️ +120.00⚠️ +0.02
ESP32C3💚 -1600.000.00000.000.00
ESP32C6💚 -140💚 -0.010.00000.000.00
ESP32H2💚 -1400.000.00000.000.00
ESP32💚 -24‼️ +12K0.00‼️ +1.230⚠️ +680.00⚠️ +0.11
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32P4ESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
ArduinoOTA/examples/BasicOTA⚠️ +6200000💚 -140💚 -140--00
AsyncUDP/examples/AsyncUDPClient⚠️ +78000000000--00
AsyncUDP/examples/AsyncUDPMulticastServer⚠️ +78000000000--00
AsyncUDP/examples/AsyncUDPServer⚠️ +78000000000--00
DNSServer/examples/CaptivePortal⚠️ +6200000💚 -140💚 -140--00
EEPROM/examples/eeprom_class00000000000000
EEPROM/examples/eeprom_extra00000000000000
EEPROM/examples/eeprom_write00000000000000
ESP32/examples/AnalogOut/LEDCFade00000000000000
ESP32/examples/AnalogOut/LEDCSingleChannel00000000000000
ESP32/examples/AnalogOut/LEDCSoftwareFade00000000000000
ESP32/examples/AnalogOut/SigmaDelta00000000000000
ESP32/examples/AnalogOut/ledcFrequency00000000000000
ESP32/examples/AnalogOut/ledcWrite_RGB00000000000000
ESP32/examples/AnalogRead00000000000000
ESP32/examples/AnalogReadContinuous00000000000000
ESP32/examples/ArduinoStackSize00000000000000
ESP32/examples/CI/CIBoardsTest00000000000000
ESP32/examples/ChipID/GetChipID00000000000000
ESP32/examples/DeepSleep/TimerWakeUp0000000000--00
ESP32/examples/DeepSleep/TouchWakeUp000000------00
ESP32/examples/FreeRTOS/BasicMultiThreading00000000000000
ESP32/examples/FreeRTOS/Mutex00000000000000
ESP32/examples/FreeRTOS/Queue00000000000000
ESP32/examples/FreeRTOS/Semaphore00000000000000
ESP32/examples/GPIO/BlinkRGB00000000000000
ESP32/examples/GPIO/FunctionalInterrupt00000000000000
ESP32/examples/GPIO/FunctionalInterruptStruct00000000000000
ESP32/examples/GPIO/GPIOInterrupt00000000000000
ESP32/examples/HWCDC_Events0000--000000--
ESP32/examples/MacAddress/GetMacAddress00000000000000
ESP32/examples/RMT/Legacy_RMT_Driver_Compatible00000000000000
ESP32/examples/RMT/RMTCallback00000000000000
ESP32/examples/RMT/RMTLoopback00000000000000
ESP32/examples/RMT/RMTReadXJT00000000000000
ESP32/examples/RMT/RMTWrite_RGB_LED00000000000000
ESP32/examples/RMT/RMT_CPUFreq_Test00000000000000
ESP32/examples/RMT/RMT_EndOfTransmissionState00000000000000
ESP32/examples/RMT/RMT_LED_Blink00000000000000
ESP32/examples/ResetReason/ResetReason00000000000000
ESP32/examples/ResetReason/ResetReason200000000000000
ESP32/examples/Serial/BaudRateDetect_Demo00000000000000
ESP32/examples/Serial/OnReceiveError_BREAK_Demo00000000000000
ESP32/examples/Serial/OnReceive_Demo00000000000000
ESP32/examples/Serial/RS485_Echo_Demo00000000000000
ESP32/examples/Serial/RxFIFOFull_Demo00000000000000
ESP32/examples/Serial/RxTimeout_Demo00000000000000
ESP32/examples/Serial/Serial_All_CPU_Freqs00000000000000
ESP32/examples/Serial/Serial_STD_Func_OnReceive00000000000000
ESP32/examples/Serial/onReceiveExample00000000000000
ESP32/examples/TWAI/TWAIreceive00000000000000
ESP32/examples/TWAI/TWAItransmit00000000000000
ESP32/examples/Template/ExampleTemplate00000000000000
ESP32/examples/Time/SimpleTime⚠️ +76000000000--00
ESP32/examples/Timer/RepeatTimer00000000000000
ESP32/examples/Timer/WatchdogTimer00000000000000
ESP32/examples/Touch/TouchInterrupt000000------00
ESP32/examples/Touch/TouchRead000000------00
ESP32/examples/Utilities/HEXBuilder💚 -140💚 -40💚 -40💚 -140💚 -140💚 -140💚 -120
ESP32/examples/Utilities/MD5Builder00000000000000
ESP32/examples/Utilities/SHA1Builder00000000000000
ESP_I2S/examples/ES8388_loopback00000000000000
ESP_I2S/examples/Record_to_WAV💚 -140💚 -40--------💚 -120
ESP_I2S/examples/Simple_tone00000000000000
ESPmDNS/examples/mDNS-SD_Extended⚠️ +76000000000--00
ESPmDNS/examples/mDNS_Web_Server⚠️ +6400000💚 -140💚 -140--00
Ethernet/examples/ETH_TLK110⚠️ +780----------00
Ethernet/examples/ETH_W5500_Arduino_SPI⚠️ +760000000000000
Ethernet/examples/ETH_W5500_IDF_SPI⚠️ +760000000000000
Ethernet/examples/ETH_WIFI_BRIDGE⚠️ +76000000000--00
FFat/examples/FFat_Test💚 -140💚 -40💚 -40💚 -140💚 -140💚 -140💚 -120
FFat/examples/FFat_time⚠️ +6400000💚 -140💚 -140--💚 -120
HTTPClient/examples/Authorization⚠️ +6400000💚 -140💚 -140--00
HTTPClient/examples/BasicHttpClient⚠️ +6400000💚 -140💚 -140--00
HTTPClient/examples/BasicHttpsClient⚠️ +6400000💚 -140💚 -140--💚 -120
HTTPClient/examples/ReuseConnection⚠️ +6400000💚 -140💚 -140--00
HTTPClient/examples/StreamHttpClient⚠️ +6400000💚 -140💚 -140--00
HTTPUpdate/examples/httpUpdate⚠️ +6400000💚 -140💚 -140--00
HTTPUpdate/examples/httpUpdateSPIFFS⚠️ +6600000💚 -140💚 -140--00
HTTPUpdate/examples/httpUpdateSecure⚠️ +6400000💚 -140💚 -140--00
HTTPUpdateServer/examples/WebUpdater⚠️ +6400000💚 -140💚 -140--00
LittleFS/examples/LITTLEFS_test💚 -140💚 -40💚 -40💚 -140💚 -140💚 -140💚 -120
LittleFS/examples/LITTLEFS_time⚠️ +64000💚 -120💚 -140💚 -140--💚 -120
NetBIOS/examples/ESP_NBNST⚠️ +76000000000--00
NetworkClientSecure/examples/WiFiClientInsecure⚠️ +76000000000--00
NetworkClientSecure/examples/WiFiClientPSK⚠️ +76000000000--00
NetworkClientSecure/examples/WiFiClientSecure⚠️ +76000000000--00
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade⚠️ +76000000000--00
NetworkClientSecure/examples/WiFiClientShowPeerCredentials⚠️ +6400000💚 -140💚 -140--00
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse⚠️ +78000000000--💚 -160
PPP/examples/PPP_Basic⚠️ +760000000000000
PPP/examples/PPP_WIFI_BRIDGE⚠️ +76000000000--00
Preferences/examples/Prefs2Struct00000000000000
Preferences/examples/StartCounter00000000000000
SD/examples/SD_Test💚 -140💚 -40💚 -40💚 -140💚 -140💚 -140💚 -120
SD/examples/SD_time⚠️ +6400000💚 -140💚 -140--00
SD_MMC/examples/SD2USBMSC💚 -140💚 -40----------
SD_MMC/examples/SDMMC_Test💚 -140💚 -40--------💚 -120
SD_MMC/examples/SDMMC_time⚠️ +64000--------00
SPI/examples/SPI_Multiple_Buses00000000000000
SPIFFS/examples/SPIFFS_Test💚 -140💚 -40💚 -40💚 -160💚 -140💚 -140💚 -120
SPIFFS/examples/SPIFFS_time⚠️ +640💚 -120💚 -160💚 -140💚 -140--00
TFLiteMicro/examples/hello_world00000000000000
Ticker/examples/Blinker00000000000000
Ticker/examples/TickerBasic00000000000000
Ticker/examples/TickerParameter00000000000000
USB/examples/CompositeDevice000000--------
USB/examples/ConsumerControl000000--------
USB/examples/CustomHIDDevice000000--------
USB/examples/FirmwareMSC000000--------
USB/examples/Gamepad000000--------
USB/examples/HIDVendor000000--------
USB/examples/Keyboard/KeyboardLogout000000--------
USB/examples/Keyboard/KeyboardMessage000000--------
USB/examples/Keyboard/KeyboardReprogram000000--------
USB/examples/Keyboard/KeyboardSerial000000--------
USB/examples/KeyboardAndMouseControl000000--------
USB/examples/MIDI/MidiController000000--------
USB/examples/MIDI/MidiInterface000000--------
USB/examples/MIDI/MidiMusicBox000000--------
USB/examples/MIDI/ReceiveMidi000000--------
USB/examples/Mouse/ButtonMouseControl000000--------
USB/examples/SystemControl000000--------
USB/examples/USBMSC000000--------
USB/examples/USBSerial000000--------
USB/examples/USBVendor000000--------
Update/examples/AWS_S3_OTA_Update⚠️ +78000000000--00
Update/examples/HTTPS_OTA_Update⚠️ +76000000000--00
Update/examples/HTTP_Client_AES_OTA_Update⚠️ +6400000💚 -140💚 -140--00
Update/examples/HTTP_Server_AES_OTA_Update⚠️ +6400000💚 -140💚 -140--💚 -120
Update/examples/OTAWebUpdater⚠️ +6600000💚 -140💚 -140--00
Update/examples/SD_Update💚 -140💚 -40💚 -40💚 -140💚 -140💚 -140💚 -120
WebServer/examples/AdvancedWebServer⚠️ +64000💚 -120💚 -140💚 -140--00
WebServer/examples/FSBrowser⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/Filters⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/HelloServer⚠️ +6600000💚 -140💚 -140--00
WebServer/examples/HttpAdvancedAuth⚠️ +6200000💚 -140💚 -140--00
WebServer/examples/HttpAuthCallback⚠️ +640💚 -12000💚 -140💚 -140--00
WebServer/examples/HttpAuthCallbackInline⚠️ +6400000💚 -140💚 -140--💚 -240
WebServer/examples/HttpBasicAuth⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/HttpBasicAuthSHA1⚠️ +6400000💚 -140💚 -140--💚 -120
WebServer/examples/HttpBasicAuthSHA1orBearerToken⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/MultiHomedServers⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/PathArgServer⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/SDWebServer⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/SimpleAuthentification⚠️ +640💚 -12000💚 -140💚 -140--00
WebServer/examples/UploadHugeFile⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/WebServer⚠️ +6400000💚 -140💚 -140--00
WebServer/examples/WebUpdate⚠️ +6400000💚 -140💚 -140--00
WiFi/examples/FTM/FTM_Initiator⚠️ +78000000000--00
WiFi/examples/FTM/FTM_Responder⚠️ +76000000000--00
WiFi/examples/SimpleWiFiServer⚠️ +78000000000--00
WiFi/examples/WiFiAccessPoint⚠️ +78000000000--00
WiFi/examples/WiFiClient⚠️ +78000000000--00
WiFi/examples/WiFiClientBasic⚠️ +80000000000--00
WiFi/examples/WiFiClientConnect⚠️ +780⚠️ +160000000--00
WiFi/examples/WiFiClientEvents⚠️ +76000000000--00
WiFi/examples/WiFiClientStaticIP⚠️ +78000000000--00
WiFi/examples/WiFiExtender⚠️ +76000000000--00
WiFi/examples/WiFiIPv6⚠️ +76000000000--00
WiFi/examples/WiFiMulti⚠️ +76000000000--00
WiFi/examples/WiFiMultiAdvanced⚠️ +6400000💚 -140💚 -140--00
WiFi/examples/WiFiScan⚠️ +78000000000--00
WiFi/examples/WiFiScanAsync⚠️ +76000000000--00
WiFi/examples/WiFiScanDualAntenna⚠️ +78000000000--00
WiFi/examples/WiFiScanTime⚠️ +80000000000--00
WiFi/examples/WiFiTelnetToSerial⚠️ +78000000000--00
WiFi/examples/WiFiUDPClient⚠️ +80000000000--00
Wire/examples/WireMaster00000000000000
Wire/examples/WireScan00000000000000
Wire/examples/WireSlave00000000000000
BLE/examples/BLE5_extended_scan--00--💚 -140💚 -140💚 -140--
BLE/examples/BLE5_multi_advertising--00--💚 -140💚 -140💚 -140--
BLE/examples/BLE5_periodic_advertising--00--💚 -140💚 -140💚 -140--
BLE/examples/BLE5_periodic_sync--00--💚 -140💚 -140💚 -140--
BLE/examples/Beacon_Scanner--00--💚 -140💚 -140💚 -14000
BLE/examples/Client--00--💚 -140💚 -140💚 -14000
BLE/examples/EddystoneTLM_Beacon--00--💚 -140💚 -140💚 -14000
BLE/examples/EddystoneURL_Beacon--00--💚 -140💚 -140💚 -14000
BLE/examples/Notify--00--💚 -140💚 -140💚 -14000
BLE/examples/Scan--00--💚 -140💚 -140💚 -14000
BLE/examples/Server--00--💚 -140💚 -140💚 -14000
BLE/examples/Server_multiconnect--00--💚 -140💚 -140💚 -140💚 -120
BLE/examples/UART--00--💚 -140💚 -140💚 -14000
BLE/examples/Write--00--💚 -140💚 -140💚 -14000
BLE/examples/iBeacon--00--💚 -140💚 -140💚 -14000
ESP32/examples/Camera/CameraWebServer--‼️ +5K⚠️ +496‼️ +4K⚠️ +12------‼️ +12K⚠️ +68
ESP32/examples/DeepSleep/ExternalWakeUp--0000------00
ESP_NOW/examples/ESP_NOW_Broadcast_Master--00000000--00
ESP_NOW/examples/ESP_NOW_Broadcast_Slave--00000000--00
ESP_NOW/examples/ESP_NOW_Network--00000000--00
ESP_NOW/examples/ESP_NOW_Serial--00000000--00
ESP_SR/examples/Basic--00----------
HTTPClient/examples/HTTPClientEnterprise--0000💚 -140💚 -140--00
Insights/examples/DiagnosticsSmokeTest--00000000--00
Insights/examples/MinimalDiagnostics--00000000--00
Matter/examples/MatterColorLight--00000000--00
Matter/examples/MatterCommissionTest--00000000--00
Matter/examples/MatterComposedLights--00000000--00
Matter/examples/MatterContactSensor--00000000--00
Matter/examples/MatterDimmableLight--00000000--00
Matter/examples/MatterEnhancedColorLight--00000000--00
Matter/examples/MatterFan--00000000--00
Matter/examples/MatterHumiditySensor--00000000--00
Matter/examples/MatterMinimum--00000000--00
Matter/examples/MatterOccupancySensor--00000000--00
Matter/examples/MatterOnIdentify--00000000--00
Matter/examples/MatterOnOffLight--00000000--00
Matter/examples/MatterOnOffPlugin--00000000--00
Matter/examples/MatterPressureSensor--00000000--00
Matter/examples/MatterSmartButon--00000000--00
Matter/examples/MatterTemperatureLight--00000000--00
Matter/examples/MatterTemperatureSensor--00000000--00
Matter/examples/MatterThermostat--00000000--00
Matter/examples/WiFiProvWithinMatter--00000000--00
NetworkClientSecure/examples/WiFiClientSecureEnterprise--00000000--00
RainMaker/examples/RMakerCustom--00000000--00
RainMaker/examples/RMakerCustomAirCooler--00000000----
RainMaker/examples/RMakerSonoffDualR3--00000000----
RainMaker/examples/RMakerSwitch--00000000--00
SimpleBLE/examples/SimpleBleDevice--00--00000000
WebServer/examples/Middleware--💚 -120💚 -120💚 -140💚 -140--00
WiFi/examples/WPS--00000000--00
WiFi/examples/WiFiBlueToothSwitch--00--0000--00
WiFi/examples/WiFiClientEnterprise--00000000--00
WiFi/examples/WiFiSmartConfig--00000000--00
WiFiProv/examples/WiFiProv--00000000--00
OpenThread/examples/COAP/coap_lamp--------0000--
OpenThread/examples/COAP/coap_switch--------0000--
OpenThread/examples/SimpleCLI--------0000--
OpenThread/examples/SimpleNode--------0000--
OpenThread/examples/SimpleThreadNetwork/ExtendedRouterNode--------0000--
OpenThread/examples/SimpleThreadNetwork/LeaderNode--------0000--
OpenThread/examples/SimpleThreadNetwork/RouterNode--------0000--
OpenThread/examples/ThreadScan--------0000--
OpenThread/examples/onReceive--------0000--
Zigbee/examples/Zigbee_CarbonDioxide_Sensor--------0000--
Zigbee/examples/Zigbee_Color_Dimmable_Light--------0000--
Zigbee/examples/Zigbee_Color_Dimmer_Switch--------0000--
Zigbee/examples/Zigbee_Contact_Switch--------0000--
Zigbee/examples/Zigbee_Dimmable_Light--------0000--
Zigbee/examples/Zigbee_Occupancy_Sensor--------0000--
Zigbee/examples/Zigbee_On_Off_Light--------0000--
Zigbee/examples/Zigbee_On_Off_Switch--------0000--
Zigbee/examples/Zigbee_Pressure_Flow_Sensor--------0000--
Zigbee/examples/Zigbee_Scan_Networks--------0000--
Zigbee/examples/Zigbee_Temp_Hum_Sensor_Sleepy--------0000--
Zigbee/examples/Zigbee_Temperature_Sensor--------0000--
Zigbee/examples/Zigbee_Thermostat--------0000--
Zigbee/examples/Zigbee_Window_Covering--------0000--
BluetoothSerial/examples/DiscoverConnect------------00
BluetoothSerial/examples/GetLocalMAC------------00
BluetoothSerial/examples/SerialToSerialBT------------00
BluetoothSerial/examples/SerialToSerialBTM------------00
BluetoothSerial/examples/SerialToSerialBT_Legacy------------00
BluetoothSerial/examples/SerialToSerialBT_SSP------------00
BluetoothSerial/examples/bt_classic_device_discovery------------00
BluetoothSerial/examples/bt_remove_paired_devices------------00
ESP32/examples/DeepSleep/SmoothBlink_ULP_Code------------00
Ethernet/examples/ETH_LAN8720------------00

@TD-er
Copy link
Contributor Author

TD-er commented Feb 6, 2025

Included in single PR: #10945

@TD-er TD-er closed this Feb 6, 2025
@TD-er TD-er deleted the patch-2 branch February 6, 2025 15:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Crash when using String::move on empty string
2 participants