Coverage Report

Created: 2026-03-21 07:01

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libzmq/src/vsock_connecter.cpp
Line
Count
Source
1
/* SPDX-License-Identifier: MPL-2.0 */
2
3
#include "precompiled.hpp"
4
5
#include "vsock_connecter.hpp"
6
#include "vsock_address.hpp"
7
8
#if defined ZMQ_HAVE_VSOCK
9
10
#include <new>
11
12
#include "io_thread.hpp"
13
#include "platform.hpp"
14
#include "random.hpp"
15
#include "err.hpp"
16
#include "ip.hpp"
17
#include "address.hpp"
18
#include "session_base.hpp"
19
#include "sys/socket.h"
20
#include "linux/vm_sockets.h"
21
22
zmq::vsock_connecter_t::vsock_connecter_t (class io_thread_t *io_thread_,
23
                                           class session_base_t *session_,
24
                                           const options_t &options_,
25
                                           address_t *addr_,
26
                                           bool delayed_start_) :
27
0
    stream_connecter_base_t (
28
0
      io_thread_, session_, options_, addr_, delayed_start_),
29
0
    _connect_timer_started (false)
30
0
{
31
0
    zmq_assert (_addr->protocol == protocol_name::vsock);
32
0
}
33
34
zmq::vsock_connecter_t::~vsock_connecter_t ()
35
0
{
36
0
    zmq_assert (!_connect_timer_started);
37
0
}
38
39
void zmq::vsock_connecter_t::process_term (int linger_)
40
0
{
41
0
    if (_connect_timer_started) {
42
0
        cancel_timer (connect_timer_id);
43
0
        _connect_timer_started = false;
44
0
    }
45
46
0
    stream_connecter_base_t::process_term (linger_);
47
0
}
48
49
void zmq::vsock_connecter_t::in_event ()
50
0
{
51
    //  We are not polling for incoming data, so we are actually called
52
    //  because of error here. However, we can get error on out event as well
53
    //  on some platforms, so we'll simply handle both events in the same way.
54
0
    out_event ();
55
0
}
56
57
void zmq::vsock_connecter_t::out_event ()
58
0
{
59
0
    if (_connect_timer_started) {
60
0
        cancel_timer (connect_timer_id);
61
0
        _connect_timer_started = false;
62
0
    }
63
64
    //  TODO this is still very similar to (t)ipc_connecter_t, maybe the
65
    //  differences can be factored out
66
67
0
    rm_handle ();
68
69
0
    const fd_t fd = connect ();
70
71
0
    if (fd == retired_fd
72
0
        && ((options.reconnect_stop & ZMQ_RECONNECT_STOP_CONN_REFUSED)
73
0
            && errno == ECONNREFUSED)) {
74
0
        send_conn_failed (_session);
75
0
        close ();
76
0
        terminate ();
77
0
        return;
78
0
    }
79
80
    //  Handle the error condition by attempt to reconnect.
81
0
    if (fd == retired_fd) {
82
0
        close ();
83
0
        add_reconnect_timer ();
84
0
        return;
85
0
    }
86
87
0
    create_engine (
88
0
      fd, zmq::vsock_connecter_t::get_socket_name (fd, socket_end_local));
89
0
}
90
91
std::string
92
zmq::vsock_connecter_t::get_socket_name (zmq::fd_t fd_,
93
                                         socket_end_t socket_end_) const
94
0
{
95
0
    struct sockaddr_storage ss;
96
0
    const zmq_socklen_t sl = get_socket_address (fd_, socket_end_, &ss);
97
0
    if (sl == 0) {
98
0
        return std::string ();
99
0
    }
100
101
0
    const vsock_address_t addr (reinterpret_cast<struct sockaddr *> (&ss), sl,
102
0
                                this->get_ctx ());
103
0
    std::string address_string;
104
0
    addr.to_string (address_string);
105
0
    return address_string;
106
0
}
107
108
void zmq::vsock_connecter_t::timer_event (int id_)
109
0
{
110
0
    if (id_ == connect_timer_id) {
111
0
        _connect_timer_started = false;
112
0
        rm_handle ();
113
0
        close ();
114
0
        add_reconnect_timer ();
115
0
    } else
116
0
        stream_connecter_base_t::timer_event (id_);
117
0
}
118
119
void zmq::vsock_connecter_t::start_connecting ()
120
0
{
121
    //  Open the connecting socket.
122
0
    const int rc = open ();
123
124
    //  Connect may succeed in synchronous manner.
125
0
    if (rc == 0) {
126
0
        _handle = add_fd (_s);
127
0
        out_event ();
128
0
    }
129
130
    //  Connection establishment may be delayed. Poll for its completion.
131
0
    else if (rc == -1 && errno == EINPROGRESS) {
132
0
        _handle = add_fd (_s);
133
0
        set_pollout (_handle);
134
0
        _socket->event_connect_delayed (
135
0
          make_unconnected_connect_endpoint_pair (_endpoint), zmq_errno ());
136
137
        //  add userspace connect timeout
138
0
        add_connect_timer ();
139
0
    }
140
141
    //  Handle any other error condition by eventual reconnect.
142
0
    else {
143
0
        if (_s != retired_fd)
144
0
            close ();
145
0
        add_reconnect_timer ();
146
0
    }
147
0
}
148
149
void zmq::vsock_connecter_t::add_connect_timer ()
150
0
{
151
0
    if (options.connect_timeout > 0) {
152
0
        add_timer (options.connect_timeout, connect_timer_id);
153
0
        _connect_timer_started = true;
154
0
    }
155
0
}
156
157
int zmq::vsock_connecter_t::open ()
158
0
{
159
0
    zmq_assert (_s == retired_fd);
160
161
    //  Resolve the address
162
0
    if (_addr->resolved.vsock_addr != NULL) {
163
0
        LIBZMQ_DELETE (_addr->resolved.vsock_addr);
164
0
    }
165
166
0
    _addr->resolved.vsock_addr =
167
0
      new (std::nothrow) vsock_address_t (this->get_ctx ());
168
0
    alloc_assert (_addr->resolved.vsock_addr);
169
170
    //  Convert the textual address into address structure.
171
0
    _addr->resolved.vsock_addr->resolve (_addr->address.c_str ());
172
173
    //  Create the socket.
174
0
    _s = open_socket (AF_VSOCK, SOCK_STREAM, 0);
175
176
0
    if (_s == retired_fd) {
177
        //  TODO we should emit some event in this case!
178
179
0
        LIBZMQ_DELETE (_addr->resolved.vsock_addr);
180
0
        return -1;
181
0
    }
182
183
0
    zmq_assert (_addr->resolved.vsock_addr != NULL);
184
185
    // Set the socket to non-blocking mode so that we get async connect().
186
0
    unblock_socket (_s);
187
188
0
    const vsock_address_t *const vsock_addr = _addr->resolved.vsock_addr;
189
190
    //  Connect to the remote peer.
191
0
    int rc = ::connect (_s, vsock_addr->addr (), vsock_addr->addrlen ());
192
    //  Connect was successful immediately.
193
0
    if (rc == 0) {
194
0
        return 0;
195
0
    }
196
197
0
    if (errno == EINTR)
198
0
        errno = EINPROGRESS;
199
200
0
    return -1;
201
0
}
202
203
zmq::fd_t zmq::vsock_connecter_t::connect ()
204
0
{
205
    //  Async connect has finished. Check whether an error occurred
206
0
    int err = 0;
207
0
    socklen_t len = sizeof err;
208
209
0
    const int rc = getsockopt (_s, SOL_SOCKET, SO_ERROR,
210
0
                               reinterpret_cast<char *> (&err), &len);
211
212
    //  Assert if the error was caused by 0MQ bug.
213
    //  Networking problems are OK. No need to assert.
214
    //  Following code should handle both Berkeley-derived socket
215
    //  implementations and Solaris.
216
0
    if (rc == -1)
217
0
        err = errno;
218
0
    if (err != 0) {
219
0
        errno = err;
220
0
        errno_assert (errno != ENOPROTOOPT && errno != ENOTSOCK
221
0
                      && errno != ENOBUFS);
222
0
        return retired_fd;
223
0
    }
224
225
    //  Return the newly connected socket.
226
0
    const fd_t result = _s;
227
0
    _s = retired_fd;
228
0
    return result;
229
0
}
230
231
#endif