zeroc-ice 3.7.10 → 3.8.0

data/dist/ice/cpp/src/Ice/ConnectionI.h

@@ -0,0 +1,429 @@
+// Copyright (c) ZeroC, Inc.
+
+#ifndef ICE_CONNECTION_I_H
+#define ICE_CONNECTION_I_H
+
+#include "ConnectionFactoryF.h"
+#include "ConnectionOptions.h"
+#include "ConnectorF.h"
+#include "EndpointIF.h"
+#include "EventHandler.h"
+#include "Ice/BatchRequestQueueF.h"
+#include "Ice/CommunicatorF.h"
+#include "Ice/Connection.h"
+#include "Ice/ConnectionIF.h"
+#include "Ice/InputStream.h"
+#include "Ice/InstanceF.h"
+#include "Ice/Logger.h"
+#include "Ice/ObjectAdapterF.h"
+#include "Ice/ObserverHelper.h"
+#include "Ice/OutgoingAsync.h"
+#include "Ice/OutgoingResponse.h"
+#include "Ice/OutputStream.h"
+#include "RequestHandler.h"
+#include "Timer.h"
+#include "TraceLevelsF.h"
+#include "TransceiverF.h"
+
+#include <chrono>
+#include <condition_variable>
+#include <deque>
+#include <list>
+#include <mutex>
+
+#ifndef ICE_HAS_BZIP2
+#    define ICE_HAS_BZIP2
+#endif
+
+namespace IceInternal
+{
+    class IdleTimeoutTransceiverDecorator;
+
+    template<typename T> class ThreadPoolMessage;
+}
+
+namespace Ice
+{
+    class LocalException;
+    class ObjectAdapterI;
+    using ObjectAdapterIPtr = std::shared_ptr<ObjectAdapterI>;
+
+    class ConnectionI final : public Connection,
+                              public IceInternal::EventHandler,
+                              public IceInternal::CancellationHandler
+    {
+        class Observer : public IceInternal::ObserverHelperT<Ice::Instrumentation::ConnectionObserver>
+        {
+        public:
+            Observer();
+
+            void startRead(const IceInternal::Buffer&);
+            void finishRead(const IceInternal::Buffer&);
+            void startWrite(const IceInternal::Buffer&);
+            void finishWrite(const IceInternal::Buffer&);
+
+            void attach(const Ice::Instrumentation::ConnectionObserverPtr&);
+
+        private:
+            std::byte* _readStreamPos{nullptr};
+            std::byte* _writeStreamPos{nullptr};
+        };
+
+    public:
+        std::shared_ptr<ConnectionI> shared_from_this()
+        {
+            return std::dynamic_pointer_cast<ConnectionI>(IceInternal::EventHandler::shared_from_this());
+        }
+
+        struct OutgoingMessage
+        {
+            OutgoingMessage(Ice::OutputStream* str, bool comp)
+                : stream(str),
+                  compress(comp),
+                  requestId(0),
+                  adopted(false)
+#if defined(ICE_USE_IOCP)
+                  ,
+                  isSent(false),
+                  invokeSent(false),
+                  receivedReply(false)
+#endif
+            {
+                assert(stream);
+                // The outgoing message can be sent asynchronously. If the stream doesn't own its memory, the memory
+                // owner could release it before the message is sent.
+                assert(stream->b.ownsMemory());
+            }
+
+            OutgoingMessage(IceInternal::OutgoingAsyncBasePtr o, Ice::OutputStream* str, bool comp, int rid)
+                : stream(str),
+                  outAsync(std::move(o)),
+                  compress(comp),
+                  requestId(rid),
+                  adopted(false)
+#if defined(ICE_USE_IOCP)
+                  ,
+                  isSent(false),
+                  invokeSent(false),
+                  receivedReply(false)
+#endif
+            {
+                assert(stream);
+                assert(stream->b.ownsMemory());
+            }
+
+            void adopt(Ice::OutputStream*);
+            void canceled(bool);
+            bool sent();
+            void completed(std::exception_ptr);
+
+            Ice::OutputStream* stream;
+            IceInternal::OutgoingAsyncBasePtr outAsync;
+            bool compress;
+            int requestId;
+            bool adopted;
+#if defined(ICE_USE_IOCP)
+            bool isSent;
+            bool invokeSent;
+            bool receivedReply;
+#endif
+        };
+
+        enum DestructionReason
+        {
+            ObjectAdapterDeactivated,
+            CommunicatorDestroyed
+        };
+
+        void startAsync(
+            std::function<void(const ConnectionIPtr&)>,
+            std::function<void(const ConnectionIPtr&, std::exception_ptr)>);
+        void activate();
+        void hold();
+        void destroy(DestructionReason);
+
+        void abort() noexcept final;
+        void close(std::function<void()> response, std::function<void(std::exception_ptr)> exception) noexcept final;
+
+        [[nodiscard]] bool isActiveOrHolding() const;
+        [[nodiscard]] bool isFinished() const;
+
+        void throwException() const final; // From Connection. Throws the connection exception if destroyed.
+
+        void waitUntilHolding() const;
+        void waitUntilFinished(); // Not const, as this might close the connection upon timeout.
+
+        void updateObserver();
+
+        /// Sends a request.
+        /// @param out The outgoing request.
+        /// @param compress True to compress the request; otherwise, false.
+        /// @param response True for a two-way request; false for a one-way request.
+        /// @param batchRequestCount The number of requests in the batch (for one-way requests); ignored for two-way
+        /// requests.
+        /// @return The sent status.
+        IceInternal::AsyncStatus sendAsyncRequest(
+            const IceInternal::OutgoingAsyncBasePtr& out,
+            bool compress,
+            bool response,
+            int batchRequestCount);
+
+        [[nodiscard]] const IceInternal::BatchRequestQueuePtr& getBatchRequestQueue() const;
+
+        std::function<void()> flushBatchRequestsAsync(
+            CompressBatch,
+            std::function<void(std::exception_ptr)>,
+            std::function<void(bool)> = nullptr) final;
+
+        void setCloseCallback(CloseCallback) final;
+
+        void disableInactivityCheck() noexcept final;
+
+        void asyncRequestCanceled(const IceInternal::OutgoingAsyncBasePtr&, std::exception_ptr) final;
+
+        [[nodiscard]] IceInternal::EndpointIPtr endpoint() const;
+        [[nodiscard]] IceInternal::ConnectorPtr connector() const;
+
+        void setAdapter(const ObjectAdapterPtr&) final;                   // From Connection.
+        [[nodiscard]] ObjectAdapterPtr getAdapter() const noexcept final; // From Connection.
+        [[nodiscard]] EndpointPtr getEndpoint() const noexcept final;     // From Connection.
+        [[nodiscard]] ObjectPrx _createProxy(Identity ident) const final; // From Connection.
+
+        void setAdapterFromAdapter(const ObjectAdapterIPtr&); // From ObjectAdapterI.
+
+        //
+        // Operations from EventHandler
+        //
+#if defined(ICE_USE_IOCP)
+        bool startAsync(IceInternal::SocketOperation);
+        bool finishAsync(IceInternal::SocketOperation);
+#endif
+
+        void message(IceInternal::ThreadPoolCurrent&) final;
+        void finished(IceInternal::ThreadPoolCurrent&, bool) final;
+        [[nodiscard]] std::string toString() const final; // From Connection and EventHandler.
+        IceInternal::NativeInfoPtr getNativeInfo() final;
+
+        [[nodiscard]] const std::string& type() const noexcept final; // From Connection.
+        [[nodiscard]] ConnectionInfoPtr getInfo() const final;        // From Connection
+
+        void setBufferSize(std::int32_t rcvSize, std::int32_t sndSize) final; // From Connection
+
+        void exception(std::exception_ptr);
+
+        // This method is called to execute user code (connection start completion callback, invocation sent callbacks,
+        // or an upcall issued from an incoming message). The invocation sent callbacks and the message upcall might
+        // both be set.
+        void upcall(
+            const std::function<void(ConnectionIPtr)>& connectionStartCompleted,
+            const std::vector<OutgoingMessage>& sentMessages,
+            const std::function<bool(InputStream&)>& messageUpcall,
+            InputStream& messageStream);
+        void finish(bool);
+
+        void closeCallback(const CloseCallback&);
+
+        /// Aborts the connection with a ConnectionAbortedException if the connection is active and did not receive
+        /// a byte for some time. See the IdleTimeoutTransceiverDecorator.
+        void idleCheck(const std::chrono::seconds& idleTimeout) noexcept;
+
+        /// Shuts down the connection gracefully if it's at rest when this function is called.
+        void inactivityCheck() noexcept;
+
+        /// Aborts the connection if its state is < StateActive.
+        void connectTimedOut() noexcept;
+
+        /// Aborts the connection if its state is < StateClosed.
+        void closeTimedOut() noexcept;
+
+        /// Sends a heartbeat.
+        void sendHeartbeat() noexcept;
+
+        ~ConnectionI() final;
+
+    private:
+        ConnectionI(
+            Ice::CommunicatorPtr,
+            const IceInternal::InstancePtr&,
+            const IceInternal::TransceiverPtr&,
+            const IceInternal::ConnectorPtr&,
+            const IceInternal::EndpointIPtr&,
+            const std::shared_ptr<ObjectAdapterI>&,
+            std::function<void(const ConnectionIPtr&)>,
+            const ConnectionOptions&) noexcept;
+
+        static ConnectionIPtr create(
+            const Ice::CommunicatorPtr&,
+            const IceInternal::InstancePtr&,
+            const IceInternal::TransceiverPtr&,
+            const IceInternal::ConnectorPtr&,
+            const IceInternal::EndpointIPtr&,
+            const std::shared_ptr<ObjectAdapterI>&,
+            std::function<void(const ConnectionIPtr&)>,
+            const ConnectionOptions&);
+
+        enum State
+        {
+            StateNotInitialized,
+            StateNotValidated,
+            StateActive,
+            StateHolding,
+            StateClosing,
+            StateClosingPending,
+            StateClosed,
+            StateFinished
+        };
+
+        friend class IceInternal::IncomingConnectionFactory;
+        friend class IceInternal::OutgoingConnectionFactory;
+
+        void setState(State, std::exception_ptr);
+        void setState(State);
+
+        void initiateShutdown();
+
+        void sendResponse(OutgoingResponse, std::uint8_t compress);
+        void dispatchException(std::exception_ptr, int);
+
+        bool initialize(IceInternal::SocketOperation = IceInternal::SocketOperationNone);
+        bool validate(IceInternal::SocketOperation = IceInternal::SocketOperationNone);
+
+        /// Sends the next queued messages. This method is called by message() once the message which is being sent
+        /// (_sendStreams.First) is fully sent. Before sending the next message, this message is removed from
+        /// _sendsStream. If any, its sent callback is also queued in given callback queue.
+        ///
+        /// @param callbacks The sent callbacks to call for the messages that were sent.
+        /// @return The socket operation to register with the thread pool's selector to send the remainder of the
+        /// pending message being sent (_sendStreams.First).
+        IceInternal::SocketOperation sendNextMessages(std::vector<OutgoingMessage>& callbacks);
+
+        /// Sends or queues the given message.
+        ///
+        /// @param message The message to send.
+        /// @return The send status.
+        IceInternal::AsyncStatus sendMessage(OutgoingMessage& message);
+
+#ifdef ICE_HAS_BZIP2
+        void doCompress(Ice::OutputStream&, Ice::OutputStream&);
+        void doUncompress(Ice::InputStream&, Ice::InputStream&);
+#endif
+
+        IceInternal::SocketOperation parseMessage(
+            std::int32_t& upcallCount,
+            std::function<bool(InputStream&)>& messageUpcall,
+            Ice::InputStream& messageStream);
+
+        void dispatchAll(Ice::InputStream&, std::int32_t, std::int32_t, std::uint8_t, const ObjectAdapterIPtr&);
+
+        [[nodiscard]] Ice::ConnectionInfoPtr initConnectionInfo() const;
+        [[nodiscard]] Ice::Instrumentation::ConnectionState toConnectionState(State) const;
+
+        IceInternal::SocketOperation read(IceInternal::Buffer&);
+        IceInternal::SocketOperation write(IceInternal::Buffer&);
+
+        void scheduleInactivityTimerTask();
+        void cancelInactivityTimerTask() noexcept;
+
+        void scheduleCloseTimerTask();
+        void doApplicationClose() noexcept;
+
+        Ice::CommunicatorPtr _communicator;
+        const IceInternal::InstancePtr _instance;
+        const IceInternal::TransceiverPtr _transceiver;
+        const std::shared_ptr<IceInternal::IdleTimeoutTransceiverDecorator> _idleTimeoutTransceiver; // can be null
+
+        const std::string _desc;
+        const std::string _type;
+        const IceInternal::ConnectorPtr _connector;
+        const IceInternal::EndpointIPtr _endpoint;
+
+        mutable Ice::ConnectionInfoPtr _info;
+
+        ObjectAdapterIPtr _adapter;
+
+        const bool _hasExecutor;
+
+        const LoggerPtr _logger;
+        const IceInternal::TraceLevelsPtr _traceLevels;
+        const IceInternal::ThreadPoolPtr _threadPool;
+
+        const IceInternal::TimerPtr _timer;
+
+        const std::chrono::seconds _connectTimeout;
+        const std::chrono::seconds _closeTimeout;
+        const std::chrono::seconds _inactivityTimeout;
+
+        IceInternal::TimerTaskPtr _inactivityTimerTask;
+        bool _inactivityTimerTaskScheduled{false};
+
+        std::function<void(ConnectionIPtr)> _connectionStartCompleted;
+        std::function<void(ConnectionIPtr, std::exception_ptr)> _connectionStartFailed;
+
+        // This function must be called outside the ConnectionI lock to avoid lock acquisition deadlocks.
+        const std::function<void(const ConnectionIPtr&)> _removeFromFactory;
+
+        const bool _warn;
+        const bool _warnUdp;
+
+        const int _compressionLevel{1};
+
+        std::int32_t _nextRequestId{1};
+
+        std::map<std::int32_t, IceInternal::OutgoingAsyncBasePtr> _asyncRequests;
+        std::map<std::int32_t, IceInternal::OutgoingAsyncBasePtr>::iterator _asyncRequestsHint;
+
+        std::exception_ptr _exception;
+
+        const std::int32_t _messageSizeMax;
+        IceInternal::BatchRequestQueuePtr _batchRequestQueue;
+
+        std::deque<OutgoingMessage> _sendStreams;
+
+        // Contains the message which is being received. If the connection is waiting to receive a message (_readHeader
+        // == true), its size is Protocol.headerSize. Otherwise, its size is the message size specified in the received
+        // message header.
+        Ice::InputStream _readStream;
+
+        // When _readHeader is true, the next bytes we'll read are the header of a new message. When false, we're
+        // reading next the remainder of a message that was already partially received.
+        bool _readHeader{false};
+
+        // Contains the message which is being sent. The write stream buffer is empty if no message is being sent.
+        Ice::OutputStream _writeStream;
+
+        Observer _observer;
+
+        // The upcall count keeps track of the number of dispatches, AMI (response) continuations, sent callbacks and
+        // connection establishment callbacks that have been started (or are about to be started) by a thread of the
+        // thread pool associated with this connection, and have not completed yet. All these operations except the
+        // connection establishment callbacks execute application code or code generated from Slice definitions.
+        int _upcallCount{0};
+
+        // The number of outstanding dispatches. Maintained only while state is StateActive or StateHolding.
+        int _dispatchCount = 0;
+
+        // When we dispatch _maxDispatches concurrent requests, we stop reading the connection to back-pressure the
+        // peer. _maxDispatches <= 0 means no limit.
+        int _maxDispatches;
+
+        State _state{StateNotInitialized}; // The current state.
+        bool _shutdownInitiated{false};
+        bool _initialized{false};
+        bool _validated{false};
+
+        // When true, the application called close and Connection must close the connection when it receives the reply
+        // for the last outstanding invocation.
+        bool _closeRequested = false;
+
+        CloseCallback _closeCallback;
+        std::list<std::pair<std::function<void()>, std::function<void(std::exception_ptr)>>> _onClosedList;
+
+        mutable std::mutex _mutex;
+        mutable std::condition_variable _conditionVariable;
+
+        // For locking the _mutex
+        template<typename T> friend class IceInternal::ThreadPoolMessage;
+    };
+}
+
+#endif

data/dist/ice/cpp/src/Ice/ConnectionOptions.h

@@ -0,0 +1,22 @@
+// Copyright (c) ZeroC, Inc.
+
+#ifndef ICE_CONNECTION_OPTIONS_H
+#define ICE_CONNECTION_OPTIONS_H
+
+#include <chrono>
+
+namespace Ice
+{
+    /// Represents a property bag used to configure client and server connections.
+    struct ConnectionOptions
+    {
+        std::chrono::seconds connectTimeout;
+        std::chrono::seconds closeTimeout;
+        std::chrono::seconds idleTimeout;
+        bool enableIdleCheck;
+        std::chrono::seconds inactivityTimeout;
+        int maxDispatches;
+    };
+}
+
+#endif

data/dist/ice/cpp/src/Ice/Connector.h

@@ -0,0 +1,38 @@
+// Copyright (c) ZeroC, Inc.
+
+#ifndef ICE_CONNECTOR_H
+#define ICE_CONNECTOR_H
+
+#include "ConnectorF.h"
+#include "TransceiverF.h"
+
+#include <cstdint>
+#include <string>
+
+#ifdef __clang__
+#    pragma clang diagnostic push
+#    pragma clang diagnostic ignored "-Wweak-vtables"
+#endif
+
+namespace IceInternal
+{
+    class Connector
+    {
+    public:
+        virtual ~Connector() = default;
+
+        virtual TransceiverPtr connect() = 0;
+
+        [[nodiscard]] virtual std::int16_t type() const = 0;
+        [[nodiscard]] virtual std::string toString() const = 0;
+
+        virtual bool operator==(const Connector&) const = 0;
+        virtual bool operator<(const Connector&) const = 0;
+    };
+}
+
+#ifdef __clang__
+#    pragma clang diagnostic pop
+#endif
+
+#endif

data/dist/ice/cpp/src/Ice/ConnectorF.h

@@ -0,0 +1,14 @@
+// Copyright (c) ZeroC, Inc.
+
+#ifndef ICE_CONNECTOR_F_H
+#define ICE_CONNECTOR_F_H
+
+#include <memory>
+
+namespace IceInternal
+{
+    class Connector;
+    using ConnectorPtr = std::shared_ptr<Connector>;
+}
+
+#endif

data/dist/ice/cpp/src/Ice/ConsoleUtil.cpp

@@ -0,0 +1,136 @@
+// Copyright (c) ZeroC, Inc.
+
+#include "ConsoleUtil.h"
+
+#ifdef _WIN32
+#    include <mutex>
+#    include <windows.h>
+#endif
+
+#include <iostream>
+
+using namespace IceInternal;
+using namespace std;
+
+#if defined(_WIN32)
+namespace
+{
+    mutex consoleMutex;
+    // We leak consoleUtil object to ensure that is available during static destruction.
+    ConsoleUtil* consoleUtil = 0;
+}
+
+const ConsoleUtil&
+IceInternal::getConsoleUtil()
+{
+    lock_guard sync(consoleMutex);
+    if (consoleUtil == 0)
+    {
+        consoleUtil = new ConsoleUtil();
+    }
+    return *consoleUtil;
+}
+
+ConsoleOut IceInternal::consoleOut;
+ConsoleErr IceInternal::consoleErr;
+
+ConsoleUtil::ConsoleUtil()
+    : _converter(Ice::getProcessStringConverter()),
+      _consoleConverter(Ice::createWindowsStringConverter(GetConsoleOutputCP()))
+{
+}
+
+string
+ConsoleUtil::toConsoleEncoding(const string& message) const
+{
+    try
+    {
+        // Convert message to UTF-8
+        string u8s = nativeToUTF8(message, _converter);
+
+        // Then from UTF-8 to console CP
+        string consoleString;
+        _consoleConverter->fromUTF8(
+            reinterpret_cast<const byte*>(u8s.data()),
+            reinterpret_cast<const byte*>(u8s.data() + u8s.size()),
+            consoleString);
+
+        return consoleString;
+    }
+    catch (const Ice::IllegalConversionException&)
+    {
+        //
+        // If there is a problem with the encoding conversions we just
+        // return the original message without encoding conversions.
+        //
+        return message;
+    }
+}
+
+void
+ConsoleUtil::output(const string& message) const
+{
+    //
+    // Use fprintf_s to avoid encoding conversion when stderr is connected
+    // to Windows console.
+    //
+    fprintf_s(stdout, "%s", toConsoleEncoding(message).c_str());
+}
+
+void
+ConsoleUtil::error(const string& message) const
+{
+    //
+    // Use fprintf_s to avoid encoding conversion when stderr is connected
+    // to Windows console.
+    //
+    fprintf_s(stderr, "%s", toConsoleEncoding(message).c_str());
+}
+
+ConsoleOut&
+IceInternal::endl(ConsoleOut& out)
+{
+    fprintf_s(stdout, "\n");
+    fflush(stdout);
+    return out;
+}
+
+ConsoleOut&
+IceInternal::flush(ConsoleOut& out)
+{
+    fflush(stdout);
+    return out;
+}
+
+ConsoleOut&
+ConsoleOut::operator<<(ConsoleOut& (*pf)(ConsoleOut&))
+{
+    pf(*this);
+    return *this;
+}
+
+ConsoleErr&
+IceInternal::endl(ConsoleErr& err)
+{
+    fprintf_s(stderr, "\n");
+    fflush(stderr);
+    return err;
+}
+
+ConsoleErr&
+IceInternal::flush(ConsoleErr& err)
+{
+    fflush(stderr);
+    return err;
+}
+
+ConsoleErr&
+ConsoleErr::operator<<(ConsoleErr& (*pf)(ConsoleErr&))
+{
+    pf(*this);
+    return *this;
+}
+#else
+std::ostream& IceInternal::consoleOut = cout;
+std::ostream& IceInternal::consoleErr = cerr;
+#endif