Core components as units

CMakeLists.txt

@@ -18,6 +18,18 @@ set(GGL_LOG_LEVEL CACHE STRING "GGL log level")
 
 option(GGL_IPC_AUTH_DISABLE "Put IPC authentication in debug mode")
 
+option(GGL_SYSTEMD_SERVICE_BUILD "Install GGL as a set of systemd services"
+       TRUE)
+set(GGL_SYSTEMD_SYSTEM_DIR
+    "lib/systemd/system"
+    CACHE STRING "Install directory for systemd unit files")
+set(GGL_SYSTEMD_SYSTEM_USER
+    "ggcore"
+    CACHE STRING "Core service user")
+set(GGL_SYSTEMD_SYSTEM_GROUP
+    "ggcore"
+    CACHE STRING "Core service group")
+
 #
 # Misc
 #
@@ -269,10 +281,14 @@ check_c_source_compiles(
 
 # Common setup for a GGL module
 function(ggl_init_module name)
-  cmake_parse_arguments(PARSE_ARGV 1 COMP_ARG "" "SRCDIR" "INCDIRS;LIBS")
+  cmake_parse_arguments(PARSE_ARGV 1 COMP_ARG "" "SRCDIR;SOCKETDIR"
+                        "INCDIRS;LIBS;SOCKETS")
   if("${COMP_ARG_SRCDIR}" STREQUAL "")
     set(COMP_ARG_SRCDIR src)
   endif()
+  if("${COMP_ARG_SOCKETDIR}" STREQUAL "")
+    set(COMP_ARG_SOCKETDIR /run/greengrass)
+  endif()
   if("${COMP_ARG_INCDIRS}" STREQUAL "")
     set(COMP_ARG_INCDIRS include)
   endif()
@@ -298,6 +314,22 @@ function(ggl_init_module name)
     target_link_libraries(${name} PRIVATE ${COMP_ARG_LIBS})
   endif()
 
+  if(GGL_SYSTEMD_SERVICE_BUILD)
+    foreach(socket ${COMP_ARG_SOCKETS})
+      configure_file(${CMAKE_SOURCE_DIR}/misc/systemd/template.socket.in
+                     ${CMAKE_CURRENT_BINARY_DIR}/ggl.${socket}.socket @ONLY)
+      install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ggl.${socket}.socket
+              DESTINATION ${GGL_SYSTEMD_SYSTEM_DIR})
+    endforeach()
+
+    if(EXISTS ${CMAKE_CURRENT_LIST_DIR}/unit/template.service.in)
+      configure_file(${CMAKE_CURRENT_LIST_DIR}/unit/template.service.in
+                     ${CMAKE_CURRENT_BINARY_DIR}/ggl.core.${name}.service @ONLY)
+      install(FILES ${CMAKE_CURRENT_BINARY_DIR}/ggl.core.${name}.service
+              DESTINATION ${GGL_SYSTEMD_SYSTEM_DIR})
+    endif()
+  endif()
+
   file(GLOB BINS CONFIGURE_DEPENDS "bin/*.c")
   foreach(bin ${BINS})
     get_filename_component(bin_name ${bin} NAME_WE)
@@ -357,6 +389,16 @@ add_subdirectory(ggl-constants)
 add_subdirectory(cloud-logger)
 add_subdirectory(hello-world-component)
 
+if(GGL_SYSTEMD_SERVICE_BUILD)
+  add_custom_target(
+    greengrass-lite.target ALL
+    COMMAND cp "${CMAKE_SOURCE_DIR}/misc/systemd/greengrass-lite.target"
+            "${CMAKE_BINARY_DIR}/misc/greengrass-lite.target"
+    COMMENT "Nucleus systemd target")
+  install(FILES "${CMAKE_BINARY_DIR}/misc/greengrass-lite.target"
+          DESTINATION ${GGL_SYSTEMD_SYSTEM_DIR})
+endif()
+
 if(BUILD_EXAMPLES)
   add_subdirectory(samples/echo-server)
   add_subdirectory(samples/example-client)

core-bus/src/client.c

@@ -50,6 +50,9 @@ GglError ggl_call(
 
     GglBuffer recv_buffer = GGL_BUF(ggl_core_bus_client_payload_array);
     EventStreamMessage msg = { 0 };
+    GGL_LOGT(
+        "Waiting for response from %.*s.", (int) interface.len, interface.data
+    );
     ret = ggl_client_get_response(
         ggl_socket_reader(&conn), recv_buffer, error, &msg
     );

core-bus/src/client_common.c

@@ -55,6 +55,7 @@ GglError ggl_client_send_message(
     int *conn_fd
 ) {
     int conn = -1;
+    GGL_LOGT("Connecting to %.*s.", (int) interface.len, interface.data);
     GglError ret = interface_connect(interface, &conn);
     if (ret != GGL_ERR_OK) {
         return ret;
@@ -81,6 +82,8 @@ GglError ggl_client_send_message(
         return ret;
     }
 
+    GGL_LOGT("Writing data to %.*s.", (int) interface.len, interface.data);
+
     ret = ggl_socket_write(conn, send_buffer);
     if (ret != GGL_ERR_OK) {
         return ret;

core-bus/src/server.c

@@ -346,7 +346,7 @@ GglError ggl_listen(
     InterfaceCtx ctx = { .handlers = handlers, .handlers_len = handlers_len };
 
     return ggl_socket_server_listen(
-        socket_path.buf, 0700, &pool, client_ready, &ctx
+        &interface, socket_path.buf, 0700, &pool, client_ready, &ctx
     );
 }
 

core-bus/src/types.h

@@ -9,7 +9,8 @@
 #define GGL_INTERFACE_NAME_MAX_LEN 50
 
 /// Socket path prefix for core bus sockets.
-#define GGL_INTERFACE_SOCKET_PREFIX "/tmp/greengrass/"
+#define GGL_INTERFACE_SOCKET_PREFIX "/run/greengrass/"
+
 /// Length of socket path prefix for core bus sockets.
 #define GGL_INTERFACE_SOCKET_PREFIX_LEN \
     (sizeof(GGL_INTERFACE_SOCKET_PREFIX) - 1)

gg-fleet-statusd/CMakeLists.txt

@@ -3,5 +3,12 @@
 # SPDX-License-Identifier: Apache-2.0
 
 ggl_init_module(
-  gg-fleet-statusd LIBS ggl-lib ggl-json core-bus core-bus-gg-config
-                        core-bus-aws-iot-mqtt ggl-constants)
+  gg-fleet-statusd
+  LIBS ggl-lib
+       ggl-json
+       core-bus
+       core-bus-gg-config
+       core-bus-aws-iot-mqtt
+       ggl-constants
+       SOCKETS
+       gg_fleet_status)

gg-fleet-statusd/src/bus_server.c

@@ -60,9 +60,8 @@ void gg_fleet_statusd_start_server(void) {
                                       NULL } };
     size_t handlers_len = sizeof(handlers) / sizeof(handlers[0]);
 
-    GglError ret = ggl_listen(
-        GGL_STR("/aws/ggl/gg-fleet-statusd"), handlers, handlers_len
-    );
+    GglError ret
+        = ggl_listen(GGL_STR("gg_fleet_status"), handlers, handlers_len);
 
     GGL_LOGE("Exiting with error %u.", (unsigned) ret);
 }

gg-fleet-statusd/src/fleet_status_service.c

@@ -47,7 +47,7 @@ static GglError retrieve_component_health_status(
     GglObject result = GGL_OBJ_NULL();
     GglError method_error = GGL_ERR_OK;
     GglError call_error = ggl_call(
-        GGL_STR("/aws/ggl/gghealthd"),
+        GGL_STR("gg_health"),
         GGL_STR("get_status"),
         GGL_MAP({ GGL_STR("component_name"), GGL_OBJ_BUF(component) }),
         &method_error,

gg-fleet-statusd/unit/template.service.in

@@ -0,0 +1,27 @@
+[Unit]
+StartLimitInterval=20
+StartLimitBurst=10
+PartOf=greengrass-lite.target
+
+[Install]
+WantedBy=greengrass-lite.target
+
+[Service]
+Type=idle
+ExecStart=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_BINDIR@/@name@
+Restart=always
+RestartSec=1
+# Disallow from having overly-permissive capabilities
+CapabilityBoundingSet=~CAP_SYS_ADMIN ~CAP_SYS_PTRACE
+User=@GGL_SYSTEMD_SYSTEM_USER@
+Group=@GGL_SYSTEMD_SYSTEM_GROUP@
+# Working directory in StateDirectory (/var/lib/greengrass)
+StateDirectory=greengrass
+WorkingDirectory=%S/greengrass
+
+[Unit]
+Description=Core-bus daemon. Sends fleet status updates periodically and when signalled.
+After=ggl.core.ggconfigd.service
+After=ggl.core.gghealthd.service
+After=ggl.core.iotcored.service
+After=network-online.target

ggconfigd-test/src/entry.c

@@ -80,7 +80,7 @@ GglError run_ggconfigd_test(void) {
 
     GglObject result;
     ret = ggl_call(
-        GGL_STR("/aws/ggl/ggdeploymentd"),
+        GGL_STR("gg_deployment"),
         GGL_STR("create_local_deployment"),
         args.map,
         NULL,

ggconfigd/CMakeLists.txt

@@ -11,7 +11,9 @@ ggl_init_module(
        ggl-yaml
        ggl-constants
        ggl-json
-       PkgConfig::sqlite3)
+       PkgConfig::sqlite3
+       SOCKETS
+       gg_config)
 target_compile_definitions(ggconfigd
                            PRIVATE "GGL_COMP_DIR=${CMAKE_CURRENT_LIST_DIR}")
 target_compile_options(ggconfigd PRIVATE $<$<COMPILE_LANGUAGE:ASM>:-undef>)

ggconfigd/unit/template.service.in

@@ -0,0 +1,24 @@
+[Unit]
+StartLimitInterval=20
+StartLimitBurst=10
+PartOf=greengrass-lite.target
+
+[Install]
+WantedBy=greengrass-lite.target
+
+[Service]
+Type=exec
+ExecStart=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_BINDIR@/@name@
+Restart=always
+RestartSec=1
+# Disallow from having overly-permissive capabilities
+CapabilityBoundingSet=~CAP_SYS_ADMIN ~CAP_SYS_PTRACE
+User=@GGL_SYSTEMD_SYSTEM_USER@
+Group=@GGL_SYSTEMD_SYSTEM_GROUP@
+# Working directory in StateDirectory (/var/lib/greengrass)
+StateDirectory=greengrass
+WorkingDirectory=%S/greengrass
+
+
+[Unit]
+Description=core-bus config interface daemon

ggdeploymentd/CMakeLists.txt

@@ -20,4 +20,6 @@ ggl_init_module(
        core-bus-aws-iot-mqtt
        core-bus-sub-response
        recipe2unit
-       PkgConfig::uuid)
+       PkgConfig::uuid
+       SOCKETS
+       gg_deployment)

ggdeploymentd/src/bus_server.c

@@ -40,8 +40,7 @@ void ggdeploymentd_start_server(void) {
                                       NULL } };
     size_t handlers_len = sizeof(handlers) / sizeof(handlers[0]);
 
-    GglError ret
-        = ggl_listen(GGL_STR("/aws/ggl/ggdeploymentd"), handlers, handlers_len);
+    GglError ret = ggl_listen(GGL_STR("gg_deployment"), handlers, handlers_len);
 
     GGL_LOGE("Exiting with error %u.", (unsigned) ret);
 }

ggdeploymentd/src/deployment_handler.c

@@ -371,7 +371,7 @@ static GglError get_tes_credentials(TesCredentials *tes_creds) {
     GglObject *aws_session_token = NULL;
 
     static uint8_t credentials_alloc[1500];
-    static GglBuffer tesd = GGL_STR("/aws/ggl/tesd");
+    static GglBuffer tesd = GGL_STR("aws_iot_tes");
     GglObject result;
     GglMap params = { 0 };
     GglBumpAlloc credential_alloc
@@ -1732,7 +1732,7 @@ static GglError add_arn_list_to_config(
 }
 
 static GglError send_fss_update(GglBuffer trigger) {
-    GglBuffer server = GGL_STR("/aws/ggl/gg-fleet-statusd");
+    GglBuffer server = GGL_STR("gg_fleet_status");
     static uint8_t buffer[10 * sizeof(GglObject)] = { 0 };
 
     GglMap args = GGL_MAP({ GGL_STR("trigger"), GGL_OBJ_BUF(trigger) });
@@ -1853,7 +1853,7 @@ static GglError wait_for_deployment_status(GglMap resolved_components) {
             component->key.data
         );
         GglError ret = ggl_sub_response(
-            GGL_STR("/aws/ggl/gghealthd"),
+            GGL_STR("gg_health"),
             GGL_STR("subscribe_to_lifecycle_completion"),
             GGL_MAP({ GGL_STR("component_name"), GGL_OBJ_BUF(component->key) }),
             deployment_status_callback,
@@ -2456,7 +2456,6 @@ static void handle_deployment(
                          "daemon-reload command.");
                 return;
             }
-
             // NOLINTNEXTLINE(concurrency-mt-unsafe)
             int system_ret = system((char *) reload_command_vec.buf.data);
             if (WIFEXITED(system_ret)) {
@@ -2476,6 +2475,13 @@ static void handle_deployment(
             }
         }
 
+        // NOLINTNEXTLINE(concurrency-mt-unsafe)
+        int system_ret = system("sudo systemctl reset-failed");
+        (void) (system_ret);
+        // NOLINTNEXTLINE(concurrency-mt-unsafe)
+        system_ret = system("sudo systemctl start greengrass-lite.target");
+        (void) (system_ret);
+
         ret = wait_for_deployment_status(resolved_components_kv_vec.map);
         if (ret != GGL_ERR_OK) {
             return;

ggdeploymentd/unit/template.service.in

@@ -0,0 +1,27 @@
+[Unit]
+StartLimitInterval=20
+StartLimitBurst=10
+PartOf=greengrass-lite.target
+
+[Install]
+WantedBy=greengrass-lite.target
+
+[Service]
+Type=exec
+ExecStart=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_BINDIR@/@name@
+Restart=always
+RestartSec=1
+User=@GGL_SYSTEMD_SYSTEM_USER@
+Group=@GGL_SYSTEMD_SYSTEM_GROUP@
+# Disallow from having overly-permissive capabilities
+CapabilityBoundingSet=~CAP_SYS_PTRACE
+# Working directory in StateDirectory (/var/lib/greengrass)
+StateDirectory=greengrass
+WorkingDirectory=%S/greengrass
+
+[Unit]
+Description=Greengrass Lite deployment queue and processor
+After=ggl.core.ggconfigd.service
+After=ggl.core.iotcored.service
+After=ggl.core.tesd.service
+After=network.target

gghealthd/CMakeLists.txt

@@ -2,5 +2,12 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
-ggl_init_module(gghealthd LIBS ggl-lib ggl-file core-bus core-bus-gg-config
-                               PkgConfig::libsystemd)
+ggl_init_module(
+  gghealthd
+  LIBS ggl-lib
+       ggl-file
+       core-bus
+       core-bus-gg-config
+       PkgConfig::libsystemd
+       SOCKETS
+       gg_health)

gghealthd/src/bus_server.c

@@ -187,7 +187,7 @@ GglError run_gghealthd(void) {
               NULL } };
     static const size_t HANDLERS_LEN = sizeof(handlers) / sizeof(handlers[0]);
 
-    ggl_listen(GGL_STR("/aws/ggl/gghealthd"), handlers, HANDLERS_LEN);
+    ggl_listen(GGL_STR("gg_health"), handlers, HANDLERS_LEN);
 
     return GGL_ERR_OK;
 }

gghealthd/unit/template.service.in

@@ -0,0 +1,28 @@
+[Unit]
+StartLimitInterval=20
+StartLimitBurst=10
+PartOf=greengrass-lite.target
+
+[Install]
+WantedBy=greengrass-lite.target
+
+[Service]
+Type=exec
+ExecStart=@CMAKE_INSTALL_PREFIX@/@CMAKE_INSTALL_BINDIR@/@name@
+Restart=always
+RestartSec=1
+# Disallow from having overly-permissive capabilities
+CapabilityBoundingSet=~CAP_SYS_ADMIN ~CAP_SYS_PTRACE
+User=@GGL_SYSTEMD_SYSTEM_USER@
+Group=@GGL_SYSTEMD_SYSTEM_GROUP@
+# Working directory in StateDirectory (/var/lib/greengrass)
+StateDirectory=greengrass
+WorkingDirectory=%S/greengrass
+
+[Unit]
+Description=core-bus abstract orchestrator interface
+After=ggl.core.ggconfigd.service
+
+# Allow gghealthd to change other service's active states
+[Service]
+NotifyAccess=all

ggipcd/CMakeLists.txt

@@ -13,4 +13,8 @@ ggl_init_module(
        core-bus-gg-config
        core-bus-aws-iot-mqtt
        ggipc-auth
-       ggl-rand)
+       ggl-rand
+       SOCKETS
+       gg-ipc.socket
+       SOCKETDIR
+       /var/lib/greengrass)