Merge pull request pocl#1702 from Yashvardhan-A/Android-discovery-support

Android: remote device addition

Author: pjaaskel

CMakeLists.txt

@@ -318,9 +318,11 @@ else()
 endif()
 option(ENABLE_LLVM_PLATFORM_SUPPORT "Enable platform support using C++ STL and LLVM's Support library" ${DEFAULT_LLVM_PLATFORM_SUPPORT})
 
-option(ENABLE_REMOTE_DISCOVERY_AVAHI "Enable remote disocvery in remote device for linux using avahi" OFF)
+option(ENABLE_REMOTE_DISCOVERY_AVAHI "Enable remote discovery in remote device for linux using avahi" OFF)
 
-option(ENABLE_REMOTE_DISCOVERY_DHT "Enable remote disocvery in remote device for linux using DHT" OFF)
+option(ENABLE_REMOTE_DISCOVERY_DHT "Enable remote discovery in remote device for linux using DHT" OFF)
+
+option(ENABLE_REMOTE_DISCOVERY_ANDROID "Enable remote discovery support in remote device for Android" OFF)
 
 option(ENABLE_REMOTE_ADVERTISEMENT_AVAHI "Enable remote server advertisement using avahi" OFF)
 

config.h.in.cmake

@@ -57,6 +57,8 @@
 
 #cmakedefine ENABLE_REMOTE_DISCOVERY_DHT
 
+#cmakedefine ENABLE_REMOTE_DISCOVERY_ANDROID
+
 #cmakedefine ENABLE_REMOTE_ADVERTISEMENT_AVAHI
 
 #cmakedefine ENABLE_REMOTE_ADVERTISEMENT_DHT

doc/sphinx/source/remote.rst

@@ -423,6 +423,10 @@ Remote Client:
 
 * ``-DENABLE_REMOTE_DISCOVERY_DHT``: Enable DHT-based discovery.
 
+* ``-DENABLE_REMOTE_DISCOVERY_ANDROID``: Enables discovery for Android. The helper
+  function ``pocl_remote_discovery_add_server()`` in include/pocl_remote.h can be
+  used to dynamically add remote servers and its devices through the remote driver.
+
 Remote Server:
 
 * ``-DENABLE_REMOTE_ADVERTISEMENT_AVAHI``: Enable mDNS advertisement via Avahi.

include/pocl_remote.h

@@ -24,6 +24,10 @@
 #ifndef POCL_REMOTE_SHARED_H
 #define POCL_REMOTE_SHARED_H
 
+#if defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
+#include <CL/cl_platform.h>
+#endif
+
 #define DEFAULT_POCL_REMOTE_PORT 10998
 
 #define MAX_REMOTE_BUILDPROGRAM_SIZE (16 << 20)
@@ -32,4 +36,34 @@
 
 #define MAX_REMOTE_PARAM_LENGTH 256
 
+#if defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+  /**
+   * Helper function used to dynamically add a remote server and its devices.
+   * It is currently only used by android where the network discovery is
+   * performed using android network libraries and the discovered servers are
+   * added using this function. The function is implemented in the remote
+   * driver in network_discovery.c.
+   *
+   * \param id [in] Unique ID with which server advertises itself.
+   * \param domain [in] Domain name in which the server was found.
+   * \param server_key [in] Combination of "IP:port"
+   * \param type [in] Type of the discovered service. Eg type: "_pocl._tcp"
+   * \param device_count [in] Number of devices in the remote server.
+   */
+  void pocl_remote_discovery_add_server (const char *id,
+                                         const char *domain,
+                                         const char *server_key,
+                                         const char *type,
+                                         cl_uint device_count);
+
+#ifdef __cplusplus
+}
+#endif
+#endif
+
 #endif

lib/CL/devices/remote/CMakeLists.txt

@@ -45,5 +45,9 @@ if(ENABLE_REMOTE_DISCOVERY_DHT)
   list(APPEND POCL_REMOTE_CLIENT_SOURCES network_discovery.c network_discovery.h)
 endif()
 
+if(ENABLE_REMOTE_DISCOVERY_ANDROID)
+  list(APPEND POCL_REMOTE_CLIENT_SOURCES network_discovery.c network_discovery.h)
+endif()
+
 add_pocl_device_library("pocl-devices-remote" ${POCL_REMOTE_CLIENT_SOURCES})
 target_link_libraries("pocl-devices-remote" PRIVATE ${LIBS})

lib/CL/devices/remote/network_discovery.c

@@ -31,6 +31,7 @@
 #include "network_discovery.h"
 #include "pocl_cl.h"
 #include "pocl_debug.h"
+#include "pocl_remote.h"
 #include "pocl_runtime_config.h"
 #include "pocl_threads.h"
 #include "uthash.h"
@@ -657,6 +658,27 @@ init_dht_discovery ()
 
 /*****************************************************************************/
 
+#if defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
+
+/**
+ * Helper function used by android to add servers through the remote driver.
+ *
+ * The function declaration is in include/pocl_remote.h.
+ */
+void
+pocl_remote_discovery_add_server (const char *id,
+                                  const char *domain,
+                                  const char *server_key,
+                                  const char *type,
+                                  cl_uint device_count)
+{
+  handle_server_discovery (id, domain, server_key, type, device_count);
+}
+
+#endif
+
+/*****************************************************************************/
+
 /**
  * Function called by the remote driver to initialize network discovery
  * methods.

lib/CL/devices/remote/remote.c

@@ -54,7 +54,8 @@
 #include "messages.h"
 
 #if defined(ENABLE_REMOTE_DISCOVERY_AVAHI)                                    \
-  || defined(ENABLE_REMOTE_DISCOVERY_DHT)
+  || defined(ENABLE_REMOTE_DISCOVERY_DHT)                                     \
+  || defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
 #include "network_discovery.h"
 #endif
 
@@ -380,7 +381,8 @@ pocl_remote_init_device_ops (struct pocl_device_ops *ops)
   ops->free_sampler = pocl_remote_free_sampler;
 
 #if defined(ENABLE_REMOTE_DISCOVERY_AVAHI)                                    \
-  || defined(ENABLE_REMOTE_DISCOVERY_DHT)
+  || defined(ENABLE_REMOTE_DISCOVERY_DHT)                                     \
+  || defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
   ops->init_discovery = pocl_remote_init_device_discovery;
 #endif
 }
@@ -640,7 +642,8 @@ pocl_remote_init (unsigned j, cl_device_id device, const char *parameters)
 }
 
 #if defined(ENABLE_REMOTE_DISCOVERY_AVAHI)                                    \
-  || defined(ENABLE_REMOTE_DISCOVERY_DHT)
+  || defined(ENABLE_REMOTE_DISCOVERY_DHT)                                     \
+  || defined(ENABLE_REMOTE_DISCOVERY_ANDROID)
 cl_int
 pocl_remote_init_device_discovery (
   cl_int (*add_discovered_device) (const char *, unsigned),