#454 Implemented DigitalOutput, some unit tests, initial JMH Performance testing

DigitalSmile · DigitalSmile · commit 4b92763180db · 2025-04-10T18:54:01.000+03:00
diff --git a/plugins/pi4j-plugin-ffm/pom.xml b/plugins/pi4j-plugin-ffm/pom.xml
@@ -34,6 +34,12 @@
             <version>${slf4j.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-core</artifactId>
+            <version>1.37</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <!-- STANDARD BUILD INSTRUCTIONS -->
     <build>
@@ -48,9 +54,14 @@
                         <target>24</target>
                         <annotationProcessorPaths>
                             <annotationProcessorPath>
-                                <groupId>io.github.digitalsmile.native</groupId>
-                                <artifactId>annotation-processor</artifactId>
-                                <version>1.1.5</version>
+                                    <groupId>io.github.digitalsmile.native</groupId>
+                                    <artifactId>annotation-processor</artifactId>
+                                    <version>1.1.5</version>
+                            </annotationProcessorPath>
+                            <annotationProcessorPath>
+                                <groupId>org.openjdk.jmh</groupId>
+                                <artifactId>jmh-generator-annprocess</artifactId>
+                                <version>1.37</version>
                             </annotationProcessorPath>
                         </annotationProcessorPaths>
                     </configuration>
@@ -145,6 +156,11 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>pw.krejci</groupId>
+                <artifactId>jmh-maven-plugin</artifactId>
+                <version>0.2.2</version>
+            </plugin>
         </plugins>
     </build>
 
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/FFMPlugin.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/FFMPlugin.java
@@ -4,8 +4,8 @@
 import com.pi4j.exception.ShutdownException;
 import com.pi4j.extension.Plugin;
 import com.pi4j.extension.PluginService;
-import com.pi4j.plugin.ffm.providers.gpio.PinInputProviderImpl;
-import com.pi4j.plugin.ffm.providers.gpio.PinOutputProviderImpl;
+import com.pi4j.plugin.ffm.providers.gpio.DigitalInputFFMProviderImpl;
+import com.pi4j.plugin.ffm.providers.gpio.DigitalOutputFFMProviderImpl;
 import com.pi4j.plugin.ffm.providers.i2c.FFMI2CProviderImpl;
 import com.pi4j.plugin.ffm.providers.pwm.FFMPwmProviderImpl;
 import com.pi4j.plugin.ffm.providers.spi.FFMSpiProviderImpl;
@@ -19,8 +19,8 @@ public class FFMPlugin implements Plugin {
     @Override
     public void initialize(PluginService service) {
         this.providers = new Provider[]{
-          new PinInputProviderImpl(),
-          new PinOutputProviderImpl(),
+          new DigitalInputFFMProviderImpl(),
+          new DigitalOutputFFMProviderImpl(),
           new FFMI2CProviderImpl(),
           new FFMSpiProviderImpl(),
           new FFMPwmProviderImpl()
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalInputFFM.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalInputFFM.java
@@ -37,8 +37,8 @@
 import java.util.List;
 import java.util.concurrent.*;
 
-public class PinInput extends DigitalInputBase implements DigitalInput {
-    private static final Logger logger = LoggerFactory.getLogger(PinInput.class);
+public class DigitalInputFFM extends DigitalInputBase implements DigitalInput {
+    private static final Logger logger = LoggerFactory.getLogger(DigitalInputFFM.class);
     private static final Ioctl ioctl = new IoctlNative();
     private static final FileDescriptor file = new FileDescriptorNative();
     private static final Poll poll = new PollNative();
@@ -47,15 +47,15 @@ public class PinInput extends DigitalInputBase implements DigitalInput {
     private final int pin;
     private final long debounce;
     private final PullResistance pull;
-    private int fd;
+    private int chipFileDescriptor;
 
     private static final ThreadFactory factory = Thread.ofVirtual().name("pin-input-event-detection-", 0).factory();
     // executor services for event watcher
     private static final ExecutorService eventTaskProcessor = Executors.newSingleThreadExecutor(factory);
 
     private boolean closed = false;
 
-    public PinInput(String chipName, DigitalInputProvider provider, DigitalInputConfig config) {
+    public DigitalInputFFM(String chipName, DigitalInputProvider provider, DigitalInputConfig config) {
         super(provider, config);
         this.pin = config.address();
         this.chipName = "/dev/" + chipName;
@@ -75,7 +75,7 @@ public DigitalInput initialize(Context context) throws InitializeException {
                 logger.error("Please, read the documentation <link> to setup right permissions.");
                 throw new InitializeException("Device '" + chipName + "' cannot be accessed with current user.");
             }
-            logger.info("{}-{} - setting up GPIO Pin...", chipName, pin);
+            logger.info("{}-{} - setting up DigitalInput Pin...", chipName, pin);
             logger.trace("{}-{} - opening device file.", chipName, pin);
             var fd = file.open(chipName, FileFlag.O_RDONLY | FileFlag.O_CLOEXEC);
             var lineInfo = new LineInfo(new byte[]{}, new byte[]{}, pin, 0, 0, new LineAttribute[]{}, new int[]{});
@@ -85,7 +85,7 @@ public DigitalInput initialize(Context context) throws InitializeException {
                 shutdown(context());
                 throw new InitializeException("Pin " + pin + " is in use");
             }
-            logger.trace("{}-{} - GPIO Pin line info: {}", chipName, pin, lineInfo);
+            logger.trace("{}-{} - DigitalInput Pin line info: {}", chipName, pin, lineInfo);
             var flags = PinFlag.INPUT.getValue() | PinFlag.EDGE_RISING.getValue() | PinFlag.EDGE_FALLING.getValue();
             var attributes = new ArrayList<LineConfigAttribute>();
             if (debounce > 0) {
@@ -98,9 +98,9 @@ public DigitalInput initialize(Context context) throws InitializeException {
                 case PULL_UP -> PinFlag.BIAS_PULL_UP.getValue();
             };
             var lineConfig = new LineConfig(flags, attributes.size(), new int[]{}, attributes.toArray(new LineConfigAttribute[0]));
-            var lineRequest = new LineRequest(new int[]{pin}, "pi4j FFM".getBytes(), lineConfig, 1, 0, new int[]{}, 0);
+            var lineRequest = new LineRequest(new int[]{pin}, ("pi4j." + getClass().getSimpleName()).getBytes(), lineConfig, 1, 0, new int[]{}, 0);
             var result = ioctl.call(fd, Command.getGpioV2GetLineIoctl(), lineRequest);
-            this.fd = result.fd();
+            this.chipFileDescriptor = result.fd();
 
             var watcher = new EventWatcher(fd, PinEvent.BOTH, events -> {
                 for (DetectedEvent detectedEvent : events) {
@@ -109,9 +109,10 @@ public DigitalInput initialize(Context context) throws InitializeException {
             }, 16);
             eventTaskProcessor.submit(watcher);
 
-            logger.info("{}-{} - GPIO Pin configured: {}", chipName, pin, result);
+            file.close(fd);
+            logger.info("{}-{} - DigitalInput Pin configured: {}", chipName, pin, result);
         } catch (NativeMemoryException | IOException e) {
-            logger.error("{}-{} - GPIO Pin Initialization error: {}", chipName, pin, e.getMessage());
+            logger.error("{}-{} - DigitalInput Pin Initialization error: {}", chipName, pin, e.getMessage());
             throw new InitializeException(e);
         }
         return this;
@@ -122,8 +123,8 @@ public DigitalInput shutdown(Context context) throws ShutdownException {
         super.shutdown(context);
         logger.info("{}-{} - closing GPIO Pin.", chipName, pin);
         try {
-            if (fd > 0) {
-                file.close(fd);
+            if (chipFileDescriptor > 0) {
+                file.close(chipFileDescriptor);
             }
             eventTaskProcessor.awaitTermination(1, TimeUnit.MILLISECONDS);
         } catch (NativeMemoryException | InterruptedException e) {
@@ -142,12 +143,12 @@ public DigitalState state() {
         var lineValues = new LineValues(0, 1);
         LineValues result;
         try {
-            result = ioctl.call(fd, Command.getGpioV2GetValuesIoctl(), lineValues);
+            result = ioctl.call(chipFileDescriptor, Command.getGpioV2GetValuesIoctl(), lineValues);
         } catch (NativeMemoryException e) {
             throw new RuntimeException(e);
         }
         var state = DigitalState.getState(result.bits());
-        logger.trace("{}-{} - new GPIO Pin state is {}.", chipName, pin, state);
+        logger.trace("{}-{} - GPIO Pin state is {}.", chipName, pin, state);
         return state;
     }
 
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalInputFFMProviderImpl.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalInputFFMProviderImpl.java
@@ -8,19 +8,17 @@
 import com.pi4j.io.gpio.digital.DigitalInputProvider;
 import com.pi4j.io.gpio.digital.DigitalInputProviderBase;
 
-public class PinInputProviderImpl extends DigitalInputProviderBase implements DigitalInputProvider {
+public class DigitalInputFFMProviderImpl extends DigitalInputProviderBase implements DigitalInputProvider {
 
-    public PinInputProviderImpl() {
-        this.id = "PinOutputProviderFFM";
+    public DigitalInputFFMProviderImpl() {
+        this.id = getClass().getSimpleName();
         this.name = "Digital Pin Input (FFM API)";
     }
 
     @Override
     public DigitalInput create(DigitalInputConfig config) {
-        // create new I/O instance based on I/O config
-        // GpioLine line = GpioDContext.getInstance().getOrOpenLine(config.address());
         var chipName =  context.config().properties().get("gpio.chip.name");
-        var digitalInput = new PinInput(chipName, this, config);
+        var digitalInput = new DigitalInputFFM(chipName, this, config);
         this.context.registry().add(digitalInput);
         return digitalInput;
     }
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalOutputFFM.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalOutputFFM.java
@@ -0,0 +1,127 @@
+package com.pi4j.plugin.ffm.providers.gpio;
+
+import com.pi4j.context.Context;
+import com.pi4j.exception.InitializeException;
+import com.pi4j.exception.ShutdownException;
+import com.pi4j.io.exception.IOException;
+import com.pi4j.io.gpio.digital.*;
+import com.pi4j.plugin.ffm.common.file.FileDescriptor;
+import com.pi4j.plugin.ffm.common.file.FileDescriptorNative;
+import com.pi4j.plugin.ffm.common.file.FileFlag;
+import com.pi4j.plugin.ffm.common.gpio.PinFlag;
+import com.pi4j.plugin.ffm.common.gpio.structs.*;
+import com.pi4j.plugin.ffm.common.ioctl.Command;
+import com.pi4j.plugin.ffm.common.ioctl.Ioctl;
+import com.pi4j.plugin.ffm.common.ioctl.IoctlNative;
+import io.github.digitalsmile.annotation.NativeMemoryException;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.attribute.PosixFileAttributes;
+import java.nio.file.attribute.PosixFilePermissions;
+
+public class DigitalOutputFFM extends DigitalOutputBase implements DigitalOutput {
+    private static final Logger logger = LoggerFactory.getLogger(DigitalOutputFFM.class);
+    private static final Ioctl ioctl = new IoctlNative();
+    private static final FileDescriptor file = new FileDescriptorNative();
+
+    private final String chipName;
+    private final int pin;
+    private int chipFileDescriptor;
+    private boolean closed = false;
+
+    public DigitalOutputFFM(String chipName, DigitalOutputProvider provider, DigitalOutputConfig config) {
+        super(provider, config);
+        this.pin = config.address();
+        this.chipName = "/dev/" + chipName;
+    }
+
+    @Override
+    public DigitalOutput initialize(Context context) throws InitializeException {
+        super.initialize(context);
+        try {
+            if (!deviceExists()) {
+                throw new InitializeException("Device '" + chipName + "' does not exist.");
+            }
+            if (!canAccessDevice()) {
+                var posix = Files.readAttributes(Path.of(chipName), PosixFileAttributes.class);
+                logger.error("Inaccessible device: '{} {} {} {}'", PosixFilePermissions.toString(posix.permissions()), posix.owner().getName(), posix.group().getName(), chipName);
+                logger.error("Please, read the documentation <link> to setup right permissions.");
+                throw new InitializeException("Device '" + chipName + "' cannot be accessed with current user.");
+            }
+            logger.info("{}-{} - setting up DigitalOutput Pin...", chipName, pin);
+            logger.trace("{}-{} - opening device file.", chipName, pin);
+            var fd = file.open(chipName, FileFlag.O_RDONLY | FileFlag.O_CLOEXEC);
+            var lineInfo = new LineInfo(new byte[]{}, new byte[]{}, pin, 0, 0, new LineAttribute[]{}, new int[]{});
+            logger.trace("{}-{} - getting line info.", chipName, pin);
+            lineInfo = ioctl.call(fd, Command.getGpioV2GetLineInfoIoctl(), lineInfo);
+            if ((lineInfo.flags() & PinFlag.USED.getValue()) > 0) {
+                shutdown(context());
+                throw new InitializeException("Pin " + pin + " is in use");
+            }
+            logger.trace("{}-{} - DigitalOutput Pin line info: {}", chipName, pin, lineInfo);
+            var flags = PinFlag.OUTPUT.getValue();
+            var lineConfig = new LineConfig(flags, 0, new int[]{}, new LineConfigAttribute[]{});
+            var lineRequest = new LineRequest(new int[]{pin}, ("pi4j." + getClass().getSimpleName()).getBytes(), lineConfig, 1, 0, new int[]{}, 0);
+            var result = ioctl.call(fd, Command.getGpioV2GetLineIoctl(), lineRequest);
+            this.chipFileDescriptor = result.fd();
+
+            file.close(fd);
+            logger.info("{}-{} - DigitalOutput Pin configured: {}", chipName, pin, result);
+        } catch (NativeMemoryException | java.io.IOException e) {
+            logger.error("{}-{} - DigitalOutput Pin Initialization error: {}", chipName, pin, e.getMessage());
+            throw new InitializeException(e);
+        }
+        return this;
+    }
+
+    @Override
+    public DigitalOutput shutdown(Context context) throws ShutdownException {
+        super.shutdown(context);
+        logger.info("{}-{} - closing GPIO Pin.", chipName, pin);
+        try {
+            if (chipFileDescriptor > 0) {
+                file.close(chipFileDescriptor);
+            }
+        } catch (NativeMemoryException e) {
+            this.closed = true;
+            throw new ShutdownException(e);
+        }
+        this.closed = true;
+        logger.info("{}-{} - GPIO Pin is closed. Recreate the pin object to reuse.", chipName, pin);
+        return this;
+    }
+
+    @Override
+    public DigitalOutput state(DigitalState state) throws IOException {
+        checkClosed();
+        logger.trace("{}-{} - writing GPIO Pin {}.", chipName, pin, state);
+        var lineValues = new LineValues(state.getValue().intValue(), 1);
+        try {
+            ioctl.call(chipFileDescriptor, Command.getGpioV2SetValuesIoctl(), lineValues);
+        } catch (NativeMemoryException e) {
+            throw new IOException(e);
+        }
+        return super.state(state);
+    }
+
+    /**
+     * Checks if GPIO Pin is closed.
+     */
+    private void checkClosed() {
+        if (closed) {
+            throw new RuntimeException("Pin " + pin + " is closed");
+        }
+    }
+
+    private boolean canAccessDevice() {
+        return new File(chipName).canRead();
+    }
+
+    private boolean deviceExists() {
+        return new File(chipName).exists();
+    }
+}
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalOutputFFMProviderImpl.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/DigitalOutputFFMProviderImpl.java
@@ -8,17 +8,18 @@
 import com.pi4j.io.gpio.digital.DigitalOutputProvider;
 import com.pi4j.io.gpio.digital.DigitalOutputProviderBase;
 
-public class PinOutputProviderImpl extends DigitalOutputProviderBase implements DigitalOutputProvider {
+public class DigitalOutputFFMProviderImpl extends DigitalOutputProviderBase implements DigitalOutputProvider {
 
-    public PinOutputProviderImpl() {
-        this.id = "PinOutputProviderFFM";
+    public DigitalOutputFFMProviderImpl() {
+        this.id = getClass().getSimpleName();
         this.name = "Digital Pin Output (FFM API)";
     }
 
 
     @Override
     public DigitalOutput create(DigitalOutputConfig config) {
-        var digitalOutput = new PinOutput(this, config);
+        var chipName =  context.config().properties().get("gpio.chip.name");
+        var digitalOutput = new DigitalOutputFFM(chipName, this, config);
         this.context.registry().add(digitalOutput);
         return digitalOutput;
     }
diff --git a/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/PinOutput.java b/plugins/pi4j-plugin-ffm/src/main/java/com/pi4j/plugin/ffm/providers/gpio/PinOutput.java
diff --git a/plugins/pi4j-plugin-ffm/src/test/java/com/pi4j/plugin/ffm/DigitalInputOutputTest.java b/plugins/pi4j-plugin-ffm/src/test/java/com/pi4j/plugin/ffm/DigitalInputOutputTest.java
diff --git a/plugins/pi4j-plugin-ffm/src/test/java/com/pi4j/plugin/jmh/DigitalInputPerformanceTest.java b/plugins/pi4j-plugin-ffm/src/test/java/com/pi4j/plugin/jmh/DigitalInputPerformanceTest.java
