Skip to content

Commit

Permalink
#1964 Mac OS issue when loading SDRPlay API native library from fully…
Browse files Browse the repository at this point in the history 
… qualified path. (#1965)

Co-authored-by: Dennis Sheirer <[email protected]>
  • Loading branch information
@DSheirer
DSheirer and Dennis Sheirer authored Sep 2, 2024
1 parent d7fbbce commit 298d9d7
Show file tree
Hide file tree
Showing 5 changed files with 108 additions and 23 deletions.
26 changes: 25 additions & 1 deletion src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/README
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ As a final step, delete the original api version branches and rename each of the

Code Modifications: for each version, modify the sdrplay_api_h.java class to wrap the SYMBOL_LOOKUP variable using the
following changes, so that the code doesn't throw an error on systems that don't have the API installed:

//jextract auto-generated code modified to wrap with exception handler for systems that don't have the library
static SymbolLookup SYMBOL_LOOKUP;
static
Expand All @@ -54,10 +55,33 @@ following changes, so that the code doesn't throw an error on systems that don't
}
catch(Exception e)
{
SYMBOL_LOOKUP = null;
if(SDRPlayLibraryHelper.LOADED_FROM_PATH)
{
try
{
SYMBOL_LOOKUP = SymbolLookup.libraryLookup(SDRPlayLibraryHelper.LIBRARY_PATH, LIBRARY_ARENA)
.or(SymbolLookup.loaderLookup())
.or(Linker.nativeLinker().defaultLookup());
}
catch(Exception e2)
{
SYMBOL_LOOKUP = null;
}
}
else
{
SYMBOL_LOOKUP = null;
}
}
}

... and add null checking to the findOrThrow() method ...
if(SYMBOL_LOOKUP == null)
{
throw new UnsatisfiedLinkError("unresolved symbol:" + symbol);
}


IntelliJ setup
1. Run configuration
2. JVM Option: --enable-native-access=ALL-UNNAMED
36 changes: 17 additions & 19 deletions src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/SDRPlayLibraryHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,22 @@ public class SDRPlayLibraryHelper
private static final String SDRPLAY_API_PATH_MAC_OS = "/usr/local/lib/libsdrplay_api.dylib";
private static final String SDRPLAY_API_PATH_MAC_OS_ALTERNATE = "/usr/local/lib/libsdrplay_api.so";
private static final String SDRPLAY_API_PATH_WINDOWS = System.getenv("ProgramFiles") +
"\\SDRplay\\API\\" + (System.getProperty("sun.arch.data.model").contentEquals("64") ? "x64" : "x86") +
"\\" + SDRPLAY_API_LIBRARY_NAME;
private static final String JAVA_LIBRARY_PATH_KEY = "java.library.path";
public static final boolean LOADED = load();
"\\SDRplay\\API\\x64\\" + SDRPLAY_API_LIBRARY_NAME;

/**
* Attempts to load the SDRPlay API library from the local system.
*
* @return true if library was loaded successfully.
*/
public static boolean load()
public static final boolean LOADED;
public static final boolean LOADED_FROM_PATH;
public static final Path LIBRARY_PATH = Path.of(getSDRplayLibraryPath());

static
{
boolean loaded = false;
boolean loadedFromPath = false;

try
{
System.loadLibrary(SDRPLAY_API_LIBRARY_NAME);
return true;
mLog.info("SDRPLay API library loaded by name [" + SDRPLAY_API_LIBRARY_NAME + "]");
loaded = true;
}
catch(Throwable t)
{
Expand All @@ -70,11 +70,13 @@ public static boolean load()
try
{
System.load(libraryPath);
return true;
mLog.info("SDRPLay API library loaded by path [" + libraryPath + "]");
loaded = true;
loadedFromPath = true;
}
catch(Throwable t2)
{
mLog.warn("Unable to load SDRPlay API native library: " + libraryPath);
mLog.info("SDRPlay API native library not found at " + libraryPath);
}
}
else
Expand All @@ -83,7 +85,8 @@ public static boolean load()
}
}

return false;
LOADED = loaded;
LOADED_FROM_PATH = loadedFromPath;
}

/**
Expand Down Expand Up @@ -115,9 +118,4 @@ else if(SystemUtils.IS_OS_MAC_OSX)
mLog.error("Unrecognized operating system. Cannot identify sdrplay api library path");
return "";
}

public static void main(String[] args)
{
System.out.println("Loaded: " + SDRPlayLibraryHelper.LOADED);
}
}
23 changes: 22 additions & 1 deletion src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_07/sdrplay_api_h.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

package io.github.dsheirer.source.tuner.sdrplay.api.v3_07;

import io.github.dsheirer.source.tuner.sdrplay.api.SDRPlayLibraryHelper;
import java.lang.foreign.AddressLayout;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
Expand Down Expand Up @@ -57,6 +58,10 @@ static void traceDowncall(String name, Object... args) {
}

static MemorySegment findOrThrow(String symbol) {
if(SYMBOL_LOOKUP == null)
{
throw new UnsatisfiedLinkError("unresolved symbol:" + symbol);
}
return SYMBOL_LOOKUP.find(symbol)
.orElseThrow(() -> new UnsatisfiedLinkError("unresolved symbol: " + symbol));
}
Expand Down Expand Up @@ -95,7 +100,23 @@ static MemoryLayout align(MemoryLayout layout, long align) {
}
catch(Exception e)
{
SYMBOL_LOOKUP = null;
if(SDRPlayLibraryHelper.LOADED_FROM_PATH)
{
try
{
SYMBOL_LOOKUP = SymbolLookup.libraryLookup(SDRPlayLibraryHelper.LIBRARY_PATH, LIBRARY_ARENA)
.or(SymbolLookup.loaderLookup())
.or(Linker.nativeLinker().defaultLookup());
}
catch(Exception e2)
{
SYMBOL_LOOKUP = null;
}
}
else
{
SYMBOL_LOOKUP = null;
}
}
}

Expand Down
23 changes: 22 additions & 1 deletion src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_08/sdrplay_api_h.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

package io.github.dsheirer.source.tuner.sdrplay.api.v3_08;

import io.github.dsheirer.source.tuner.sdrplay.api.SDRPlayLibraryHelper;
import java.lang.foreign.AddressLayout;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
Expand Down Expand Up @@ -57,6 +58,10 @@ static void traceDowncall(String name, Object... args) {
}

static MemorySegment findOrThrow(String symbol) {
if(SYMBOL_LOOKUP == null)
{
throw new UnsatisfiedLinkError("unresolved symbol:" + symbol);
}
return SYMBOL_LOOKUP.find(symbol)
.orElseThrow(() -> new UnsatisfiedLinkError("unresolved symbol: " + symbol));
}
Expand Down Expand Up @@ -95,7 +100,23 @@ static MemoryLayout align(MemoryLayout layout, long align) {
}
catch(Exception e)
{
SYMBOL_LOOKUP = null;
if(SDRPlayLibraryHelper.LOADED_FROM_PATH)
{
try
{
SYMBOL_LOOKUP = SymbolLookup.libraryLookup(SDRPlayLibraryHelper.LIBRARY_PATH, LIBRARY_ARENA)
.or(SymbolLookup.loaderLookup())
.or(Linker.nativeLinker().defaultLookup());
}
catch(Exception e2)
{
SYMBOL_LOOKUP = null;
}
}
else
{
SYMBOL_LOOKUP = null;
}
}
}

Expand Down
23 changes: 22 additions & 1 deletion src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_15/sdrplay_api_h.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

package io.github.dsheirer.source.tuner.sdrplay.api.v3_15;

import io.github.dsheirer.source.tuner.sdrplay.api.SDRPlayLibraryHelper;
import java.lang.foreign.AddressLayout;
import java.lang.foreign.Arena;
import java.lang.foreign.FunctionDescriptor;
Expand Down Expand Up @@ -57,6 +58,10 @@ static void traceDowncall(String name, Object... args) {
}

static MemorySegment findOrThrow(String symbol) {
if(SYMBOL_LOOKUP == null)
{
throw new UnsatisfiedLinkError("unresolved symbol:" + symbol);
}
return SYMBOL_LOOKUP.find(symbol)
.orElseThrow(() -> new UnsatisfiedLinkError("unresolved symbol: " + symbol));
}
Expand Down Expand Up @@ -95,7 +100,23 @@ static MemoryLayout align(MemoryLayout layout, long align) {
}
catch(Exception e)
{
SYMBOL_LOOKUP = null;
if(SDRPlayLibraryHelper.LOADED_FROM_PATH)
{
try
{
SYMBOL_LOOKUP = SymbolLookup.libraryLookup(SDRPlayLibraryHelper.LIBRARY_PATH, LIBRARY_ARENA)
.or(SymbolLookup.loaderLookup())
.or(Linker.nativeLinker().defaultLookup());
}
catch(Exception e2)
{
SYMBOL_LOOKUP = null;
}
}
else
{
SYMBOL_LOOKUP = null;
}
}
}

Expand Down

0 comments on commit 298d9d7

Please sign in to comment.