base line for nkolban#226

Author: nkolban

cpp_utils/ArduinoBLE.md

@@ -1,11 +1,13 @@
 # Arduino BLE Support
-As part of this Github project, we provide libraries for Bluetooth Low Energy (BLE) for the ESP32 Arduino environment.  Support for this capability is still in the process of being cooked (as of September 2017).  As such you should not build product based on these functions as changes to the API and implementation are extremely likely over the next couple of months.
+As part of this Github project, we provide libraries for Bluetooth Low Energy (BLE) for the ESP32 Arduino environment.  Support for this capability is still in the process of being cooked (as of November 2017).  As such you should not build product based on these functions as changes to the API and implementation are extremely likely over the next couple of months.
 
 That said, we now have the ability to produce a driver you can use for testing.  This will give you early access to the function while give those who choose to build and maintain the code early feedback on what works, what doesn't and what can be improved from a usage perspective.
 
 When complete, the BLE support for ESP32 Arduino will be available as a single ZIP file.  The file will be called **ESP32_BLE.zip**.  It is this file that will be able to be imported into the Arduino IDE from the `Sketch -> Include Library -> Add .ZIP library`.  When initial development of the library has been completed, this ZIP will be placed under some form of release control so that an ordinary Arduino IDE user can simply download this as a unit and install.
 
-A build of the BLE support for Arduino can be found through the Arduino IDE.  Visit Sketch -> Include Library -> Manage Libraries.  In the library filter, enter "esp32 ble arduino".  The search will narrow and you should see "ESP32 BLE Arduino" available for installation or upgrade.
+Update: As of 2017-11, the BLE support has been included with the Arduino ESP32 base package.
+
+A build of the BLE support for Arduino can be found through the Arduino IDE.  Visit `Sketch -> Include Library -> Manage Libraries`.  In the library filter, enter "esp32 ble arduino".  The search will narrow and you should see "ESP32 BLE Arduino" available for installation or upgrade.
 
 
 
@@ -32,7 +34,7 @@ From October 2017 onwards, a build of the BLE libraries is supplied with the Ard
 4. Extract the `ESP32_BLE.zip` file there
 
 ## Switching on debugging
-The BLE support contains extensive internal diagnostics which can be switched on through the "Tools > Core Debug Level" setting:
+The BLE support contains extensive internal diagnostics which can be switched on through the `Tools > Core Debug Level` setting:
 
 ![](../../Documentation/images/arduino_debug.png) 
 

cpp_utils/GeneralUtils.cpp

@@ -398,9 +398,4 @@ const char* GeneralUtils::errorToString(esp_err_t errCode) {
 } // errorToString
 
 
-/**
- * @brief Restart the ESP32.
- */
-void GeneralUtils::restart() {
-	esp_restart();
-} // restart
+

cpp_utils/GeneralUtils.h

@@ -22,7 +22,7 @@ class GeneralUtils {
 	static const char* errorToString(esp_err_t errCode);
 	static void        hexDump(const uint8_t* pData, uint32_t length);
 	static std::string ipToString(uint8_t* ip);
-	static void        restart();
+
 };
 
 #endif /* COMPONENTS_CPP_UTILS_GENERALUTILS_H_ */

cpp_utils/HttpServer.cpp

@@ -15,6 +15,7 @@
 #include "FileSystem.h"
 #include "WebSocket.h"
 #include "GeneralUtils.h"
+#include "Memory.h"
 static const char* LOG_TAG = "HttpServer";
 
 #undef close
@@ -65,9 +66,9 @@ static void listDirectory(std::string path, HttpResponse& response) {
  * Constructor for HTTP Server
  */
 HttpServer::HttpServer() {
-	m_portNumber = 80;              // The default port number.
-	m_rootPath   = "";             // The default path.
-	m_useSSL     = false;           // Default SSL is no.
+	m_portNumber = 80;            // The default port number.
+	m_rootPath   = "";            // The default path.
+	m_useSSL     = false;         // Default SSL is no.
 	setDirectoryListing(false);   // Default directory listing is no.
 } // HttpServer
 
@@ -188,11 +189,12 @@ class HttpServerTask: public Task {
 		while(1) {   // Loop forever.
 
 			ESP_LOGD("HttpServerTask", "Waiting for new peer client");
-
+			Memory::checkIntegrity();
 			try {
 				clientSocket = m_pHttpServer->m_sockServ.waitForNewClient();   // Block waiting for a new external client connection.
 			}
-			catch(std::exception e) {
+			catch(std::exception &e) {
+				ESP_LOGE("HttpServerTask", "Caught an exception waiting for new client!");
 				return;
 			}
 

cpp_utils/Memory.cpp

@@ -11,20 +11,36 @@
 #include <stdlib.h>
 #include "GeneralUtils.h"
 extern "C" {
-#include <esp_heap_trace.h>
-#include <esp_heap_caps.h>
+	#include <esp_heap_trace.h>
+	#include <esp_heap_caps.h>
 }
 #include <esp_log.h>
+#include <esp_err.h>
 
 static const char* LOG_TAG = "Memory";
 
 heap_trace_record_t* Memory::m_pRecords = nullptr;
 size_t               Memory::m_lastHeapSize = 0;
 
+
+/**
+ * @brief Check the integrity of memory.
+ * @return True if all integrity checks passed
+ */
+/* STATIC */ bool Memory::checkIntegrity() {
+	bool rc = ::heap_caps_check_integrity_all(true);
+	if (rc == false && m_pRecords != nullptr) {
+		dumpRanges();
+		abort();
+	}
+	return rc;
+} // checkIntegrity
+
+
 /**
  * @brief Dump the trace records from the heap.
  */
-void Memory::dump() {
+/* STATIC */ void Memory::dump() {
 	::heap_trace_dump();
 } // dump
 
@@ -34,13 +50,53 @@ void Memory::dump() {
 	int diff = currentUsage - m_lastHeapSize;
 	ESP_LOGD(LOG_TAG, "%s: Heap changed by %d bytes  (%d to %d)", tag.c_str(), diff, m_lastHeapSize, currentUsage);
 	m_lastHeapSize = currentUsage;
-}
+} // dumpHeapChange
+
+
+/**
+ * @brief Dump the ranges of allocations found.
+ */
+/* STATIC */ void Memory::dumpRanges() {
+	// Each record contained in the Heap trace has the following format:
+	//
+	// * uint32_t ccount – Timestamp of record.
+	// * void*    address – Address that was allocated or released.
+	// * size_t   size – Size of the block that was requested and allocated.
+	// * void*    alloced_by[CONFIG_HEAP_TRACING_STACK_DEPTH] – Call stack of allocator
+	// * void*    freed_by[CONFIG_HEAP_TRACING_STACK_DEPTH] – Call stack of releasor
+	//
+	if (m_pRecords == nullptr) {
+		return;
+	}
+	esp_log_level_set("*", ESP_LOG_NONE);
+	size_t count = heap_trace_get_count();
+	heap_trace_record_t record;
+	printf(">>> dumpRanges\n");
+	for (size_t i=0; i<count; i++) {
+		esp_err_t errRc = heap_trace_get(i, &record);
+		if (errRc != ESP_OK) {
+			ESP_LOGE(LOG_TAG, "heap_trace_get: %d", errRc);
+		}
+		printf("0x%x:0x%x:%d:", (uint32_t)record.address, ((uint32_t)record.address) + record.size, record.size);
+		for (size_t j=0; j<CONFIG_HEAP_TRACING_STACK_DEPTH; j++) {
+			printf("%x ", (uint32_t)record.alloced_by[j]);
+		}
+		printf(":");
+		for (size_t j=0; j<CONFIG_HEAP_TRACING_STACK_DEPTH; j++) {
+			printf("%x ", (uint32_t)record.freed_by[j]);
+		}
+		printf("\n");
+	}
+	printf("<<< dumpRanges\n");
+	esp_log_level_set("*", ESP_LOG_VERBOSE);
+} // dumpRanges
+
 
 /**
  * @brief Initialize heap recording.
  * @param [in] recordCount The maximum number of records to be recorded.
  */
-void Memory::init(uint32_t recordCount) {
+/* STATIC */ void Memory::init(uint32_t recordCount) {
 	assert(recordCount > 0);
 	if (m_pRecords != nullptr) {
 		ESP_LOGE(LOG_TAG, "Already initialized");
@@ -60,7 +116,10 @@ void Memory::init(uint32_t recordCount) {
 } // init
 
 
-void Memory::resumeTrace() {
+/**
+ * @brief Resume previously paused trace.
+ */
+/* STATIC */ void Memory::resumeTrace() {
 	esp_err_t errRc = ::heap_trace_resume();
 	if (errRc != ESP_OK) {
 		ESP_LOGE(LOG_TAG, "heap_trace_resume: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
@@ -69,7 +128,10 @@ void Memory::resumeTrace() {
 } // resumeTrace
 
 
-void Memory::startTraceAll() {
+/**
+ * @brief Start tracing all allocate and free calls.
+ */
+/* STATIC */ void Memory::startTraceAll() {
 	esp_err_t errRc = ::heap_trace_start(HEAP_TRACE_ALL);
 	if (errRc != ESP_OK) {
 		ESP_LOGE(LOG_TAG, "heap_trace_start: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
@@ -78,7 +140,10 @@ void Memory::startTraceAll() {
 } // startTraceAll
 
 
-void Memory::startTraceLeaks() {
+/**
+ * Start tracing leaks.  Matched allocate and free calls are removed.
+ */
+/* STATIC */ void Memory::startTraceLeaks() {
 	esp_err_t errRc = ::heap_trace_start(HEAP_TRACE_LEAKS);
 	if (errRc != ESP_OK) {
 		ESP_LOGE(LOG_TAG, "heap_trace_start: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));
@@ -87,7 +152,10 @@ void Memory::startTraceLeaks() {
 } // startTraceLeaks
 
 
-void Memory::stopTrace() {
+/**
+ * @brief Stop recording heap trace.
+ */
+/* STATIC */ void Memory::stopTrace() {
 	esp_err_t errRc = ::heap_trace_stop();
 	if (errRc != ESP_OK) {
 		ESP_LOGE(LOG_TAG, "heap_trace_start: rc=%d %s", errRc, GeneralUtils::errorToString(errRc));

cpp_utils/Memory.h

@@ -16,7 +16,9 @@ extern "C" {
 
 class Memory {
 public:
+	static bool checkIntegrity();
 	static void dump();
+	static void dumpRanges();
 	static void dumpHeapChange(std::string tag);
 	static void init(uint32_t recordCount);
 	static void resumeTrace();

cpp_utils/SockServ.cpp

@@ -64,6 +64,7 @@ SockServ::~SockServ() {
 	SockServ* pSockServ = (SockServ*)data;
 	try {
 		while(1) {
+			ESP_LOGD(LOG_TAG, "Waiting on accept")
 			Socket tempSock = pSockServ->m_serverSocket.accept(pSockServ->getSSL());
 			if (!tempSock.isValid()) {
 				continue;

cpp_utils/Socket.cpp

@@ -78,7 +78,7 @@ Socket Socket::accept(bool useSSL) {
 		newSocket.m_sslSock.fd = clientSockFD;
 		newSocket.sslHandshake();
 		ESP_LOGD(LOG_TAG, "DEBUG DEBUG ");
-		uint8_t x;
+		uint8_t x;   // What is going on here???
 		newSocket.receive(&x, 1, 0); // FIX FIX FIX
 	}
 	ESP_LOGD(LOG_TAG, "<< accept: sockFd: %d", clientSockFD);
@@ -226,7 +226,10 @@ void Socket::getBind(struct sockaddr* pAddr) {
 		ESP_LOGE(LOG_TAG, "getBind: Socket is not initialized.");
 	}
 	socklen_t nameLen = sizeof(struct sockaddr);
-	::getsockname(m_sock, pAddr, &nameLen);
+	int rc = ::getsockname(m_sock, pAddr, &nameLen);
+	if (rc != 0) {
+		ESP_LOGE(LOG_TAG, "Error with getsockname in getBind: %s", strerror(errno));
+	}
 } // getBind
 
 

cpp_utils/System.cpp

@@ -57,3 +57,10 @@ std::string System::getIDFVersion() {
 size_t System::getMinimumFreeHeapSize() {
 	return heap_caps_get_minimum_free_size(MALLOC_CAP_8BIT);
 } // getMinimumFreeHeapSize
+
+/**
+ * @brief Restart the ESP32.
+ */
+void System::restart() {
+	esp_restart();
+} // restart

cpp_utils/System.h

@@ -22,6 +22,7 @@ class System {
 	static size_t getFreeHeapSize();
 	static std::string getIDFVersion();
 	static size_t getMinimumFreeHeapSize();
+	static void restart();
 };
 
 #endif /* COMPONENTS_CPP_UTILS_SYSTEM_H_ */