test_ctx_options.cpp 9.37 KB
Newer Older
Pieter Hintjens's avatar
Pieter Hintjens committed
1
/*
2
    Copyright (c) 2007-2016 Contributors as noted in the AUTHORS file
Pieter Hintjens's avatar
Pieter Hintjens committed
3

4
    This file is part of libzmq, the ZeroMQ core engine in C++.
Pieter Hintjens's avatar
Pieter Hintjens committed
5

6 7 8
    libzmq is free software; you can redistribute it and/or modify it under
    the terms of the GNU Lesser General Public License (LGPL) as published
    by the Free Software Foundation; either version 3 of the License, or
Pieter Hintjens's avatar
Pieter Hintjens committed
9 10
    (at your option) any later version.

11 12 13 14 15 16 17 18 19 20 21 22 23 24
    As a special exception, the Contributors give you permission to link
    this library with independent modules to produce an executable,
    regardless of the license terms of these independent modules, and to
    copy and distribute the resulting executable under terms of your choice,
    provided that you also meet, for each linked independent module, the
    terms and conditions of the license of that module. An independent
    module is a module which is not derived from or based on this library.
    If you modify this library, you must extend this exception to your
    version of the library.

    libzmq is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
    License for more details.
Pieter Hintjens's avatar
Pieter Hintjens committed
25 26 27 28 29

    You should have received a copy of the GNU Lesser General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

30
#include <limits>
31
#include "testutil.hpp"
Pieter Hintjens's avatar
Pieter Hintjens committed
32

33
#define WAIT_FOR_BACKGROUND_THREAD_INSPECTION (0)
34 35 36 37

#ifdef ZMQ_HAVE_LINUX
#include <sys/time.h>
#include <sys/resource.h>
38
#include <unistd.h> // for sleep()
39

40 41
#define TEST_POLICY                                                            \
    (SCHED_OTHER) // NOTE: SCHED_OTHER is the default Linux scheduler
42

43
bool is_allowed_to_raise_priority ()
44 45 46 47 48 49 50
{
    // NOTE1: if setrlimit() fails with EPERM, this means that current user has not enough permissions.
    // NOTE2: even for privileged users (e.g., root) getrlimit() would usually return 0 as nice limit; the only way to
    //        discover if the user is able to increase the nice value is to actually try to change the rlimit:
    struct rlimit rlim;
    rlim.rlim_cur = 40;
    rlim.rlim_max = 40;
51
    if (setrlimit (RLIMIT_NICE, &rlim) == 0) {
52 53
        // rlim_cur == 40 means that this process is allowed to set a nice value of -20
        if (WAIT_FOR_BACKGROUND_THREAD_INSPECTION)
54 55
            printf ("This process has enough permissions to raise ZMQ "
                    "background thread priority!\n");
56 57 58 59
        return true;
    }

    if (WAIT_FOR_BACKGROUND_THREAD_INSPECTION)
60 61
        printf ("This process has NOT enough permissions to raise ZMQ "
                "background thread priority.\n");
62 63 64 65 66
    return false;
}

#else

67
#define TEST_POLICY (0)
68

69
bool is_allowed_to_raise_priority ()
70 71 72 73 74 75 76
{
    return false;
}

#endif


77
void test_ctx_thread_opts (void *ctx_)
78 79 80 81
{
    int rc;

    // verify that setting negative values (e.g., default values) fail:
82
    rc =
83
      zmq_ctx_set (ctx_, ZMQ_THREAD_SCHED_POLICY, ZMQ_THREAD_SCHED_POLICY_DFLT);
84
    assert (rc == -1 && errno == EINVAL);
85
    rc = zmq_ctx_set (ctx_, ZMQ_THREAD_PRIORITY, ZMQ_THREAD_PRIORITY_DFLT);
86 87 88 89 90 91 92
    assert (rc == -1 && errno == EINVAL);


    // test scheduling policy:

    // set context options that alter the background thread CPU scheduling/affinity settings;
    // as of ZMQ 4.2.3 this has an effect only on POSIX systems (nothing happens on Windows, but still it should return success):
93
    rc = zmq_ctx_set (ctx_, ZMQ_THREAD_SCHED_POLICY, TEST_POLICY);
94
    assert (rc == 0);
95 96
    rc = zmq_ctx_get (ctx_, ZMQ_THREAD_SCHED_POLICY);
    assert (rc == TEST_POLICY);
97 98 99 100 101 102 103 104 105 106 107 108 109


    // test priority:

    // in theory SCHED_OTHER supports only the static priority 0 but quoting the docs
    //     http://man7.org/linux/man-pages/man7/sched.7.html
    // "The thread to run is chosen from the static priority 0 list based on
    // a dynamic priority that is determined only inside this list.  The
    // dynamic priority is based on the nice value [...]
    // The nice value can be modified using nice(2), setpriority(2), or sched_setattr(2)."
    // ZMQ will internally use nice(2) to set the nice value when using SCHED_OTHER.
    // However changing the nice value of a process requires appropriate permissions...
    // check that the current effective user is able to do that:
110 111
    if (is_allowed_to_raise_priority ()) {
        rc = zmq_ctx_set (
112
          ctx_, ZMQ_THREAD_PRIORITY,
113
          1 /* any positive value different than the default will be ok */);
114 115 116 117
        assert (rc == 0);
    }


118
#ifdef ZMQ_THREAD_AFFINITY_CPU_ADD
119 120
    // test affinity:

121 122 123
    // this should result in background threads being placed only on the
    // first CPU available on this system; try experimenting with other values
    // (e.g., 5 to use CPU index 5) and use "top -H" or "taskset -pc" to see the result
124

125 126 127
    int cpus_add[] = {0, 1};
    for (unsigned int idx = 0; idx < sizeof (cpus_add) / sizeof (cpus_add[0]);
         idx++) {
128
        rc = zmq_ctx_set (ctx_, ZMQ_THREAD_AFFINITY_CPU_ADD, cpus_add[idx]);
129 130 131 132
        assert (rc == 0);
    }

    // you can also remove CPUs from list of affinities:
133 134 135 136
    int cpus_remove[] = {1};
    for (unsigned int idx = 0;
         idx < sizeof (cpus_remove) / sizeof (cpus_remove[0]); idx++) {
        rc =
137
          zmq_ctx_set (ctx_, ZMQ_THREAD_AFFINITY_CPU_REMOVE, cpus_remove[idx]);
138 139
        assert (rc == 0);
    }
140
#endif
f18m's avatar
f18m committed
141 142 143 144 145


#ifdef ZMQ_THREAD_NAME_PREFIX
    // test thread name prefix:

146
    rc = zmq_ctx_set (ctx_, ZMQ_THREAD_NAME_PREFIX, 1234);
f18m's avatar
f18m committed
147
    assert (rc == 0);
148 149
    rc = zmq_ctx_get (ctx_, ZMQ_THREAD_NAME_PREFIX);
    assert (rc == 1234);
f18m's avatar
f18m committed
150
#endif
151 152
}

153
void test_ctx_zero_copy (void *ctx_)
154 155 156 157
{
#ifdef ZMQ_ZERO_COPY_RECV
    int zero_copy;
    // Default value is 1.
158
    zero_copy = zmq_ctx_get (ctx_, ZMQ_ZERO_COPY_RECV);
159 160 161
    assert (zero_copy == 1);

    // Test we can set it to 0.
162 163
    assert (0 == zmq_ctx_set (ctx_, ZMQ_ZERO_COPY_RECV, 0));
    zero_copy = zmq_ctx_get (ctx_, ZMQ_ZERO_COPY_RECV);
164 165 166 167
    assert (zero_copy == 0);

    // Create a TCP socket pair using the context and test that messages can be
    // received. Note that inproc sockets cannot be used for this test.
168
    void *pull = zmq_socket (ctx_, ZMQ_PULL);
169 170
    assert (0 == zmq_bind (pull, "tcp://127.0.0.1:*"));

171
    void *push = zmq_socket (ctx_, ZMQ_PUSH);
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    size_t endpoint_len = MAX_SOCKET_STRING;
    char endpoint[MAX_SOCKET_STRING];
    assert (
      0 == zmq_getsockopt (pull, ZMQ_LAST_ENDPOINT, endpoint, &endpoint_len));
    assert (0 == zmq_connect (push, endpoint));

    const char *small_str = "abcd";
    const char *large_str =
      "01234567890123456789012345678901234567890123456789";

    assert (4 == zmq_send (push, (void *) small_str, 4, 0));
    assert (40 == zmq_send (push, (void *) large_str, 40, 0));

    zmq_msg_t small_msg, large_msg;
    zmq_msg_init (&small_msg);
    zmq_msg_init (&large_msg);
    assert (4 == zmq_msg_recv (&small_msg, pull, 0));
    assert (40 == zmq_msg_recv (&large_msg, pull, 0));
    assert (!strncmp (small_str, (const char *) zmq_msg_data (&small_msg), 4));
    assert (!strncmp (large_str, (const char *) zmq_msg_data (&large_msg), 40));

    // Clean up.
    assert (0 == zmq_close (push));
    assert (0 == zmq_close (pull));
    assert (0 == zmq_msg_close (&small_msg));
    assert (0 == zmq_msg_close (&large_msg));
198 199
    assert (0 == zmq_ctx_set (ctx_, ZMQ_ZERO_COPY_RECV, 1));
    zero_copy = zmq_ctx_get (ctx_, ZMQ_ZERO_COPY_RECV);
200 201 202
    assert (zero_copy == 1);
#endif
}
203

Pieter Hintjens's avatar
Pieter Hintjens committed
204 205
int main (void)
{
206
    setup_test_environment ();
Pieter Hintjens's avatar
Pieter Hintjens committed
207
    int rc;
208

Pieter Hintjens's avatar
Pieter Hintjens committed
209 210 211
    //  Set up our context and sockets
    void *ctx = zmq_ctx_new ();
    assert (ctx);
212

Pieter Hintjens's avatar
Pieter Hintjens committed
213
    assert (zmq_ctx_get (ctx, ZMQ_MAX_SOCKETS) == ZMQ_MAX_SOCKETS_DFLT);
214
#if defined(ZMQ_USE_SELECT)
215
    assert (zmq_ctx_get (ctx, ZMQ_SOCKET_LIMIT) == FD_SETSIZE - 1);
216 217
#elif defined(ZMQ_USE_POLL) || defined(ZMQ_USE_EPOLL)                          \
  || defined(ZMQ_USE_DEVPOLL) || defined(ZMQ_USE_KQUEUE)
218
    assert (zmq_ctx_get (ctx, ZMQ_SOCKET_LIMIT) == 65535);
219
#endif
Pieter Hintjens's avatar
Pieter Hintjens committed
220 221
    assert (zmq_ctx_get (ctx, ZMQ_IO_THREADS) == ZMQ_IO_THREADS_DFLT);
    assert (zmq_ctx_get (ctx, ZMQ_IPV6) == 0);
222
#if defined(ZMQ_MSG_T_SIZE)
223
    assert (zmq_ctx_get (ctx, ZMQ_MSG_T_SIZE) == sizeof (zmq_msg_t));
224
#endif
225

Pieter Hintjens's avatar
Pieter Hintjens committed
226
    rc = zmq_ctx_set (ctx, ZMQ_IPV6, true);
Richard Newton's avatar
Richard Newton committed
227
    assert (zmq_ctx_get (ctx, ZMQ_IPV6) == 1);
228

229
    test_ctx_thread_opts (ctx);
230
    test_ctx_zero_copy (ctx);
231

Pieter Hintjens's avatar
Pieter Hintjens committed
232
    void *router = zmq_socket (ctx, ZMQ_ROUTER);
233
    int value;
Pieter Hintjens's avatar
Pieter Hintjens committed
234
    size_t optsize = sizeof (int);
235
    rc = zmq_getsockopt (router, ZMQ_IPV6, &value, &optsize);
Pieter Hintjens's avatar
Pieter Hintjens committed
236
    assert (rc == 0);
237 238 239 240
    assert (value == 1);
    rc = zmq_getsockopt (router, ZMQ_LINGER, &value, &optsize);
    assert (rc == 0);
    assert (value == -1);
Pieter Hintjens's avatar
Pieter Hintjens committed
241 242
    rc = zmq_close (router);
    assert (rc == 0);
243 244 245 246

#if WAIT_FOR_BACKGROUND_THREAD_INSPECTION
    // this is useful when you want to use an external tool (like top or taskset) to view
    // properties of the background threads
247 248 249 250
    printf ("Sleeping for 100sec. You can now use 'top -H -p $(pgrep -f "
            "test_ctx_options)' and 'taskset -pc <ZMQ background thread PID>' "
            "to view ZMQ background thread properties.\n");
    sleep (100);
251 252
#endif

253 254 255 256 257 258 259 260 261
    rc = zmq_ctx_set (ctx, ZMQ_BLOCKY, false);
    assert (zmq_ctx_get (ctx, ZMQ_BLOCKY) == 0);
    router = zmq_socket (ctx, ZMQ_ROUTER);
    rc = zmq_getsockopt (router, ZMQ_LINGER, &value, &optsize);
    assert (rc == 0);
    assert (value == 0);
    rc = zmq_close (router);
    assert (rc == 0);

Pieter Hintjens's avatar
Pieter Hintjens committed
262 263 264 265 266
    rc = zmq_ctx_term (ctx);
    assert (rc == 0);

    return 0;
}