hide symbols by default (#140)

CMakeLists.txt

@@ -27,7 +27,7 @@ if (OPENDHT_TOOLS)
     find_package (Readline 6 REQUIRED)
 endif ()
 
-set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread -std=c++11 -Wno-return-type -Wall -Wextra -Wnon-virtual-dtor -pedantic-errors")
+set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread -std=c++11 -Wno-return-type -Wall -Wextra -Wnon-virtual-dtor -pedantic-errors -fvisibility=hidden")
 set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DMSGPACK_DISABLE_LEGACY_NIL -DMSGPACK_DISABLE_LEGACY_CONVERT")
 if (NOT CMAKE_BUILD_TYPE)
     set(CMAKE_BUILD_TYPE Release)
@@ -131,6 +131,7 @@ if (OPENDHT_SHARED)
     )
     set_target_properties (opendht PROPERTIES IMPORT_SUFFIX "_import.lib")
     set_target_properties (opendht PROPERTIES SOVERSION ${opendht_VERSION_MAJOR} VERSION ${opendht_VERSION})
+    target_compile_definitions(opendht PRIVATE OPENDHT_BUILD)
     if (OPENDHT_LTO)
         target_link_libraries(opendht -flto -fuse-linker-plugin)
     endif ()

include/opendht/callbacks.h

@@ -42,7 +42,7 @@ enum class NodeStatus {
 /**
  * Dht configuration.
  */
-struct Config {
+struct OPENDHT_PUBLIC Config {
     /** DHT node ID */
     InfoHash node_id;
 
@@ -63,7 +63,7 @@ struct Config {
 /**
  * SecureDht configuration.
  */
-struct SecureDhtConfig
+struct OPENDHT_PUBLIC SecureDhtConfig
 {
     Config node_config;
     crypto::Identity id;
@@ -82,8 +82,8 @@ using CertificateStoreQuery = std::function<std::vector<std::shared_ptr<crypto::
 
 typedef bool (*GetCallbackRaw)(std::shared_ptr<Value>, void *user_data);
 
-GetCallbackSimple bindGetCb(GetCallbackRaw raw_cb, void* user_data);
-GetCallback bindGetCb(GetCallbackSimple cb);
+OPENDHT_PUBLIC GetCallbackSimple bindGetCb(GetCallbackRaw raw_cb, void* user_data);
+OPENDHT_PUBLIC GetCallback bindGetCb(GetCallbackSimple cb);
 
 using DoneCallback = std::function<void(bool success, const std::vector<std::shared_ptr<Node>>& nodes)>;
 typedef void (*DoneCallbackRaw)(bool, std::vector<std::shared_ptr<Node>>*, void *user_data);
@@ -92,9 +92,9 @@ typedef void (*DoneCallbackSimpleRaw)(bool, void *user_data);
 
 using DoneCallbackSimple = std::function<void(bool success)>;
 
-ShutdownCallback bindShutdownCb(ShutdownCallbackRaw shutdown_cb_raw, void* user_data);
-DoneCallback bindDoneCb(DoneCallbackSimple donecb);
-DoneCallback bindDoneCb(DoneCallbackRaw raw_cb, void* user_data);
-DoneCallbackSimple bindDoneCbSimple(DoneCallbackSimpleRaw raw_cb, void* user_data);
+OPENDHT_PUBLIC ShutdownCallback bindShutdownCb(ShutdownCallbackRaw shutdown_cb_raw, void* user_data);
+OPENDHT_PUBLIC DoneCallback bindDoneCb(DoneCallbackSimple donecb);
+OPENDHT_PUBLIC DoneCallback bindDoneCb(DoneCallbackRaw raw_cb, void* user_data);
+OPENDHT_PUBLIC DoneCallbackSimple bindDoneCbSimple(DoneCallbackSimpleRaw raw_cb, void* user_data);
 
 }

include/opendht/crypto.h

@@ -38,7 +38,7 @@ extern "C" {
 namespace dht {
 namespace crypto {
 
-class CryptoException : public std::runtime_error {
+class OPENDHT_PUBLIC CryptoException : public std::runtime_error {
     public:
         CryptoException(const std::string& str) : std::runtime_error(str) {};
 };
@@ -46,7 +46,7 @@ class CryptoException : public std::runtime_error {
 /**
  * Exception thrown when a decryption error happened.
  */
-class DecryptError : public CryptoException {
+class OPENDHT_PUBLIC DecryptError : public CryptoException {
     public:
         DecryptError(const std::string& str = "") : CryptoException(str) {};
 };
@@ -59,7 +59,7 @@ using Identity = std::pair<std::shared_ptr<PrivateKey>, std::shared_ptr<Certific
 /**
  * A public key.
  */
-struct PublicKey
+struct OPENDHT_PUBLIC PublicKey
 {
     PublicKey() {}
 
@@ -109,7 +109,7 @@ private:
 /**
  * A private key, including the corresponding public key.
  */
-struct PrivateKey
+struct OPENDHT_PUBLIC PrivateKey
 {
     PrivateKey();
     //PrivateKey(gnutls_privkey_t k) : key(k) {}
@@ -159,7 +159,7 @@ private:
     //friend dht::crypto::Identity dht::crypto::generateIdentity(const std::string&, dht::crypto::Identity, unsigned key_length);
 };
 
-struct Certificate {
+struct OPENDHT_PUBLIC Certificate {
     Certificate() {}
 
     /**
@@ -324,8 +324,8 @@ private:
  *           If not set, the generated certificate will be a self-signed CA.
  * @param key_length stength of the generated private key (bits).
  */
-Identity generateIdentity(const std::string& name, Identity ca, unsigned key_length, bool is_ca);
-Identity generateIdentity(const std::string& name = "dhtnode", Identity ca = {}, unsigned key_length = 4096);
+OPENDHT_PUBLIC Identity generateIdentity(const std::string& name, Identity ca, unsigned key_length, bool is_ca);
+OPENDHT_PUBLIC Identity generateIdentity(const std::string& name = "dhtnode", Identity ca = {}, unsigned key_length = 4096);
 
 
 /**
@@ -336,7 +336,7 @@ Identity generateIdentity(const std::string& name = "dhtnode", Identity ca = {},
  * will use SHA256 for hash_length up to 32 bytes,
  * will use SHA512 for hash_length of 33 bytes and more.
  */
-Blob hash(const Blob& data, size_t hash_length = 512/8);
+OPENDHT_PUBLIC Blob hash(const Blob& data, size_t hash_length = 512/8);
 
 /**
  * Generates an encryption key from a text password,
@@ -345,19 +345,19 @@ Blob hash(const Blob& data, size_t hash_length = 512/8);
  * that can be transmitted in clear, and will be generated if
  * not provided (32 bytes).
  */
-Blob stretchKey(const std::string& password, Blob& salt, size_t key_length = 512/8);
+OPENDHT_PUBLIC Blob stretchKey(const std::string& password, Blob& salt, size_t key_length = 512/8);
 
 /**
  * AES-GCM encryption. Key must be 128, 192 or 256 bits long (16, 24 or 32 bytes).
  */
-Blob aesEncrypt(const Blob& data, const Blob& key);
-Blob aesEncrypt(const Blob& data, const std::string& password);
+OPENDHT_PUBLIC Blob aesEncrypt(const Blob& data, const Blob& key);
+OPENDHT_PUBLIC Blob aesEncrypt(const Blob& data, const std::string& password);
 
 /**
  * AES-GCM decryption.
  */
-Blob aesDecrypt(const Blob& data, const Blob& key);
-Blob aesDecrypt(const Blob& data, const std::string& password);
+OPENDHT_PUBLIC Blob aesDecrypt(const Blob& data, const Blob& key);
+OPENDHT_PUBLIC Blob aesDecrypt(const Blob& data, const std::string& password);
 
 }
 }

include/opendht/def.h

@@ -0,0 +1,28 @@
+#pragma once
+
+// Generic helper definitions for shared library support
+#if defined _WIN32 || defined __CYGWIN__
+  #define OPENDTH_IMPORT __declspec(dllimport)
+  #define OPENDHT_EXPORT __declspec(dllexport)
+  #define OPENDHT_HIDDEN
+#else
+  #define OPENDTH_IMPORT __attribute__ ((visibility ("default")))
+  #define OPENDHT_EXPORT __attribute__ ((visibility ("default")))
+  #define OPENDHT_HIDDEN __attribute__ ((visibility ("hidden")))
+#endif
+
+// Now we use the generic helper definitions above to define OPENDHT_PUBLIC and OPENDHT_LOCAL.
+// OPENDHT_PUBLIC is used for the public API symbols. It either DLL imports or DLL exports (or does nothing for static build)
+// OPENDHT_LOCAL is used for non-api symbols.
+
+#ifdef opendht_EXPORTS // defined if OpenDHT is compiled as a shared library
+  #ifdef OPENDHT_BUILD // defined if we are building the OpenDHT shared library (instead of using it)
+    #define OPENDHT_PUBLIC OPENDHT_EXPORT
+  #else
+    #define OPENDHT_PUBLIC OPENDTH_IMPORT
+  #endif // OPENDHT_BUILD
+  #define OPENDHT_LOCAL OPENDHT_HIDDEN
+#else // opendht_EXPORTS is not defined: this means OpenDHT is a static lib.
+  #define OPENDHT_PUBLIC
+  #define OPENDHT_LOCAL
+#endif // opendht_EXPORTS

include/opendht/default_types.h

@@ -35,7 +35,7 @@ MSGPACK_ADD_ENUM(dht::ImStatus)
 
 namespace dht {
 
-class DhtMessage : public Value::Serializable<DhtMessage>
+class OPENDHT_PUBLIC DhtMessage : public Value::Serializable<DhtMessage>
 {
 public:
     static const ValueType TYPE;
@@ -61,7 +61,7 @@ public:
 };
 
 template <typename T>
-class SignedValue : public Value::Serializable<T>
+class OPENDHT_PUBLIC SignedValue : public Value::Serializable<T>
 {
 private:
     using BaseClass = Value::Serializable<T>;
@@ -81,7 +81,7 @@ public:
 };
 
 template <typename T>
-class EncryptedValue : public SignedValue<T>
+class OPENDHT_PUBLIC EncryptedValue : public SignedValue<T>
 {
 public:
     using BaseClass = SignedValue<T>;
@@ -105,7 +105,7 @@ public:
 
 
 
-class ImMessage : public SignedValue<ImMessage>
+class OPENDHT_PUBLIC ImMessage : public SignedValue<ImMessage>
 {
 private:
     using BaseClass = SignedValue<ImMessage>;
@@ -131,7 +131,7 @@ public:
     MSGPACK_DEFINE_MAP(id, msg, date, status)
 };
 
-class TrustRequest : public EncryptedValue<TrustRequest>
+class OPENDHT_PUBLIC TrustRequest : public EncryptedValue<TrustRequest>
 {
 private:
     using BaseClass = EncryptedValue<TrustRequest>;
@@ -152,7 +152,7 @@ public:
     MSGPACK_DEFINE(service, payload)
 };
 
-class IceCandidates : public EncryptedValue<IceCandidates>
+class OPENDHT_PUBLIC IceCandidates : public EncryptedValue<IceCandidates>
 {
 private:
     using BaseClass = EncryptedValue<IceCandidates>;
@@ -198,7 +198,7 @@ public:
 
 /* "Peer" announcement
  */
-class IpServiceAnnouncement : public Value::Serializable<IpServiceAnnouncement>
+class OPENDHT_PUBLIC IpServiceAnnouncement : public Value::Serializable<IpServiceAnnouncement>
 {
 private:
     using BaseClass = Value::Serializable<IpServiceAnnouncement>;
@@ -273,8 +273,8 @@ private:
 };
 
 
-extern const std::array<std::reference_wrapper<const ValueType>, 5> DEFAULT_TYPES;
+OPENDHT_PUBLIC extern const std::array<std::reference_wrapper<const ValueType>, 5> DEFAULT_TYPES;
 
-extern const std::array<std::reference_wrapper<const ValueType>, 1> DEFAULT_INSECURE_TYPES;
+OPENDHT_PUBLIC extern const std::array<std::reference_wrapper<const ValueType>, 1> DEFAULT_INSECURE_TYPES;
 
 }

include/opendht/dht.h

@@ -52,7 +52,7 @@ struct Request;
  * Must be given open UDP sockets and ::periodic must be
  * called regularly.
  */
-class Dht {
+class OPENDHT_PUBLIC Dht {
 public:
 
     // [[deprecated]]

include/opendht/dhtrunner.h

@@ -26,6 +26,7 @@
 #include "callbacks.h"
 #include "sockaddr.h"
 #include "log_enable.h"
+#include "def.h"
 
 #include <thread>
 #include <mutex>
@@ -48,7 +49,7 @@ struct SecureDhtConfig;
  * either wait for (expectedly frequent) calls to ::loop() or start an internal
  * thread that will update the DHT when appropriate.
  */
-class DhtRunner {
+class OPENDHT_PUBLIC DhtRunner {
 
 public:
     typedef std::function<void(NodeStatus, NodeStatus)> StatusCallback;

include/opendht/indexation/pht.h

@@ -26,7 +26,7 @@ namespace indexation {
  * the node in question is a leaf, *the label is a prefix of all the keys
  * contained in the leaf*.
  */
-struct Prefix {
+struct OPENDHT_PUBLIC Prefix {
     Prefix() {}
     Prefix(InfoHash h) : size_(h.size() * 8), content_(h.begin(), h.end()) { }
     Prefix(const Blob& d, const Blob& f={}) : size_(d.size()*8), flags_(f), content_(d) { }
@@ -245,7 +245,7 @@ private:
 };
 
 using Value = std::pair<InfoHash, dht::Value::Id>;
-struct IndexEntry : public dht::Value::Serializable<IndexEntry> {
+struct OPENDHT_PUBLIC IndexEntry : public dht::Value::Serializable<IndexEntry> {
     static const ValueType TYPE;
 
     virtual void unpackValue(const dht::Value& v) {
@@ -265,7 +265,7 @@ struct IndexEntry : public dht::Value::Serializable<IndexEntry> {
     MSGPACK_DEFINE_MAP(prefix, value)
 };
 
-class Pht {
+class OPENDHT_PUBLIC Pht {
     static constexpr const char* INVALID_KEY = "Key does not match the PHT key spec.";
 
     /* Prefixes the user_type for all dht values put on the DHT */

include/opendht/infohash.h

@@ -19,6 +19,8 @@
 
 #pragma once
 
+#include "def.h"
+
 #include <msgpack.hpp>
 
 #ifndef _WIN32
@@ -53,7 +55,7 @@ namespace dht {
  * An InfoHash is a byte array of HASH_LEN bytes.
  * InfoHashes identify nodes and values in the Dht.
  */
-class InfoHash final : public std::array<uint8_t, HASH_LEN> {
+class OPENDHT_PUBLIC InfoHash final : public std::array<uint8_t, HASH_LEN> {
 public:
     constexpr InfoHash() : std::array<uint8_t, HASH_LEN>() {}
     constexpr InfoHash(const std::array<uint8_t, HASH_LEN>& h) : std::array<uint8_t, HASH_LEN>(h) {}
@@ -192,8 +194,8 @@ public:
 
     static InfoHash getRandom();
 
-    friend std::ostream& operator<< (std::ostream& s, const InfoHash& h);
-    friend std::istream& operator>> (std::istream& s, InfoHash& h);
+    OPENDHT_PUBLIC friend std::ostream& operator<< (std::ostream& s, const InfoHash& h);
+    OPENDHT_PUBLIC friend std::istream& operator>> (std::istream& s, InfoHash& h);
 
     std::string toString() const;
 

include/opendht/node.h

@@ -86,7 +86,7 @@ struct Node {
 
     std::string toString() const;
 
-    friend std::ostream& operator<< (std::ostream& s, const Node& h);
+    OPENDHT_PUBLIC friend std::ostream& operator<< (std::ostream& s, const Node& h);
 
     static constexpr const std::chrono::minutes NODE_GOOD_TIME {120};
 

include/opendht/securedht.h

@@ -40,7 +40,7 @@
 
 namespace dht {
 
-class SecureDht : public Dht {
+class OPENDHT_PUBLIC SecureDht : public Dht {
 public:
 
     typedef std::function<void(bool)> SignatureCheckCallback;

include/opendht/sockaddr.h

@@ -18,6 +18,8 @@
 
 #pragma once
 
+#include "def.h"
+
 #ifndef _WIN32
 #include <sys/socket.h>
 #else
@@ -30,10 +32,10 @@ typedef uint16_t in_port_t;
 
 namespace dht {
 
-std::string print_addr(const sockaddr* sa, socklen_t slen);
-std::string print_addr(const sockaddr_storage& ss, socklen_t sslen);
+OPENDHT_PUBLIC std::string print_addr(const sockaddr* sa, socklen_t slen);
+OPENDHT_PUBLIC std::string print_addr(const sockaddr_storage& ss, socklen_t sslen);
 
-struct SockAddr : public std::pair<sockaddr_storage, socklen_t> {
+struct OPENDHT_PUBLIC SockAddr : public std::pair<sockaddr_storage, socklen_t> {
 public:
     SockAddr() : pair<sockaddr_storage, socklen_t>::pair({},0) {}
     SockAddr(const SockAddr& o) : pair<sockaddr_storage, socklen_t>::pair({},o.second) {
@@ -68,8 +70,8 @@ public:
     sa_family_t getFamily() const { return second > sizeof(sa_family_t) ? first.ss_family : AF_UNSPEC; }
 };
 
-bool operator==(const SockAddr& a, const SockAddr& b);
+OPENDHT_PUBLIC bool operator==(const SockAddr& a, const SockAddr& b);
 
-std::string printAddr(const SockAddr& addr);
+OPENDHT_PUBLIC std::string printAddr(const SockAddr& addr);
 
 }

include/opendht/utils.h

@@ -18,8 +18,7 @@
 
 #pragma once
 
-#define WANT4 1
-#define WANT6 2
+#include "def.h"
 
 #include <msgpack.hpp>
 
@@ -30,6 +29,9 @@
 
 #include <cstdarg>
 
+#define WANT4 1
+#define WANT6 2
+
 namespace dht {
 
 using NetId = uint32_t;
@@ -45,7 +47,7 @@ void erase_if(std::map<Key, Item>& map, const Condition& condition)
     }
 }
 
-class DhtException : public std::runtime_error {
+class OPENDHT_PUBLIC DhtException : public std::runtime_error {
     public:
         DhtException(const std::string &str = "") :
             std::runtime_error("DhtException occurred: " + str) {}
@@ -93,7 +95,7 @@ using Blob = std::vector<uint8_t>;
 /**
  * Provides backward compatibility with msgpack 1.0
  */
-Blob unpackBlob(msgpack::object& o);
+OPENDHT_PUBLIC Blob unpackBlob(msgpack::object& o);
 
 template <typename Type>
 Blob

include/opendht/value.h

@@ -72,7 +72,7 @@ using EditPolicy = std::function<bool(InfoHash key, const std::shared_ptr<Value>
 
 static constexpr const size_t MAX_VALUE_SIZE {1024 * 64};
 
-struct ValueType {
+struct OPENDHT_PUBLIC ValueType {
     typedef uint16_t Id;
 
     static bool DEFAULT_STORE_POLICY(InfoHash, std::shared_ptr<Value>& v, InfoHash, const sockaddr*, socklen_t);
@@ -114,7 +114,7 @@ struct ValueType {
  * Values are stored at a given InfoHash in the Dht, but also have a
  * unique ID to distinguish between values stored at the same location.
  */
-struct Value
+struct OPENDHT_PUBLIC Value
 {
     enum class Field : int {
         None = 0,
@@ -409,7 +409,7 @@ struct Value
     }
 
     /** print value for debugging */
-    friend std::ostream& operator<< (std::ostream& s, const Value& v);
+    OPENDHT_PUBLIC friend std::ostream& operator<< (std::ostream& s, const Value& v);
 
     std::string toString() const {
         std::stringstream ss;
@@ -553,7 +553,7 @@ using ValuesExport = std::pair<InfoHash, Blob>;
  * This structure holds the value for a specified field. It's type can either be
  * uint64_t, InfoHash or Blob.
  */
-struct FieldValue
+struct OPENDHT_PUBLIC FieldValue
 {
     FieldValue() {}
     FieldValue(Value::Field f, uint64_t int_value) : field(f), intValue(int_value) {}
@@ -638,7 +638,7 @@ private:
  * This is meant to narrow data to a set of specified fields. This structure is
  * used to construct a Select structure.
  */
-struct FieldSelectorDescription
+struct OPENDHT_PUBLIC FieldSelectorDescription
 {
     FieldSelectorDescription() {}
     FieldSelectorDescription(Value::Field f) : field(f) {}
@@ -661,7 +661,7 @@ private:
  * This is a container for a list of FieldSelectorDescription instances. It
  * describes a complete SELECT query for dht::Value.
  */
-struct Select
+struct OPENDHT_PUBLIC Select
 {
     Select() { }
     Select(const std::string& q_str);
@@ -700,7 +700,7 @@ struct Select
         fieldSelection_ = o.as<decltype(fieldSelection_)>();
     }
 
-    friend std::ostream& operator<<(std::ostream& s, const dht::Select& q);
+    OPENDHT_PUBLIC friend std::ostream& operator<<(std::ostream& s, const dht::Select& q);
 private:
     std::vector<FieldSelectorDescription> fieldSelection_ {};
 };
@@ -712,7 +712,7 @@ private:
  * This is container for a list of FieldValue instances. It describes a
  * complete WHERE query for dht::Value.
  */
-struct Where
+struct OPENDHT_PUBLIC Where
 {
     Where() { }
     Where(const std::string& q_str);
@@ -802,7 +802,7 @@ struct Where
         filters_ = o.as<decltype(filters_)>();
     }
 
-    friend std::ostream& operator<<(std::ostream& s, const dht::Where& q);
+    OPENDHT_PUBLIC friend std::ostream& operator<<(std::ostream& s, const dht::Where& q);
 
 private:
     std::vector<FieldValue> filters_;
@@ -816,7 +816,7 @@ private:
  * itselves to include in the peer response to a GET operation. See
  * FieldValue.
  */
-struct Query
+struct OPENDHT_PUBLIC Query
 {
     static const std::string QUERY_PARSE_ERROR;
 
@@ -864,7 +864,7 @@ struct Query
         return ss.str();
     }
 
-    friend std::ostream& operator<<(std::ostream& s, const dht::Query& q) {
+    OPENDHT_PUBLIC friend std::ostream& operator<<(std::ostream& s, const dht::Query& q) {
         return s << "Query[" << q.select << " " << q.where << "]";
     }
 
@@ -880,7 +880,7 @@ struct Query
  * This structures is meant to manipulate a subset of fields normally contained
  * in Value.
  */
-struct FieldValueIndex {
+struct OPENDHT_PUBLIC FieldValueIndex {
     FieldValueIndex() {}
     FieldValueIndex(const Value& v, Select s = {});
     /**
@@ -891,7 +891,7 @@ struct FieldValueIndex {
      */
     bool containedIn(const FieldValueIndex& other) const;
 
-    friend std::ostream& operator<<(std::ostream& os, const FieldValueIndex& fvi);
+    OPENDHT_PUBLIC friend std::ostream& operator<<(std::ostream& os, const FieldValueIndex& fvi);
 
     void msgpack_unpack_fields(const std::set<Value::Field>& fields,
             const msgpack::object& o,