Initial implementation of FHS installed and freestanding bundles proposal

millenomi · millenomi · commit d35242eaa756 · 2018-01-16T13:51:54.000-08:00
diff --git a/CoreFoundation/Base.subproj/module.modulemap b/CoreFoundation/Base.subproj/module.modulemap
@@ -2,4 +2,5 @@ module CoreFoundation [extern_c] [system] {
     umbrella header "CoreFoundation.h"
     explicit module CFPlugInCOM { header "CFPlugInCOM.h" }
 
+    explicit module Private { header "CFPriv.h" }
 }
diff --git a/CoreFoundation/PlugIn.subproj/CFBundle.c b/CoreFoundation/PlugIn.subproj/CFBundle.c
@@ -118,6 +118,7 @@ CONST_STRING_DECL(_kCFBundleCFMLoadAsBundleKey, "CFBundleCFMLoadAsBundle")
 // Keys used by NSBundle for loaded Info plists.
 CONST_STRING_DECL(_kCFBundlePrincipalClassKey, "NSPrincipalClass")
 
+
 static CFTypeID __kCFBundleTypeID = _kCFRuntimeNotATypeID;
 
 static pthread_mutex_t CFBundleGlobalDataLock = PTHREAD_MUTEX_INITIALIZER;
@@ -136,6 +137,39 @@ static void _CFBundleEnsureBundlesExistForImagePaths(CFArrayRef imagePaths);
 
 #pragma mark -
 
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+#define _CFBundleFHSDirectory_share CFSTR("share")
+
+CF_INLINE Boolean _CFBundleURLIsForFHSInstalledBundle(CFURLRef bundleURL) {
+    // Paths of this form are FHS installed bundles:
+    // <anywhere>/share/<name>.resources
+    
+    CFStringRef extension = CFURLCopyPathExtension(bundleURL);
+    CFURLRef parentURL = CFURLCreateCopyDeletingLastPathComponent(NULL, bundleURL);
+    CFStringRef containingDirectoryName = parentURL ? CFURLCopyLastPathComponent(parentURL) : NULL;
+    
+    Boolean isFHSBundle =
+    extension &&
+    containingDirectoryName &&
+    CFEqual(extension, _CFBundleSiblingResourceDirectoryExtension) &&
+    CFEqual(containingDirectoryName, _CFBundleFHSDirectory_share);
+    
+    if (extension) CFRelease(extension);
+    if (parentURL) CFRelease(parentURL);
+    if (containingDirectoryName) CFRelease(containingDirectoryName);
+    
+    return isFHSBundle;
+}
+#endif // CFBUNDLE_ALLOW_FHS_BUNDLES
+
+Boolean _CFBundleSupportsFHSBundles() {
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+    return true;
+#else
+    return false;
+#endif
+}
+
 CF_PRIVATE os_log_t _CFBundleResourceLogger(void) {
     static os_log_t _log;
     static dispatch_once_t onceToken;
@@ -677,6 +711,10 @@ static CFBundleRef _CFBundleCreate(CFAllocatorRef allocator, CFURLRef bundleURL,
     }
 
     bundle->_url = newURL;
+    
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+    bundle->_isFHSInstalledBundle = _CFBundleURLIsForFHSInstalledBundle(newURL);
+#endif
 
     bundle->_version = localVersion;
     bundle->_infoDict = NULL;
diff --git a/CoreFoundation/PlugIn.subproj/CFBundlePriv.h b/CoreFoundation/PlugIn.subproj/CFBundlePriv.h
@@ -302,6 +302,9 @@ CFBundleRefNum _CFBundleOpenBundleResourceFork(CFBundleRef bundle);	// deprecate
 CF_EXPORT
 void _CFBundleCloseBundleResourceFork(CFBundleRef bundle);	// deprecated in favor of CFBundleCloseBundleResourceMap
 
+CF_EXPORT
+Boolean _CFBundleSupportsFHSBundles(void);
+
 CF_EXTERN_C_END
 
 #endif /* ! __COREFOUNDATION_CFBUNDLEPRIV__ */
diff --git a/CoreFoundation/PlugIn.subproj/CFBundle_Executable.c b/CoreFoundation/PlugIn.subproj/CFBundle_Executable.c
@@ -15,6 +15,30 @@
 #include <dlfcn.h>
 #endif
 
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+    #if __LP64__
+        #define _CFBundleFHSArchDirectorySuffix "64"
+    #else // !__LP64__
+        #define _CFBundleFHSArchDirectorySuffix "32"
+    #endif // __LP64__
+
+    CONST_STRING_DECL(_CFBundleFHSDirectory_bin, "bin");
+    CONST_STRING_DECL(_CFBundleFHSDirectory_sbin, "sbin");
+    CONST_STRING_DECL(_CFBundleFHSDirectory_libWithArchSuffix, "lib" _CFBundleFHSArchDirectorySuffix);
+    CONST_STRING_DECL(_CFBundleFHSDirectory_lib, "lib");
+
+    #define _CFBundleFHSExecutablesDirectorySuffix CFSTR(".executables")
+
+    #define _CFBundleFHSDirectoryCLiteral_libexec "libexec"
+
+    #define _CFBundleFHSDirectoriesInExecutableSearchOrder \
+        _CFBundleFHSDirectory_bin, \
+        _CFBundleFHSDirectory_sbin, \
+        _CFBundleFHSDirectory_libWithArchSuffix, \
+        _CFBundleFHSDirectory_lib
+
+#endif // CFBUNDLE_ALLOW_FHS_BUNDLES
+
 // This is here because on iPhoneOS with the dyld shared cache, we remove binaries from their
 // original locations on disk, so checking whether a binary's path exists is no longer sufficient.
 // For performance reasons, we only call dlopen_preflight() after we've verified that the binary
@@ -38,7 +62,22 @@ static CFURLRef _CFBundleCopyExecutableURLRaw(CFURLRef urlPath, CFStringRef exeN
     CFURLRef executableURL = NULL;
     if (!urlPath || !exeName) return NULL;
     
-#if DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_EMBEDDED_MINI
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+    if (!executableURL) {
+        executableURL = CFURLCreateWithFileSystemPathRelativeToBase(kCFAllocatorSystemDefault, exeName, kCFURLPOSIXPathStyle, false, urlPath);
+        if (!_binaryLoadable(executableURL)) {
+            CFRelease(executableURL);
+            
+            CFStringRef sharedLibraryName = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("%@%@%@"), _CFBundleFHSSharedLibraryFilenamePrefix, exeName, _CFBundleFHSSharedLibraryFilenameSuffix);
+            
+            executableURL = CFURLCreateWithFileSystemPathRelativeToBase(kCFAllocatorSystemDefault, sharedLibraryName, kCFURLPOSIXPathStyle, false, urlPath);
+            if (!_binaryLoadable(executableURL)) {
+                CFRelease(executableURL);
+                executableURL = NULL;
+            }
+        }
+    }
+#elif DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_EMBEDDED_MINI
     const uint8_t *image_suffix = (uint8_t *)__CFgetenvIfNotRestricted("DYLD_IMAGE_SUFFIX");
     
     if (image_suffix) {
@@ -152,19 +191,60 @@ static CFURLRef _CFBundleCopyExecutableURLInDirectory2(CFBundleRef bundle, CFURL
 #else
             Boolean doExecSearch = true;
 #endif
+            
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+            if (lookupMainExe && bundle && bundle->_isFHSInstalledBundle) {
+                // For a FHS installed bundle, the URL points to share/Bundle.resources, and the binary is in:
+                
+                CFURLRef prefix = CFURLCreateCopyDeletingLastPathComponent(kCFAllocatorSystemDefault, url);
+                
+                CFStringRef directories[] = { _CFBundleFHSDirectoriesInExecutableSearchOrder };
+                size_t directoriesCount = sizeof(directories) / sizeof(directories[0]);
+                
+                for (size_t i = 0; i < directoriesCount; i++) {
+                    CFURLRef where = CFURLCreateCopyAppendingPathComponent(kCFAllocatorSystemDefault, prefix, directories[i], true);
+                    executableURL = _CFBundleCopyExecutableURLRaw(where, executableName);
+                    CFRelease(where);
+                    
+                    if (executableURL) {
+                        foundIt = true;
+                        break;
+                    }
+                }
+                
+                CFRelease(prefix);
+            }
+#endif // CFBUNDLE_ALLOW_FHS_BUNDLES
+            
             // Now, look for the executable inside the bundle.
-            if (doExecSearch && 0 != version) {
+            if (!foundIt && doExecSearch && 0 != version) {
                 CFURLRef exeDirURL = NULL;
                 
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+                if (bundle && bundle->_isFHSInstalledBundle) {
+                    CFURLRef withoutExtension = CFURLCreateCopyDeletingPathExtension(kCFAllocatorSystemDefault, url);
+                    CFStringRef lastPathComponent = CFURLCopyLastPathComponent(withoutExtension);
+                    
+                    CFURLRef libexec = CFURLCreateWithString(kCFAllocatorSystemDefault, CFSTR("../../" _CFBundleFHSDirectoryCLiteral_libexec), url);
+                    
+                    CFStringRef exeDirName = CFStringCreateWithFormat(kCFAllocatorSystemDefault, NULL, CFSTR("%@%@"), lastPathComponent, _CFBundleFHSExecutablesDirectorySuffix);
+                    exeDirURL = CFURLCreateCopyAppendingPathComponent(kCFAllocatorSystemDefault, libexec, exeDirName, true);
+                    
+                    CFRelease(withoutExtension);
+                    CFRelease(lastPathComponent);
+                    CFRelease(libexec);
+                    CFRelease(exeDirName);
+                } else
+#endif // CFBUNDLE_ALLOW_FHS_BUNDLES
                 if (1 == version) {
                     exeDirURL = CFURLCreateWithString(kCFAllocatorSystemDefault, _CFBundleExecutablesURLFromBase1, url);
                 } else if (2 == version) {
                     exeDirURL = CFURLCreateWithString(kCFAllocatorSystemDefault, _CFBundleExecutablesURLFromBase2, url);
                 } else {
-#if DEPLOYMENT_TARGET_WINDOWS
-                    // On Windows, if the bundle URL is foo.resources, then the executable is at the same level as the .resources directory
+#if DEPLOYMENT_TARGET_WINDOWS || CFBUNDLE_ALLOW_FHS_BUNDLES
+                    // On Windows, Linyx if the bundle URL is foo.resources, then the executable is at the same level as the .resources directory
                     CFStringRef extension = CFURLCopyPathExtension(url);
-                    if (extension && CFEqual(extension, _CFBundleWindowsResourceDirectoryExtension)) {
+                    if (extension && CFEqual(extension, _CFBundleSiblingResourceDirectoryExtension)) {
                         exeDirURL = CFURLCreateCopyDeletingLastPathComponent(kCFAllocatorSystemDefault, url);
                     } else {
                         exeDirURL = (CFURLRef)CFRetain(url);
@@ -232,15 +312,15 @@ static CFURLRef _CFBundleCopyBundleURLForExecutablePath(CFStringRef str) {
 #if DEPLOYMENT_TARGET_WINDOWS
     // Is this a .dll or .exe?
     if (buffLen >= 5 && (_wcsnicmp((wchar_t *)&(buff[buffLen-4]), L".dll", 4) == 0 || _wcsnicmp((wchar_t *)&(buff[buffLen-4]), L".exe", 4) == 0)) {
-        CFIndex extensionLength = CFStringGetLength(_CFBundleWindowsResourceDirectoryExtension);
+        CFIndex extensionLength = CFStringGetLength(_CFBundleSiblingResourceDirectoryExtension);
         buffLen -= 4;
         // If this is an _debug, we should strip that before looking for the bundle
         if (buffLen >= 7 && (_wcsnicmp((wchar_t *)&buff[buffLen-6], L"_debug", 6) == 0)) buffLen -= 6;
         
         if (buffLen + 1 + extensionLength < CFMaxPathSize) {
             buff[buffLen] = '.';
             buffLen ++;
-            CFStringGetCharacters(_CFBundleWindowsResourceDirectoryExtension, CFRangeMake(0, extensionLength), buff + buffLen);
+            CFStringGetCharacters(_CFBundleSiblingResourceDirectoryExtension, CFRangeMake(0, extensionLength), buff + buffLen);
             buffLen += extensionLength;
             outstr = CFStringCreateWithCharactersNoCopy(kCFAllocatorSystemDefault, buff, buffLen, kCFAllocatorNull);
             url = CFURLCreateWithFileSystemPath(kCFAllocatorSystemDefault, outstr, PLATFORM_PATH_STYLE, true);
diff --git a/CoreFoundation/PlugIn.subproj/CFBundle_Internal.h b/CoreFoundation/PlugIn.subproj/CFBundle_Internal.h
@@ -30,6 +30,22 @@ CF_EXTERN_C_BEGIN
 #define PLATFORM_PATH_STYLE kCFURLPOSIXPathStyle
 #endif
 
+// For development use only:
+#define _CFBUNDLE_ALLOW_FHS_BUNDLES_ON_ALL_TARGETS 0
+
+#define CFBUNDLE_ALLOW_FHS_BUNDLES (_CFBUNDLE_ALLOW_FHS_BUNDLES_ON_ALL_TARGETS || !(DEPLOYMENT_TARGET_MACOSX || DEPLOYMENT_TARGET_EMBEDDED || DEPLOYMENT_TARGET_EMBEDDED_MINI || DEPLOYMENT_TARGET_WINDOWS))
+
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+
+#if DEPLOYMENT_TARGET_LINUX || DEPLOYMENT_TARGET_FREEBSD || _CFBUNDLE_ALLOW_FHS_BUNDLES_ON_ALL_TARGETS
+    #define _CFBundleFHSSharedLibraryFilenamePrefix CFSTR("lib")
+    #define _CFBundleFHSSharedLibraryFilenameSuffix CFSTR(".so")
+#else // a non-covered DEPLOYMENT_TARGET…
+    #error Disable FHS bundles or specify shared library prefixes and suffixes for this platform.
+#endif // DEPLOYMENT_TARGET_…
+
+#endif // CFBUNDLE_ALLOW_FHS_BUNDLES
+
 #define CFBundleExecutableNotFoundError             4
 #define CFBundleExecutableNotLoadableError          3584
 #define CFBundleExecutableArchitectureMismatchError 3585
@@ -62,6 +78,10 @@ struct __CFBundle {
     
     CFURLRef _url;
     
+#if CFBUNDLE_ALLOW_FHS_BUNDLES
+    Boolean _isFHSInstalledBundle;
+#endif
+    
     CFDictionaryRef _infoDict;
     CFDictionaryRef _localInfoDict;
     CFArrayRef _searchLanguages;
@@ -348,7 +368,7 @@ CF_PRIVATE CFStringRef _CFBundleGetPlatformNameSuffix(void);
 
 #define _CFBundleLocalizedResourceForkFileName CFSTR("Localized")
 
-#define _CFBundleWindowsResourceDirectoryExtension CFSTR("resources")
+#define _CFBundleSiblingResourceDirectoryExtension CFSTR("resources")
 
 #define _CFBundleMacOSXInfoPlistPlatformName_OLD CFSTR("macos")
 #define _CFBundleWindowsInfoPlistPlatformName_OLD CFSTR("win32")
diff --git a/TestFoundation/TestBundle.swift b/TestFoundation/TestBundle.swift

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@ module CoreFoundation [extern_c] [system] {`
`2`	`2`	`umbrella header "CoreFoundation.h"`
`3`	`3`	`explicit module CFPlugInCOM { header "CFPlugInCOM.h" }`
`4`	`4`
	`5`	`+ explicit module Private { header "CFPriv.h" }`
`5`	`6`	`}`