liblttng-ust-comm/lttng-ust-comm.c

   1 /*
   2  * SPDX-License-Identifier: LGPL-2.1-only
   3  *
   4  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
   5  * Copyright (C) 2011-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   6  */
   7
   8 #include <limits.h>
   9 #include <stdint.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <string.h>
  13 #include <sys/socket.h>
  14 #include <sys/stat.h>
  15 #include <sys/types.h>
  16 #include <sys/un.h>
  17 #include <unistd.h>
  18 #include <assert.h>
  19 #include <errno.h>
  20 #include <fcntl.h>
  21
  22 #include <lttng/ust-ctl.h>
  23 #include <ust-comm.h>
  24 #include <ust-fd.h>
  25 #include <ust-helper.h>
  26 #include <lttng/ust-error.h>
  27 #include <ust-dynamic-type.h>
  28 #include <usterr-signal-safe.h>
  29
  30 #include "../liblttng-ust/ust-events-internal.h"
  31 #include "../liblttng-ust/compat.h"
  32
  33 #define USTCOMM_CODE_OFFSET(code)       \
  34         (code == LTTNG_UST_OK ? 0 : (code - LTTNG_UST_ERR + 1))
  35
  36 #define USTCOMM_MAX_SEND_FDS    4
  37
  38 static
  39 ssize_t count_fields_recursive(size_t nr_fields,
  40                 const struct lttng_event_field *lttng_fields);
  41 static
  42 int serialize_one_field(struct lttng_session *session,
  43                 struct ustctl_field *fields, size_t *iter_output,
  44                 const struct lttng_event_field *lf);
  45 static
  46 int serialize_fields(struct lttng_session *session,
  47                 struct ustctl_field *ustctl_fields,
  48                 size_t *iter_output, size_t nr_lttng_fields,
  49                 const struct lttng_event_field *lttng_fields);
  50
  51 /*
  52  * Human readable error message.
  53  */
  54 static const char *ustcomm_readable_code[] = {
  55         [ USTCOMM_CODE_OFFSET(LTTNG_UST_OK) ] = "Success",
  56         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR) ] = "Unknown error",
  57         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOENT) ] = "No entry",
  58         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXIST) ] = "Object already exists",
  59         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL) ] = "Invalid argument",
  60         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PERM) ] = "Permission denied",
  61         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOSYS) ] = "Not implemented",
  62         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXITING) ] = "Process is exiting",
  63
  64         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_MAGIC) ] = "Invalid magic number",
  65         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_SOCKET_TYPE) ] = "Invalid socket type",
  66         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_UNSUP_MAJOR) ] = "Unsupported major version",
  67         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PEERCRED) ] = "Cannot get unix socket peer credentials",
  68         [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PEERCRED_PID) ] = "Peer credentials PID is invalid. Socket appears to belong to a distinct, non-nested pid namespace.",
  69 };
  70
  71 /*
  72  * lttng_ust_strerror
  73  *
  74  * Receives positive error value.
  75  * Return ptr to string representing a human readable
  76  * error code from the ustcomm_return_code enum.
  77  */
  78 const char *lttng_ust_strerror(int code)
  79 {
  80         if (code == LTTNG_UST_OK)
  81                 return ustcomm_readable_code[USTCOMM_CODE_OFFSET(code)];
  82         if (code < LTTNG_UST_ERR)
  83                 return strerror(code);
  84         if (code >= LTTNG_UST_ERR_NR)
  85                 code = LTTNG_UST_ERR;
  86         return ustcomm_readable_code[USTCOMM_CODE_OFFSET(code)];
  87 }
  88
  89 /*
  90  * ustcomm_connect_unix_sock
  91  *
  92  * Connect to unix socket using the path name.
  93  *
  94  * Caller handles FD tracker.
  95  */
  96 int ustcomm_connect_unix_sock(const char *pathname, long timeout)
  97 {
  98         struct sockaddr_un sun;
  99         int fd, ret;
 100
 101         /*
 102          * libust threads require the close-on-exec flag for all
 103          * resources so it does not leak file descriptors upon exec.
 104          * SOCK_CLOEXEC is not used since it is linux specific.
 105          */
 106         fd = socket(PF_UNIX, SOCK_STREAM, 0);
 107         if (fd < 0) {
 108                 PERROR("socket");
 109                 ret = -errno;
 110                 goto error;
 111         }
 112         if (timeout >= 0) {
 113                 /* Give at least 10ms. */
 114                 if (timeout < 10)
 115                         timeout = 10;
 116                 ret = ustcomm_setsockopt_snd_timeout(fd, timeout);
 117                 if (ret < 0) {
 118                         WARN("Error setting connect socket send timeout");
 119                 }
 120         }
 121         ret = fcntl(fd, F_SETFD, FD_CLOEXEC);
 122         if (ret < 0) {
 123                 PERROR("fcntl");
 124                 ret = -errno;
 125                 goto error_fcntl;
 126         }
 127
 128         memset(&sun, 0, sizeof(sun));
 129         sun.sun_family = AF_UNIX;
 130         strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
 131         sun.sun_path[sizeof(sun.sun_path) - 1] = '\0';
 132
 133         ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
 134         if (ret < 0) {
 135                 /*
 136                  * Don't print message on connect ENOENT error, because
 137                  * connect is used in normal execution to detect if
 138                  * sessiond is alive. ENOENT is when the unix socket
 139                  * file does not exist, and ECONNREFUSED is when the
 140                  * file exists but no sessiond is listening.
 141                  */
 142                 if (errno != ECONNREFUSED && errno != ECONNRESET
 143                                 && errno != ENOENT && errno != EACCES)
 144                         PERROR("connect");
 145                 ret = -errno;
 146                 if (ret == -ECONNREFUSED || ret == -ECONNRESET)
 147                         ret = -EPIPE;
 148                 goto error_connect;
 149         }
 150
 151         return fd;
 152
 153 error_connect:
 154 error_fcntl:
 155         {
 156                 int closeret;
 157
 158                 closeret = close(fd);
 159                 if (closeret)
 160                         PERROR("close");
 161         }
 162 error:
 163         return ret;
 164 }
 165
 166 /*
 167  * ustcomm_accept_unix_sock
 168  *
 169  * Do an accept(2) on the sock and return the
 170  * new file descriptor. The socket MUST be bind(2) before.
 171  */
 172 int ustcomm_accept_unix_sock(int sock)
 173 {
 174         int new_fd;
 175         struct sockaddr_un sun;
 176         socklen_t len = 0;
 177
 178         /* Blocking call */
 179         new_fd = accept(sock, (struct sockaddr *) &sun, &len);
 180         if (new_fd < 0) {
 181                 if (errno != ECONNABORTED)
 182                         PERROR("accept");
 183                 new_fd = -errno;
 184                 if (new_fd == -ECONNABORTED)
 185                         new_fd = -EPIPE;
 186         }
 187         return new_fd;
 188 }
 189
 190 /*
 191  * ustcomm_create_unix_sock
 192  *
 193  * Creates a AF_UNIX local socket using pathname
 194  * bind the socket upon creation and return the fd.
 195  */
 196 int ustcomm_create_unix_sock(const char *pathname)
 197 {
 198         struct sockaddr_un sun;
 199         int fd, ret;
 200
 201         /* Create server socket */
 202         if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
 203                 PERROR("socket");
 204                 ret = -errno;
 205                 goto error;
 206         }
 207
 208         memset(&sun, 0, sizeof(sun));
 209         sun.sun_family = AF_UNIX;
 210         strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
 211         sun.sun_path[sizeof(sun.sun_path) - 1] = '\0';
 212
 213         /* Unlink the old file if present */
 214         (void) unlink(pathname);
 215         ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
 216         if (ret < 0) {
 217                 PERROR("bind");
 218                 ret = -errno;
 219                 goto error_close;
 220         }
 221
 222         return fd;
 223
 224 error_close:
 225         {
 226                 int closeret;
 227
 228                 closeret = close(fd);
 229                 if (closeret) {
 230                         PERROR("close");
 231                 }
 232         }
 233 error:
 234         return ret;
 235 }
 236
 237 /*
 238  * ustcomm_listen_unix_sock
 239  *
 240  * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN.
 241  */
 242 int ustcomm_listen_unix_sock(int sock)
 243 {
 244         int ret;
 245
 246         ret = listen(sock, LTTNG_UST_COMM_MAX_LISTEN);
 247         if (ret < 0) {
 248                 ret = -errno;
 249                 PERROR("listen");
 250         }
 251
 252         return ret;
 253 }
 254
 255 /*
 256  * ustcomm_close_unix_sock
 257  *
 258  * Shutdown cleanly a unix socket.
 259  *
 260  * Handles fd tracker internally.
 261  */
 262 int ustcomm_close_unix_sock(int sock)
 263 {
 264         int ret;
 265
 266         lttng_ust_lock_fd_tracker();
 267         ret = close(sock);
 268         if (!ret) {
 269                 lttng_ust_delete_fd_from_tracker(sock);
 270         } else {
 271                 PERROR("close");
 272                 ret = -errno;
 273         }
 274         lttng_ust_unlock_fd_tracker();
 275
 276         return ret;
 277 }
 278
 279 /*
 280  * ustcomm_recv_unix_sock
 281  *
 282  * Receive data of size len in put that data into
 283  * the buf param. Using recvmsg API.
 284  * Return the size of received data.
 285  * Return 0 on orderly shutdown.
 286  */
 287 ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
 288 {
 289         struct msghdr msg;
 290         struct iovec iov[1];
 291         ssize_t ret = -1;
 292         size_t len_last;
 293
 294         memset(&msg, 0, sizeof(msg));
 295
 296         iov[0].iov_base = buf;
 297         iov[0].iov_len = len;
 298         msg.msg_iov = iov;
 299         msg.msg_iovlen = 1;
 300
 301         do {
 302                 len_last = iov[0].iov_len;
 303                 ret = recvmsg(sock, &msg, 0);
 304                 if (ret > 0) {
 305                         iov[0].iov_base += ret;
 306                         iov[0].iov_len -= ret;
 307                         assert(ret <= len_last);
 308                 }
 309         } while ((ret > 0 && ret < len_last) || (ret < 0 && errno == EINTR));
 310
 311         if (ret < 0) {
 312                 int shutret;
 313
 314                 if (errno != EPIPE && errno != ECONNRESET && errno != ECONNREFUSED)
 315                         PERROR("recvmsg");
 316                 ret = -errno;
 317                 if (ret == -ECONNRESET || ret == -ECONNREFUSED)
 318                         ret = -EPIPE;
 319
 320                 shutret = shutdown(sock, SHUT_RDWR);
 321                 if (shutret)
 322                         ERR("Socket shutdown error");
 323         } else if (ret > 0) {
 324                 ret = len;
 325         }
 326         /* ret = 0 means an orderly shutdown. */
 327
 328         return ret;
 329 }
 330
 331 /*
 332  * ustcomm_send_unix_sock
 333  *
 334  * Send buf data of size len. Using sendmsg API.
 335  * Return the size of sent data.
 336  */
 337 ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len)
 338 {
 339         struct msghdr msg;
 340         struct iovec iov[1];
 341         ssize_t ret;
 342
 343         memset(&msg, 0, sizeof(msg));
 344
 345         iov[0].iov_base = (void *) buf;
 346         iov[0].iov_len = len;
 347         msg.msg_iov = iov;
 348         msg.msg_iovlen = 1;
 349
 350         /*
 351          * Using the MSG_NOSIGNAL when sending data from sessiond to
 352          * libust, so libust does not receive an unhandled SIGPIPE or
 353          * SIGURG. The sessiond receiver side can be made more resilient
 354          * by ignoring SIGPIPE, but we don't have this luxury on the
 355          * libust side.
 356          */
 357         do {
 358                 ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
 359         } while (ret < 0 && errno == EINTR);
 360
 361         if (ret < 0) {
 362                 int shutret;
 363
 364                 if (errno != EPIPE && errno != ECONNRESET)
 365                         PERROR("sendmsg");
 366                 ret = -errno;
 367                 if (ret == -ECONNRESET)
 368                         ret = -EPIPE;
 369
 370                 shutret = shutdown(sock, SHUT_RDWR);
 371                 if (shutret)
 372                         ERR("Socket shutdown error");
 373         }
 374
 375         return ret;
 376 }
 377
 378 /*
 379  * Send a message accompanied by fd(s) over a unix socket.
 380  *
 381  * Returns the size of data sent, or negative error value.
 382  */
 383 ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
 384 {
 385         struct msghdr msg;
 386         struct cmsghdr *cmptr;
 387         struct iovec iov[1];
 388         ssize_t ret = -1;
 389         unsigned int sizeof_fds = nb_fd * sizeof(int);
 390         char tmp[CMSG_SPACE(sizeof_fds)];
 391         char dummy = 0;
 392
 393         memset(&msg, 0, sizeof(msg));
 394         memset(tmp, 0, CMSG_SPACE(sizeof_fds) * sizeof(char));
 395
 396         if (nb_fd > USTCOMM_MAX_SEND_FDS)
 397                 return -EINVAL;
 398
 399         msg.msg_control = (caddr_t)tmp;
 400         msg.msg_controllen = CMSG_LEN(sizeof_fds);
 401
 402         cmptr = CMSG_FIRSTHDR(&msg);
 403         if (!cmptr)
 404                 return -EINVAL;
 405         cmptr->cmsg_level = SOL_SOCKET;
 406         cmptr->cmsg_type = SCM_RIGHTS;
 407         cmptr->cmsg_len = CMSG_LEN(sizeof_fds);
 408         memcpy(CMSG_DATA(cmptr), fds, sizeof_fds);
 409         /* Sum of the length of all control messages in the buffer: */
 410         msg.msg_controllen = cmptr->cmsg_len;
 411
 412         iov[0].iov_base = &dummy;
 413         iov[0].iov_len = 1;
 414         msg.msg_iov = iov;
 415         msg.msg_iovlen = 1;
 416
 417         do {
 418                 ret = sendmsg(sock, &msg, MSG_NOSIGNAL);
 419         } while (ret < 0 && errno == EINTR);
 420         if (ret < 0) {
 421                 /*
 422                  * We consider EPIPE and ECONNRESET as expected.
 423                  */
 424                 if (errno != EPIPE && errno != ECONNRESET) {
 425                         PERROR("sendmsg");
 426                 }
 427                 ret = -errno;
 428                 if (ret == -ECONNRESET)
 429                         ret = -EPIPE;
 430         }
 431         return ret;
 432 }
 433
 434 /*
 435  * Recv a message accompanied by fd(s) from a unix socket.
 436  *
 437  * Expect at most "nb_fd" file descriptors. Returns the number of fd
 438  * actually received in nb_fd.
 439  * Returns -EPIPE on orderly shutdown.
 440  */
 441 ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
 442 {
 443         struct iovec iov[1];
 444         ssize_t ret = 0;
 445         struct cmsghdr *cmsg;
 446         size_t sizeof_fds = nb_fd * sizeof(int);
 447         char recv_fd[CMSG_SPACE(sizeof_fds)];
 448         struct msghdr msg;
 449         char dummy;
 450         int i;
 451
 452         memset(&msg, 0, sizeof(msg));
 453
 454         /* Prepare to receive the structures */
 455         iov[0].iov_base = &dummy;
 456         iov[0].iov_len = 1;
 457         msg.msg_iov = iov;
 458         msg.msg_iovlen = 1;
 459         msg.msg_control = recv_fd;
 460         msg.msg_controllen = sizeof(recv_fd);
 461
 462         do {
 463                 ret = recvmsg(sock, &msg, 0);
 464         } while (ret < 0 && errno == EINTR);
 465         if (ret < 0) {
 466                 if (errno != EPIPE && errno != ECONNRESET) {
 467                         PERROR("recvmsg fds");
 468                 }
 469                 ret = -errno;
 470                 if (ret == -ECONNRESET)
 471                         ret = -EPIPE;
 472                 goto end;
 473         }
 474         if (ret == 0) {
 475                 /* orderly shutdown */
 476                 ret = -EPIPE;
 477                 goto end;
 478         }
 479         if (ret != 1) {
 480                 ERR("Error: Received %zd bytes, expected %d\n",
 481                                 ret, 1);
 482                 goto end;
 483         }
 484         if (msg.msg_flags & MSG_CTRUNC) {
 485                 ERR("Error: Control message truncated.\n");
 486                 ret = -1;
 487                 goto end;
 488         }
 489         cmsg = CMSG_FIRSTHDR(&msg);
 490         if (!cmsg) {
 491                 ERR("Error: Invalid control message header\n");
 492                 ret = -1;
 493                 goto end;
 494         }
 495         if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) {
 496                 ERR("Didn't received any fd\n");
 497                 ret = -1;
 498                 goto end;
 499         }
 500         if (cmsg->cmsg_len != CMSG_LEN(sizeof_fds)) {
 501                 ERR("Error: Received %zu bytes of ancillary data, expected %zu\n",
 502                                 (size_t) cmsg->cmsg_len, (size_t) CMSG_LEN(sizeof_fds));
 503                 ret = -1;
 504                 goto end;
 505         }
 506
 507         memcpy(fds, CMSG_DATA(cmsg), sizeof_fds);
 508
 509         /* Set FD_CLOEXEC */
 510         for (i = 0; i < nb_fd; i++) {
 511                 ret = fcntl(fds[i], F_SETFD, FD_CLOEXEC);
 512                 if (ret < 0) {
 513                         PERROR("fcntl failed to set FD_CLOEXEC on fd %d",
 514                                fds[i]);
 515                 }
 516         }
 517
 518         ret = nb_fd;
 519 end:
 520         return ret;
 521 }
 522
 523 int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
 524 {
 525         ssize_t len;
 526
 527         len = ustcomm_send_unix_sock(sock, lum, sizeof(*lum));
 528         switch (len) {
 529         case sizeof(*lum):
 530                 break;
 531         default:
 532                 if (len < 0) {
 533                         return len;
 534                 } else {
 535                         ERR("incorrect message size: %zd\n", len);
 536                         return -EINVAL;
 537                 }
 538         }
 539         return 0;
 540 }
 541
 542 int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
 543                           uint32_t expected_handle, uint32_t expected_cmd)
 544 {
 545         ssize_t len;
 546
 547         memset(lur, 0, sizeof(*lur));
 548         len = ustcomm_recv_unix_sock(sock, lur, sizeof(*lur));
 549         switch (len) {
 550         case 0: /* orderly shutdown */
 551                 return -EPIPE;
 552         case sizeof(*lur):
 553         {
 554                 int err = 0;
 555
 556                 if (lur->handle != expected_handle) {
 557                         ERR("Unexpected result message handle: "
 558                                 "expected: %u vs received: %u\n",
 559                                 expected_handle, lur->handle);
 560                         err = 1;
 561                 }
 562                 if (lur->cmd != expected_cmd) {
 563                         ERR("Unexpected result message command "
 564                                 "expected: %u vs received: %u\n",
 565                                 expected_cmd, lur->cmd);
 566                         err = 1;
 567                 }
 568                 if (err) {
 569                         return -EINVAL;
 570                 } else {
 571                         return lur->ret_code;
 572                 }
 573         }
 574         default:
 575                 if (len >= 0) {
 576                         ERR("incorrect message size: %zd\n", len);
 577                 }
 578                 return len;
 579         }
 580 }
 581
 582 int ustcomm_send_app_cmd(int sock,
 583                         struct ustcomm_ust_msg *lum,
 584                         struct ustcomm_ust_reply *lur)
 585 {
 586         int ret;
 587
 588         ret = ustcomm_send_app_msg(sock, lum);
 589         if (ret)
 590                 return ret;
 591         ret = ustcomm_recv_app_reply(sock, lur, lum->handle, lum->cmd);
 592         if (ret > 0)
 593                 return -EIO;
 594         return ret;
 595 }
 596
 597 /*
 598  * chan_data is allocated internally if this function returns the
 599  * expected var_len.
 600  */
 601 ssize_t ustcomm_recv_channel_from_sessiond(int sock,
 602                 void **_chan_data, uint64_t var_len,
 603                 int *_wakeup_fd)
 604 {
 605         void *chan_data;
 606         ssize_t len, nr_fd;
 607         int wakeup_fd, ret;
 608
 609         if (var_len > LTTNG_UST_CHANNEL_DATA_MAX_LEN) {
 610                 len = -EINVAL;
 611                 goto error_check;
 612         }
 613         /* Receive variable length data */
 614         chan_data = zmalloc(var_len);
 615         if (!chan_data) {
 616                 len = -ENOMEM;
 617                 goto error_alloc;
 618         }
 619         len = ustcomm_recv_unix_sock(sock, chan_data, var_len);
 620         if (len != var_len) {
 621                 goto error_recv;
 622         }
 623         /* recv wakeup fd */
 624         lttng_ust_lock_fd_tracker();
 625         nr_fd = ustcomm_recv_fds_unix_sock(sock, &wakeup_fd, 1);
 626         if (nr_fd <= 0) {
 627                 lttng_ust_unlock_fd_tracker();
 628                 if (nr_fd < 0) {
 629                         len = nr_fd;
 630                         goto error_recv;
 631                 } else {
 632                         len = -EIO;
 633                         goto error_recv;
 634                 }
 635         }
 636
 637         ret = lttng_ust_add_fd_to_tracker(wakeup_fd);
 638         if (ret < 0) {
 639                 ret = close(wakeup_fd);
 640                 if (ret) {
 641                         PERROR("close on wakeup_fd");
 642                 }
 643                 len = -EIO;
 644                 lttng_ust_unlock_fd_tracker();
 645                 goto error_recv;
 646         }
 647
 648         *_wakeup_fd = ret;
 649         lttng_ust_unlock_fd_tracker();
 650
 651         *_chan_data = chan_data;
 652         return len;
 653
 654 error_recv:
 655         free(chan_data);
 656 error_alloc:
 657 error_check:
 658         return len;
 659 }
 660
 661 ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock,
 662                 int *_event_notifier_notif_fd)
 663 {
 664         ssize_t nr_fd;
 665         int event_notifier_notif_fd, ret;
 666
 667         /* Receive event_notifier notification fd */
 668         lttng_ust_lock_fd_tracker();
 669         nr_fd = ustcomm_recv_fds_unix_sock(sock, &event_notifier_notif_fd, 1);
 670         if (nr_fd <= 0) {
 671                 lttng_ust_unlock_fd_tracker();
 672                 if (nr_fd < 0) {
 673                         ret = nr_fd;
 674                         goto error;
 675                 } else {
 676                         ret = -EIO;
 677                         goto error;
 678                 }
 679         }
 680
 681         ret = lttng_ust_add_fd_to_tracker(event_notifier_notif_fd);
 682         if (ret < 0) {
 683                 ret = close(event_notifier_notif_fd);
 684                 if (ret) {
 685                         PERROR("close on event_notifier notif fd");
 686                 }
 687                 ret = -EIO;
 688                 lttng_ust_unlock_fd_tracker();
 689                 goto error;
 690         }
 691
 692         *_event_notifier_notif_fd = ret;
 693         lttng_ust_unlock_fd_tracker();
 694
 695         ret = nr_fd;
 696
 697 error:
 698         return ret;
 699 }
 700
 701 int ustcomm_recv_stream_from_sessiond(int sock,
 702                 uint64_t *memory_map_size,
 703                 int *shm_fd, int *wakeup_fd)
 704 {
 705         ssize_t len;
 706         int ret;
 707         int fds[2];
 708
 709         /* recv shm fd and wakeup fd */
 710         lttng_ust_lock_fd_tracker();
 711         len = ustcomm_recv_fds_unix_sock(sock, fds, 2);
 712         if (len <= 0) {
 713                 lttng_ust_unlock_fd_tracker();
 714                 if (len < 0) {
 715                         ret = len;
 716                         goto error;
 717                 } else {
 718                         ret = -EIO;
 719                         goto error;
 720                 }
 721         }
 722
 723         ret = lttng_ust_add_fd_to_tracker(fds[0]);
 724         if (ret < 0) {
 725                 ret = close(fds[0]);
 726                 if (ret) {
 727                         PERROR("close on received shm_fd");
 728                 }
 729                 ret = -EIO;
 730                 lttng_ust_unlock_fd_tracker();
 731                 goto error;
 732         }
 733         *shm_fd = ret;
 734
 735         ret = lttng_ust_add_fd_to_tracker(fds[1]);
 736         if (ret < 0) {
 737                 ret = close(*shm_fd);
 738                 if (ret) {
 739                         PERROR("close on shm_fd");
 740                 }
 741                 *shm_fd = -1;
 742                 ret = close(fds[1]);
 743                 if (ret) {
 744                         PERROR("close on received wakeup_fd");
 745                 }
 746                 ret = -EIO;
 747                 lttng_ust_unlock_fd_tracker();
 748                 goto error;
 749         }
 750         *wakeup_fd = ret;
 751         lttng_ust_unlock_fd_tracker();
 752         return 0;
 753
 754 error:
 755         return ret;
 756 }
 757
 758 ssize_t ustcomm_recv_counter_from_sessiond(int sock,
 759                 void **_counter_data, uint64_t var_len)
 760 {
 761         void *counter_data;
 762         ssize_t len;
 763
 764         if (var_len > LTTNG_UST_COUNTER_DATA_MAX_LEN) {
 765                 len = -EINVAL;
 766                 goto error_check;
 767         }
 768         /* Receive variable length data */
 769         counter_data = zmalloc(var_len);
 770         if (!counter_data) {
 771                 len = -ENOMEM;
 772                 goto error_alloc;
 773         }
 774         len = ustcomm_recv_unix_sock(sock, counter_data, var_len);
 775         if (len != var_len) {
 776                 goto error_recv;
 777         }
 778         *_counter_data = counter_data;
 779         return len;
 780
 781 error_recv:
 782         free(counter_data);
 783 error_alloc:
 784 error_check:
 785         return len;
 786 }
 787
 788 int ustcomm_recv_counter_shm_from_sessiond(int sock,
 789                 int *shm_fd)
 790 {
 791         ssize_t len;
 792         int ret;
 793         int fds[1];
 794
 795         /* recv shm fd fd */
 796         lttng_ust_lock_fd_tracker();
 797         len = ustcomm_recv_fds_unix_sock(sock, fds, 1);
 798         if (len <= 0) {
 799                 lttng_ust_unlock_fd_tracker();
 800                 if (len < 0) {
 801                         ret = len;
 802                         goto error;
 803                 } else {
 804                         ret = -EIO;
 805                         goto error;
 806                 }
 807         }
 808
 809         ret = lttng_ust_add_fd_to_tracker(fds[0]);
 810         if (ret < 0) {
 811                 ret = close(fds[0]);
 812                 if (ret) {
 813                         PERROR("close on received shm_fd");
 814                 }
 815                 ret = -EIO;
 816                 lttng_ust_unlock_fd_tracker();
 817                 goto error;
 818         }
 819         *shm_fd = ret;
 820         lttng_ust_unlock_fd_tracker();
 821         return 0;
 822
 823 error:
 824         return ret;
 825 }
 826
 827 /*
 828  * Returns 0 on success, negative error value on error.
 829  */
 830 int ustcomm_send_reg_msg(int sock,
 831                 enum ustctl_socket_type type,
 832                 uint32_t bits_per_long,
 833                 uint32_t uint8_t_alignment,
 834                 uint32_t uint16_t_alignment,
 835                 uint32_t uint32_t_alignment,
 836                 uint32_t uint64_t_alignment,
 837                 uint32_t long_alignment)
 838 {
 839         ssize_t len;
 840         struct ustctl_reg_msg reg_msg;
 841
 842         reg_msg.magic = LTTNG_UST_COMM_MAGIC;
 843         reg_msg.major = LTTNG_UST_ABI_MAJOR_VERSION;
 844         reg_msg.minor = LTTNG_UST_ABI_MINOR_VERSION;
 845         reg_msg.pid = getpid();
 846         reg_msg.ppid = getppid();
 847         reg_msg.uid = getuid();
 848         reg_msg.gid = getgid();
 849         reg_msg.bits_per_long = bits_per_long;
 850         reg_msg.uint8_t_alignment = uint8_t_alignment;
 851         reg_msg.uint16_t_alignment = uint16_t_alignment;
 852         reg_msg.uint32_t_alignment = uint32_t_alignment;
 853         reg_msg.uint64_t_alignment = uint64_t_alignment;
 854         reg_msg.long_alignment = long_alignment;
 855         reg_msg.socket_type = type;
 856         lttng_pthread_getname_np(reg_msg.name, LTTNG_UST_ABI_PROCNAME_LEN);
 857         memset(reg_msg.padding, 0, sizeof(reg_msg.padding));
 858
 859         len = ustcomm_send_unix_sock(sock, &reg_msg, sizeof(reg_msg));
 860         if (len > 0 && len != sizeof(reg_msg))
 861                 return -EIO;
 862         if (len < 0)
 863                 return len;
 864         return 0;
 865 }
 866
 867 static
 868 ssize_t count_one_type(const struct lttng_type *lt)
 869 {
 870         switch (lt->atype) {
 871         case atype_integer:
 872         case atype_float:
 873         case atype_string:
 874                 return 1;
 875         case atype_enum_nestable:
 876                 return count_one_type(lt->u.enum_nestable.container_type) + 1;
 877         case atype_array_nestable:
 878                 return count_one_type(lt->u.array_nestable.elem_type) + 1;
 879         case atype_sequence_nestable:
 880                 return count_one_type(lt->u.sequence_nestable.elem_type) + 1;
 881         case atype_struct_nestable:
 882                 return count_fields_recursive(lt->u.struct_nestable.nr_fields,
 883                                 lt->u.struct_nestable.fields) + 1;
 884
 885         case atype_dynamic:
 886         {
 887                 const struct lttng_event_field *choices;
 888                 size_t nr_choices;
 889                 int ret;
 890
 891                 ret = lttng_ust_dynamic_type_choices(&nr_choices,
 892                         &choices);
 893                 if (ret)
 894                         return ret;
 895                 /*
 896                  * Two fields for enum, one field for variant, and
 897                  * one field per choice.
 898                  */
 899                 return count_fields_recursive(nr_choices, choices) + 3;
 900         }
 901
 902         default:
 903                 return -EINVAL;
 904         }
 905         return 0;
 906 }
 907
 908 static
 909 ssize_t count_fields_recursive(size_t nr_fields,
 910                 const struct lttng_event_field *lttng_fields)
 911 {
 912         int i;
 913         ssize_t ret, count = 0;
 914
 915         for (i = 0; i < nr_fields; i++) {
 916                 const struct lttng_event_field *lf;
 917
 918                 lf = &lttng_fields[i];
 919                 /* skip 'nowrite' fields */
 920                 if (lf->nowrite)
 921                         continue;
 922                 ret = count_one_type(&lf->type);
 923                 if (ret < 0)
 924                         return ret;     /* error */
 925                 count += ret;
 926         }
 927         return count;
 928 }
 929
 930 static
 931 ssize_t count_ctx_fields_recursive(size_t nr_fields,
 932                 const struct lttng_ctx_field *lttng_fields)
 933 {
 934         int i;
 935         ssize_t ret, count = 0;
 936
 937         for (i = 0; i < nr_fields; i++) {
 938                 const struct lttng_event_field *lf;
 939
 940                 lf = &lttng_fields[i].event_field;
 941                 /* skip 'nowrite' fields */
 942                 if (lf->nowrite)
 943                         continue;
 944                 ret = count_one_type(&lf->type);
 945                 if (ret < 0)
 946                         return ret;     /* error */
 947                 count += ret;
 948         }
 949         return count;
 950 }
 951
 952 static
 953 int serialize_string_encoding(int32_t *ue,
 954                 enum lttng_string_encodings le)
 955 {
 956         switch (le) {
 957         case lttng_encode_none:
 958                 *ue = ustctl_encode_none;
 959                 break;
 960         case lttng_encode_UTF8:
 961                 *ue = ustctl_encode_UTF8;
 962                 break;
 963         case lttng_encode_ASCII:
 964                 *ue = ustctl_encode_ASCII;
 965                 break;
 966         default:
 967                 return -EINVAL;
 968         }
 969         return 0;
 970 }
 971
 972 static
 973 int serialize_integer_type(struct ustctl_integer_type *uit,
 974                 const struct lttng_integer_type *lit)
 975 {
 976         int32_t encoding;
 977
 978         uit->size = lit->size;
 979         uit->signedness = lit->signedness;
 980         uit->reverse_byte_order = lit->reverse_byte_order;
 981         uit->base = lit->base;
 982         if (serialize_string_encoding(&encoding, lit->encoding))
 983                 return -EINVAL;
 984         uit->encoding = encoding;
 985         uit->alignment = lit->alignment;
 986         return 0;
 987 }
 988
 989 static
 990 int serialize_dynamic_type(struct lttng_session *session,
 991                 struct ustctl_field *fields, size_t *iter_output,
 992                 const char *field_name)
 993 {
 994         const struct lttng_event_field *choices;
 995         char tag_field_name[LTTNG_UST_SYM_NAME_LEN];
 996         const struct lttng_type *tag_type;
 997         const struct lttng_event_field *tag_field_generic;
 998         struct lttng_event_field tag_field = {
 999                 .name = tag_field_name,
1000                 .nowrite = 0,
1001         };
1002         struct ustctl_field *uf;
1003         size_t nr_choices, i;
1004         int ret;
1005
1006         tag_field_generic = lttng_ust_dynamic_type_tag_field();
1007         tag_type = &tag_field_generic->type;
1008
1009         /* Serialize enum field. */
1010         strncpy(tag_field_name, field_name, LTTNG_UST_SYM_NAME_LEN);
1011         tag_field_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1012         strncat(tag_field_name,
1013                 "_tag",
1014                 LTTNG_UST_SYM_NAME_LEN - strlen(tag_field_name) - 1);
1015         tag_field.type = *tag_type;
1016         ret = serialize_one_field(session, fields, iter_output,
1017                 &tag_field);
1018         if (ret)
1019                 return ret;
1020
1021         /* Serialize variant field. */
1022         uf = &fields[*iter_output];
1023         ret = lttng_ust_dynamic_type_choices(&nr_choices, &choices);
1024         if (ret)
1025                 return ret;
1026
1027         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1028         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1029         uf->type.atype = ustctl_atype_variant;
1030         uf->type.u.variant_nestable.nr_choices = nr_choices;
1031         strncpy(uf->type.u.variant_nestable.tag_name,
1032                 tag_field_name,
1033                 LTTNG_UST_SYM_NAME_LEN);
1034         uf->type.u.variant_nestable.tag_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1035         uf->type.u.variant_nestable.alignment = 0;
1036         (*iter_output)++;
1037
1038         /* Serialize choice fields after variant. */
1039         for (i = 0; i < nr_choices; i++) {
1040                 ret = serialize_one_field(session, fields,
1041                         iter_output, &choices[i]);
1042                 if (ret)
1043                         return ret;
1044         }
1045         return 0;
1046 }
1047
1048 static
1049 int serialize_one_type(struct lttng_session *session,
1050                 struct ustctl_field *fields, size_t *iter_output,
1051                 const char *field_name, const struct lttng_type *lt)
1052 {
1053         int ret;
1054
1055         /*
1056          * Serializing a type (rather than a field) generates a ustctl_field
1057          * entry with 0-length name.
1058          */
1059
1060         switch (lt->atype) {
1061         case atype_integer:
1062         {
1063                 struct ustctl_field *uf = &fields[*iter_output];
1064                 struct ustctl_type *ut = &uf->type;
1065
1066                 if (field_name) {
1067                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1068                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1069                 } else {
1070                         uf->name[0] = '\0';
1071                 }
1072                 ret = serialize_integer_type(&ut->u.integer, &lt->u.integer);
1073                 if (ret)
1074                         return ret;
1075                 ut->atype = ustctl_atype_integer;
1076                 (*iter_output)++;
1077                 break;
1078         }
1079         case atype_float:
1080         {
1081                 struct ustctl_field *uf = &fields[*iter_output];
1082                 struct ustctl_type *ut = &uf->type;
1083                 struct ustctl_float_type *uft;
1084                 const struct lttng_float_type *lft;
1085
1086                 if (field_name) {
1087                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1088                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1089                 } else {
1090                         uf->name[0] = '\0';
1091                 }
1092                 uft = &ut->u._float;
1093                 lft = &lt->u._float;
1094                 uft->exp_dig = lft->exp_dig;
1095                 uft->mant_dig = lft->mant_dig;
1096                 uft->alignment = lft->alignment;
1097                 uft->reverse_byte_order = lft->reverse_byte_order;
1098                 ut->atype = ustctl_atype_float;
1099                 (*iter_output)++;
1100                 break;
1101         }
1102         case atype_string:
1103         {
1104                 struct ustctl_field *uf = &fields[*iter_output];
1105                 struct ustctl_type *ut = &uf->type;
1106                 int32_t encoding;
1107
1108                 if (field_name) {
1109                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1110                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1111                 } else {
1112                         uf->name[0] = '\0';
1113                 }
1114                 ret = serialize_string_encoding(&encoding, lt->u.string.encoding);
1115                 if (ret)
1116                         return ret;
1117                 ut->u.string.encoding = encoding;
1118                 ut->atype = ustctl_atype_string;
1119                 (*iter_output)++;
1120                 break;
1121         }
1122         case atype_array_nestable:
1123         {
1124                 struct ustctl_field *uf = &fields[*iter_output];
1125                 struct ustctl_type *ut = &uf->type;
1126
1127                 if (field_name) {
1128                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1129                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1130                 } else {
1131                         uf->name[0] = '\0';
1132                 }
1133                 ut->atype = ustctl_atype_array_nestable;
1134                 ut->u.array_nestable.length = lt->u.array_nestable.length;
1135                 ut->u.array_nestable.alignment = lt->u.array_nestable.alignment;
1136                 (*iter_output)++;
1137
1138                 ret = serialize_one_type(session, fields, iter_output, NULL,
1139                                 lt->u.array_nestable.elem_type);
1140                 if (ret)
1141                         return -EINVAL;
1142                 break;
1143         }
1144         case atype_sequence_nestable:
1145         {
1146                 struct ustctl_field *uf = &fields[*iter_output];
1147                 struct ustctl_type *ut = &uf->type;
1148
1149                 if (field_name) {
1150                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1151                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1152                 } else {
1153                         uf->name[0] = '\0';
1154                 }
1155                 ut->atype = ustctl_atype_sequence_nestable;
1156                 strncpy(ut->u.sequence_nestable.length_name,
1157                         lt->u.sequence_nestable.length_name,
1158                         LTTNG_UST_SYM_NAME_LEN);
1159                 ut->u.sequence_nestable.length_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1160                 ut->u.sequence_nestable.alignment = lt->u.sequence_nestable.alignment;
1161                 (*iter_output)++;
1162
1163                 ret = serialize_one_type(session, fields, iter_output, NULL,
1164                                 lt->u.sequence_nestable.elem_type);
1165                 if (ret)
1166                         return -EINVAL;
1167                 break;
1168         }
1169         case atype_dynamic:
1170         {
1171                 ret = serialize_dynamic_type(session, fields, iter_output,
1172                                 field_name);
1173                 if (ret)
1174                         return -EINVAL;
1175                 break;
1176         }
1177         case atype_struct_nestable:
1178         {
1179                 struct ustctl_field *uf = &fields[*iter_output];
1180
1181                 if (field_name) {
1182                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1183                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1184                 } else {
1185                         uf->name[0] = '\0';
1186                 }
1187                 uf->type.atype = ustctl_atype_struct_nestable;
1188                 uf->type.u.struct_nestable.nr_fields = lt->u.struct_nestable.nr_fields;
1189                 uf->type.u.struct_nestable.alignment = lt->u.struct_nestable.alignment;
1190                 (*iter_output)++;
1191
1192                 ret = serialize_fields(session, fields, iter_output,
1193                                 lt->u.struct_nestable.nr_fields,
1194                                 lt->u.struct_nestable.fields);
1195                 if (ret)
1196                         return -EINVAL;
1197                 break;
1198         }
1199         case atype_enum_nestable:
1200         {
1201                 struct ustctl_field *uf = &fields[*iter_output];
1202                 struct ustctl_type *ut = &uf->type;
1203
1204                 if (field_name) {
1205                         strncpy(uf->name, field_name, LTTNG_UST_SYM_NAME_LEN);
1206                         uf->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1207                 } else {
1208                         uf->name[0] = '\0';
1209                 }
1210                 strncpy(ut->u.enum_nestable.name, lt->u.enum_nestable.desc->name,
1211                                 LTTNG_UST_SYM_NAME_LEN);
1212                 ut->u.enum_nestable.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1213                 ut->atype = ustctl_atype_enum_nestable;
1214                 (*iter_output)++;
1215
1216                 ret = serialize_one_type(session, fields, iter_output, NULL,
1217                                 lt->u.enum_nestable.container_type);
1218                 if (ret)
1219                         return -EINVAL;
1220                 if (session) {
1221                         const struct lttng_enum *_enum;
1222
1223                         _enum = lttng_ust_enum_get_from_desc(session, lt->u.enum_nestable.desc);
1224                         if (!_enum)
1225                                 return -EINVAL;
1226                         ut->u.enum_nestable.id = _enum->id;
1227                 } else {
1228                         ut->u.enum_nestable.id = -1ULL;
1229                 }
1230                 break;
1231         }
1232         default:
1233                 return -EINVAL;
1234         }
1235         return 0;
1236 }
1237
1238 static
1239 int serialize_one_field(struct lttng_session *session,
1240                 struct ustctl_field *fields, size_t *iter_output,
1241                 const struct lttng_event_field *lf)
1242 {
1243         /* skip 'nowrite' fields */
1244         if (lf->nowrite)
1245                 return 0;
1246
1247         return serialize_one_type(session, fields, iter_output, lf->name, &lf->type);
1248 }
1249
1250 static
1251 int serialize_fields(struct lttng_session *session,
1252                 struct ustctl_field *ustctl_fields,
1253                 size_t *iter_output, size_t nr_lttng_fields,
1254                 const struct lttng_event_field *lttng_fields)
1255 {
1256         int ret;
1257         size_t i;
1258
1259         for (i = 0; i < nr_lttng_fields; i++) {
1260                 ret = serialize_one_field(session, ustctl_fields,
1261                                 iter_output, &lttng_fields[i]);
1262                 if (ret)
1263                         return ret;
1264         }
1265         return 0;
1266 }
1267
1268 static
1269 int alloc_serialize_fields(struct lttng_session *session,
1270                 size_t *_nr_write_fields,
1271                 struct ustctl_field **ustctl_fields,
1272                 size_t nr_fields,
1273                 const struct lttng_event_field *lttng_fields)
1274 {
1275         struct ustctl_field *fields;
1276         int ret;
1277         size_t iter_output = 0;
1278         ssize_t nr_write_fields;
1279
1280         nr_write_fields = count_fields_recursive(nr_fields, lttng_fields);
1281         if (nr_write_fields < 0) {
1282                 return (int) nr_write_fields;
1283         }
1284
1285         fields = zmalloc(nr_write_fields * sizeof(*fields));
1286         if (!fields)
1287                 return -ENOMEM;
1288
1289         ret = serialize_fields(session, fields, &iter_output, nr_fields,
1290                         lttng_fields);
1291         if (ret)
1292                 goto error_type;
1293
1294         *_nr_write_fields = nr_write_fields;
1295         *ustctl_fields = fields;
1296         return 0;
1297
1298 error_type:
1299         free(fields);
1300         return ret;
1301 }
1302
1303 static
1304 int serialize_entries(struct ustctl_enum_entry **_entries,
1305                 size_t nr_entries,
1306                 const struct lttng_enum_entry *lttng_entries)
1307 {
1308         struct ustctl_enum_entry *entries;
1309         int i;
1310
1311         /* Serialize the entries */
1312         entries = zmalloc(nr_entries * sizeof(*entries));
1313         if (!entries)
1314                 return -ENOMEM;
1315         for (i = 0; i < nr_entries; i++) {
1316                 struct ustctl_enum_entry *uentry;
1317                 const struct lttng_enum_entry *lentry;
1318
1319                 uentry = &entries[i];
1320                 lentry = &lttng_entries[i];
1321
1322                 uentry->start.value = lentry->start.value;
1323                 uentry->start.signedness = lentry->start.signedness;
1324                 uentry->end.value = lentry->end.value;
1325                 uentry->end.signedness = lentry->end.signedness;
1326                 strncpy(uentry->string, lentry->string, LTTNG_UST_SYM_NAME_LEN);
1327                 uentry->string[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1328
1329                 if (lentry->u.extra.options & LTTNG_ENUM_ENTRY_OPTION_IS_AUTO) {
1330                         uentry->u.extra.options |=
1331                                 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO;
1332                 }
1333         }
1334         *_entries = entries;
1335         return 0;
1336 }
1337
1338 static
1339 int serialize_ctx_fields(struct lttng_session *session,
1340                 size_t *_nr_write_fields,
1341                 struct ustctl_field **ustctl_fields,
1342                 size_t nr_fields,
1343                 const struct lttng_ctx_field *lttng_fields)
1344 {
1345         struct ustctl_field *fields;
1346         int ret;
1347         size_t i, iter_output = 0;
1348         ssize_t nr_write_fields;
1349
1350         nr_write_fields = count_ctx_fields_recursive(nr_fields,
1351                         lttng_fields);
1352         if (nr_write_fields < 0) {
1353                 return (int) nr_write_fields;
1354         }
1355
1356         fields = zmalloc(nr_write_fields * sizeof(*fields));
1357         if (!fields)
1358                 return -ENOMEM;
1359
1360         for (i = 0; i < nr_fields; i++) {
1361                 ret = serialize_one_field(session, fields, &iter_output,
1362                                 &lttng_fields[i].event_field);
1363                 if (ret)
1364                         goto error_type;
1365         }
1366
1367         *_nr_write_fields = nr_write_fields;
1368         *ustctl_fields = fields;
1369         return 0;
1370
1371 error_type:
1372         free(fields);
1373         return ret;
1374 }
1375
1376 /*
1377  * Returns 0 on success, negative error value on error.
1378  */
1379 int ustcomm_register_event(int sock,
1380         struct lttng_session *session,
1381         int session_objd,               /* session descriptor */
1382         int channel_objd,               /* channel descriptor */
1383         const char *event_name,         /* event name (input) */
1384         int loglevel,
1385         const char *signature,          /* event signature (input) */
1386         size_t nr_fields,               /* fields */
1387         const struct lttng_event_field *lttng_fields,
1388         const char *model_emf_uri,
1389         uint32_t *id)                   /* event id (output) */
1390 {
1391         ssize_t len;
1392         struct {
1393                 struct ustcomm_notify_hdr header;
1394                 struct ustcomm_notify_event_msg m;
1395         } msg;
1396         struct {
1397                 struct ustcomm_notify_hdr header;
1398                 struct ustcomm_notify_event_reply r;
1399         } reply;
1400         size_t signature_len, fields_len, model_emf_uri_len;
1401         struct ustctl_field *fields = NULL;
1402         size_t nr_write_fields = 0;
1403         int ret;
1404
1405         memset(&msg, 0, sizeof(msg));
1406         msg.header.notify_cmd = USTCTL_NOTIFY_CMD_EVENT;
1407         msg.m.session_objd = session_objd;
1408         msg.m.channel_objd = channel_objd;
1409         strncpy(msg.m.event_name, event_name, LTTNG_UST_SYM_NAME_LEN);
1410         msg.m.event_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1411         msg.m.loglevel = loglevel;
1412         signature_len = strlen(signature) + 1;
1413         msg.m.signature_len = signature_len;
1414
1415         /* Calculate fields len, serialize fields. */
1416         if (nr_fields > 0) {
1417                 ret = alloc_serialize_fields(session, &nr_write_fields, &fields,
1418                                 nr_fields, lttng_fields);
1419                 if (ret)
1420                         return ret;
1421         }
1422
1423         fields_len = sizeof(*fields) * nr_write_fields;
1424         msg.m.fields_len = fields_len;
1425         if (model_emf_uri) {
1426                 model_emf_uri_len = strlen(model_emf_uri) + 1;
1427         } else {
1428                 model_emf_uri_len = 0;
1429         }
1430         msg.m.model_emf_uri_len = model_emf_uri_len;
1431
1432         len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
1433         if (len > 0 && len != sizeof(msg)) {
1434                 ret = -EIO;
1435                 goto error_fields;
1436         }
1437         if (len < 0) {
1438                 ret = len;
1439                 goto error_fields;
1440         }
1441
1442         /* send signature */
1443         len = ustcomm_send_unix_sock(sock, signature, signature_len);
1444         if (len > 0 && len != signature_len) {
1445                 ret = -EIO;
1446                 goto error_fields;
1447         }
1448         if (len < 0) {
1449                 ret = len;
1450                 goto error_fields;
1451         }
1452
1453         /* send fields */
1454         if (fields_len > 0) {
1455                 len = ustcomm_send_unix_sock(sock, fields, fields_len);
1456                 if (len > 0 && len != fields_len) {
1457                         ret = -EIO;
1458                         goto error_fields;
1459                 }
1460                 if (len < 0) {
1461                         ret = len;
1462                         goto error_fields;
1463                 }
1464         }
1465         free(fields);
1466
1467         if (model_emf_uri_len) {
1468                 /* send model_emf_uri */
1469                 len = ustcomm_send_unix_sock(sock, model_emf_uri,
1470                                 model_emf_uri_len);
1471                 if (len > 0 && len != model_emf_uri_len) {
1472                         return -EIO;
1473                 }
1474                 if (len < 0) {
1475                         return len;
1476                 }
1477         }
1478
1479         /* receive reply */
1480         len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
1481         switch (len) {
1482         case 0: /* orderly shutdown */
1483                 return -EPIPE;
1484         case sizeof(reply):
1485                 if (reply.header.notify_cmd != msg.header.notify_cmd) {
1486                         ERR("Unexpected result message command "
1487                                 "expected: %u vs received: %u\n",
1488                                 msg.header.notify_cmd, reply.header.notify_cmd);
1489                         return -EINVAL;
1490                 }
1491                 if (reply.r.ret_code > 0)
1492                         return -EINVAL;
1493                 if (reply.r.ret_code < 0)
1494                         return reply.r.ret_code;
1495                 *id = reply.r.event_id;
1496                 DBG("Sent register event notification for name \"%s\": ret_code %d, event_id %u\n",
1497                         event_name, reply.r.ret_code, reply.r.event_id);
1498                 return 0;
1499         default:
1500                 if (len < 0) {
1501                         /* Transport level error */
1502                         if (errno == EPIPE || errno == ECONNRESET)
1503                                 len = -errno;
1504                         return len;
1505                 } else {
1506                         ERR("incorrect message size: %zd\n", len);
1507                         return len;
1508                 }
1509         }
1510         /* Unreached. */
1511
1512         /* Error path only. */
1513 error_fields:
1514         free(fields);
1515         return ret;
1516 }
1517
1518 /*
1519  * Returns 0 on success, negative error value on error.
1520  * Returns -EPIPE or -ECONNRESET if other end has hung up.
1521  */
1522 int ustcomm_register_enum(int sock,
1523         int session_objd,               /* session descriptor */
1524         const char *enum_name,          /* enum name (input) */
1525         size_t nr_entries,              /* entries */
1526         const struct lttng_enum_entry *lttng_entries,
1527         uint64_t *id)
1528 {
1529         ssize_t len;
1530         struct {
1531                 struct ustcomm_notify_hdr header;
1532                 struct ustcomm_notify_enum_msg m;
1533         } msg;
1534         struct {
1535                 struct ustcomm_notify_hdr header;
1536                 struct ustcomm_notify_enum_reply r;
1537         } reply;
1538         size_t entries_len;
1539         struct ustctl_enum_entry *entries = NULL;
1540         int ret;
1541
1542         memset(&msg, 0, sizeof(msg));
1543         msg.header.notify_cmd = USTCTL_NOTIFY_CMD_ENUM;
1544         msg.m.session_objd = session_objd;
1545         strncpy(msg.m.enum_name, enum_name, LTTNG_UST_SYM_NAME_LEN);
1546         msg.m.enum_name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
1547
1548         /* Calculate entries len, serialize entries. */
1549         if (nr_entries > 0) {
1550                 ret = serialize_entries(&entries,
1551                                 nr_entries, lttng_entries);
1552                 if (ret)
1553                         return ret;
1554         }
1555
1556         entries_len = sizeof(*entries) * nr_entries;
1557         msg.m.entries_len = entries_len;
1558
1559         len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
1560         if (len > 0 && len != sizeof(msg)) {
1561                 ret = -EIO;
1562                 goto error_entries;
1563         }
1564         if (len < 0) {
1565                 ret = len;
1566                 goto error_entries;
1567         }
1568
1569         /* send entries */
1570         if (entries_len > 0) {
1571                 len = ustcomm_send_unix_sock(sock, entries, entries_len);
1572                 if (len > 0 && len != entries_len) {
1573                         ret = -EIO;
1574                         goto error_entries;
1575                 }
1576                 if (len < 0) {
1577                         ret = len;
1578                         goto error_entries;
1579                 }
1580         }
1581         free(entries);
1582         entries = NULL;
1583
1584         /* receive reply */
1585         len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
1586         switch (len) {
1587         case 0: /* orderly shutdown */
1588                 return -EPIPE;
1589         case sizeof(reply):
1590                 if (reply.header.notify_cmd != msg.header.notify_cmd) {
1591                         ERR("Unexpected result message command "
1592                                 "expected: %u vs received: %u\n",
1593                                 msg.header.notify_cmd, reply.header.notify_cmd);
1594                         return -EINVAL;
1595                 }
1596                 if (reply.r.ret_code > 0)
1597                         return -EINVAL;
1598                 if (reply.r.ret_code < 0)
1599                         return reply.r.ret_code;
1600                 *id = reply.r.enum_id;
1601                 DBG("Sent register enum notification for name \"%s\": ret_code %d\n",
1602                         enum_name, reply.r.ret_code);
1603                 return 0;
1604         default:
1605                 if (len < 0) {
1606                         /* Transport level error */
1607                         if (errno == EPIPE || errno == ECONNRESET)
1608                                 len = -errno;
1609                         return len;
1610                 } else {
1611                         ERR("incorrect message size: %zd\n", len);
1612                         return len;
1613                 }
1614         }
1615         return ret;
1616
1617 error_entries:
1618         free(entries);
1619         return ret;
1620 }
1621
1622 /*
1623  * Returns 0 on success, negative error value on error.
1624  * Returns -EPIPE or -ECONNRESET if other end has hung up.
1625  */
1626 int ustcomm_register_channel(int sock,
1627         struct lttng_session *session,
1628         int session_objd,               /* session descriptor */
1629         int channel_objd,               /* channel descriptor */
1630         size_t nr_ctx_fields,
1631         const struct lttng_ctx_field *ctx_fields,
1632         uint32_t *chan_id,              /* channel id (output) */
1633         int *header_type)               /* header type (output) */
1634 {
1635         ssize_t len;
1636         struct {
1637                 struct ustcomm_notify_hdr header;
1638                 struct ustcomm_notify_channel_msg m;
1639         } msg;
1640         struct {
1641                 struct ustcomm_notify_hdr header;
1642                 struct ustcomm_notify_channel_reply r;
1643         } reply;
1644         size_t fields_len;
1645         struct ustctl_field *fields = NULL;
1646         int ret;
1647         size_t nr_write_fields = 0;
1648
1649         memset(&msg, 0, sizeof(msg));
1650         msg.header.notify_cmd = USTCTL_NOTIFY_CMD_CHANNEL;
1651         msg.m.session_objd = session_objd;
1652         msg.m.channel_objd = channel_objd;
1653
1654         /* Calculate fields len, serialize fields. */
1655         if (nr_ctx_fields > 0) {
1656                 ret = serialize_ctx_fields(session, &nr_write_fields, &fields,
1657                                 nr_ctx_fields, ctx_fields);
1658                 if (ret)
1659                         return ret;
1660         }
1661
1662         fields_len = sizeof(*fields) * nr_write_fields;
1663         msg.m.ctx_fields_len = fields_len;
1664         len = ustcomm_send_unix_sock(sock, &msg, sizeof(msg));
1665         if (len > 0 && len != sizeof(msg)) {
1666                 free(fields);
1667                 return -EIO;
1668         }
1669         if (len < 0) {
1670                 free(fields);
1671                 return len;
1672         }
1673
1674         /* send fields */
1675         if (fields_len > 0) {
1676                 len = ustcomm_send_unix_sock(sock, fields, fields_len);
1677                 free(fields);
1678                 if (len > 0 && len != fields_len) {
1679                         return -EIO;
1680                 }
1681                 if (len < 0) {
1682                         return len;
1683                 }
1684         } else {
1685                 free(fields);
1686         }
1687
1688         len = ustcomm_recv_unix_sock(sock, &reply, sizeof(reply));
1689         switch (len) {
1690         case 0: /* orderly shutdown */
1691                 return -EPIPE;
1692         case sizeof(reply):
1693                 if (reply.header.notify_cmd != msg.header.notify_cmd) {
1694                         ERR("Unexpected result message command "
1695                                 "expected: %u vs received: %u\n",
1696                                 msg.header.notify_cmd, reply.header.notify_cmd);
1697                         return -EINVAL;
1698                 }
1699                 if (reply.r.ret_code > 0)
1700                         return -EINVAL;
1701                 if (reply.r.ret_code < 0)
1702                         return reply.r.ret_code;
1703                 *chan_id = reply.r.chan_id;
1704                 switch (reply.r.header_type) {
1705                 case 1:
1706                 case 2:
1707                         *header_type = reply.r.header_type;
1708                         break;
1709                 default:
1710                         ERR("Unexpected channel header type %u\n",
1711                                 reply.r.header_type);
1712                         return -EINVAL;
1713                 }
1714                 DBG("Sent register channel notification: chan_id %d, header_type %d\n",
1715                         reply.r.chan_id, reply.r.header_type);
1716                 return 0;
1717         default:
1718                 if (len < 0) {
1719                         /* Transport level error */
1720                         if (errno == EPIPE || errno == ECONNRESET)
1721                                 len = -errno;
1722                         return len;
1723                 } else {
1724                         ERR("incorrect message size: %zd\n", len);
1725                         return len;
1726                 }
1727         }
1728 }
1729
1730 /*
1731  * Set socket reciving timeout.
1732  */
1733 int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
1734 {
1735         int ret;
1736         struct timeval tv;
1737
1738         tv.tv_sec = msec / 1000;
1739         tv.tv_usec = (msec * 1000 % 1000000);
1740
1741         ret = setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
1742         if (ret < 0) {
1743                 PERROR("setsockopt SO_RCVTIMEO");
1744                 ret = -errno;
1745         }
1746
1747         return ret;
1748 }
1749
1750 /*
1751  * Set socket sending timeout.
1752  */
1753 int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
1754 {
1755         int ret;
1756         struct timeval tv;
1757
1758         tv.tv_sec = msec / 1000;
1759         tv.tv_usec = (msec * 1000) % 1000000;
1760
1761         ret = setsockopt(sock, SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
1762         if (ret < 0) {
1763                 PERROR("setsockopt SO_SNDTIMEO");
1764                 ret = -errno;
1765         }
1766
1767         return ret;
1768 }