[SharedCache] Refactor Shared Cache

In absence of a better name, this commit refactors the shared cache code.

Author: emesare

docs/dev/workflows.md

@@ -145,7 +145,7 @@ You can query the list of all registered workflows or filter them by type using
 # List all Module and Function workflows
 list(Workflow)
 [<Workflow: core.function.baseAnalysis>,
-<Workflow: core.function.dsc>,
+<Workflow: core.function.sharedCache>,
 <Workflow: core.function.metaAnalysis>,
 <Workflow: core.function.objectiveC>,
 <Workflow: core.module.baseAnalysis>,
@@ -157,7 +157,7 @@ Settings().query_property_string_list("analysis.workflows.moduleWorkflow", "enum
 
 # List all function workflows from the Settings API
 >>> Settings().query_property_string_list("analysis.workflows.functionWorkflow", "enum")
-['core.function.baseAnalysis', 'core.function.dsc', 'core.function.metaAnalysis', 'core.function.objectiveC']
+['core.function.baseAnalysis', 'core.function.sharedCache', 'core.function.metaAnalysis', 'core.function.objectiveC']
 ```
 
 Once you've queried the available workflows, you can create your own by cloning and modifying an existing workflow. Below are some simple examples that demonstrate how to modify module-level analysis.

objectivec/objc.cpp

@@ -1509,12 +1509,22 @@ void ObjCProcessor::ProcessCFStrings(std::optional<std::string> imageName)
 					uint8_t* rawData = static_cast<uint8_t*>(data.GetData());
 					uint8_t* offsetAddress = rawData + bufferOff;
 					uint16_t c = *reinterpret_cast<uint16_t*>(offsetAddress);
-					if (c == 0x20)
+					if (c == 0x20) {
 						str.push_back('_');
-					else if (c < 0x80)
+					} else if (c == '\r') {
+						str.push_back('\\');
+						str.push_back('r');
+					} else if (c == '\n') {
+						str.push_back('\\');
+						str.push_back('n');
+					} else if (c == '\t') {
+						str.push_back('\\');
+						str.push_back('t');
+					} else if (c > 0x20 && c < 0x80) {
 						str.push_back(c);
-					else
+					} else {
 						str.push_back('?');
+					}
 				}
 				DefineObjCSymbol(
 					DataSymbol, Type::ArrayType(Type::WideCharType(2), size + 1), "ustr_" + str, strLoc, true);
@@ -1524,11 +1534,26 @@ void ObjCProcessor::ProcessCFStrings(std::optional<std::string> imageName)
 			else  // UTF8 / ASCII
 			{
 				reader->Seek(strLoc);
-				str = reader->ReadCString();
-				for (auto& c : str)
+				std::string rawStr = reader->ReadCString(size + 1);
+				str = "";
+				for (signed char c : rawStr)
 				{
-					if (c == ' ')
-						c = '_';
+					if (c == 0x20) {
+						str.push_back('_');
+					} else if (c == '\r') {
+						str.push_back('\\');
+						str.push_back('r');
+					} else if (c == '\n') {
+						str.push_back('\\');
+						str.push_back('n');
+					} else if (c == '\t') {
+						str.push_back('\\');
+						str.push_back('t');
+					} else if (c > 0x20 || c < 0) {
+						str.push_back(c);
+					} else {
+						str.push_back('?');
+					}
 				}
 				DefineObjCSymbol(DataSymbol, Type::ArrayType(Type::IntegerType(1, true), str.size() + 1), "cstr_" + str,
 					strLoc, true);

objectivec/objc.h

@@ -166,7 +166,7 @@ namespace BinaryNinja {
 		    \throws Exception
 			\return the string
 		*/
-		virtual std::string ReadCString() = 0;
+		virtual std::string ReadCString(size_t maxLength = -1) = 0;
 
 		/*! Read a uint8_t from the current cursor position and advance the cursor by 1 byte
 

view/macho/objc.cpp

@@ -11,9 +11,9 @@ void MachoObjCReader::Read(void* dest, size_t len)
 	m_reader.Read(dest, len);
 }
 
-std::string MachoObjCReader::ReadCString()
+std::string MachoObjCReader::ReadCString(size_t maxLength)
 {
-	return m_reader.ReadCString();
+	return m_reader.ReadCString(maxLength);
 }
 
 uint8_t MachoObjCReader::Read8()

view/macho/objc.h

@@ -10,7 +10,7 @@ namespace BinaryNinja {
 
 	public:
 		void Read(void* dest, size_t len) override;
-		std::string ReadCString() override;
+		std::string ReadCString(size_t maxLength = -1) override;
 		uint8_t Read8() override;
 		uint16_t Read16() override;
 		uint32_t Read32() override;

view/sharedcache/CMakeLists.txt

@@ -33,6 +33,7 @@ endif()
 set(HARD_FAIL_MODE OFF CACHE BOOL "Enable hard fail mode")
 set(SLIDEINFO_DEBUG_TAGS OFF CACHE BOOL "Enable debug tags in slideinfo")
 set(VIEW_NAME "DSCView" CACHE STRING "Name of the view")
+# TODO: Remove this, if we want to keep a metadata version around we must have this in the source.
 set(METADATA_VERSION 5 CACHE STRING "Version of the metadata")
 
 add_subdirectory(core)

view/sharedcache/HeadlessPlugin.cpp

@@ -1,9 +1,9 @@
 #include <binaryninjaapi.h>
-#include "DSCView.h"
-#include "SharedCache.h"
+#include "SharedCacheView.h"
 
 #ifdef __cplusplus
-extern "C" {
+extern "C"
+{
 #endif
 	extern void RegisterSharedCacheWorkflow();
 #ifdef __cplusplus
@@ -16,7 +16,7 @@ extern "C"
 
 	BINARYNINJAPLUGIN bool CorePluginInit()
 	{
-		InitDSCViewType();
+		SharedCacheViewType::Register();
 		RegisterSharedCacheWorkflow();
 		return true;
 	}