Implement daemonizer component (#9)

* integrate daemonizer component

* fix dependency conflicts between windows and unix builds

* add canape project for daemon example

* rewrite deamonizer component with nix

* Minor changes

* Minor changes

* install daemon with shell script

* add logir cfg item for daemonization

* split syslog logging from process logging

* minor fix

* update cargo lock

* make xcp loglvl configurable in xcp daemon example

* append to daemon logfile instead of overwrite

* prevent unintentional daemonizer builds outside unix platforms

* re-export xcp dependencies

* ignore snake case warnings in IdlGenrator output

* fix xcp daemon example

---------

Co-authored-by: Rainer Zaiser <[email protected]>

examples/hello_xcp/Cargo.toml

@@ -13,9 +13,4 @@ lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
-xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-
-
-
+xcp = { path = "../../", features = [] }

examples/hello_xcp/src/main.rs

@@ -12,7 +12,6 @@ use log::{debug, error, info, trace, warn};
 use std::{fmt::Debug, thread, time::Duration};
 
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 //-----------------------------------------------------------------------------
 // Calibration parameters

examples/multi_thread_demo/Cargo.toml

@@ -11,6 +11,4 @@ lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
-xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
+xcp = { path = "../../", features = [] }

examples/multi_thread_demo/src/main.rs

@@ -12,7 +12,6 @@ use std::{
 use anyhow::Result;
 
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 // Static application start time
 lazy_static::lazy_static! {

examples/point_cloud_demo/Cargo.toml

@@ -17,10 +17,6 @@ lazy_static = "1.4.0"
 cdr = "0.2.4"
 
 xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-xcp_idl_generator  = { path = "../../xcp_idl_generator/"}
-xcp_idl_generator_derive  = { path = "../../xcp_idl_generator/xcp_idl_generator_derive/"}
 
 
 

examples/point_cloud_demo/src/main.rs

@@ -14,8 +14,6 @@ use std::{
 // XCP
 
 use xcp::*;
-use xcp_idl_generator::prelude::*;
-use xcp_type_description::prelude::*;
 
 //-----------------------------------------------------------------------------
 // Defaults

examples/protobuf_demo/Cargo.toml

@@ -16,8 +16,4 @@ prost-types = "0.13.1"
 
 
 xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-
-
 

examples/rayon_demo/Cargo.toml

@@ -16,9 +16,5 @@ serde_json = "1.0"
 lazy_static = "1.4.0"
 
 xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-
-
 
 

examples/rayon_demo/src/main.rs

@@ -13,7 +13,6 @@ use num::Complex;
 use rayon::prelude::*;
 use std::{thread, time::Duration};
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 //---------------------------------------------------------------------------------------
 // Calibratable parameters

examples/scoped_threads/Cargo.toml

@@ -11,7 +11,4 @@ lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
-xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-
+xcp = { path = "../../", features = [] }

examples/scoped_threads/src/main.rs

@@ -6,7 +6,6 @@ use log::{debug, error, info, trace, warn};
 use std::{fmt::Debug, thread, time::Duration};
 
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 //-----------------------------------------------------------------------------
 

examples/single_thread_demo/Cargo.toml

@@ -11,9 +11,4 @@ lazy_static = "1.4.0"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
-xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-xcp_idl_generator  = { path = "../../xcp_idl_generator/"}
-xcp_idl_generator_derive  = { path = "../../xcp_idl_generator/xcp_idl_generator_derive/"}
-
+xcp = { path = "../../", features = [] }

examples/single_thread_demo/src/main.rs

@@ -11,7 +11,6 @@ use std::{
 };
 
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 //-----------------------------------------------------------------------------
 // Demo calibration parameters

examples/tokio_demo/Cargo.toml

@@ -16,6 +16,3 @@ serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 
 xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-

examples/tokio_demo/src/main.rs

@@ -10,7 +10,6 @@ use core::f64::consts::PI;
 use std::error::Error;
 
 use xcp::*;
-use xcp_type_description::prelude::*;
 
 include!("../../../tests/xcp_server_task.rs");
 

examples/type_description_demo/Cargo.toml

@@ -5,8 +5,4 @@ edition = "2021"
 
 [dependencies]
 xcp = { path = "../../", features = [] }
-xcp_type_description = { path = "../../xcp_type_description" }
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
-
-
 

examples/type_description_demo/src/main.rs

@@ -1,5 +1,4 @@
-//use xcp::*;
-use xcp_type_description::prelude::*;
+use xcp::*;
 
 #[derive(Clone, Copy, XcpTypeDescription, Debug)]
 struct Parent {

examples/xcp_daemon/Cargo.toml

@@ -3,10 +3,14 @@ name = "xcp_daemon"
 version = "0.1.0"
 edition = "2021"
 
+# In windows we simply log an error message and exit
+# So we don't need to link any dependencies
 [dependencies]
+log = "0.4.22"
+
+# In unix we link our dependencies as per usual
+[target.'cfg(unix)'.dependencies]
 xcp = { path = "../../", features = [] }
-xcp_type_description  = { path = "../../xcp_type_description/"}
-xcp_type_description_derive = { path = "../../xcp_type_description/xcp_type_description_derive/" }
 
 log = "0.4.22"
 signal-hook = "0.3.17"

examples/xcp_daemon/README.md

@@ -13,7 +13,7 @@ sudo chmod +x ./install.sh; # Make the install script executable
 sudo ./install.sh; # Install the example (binaries and configuration files)
 
 # edit parameters
-sudo nano /etc/xcpd/xcpd.conf 
+sudo nano /etc/xcpd/xcpd.conf
 
 # run
 sudo systemctl start xcpd; # Start the daemon

examples/xcp_daemon/src/main.rs

@@ -1,17 +1,14 @@
-use xcp::*;
-use xcp_type_description::prelude::*;
-
+#[cfg(unix)]
+mod platform;
+#[cfg(unix)]
+use platform::*;
+#[cfg(unix)]
 use log::info;
-use serde::{Deserialize, Serialize};
-use signal_hook::{
-    consts::{SIGHUP, SIGINT, SIGTERM},
-    iterator::Signals,
-};
-use thiserror::Error;
 
-use std::{thread, time::Duration};
+use log::error;
 
-#[derive(Serialize, Deserialize, Debug, Clone, Copy, XcpTypeDescription)]
+#[cfg(unix)]
+#[derive(serde::Serialize, serde::Deserialize, Debug, Clone, Copy, XcpTypeDescription)]
 struct CalPage1 {
     #[type_description(comment = "Max counter value", min = "0", max = "1023")]
     counter_max: u32,
@@ -21,13 +18,15 @@ struct CalPage1 {
     delay: u32,
 }
 
+#[cfg(unix)]
 // Default value for the calibration parameters
 const CAL_PAGE: CalPage1 = CalPage1 {
     counter_min: 5,
     counter_max: 10,
     delay: 100000,
 };
 
+#[cfg(unix)]
 #[derive(Error, Debug)]
 enum XcpProcessError {
     #[error("An XCP error occurred: {0}")]
@@ -38,16 +37,19 @@ enum XcpProcessError {
     IoError(#[from] std::io::Error),
 }
 
+#[cfg(unix)]
 struct XcpProcess {
     cfg: ProcessConfig,
 }
 
+#[cfg(unix)]
 impl XcpProcess {
     fn new(config: ProcessConfig) -> Self {
         XcpProcess { cfg: config }
     }
 }
 
+#[cfg(unix)]
 impl Process for XcpProcess {
     type Error = XcpProcessError;
 
@@ -179,8 +181,8 @@ impl Process for XcpProcess {
         &self.cfg
     }
 }
-
-fn main() {
+#[cfg(unix)]
+fn _main() {
     let cfg = ProcessConfig::new(
         "xcpd",
         "/var/run/xcpd.pid",
@@ -195,3 +197,12 @@ fn main() {
     let mut daemon = Daemon::new(XcpProcess::new(cfg));
     daemon.run().expect("Failed to run daemon");
 }
+
+#[cfg(not(unix))]
+fn _main() {
+    error!("Daemonization is only supported for Unix platforms.");
+}
+
+fn main() {
+    _main();
+}

examples/xcp_daemon/src/platform.rs

@@ -0,0 +1,9 @@
+#![cfg(unix)]
+
+pub use signal_hook::{
+    consts::{SIGHUP, SIGINT, SIGTERM},
+    iterator::Signals,
+};
+pub use std::{thread, time::Duration};
+pub use thiserror::Error;
+pub use xcp::*;

src/lib.rs

@@ -126,6 +126,9 @@ mod daemon;
 #[cfg(unix)]
 pub use daemon::unix::*;
 
+pub use xcp_type_description::prelude::*;
+pub use xcp_idl_generator::prelude::*;
+
 //----------------------------------------------------------------------------------------------
 // Manually register a static measurement and calibration variables
 

xcp_idl_generator/xcp_idl_generator_derive/src/lib.rs

@@ -17,7 +17,6 @@ pub fn idl_generator_derive(input: TokenStream) -> TokenStream {
                 .fields
                 .iter()
                 .map(|field| {
-                    //TODO Error handling
                     let field_name = &field.ident.as_ref().unwrap();
                     let field_type = &field.ty;
 
@@ -44,14 +43,15 @@ pub fn idl_generator_derive(input: TokenStream) -> TokenStream {
                 }
 
                 #[ctor::ctor]
+                #[allow(non_snake_case)]
                 fn #register_function_name() {
                     let mut struct_fields = FieldList::new();
                     #(#field_handlers)*
 
                     static mut STRUCT_INSTANCE: Option<Struct> = None;
                     static mut INITIALIZED: bool = false;
 
-                    // @@@@ - unsafe - Mutable static, todo
+                    // @@@@ - unsafe - Mutable static
                     unsafe {
                         // Prevent the user from calling the register function multiple times
                         if INITIALIZED {