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

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