src/common/sessiond-comm/sessiond-comm.c

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License, version 2 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <assert.h>
  21 #include <limits.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/stat.h>
  26 #include <sys/types.h>
  27 #include <unistd.h>
  28 #include <errno.h>
  29
  30 #include <common/defaults.h>
  31 #include <common/error.h>
  32
  33 #include "sessiond-comm.h"
  34
  35 /* For Unix socket */
  36 #include "unix.h"
  37 /* For Inet socket */
  38 #include "inet.h"
  39 /* For Inet6 socket */
  40 #include "inet6.h"
  41
  42 struct lttcomm_net_family net_families[] = {
  43         { LTTCOMM_INET, lttcomm_create_inet_sock },
  44         { LTTCOMM_INET6, lttcomm_create_inet6_sock },
  45 };
  46
  47 /*
  48  * Human readable error message.
  49  */
  50 static const char *lttcomm_readable_code[] = {
  51         [ LTTCOMM_ERR_INDEX(LTTCOMM_OK) ] = "Success",
  52         [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR) ] = "Unknown error",
  53         [ LTTCOMM_ERR_INDEX(LTTCOMM_UND) ] = "Undefined command",
  54         [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED) ] = "Not implemented",
  55         [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN) ] = "Unknown tracing domain",
  56         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION) ] = "No session found",
  57         [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL) ] = "Unable to list traceable apps",
  58         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS) ] = "No traceable apps found",
  59         [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND) ] = "Session name not found",
  60         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE) ] = "No trace found",
  61         [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL) ] = "Fatal error of the session daemon",
  62         [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_DIR_FAIL) ] = "Create directory failed",
  63         [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL) ] = "Start trace failed",
  64         [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL) ] = "Stop trace failed",
  65         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE) ] = "App is not traceable",
  66         [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS) ] = "A session MUST be selected",
  67         [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS) ] = "Session name already exist",
  68         [ LTTCOMM_ERR_INDEX(LTTCOMM_CONNECT_FAIL) ] = "Unable to connect to Unix socket",
  69         [ LTTCOMM_ERR_INDEX(LTTCOMM_APP_NOT_FOUND) ] = "Application not found",
  70         [ LTTCOMM_ERR_INDEX(LTTCOMM_EPERM) ] = "Permission denied",
  71         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA) ] = "Kernel tracer not available",
  72         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_VERSION) ] = "Kernel tracer version is not compatible",
  73         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST) ] = "Kernel event already exists",
  74         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL) ] = "Kernel create session failed",
  75         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_EXIST) ] = "Kernel channel already exists",
  76         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL) ] = "Kernel create channel failed",
  77         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found",
  78         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed",
  79         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed",
  80         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL) ] = "Add kernel context failed",
  81         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed",
  82         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed",
  83         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
  84         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed",
  85         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed",
  86         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed",
  87         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed",
  88         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed",
  89         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist",
  90         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION) ] = "No kernel session found",
  91         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL) ] = "Listing kernel events failed",
  92         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CALIBRATE_FAIL) ] = "UST calibration failed",
  93         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_VERSION) ] = "UST tracer version is not compatible",
  94         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL) ] = "UST create session failed",
  95         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL) ] = "UST create channel failed",
  96         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_EXIST) ] = "UST channel already exist",
  97         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_NOT_FOUND) ] = "UST channel not found",
  98         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_DISABLE_FAIL) ] = "Disable UST channel failed",
  99         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_ENABLE_FAIL) ] = "Enable UST channel failed",
 100         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_FAIL) ] = "Add UST context failed",
 101         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_ENABLE_FAIL) ] = "Enable UST event failed",
 102         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DISABLE_FAIL) ] = "Disable UST event failed",
 103         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_META_FAIL) ] = "Opening metadata failed",
 104         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_START_FAIL) ] = "Starting UST trace failed",
 105         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STOP_FAIL) ] = "Stoping UST trace failed",
 106         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER64_FAIL) ] = "64-bit UST consumer start failed",
 107         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER32_FAIL) ] = "32-bit UST consumer start failed",
 108         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STREAM_FAIL) ] = "UST create stream failed",
 109         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_FAIL) ] = "UST trace directory creation failed",
 110         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_EXIST) ] = "UST trace directory already exist",
 111         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_NO_SESSION) ] = "No UST session found",
 112         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_LIST_FAIL) ] = "Listing UST events failed",
 113         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_EXIST) ] = "UST event already exist",
 114         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_NOT_FOUND)] = "UST event not found",
 115         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_EXIST)] = "UST context already exist",
 116         [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_INVAL)] = "UST invalid context",
 117         [ LTTCOMM_ERR_INDEX(LTTCOMM_NEED_ROOT_SESSIOND) ] = "Tracing the kernel requires a root lttng-sessiond daemon and \"tracing\" group user membership",
 118         [ LTTCOMM_ERR_INDEX(LTTCOMM_TRACE_ALREADY_STARTED) ] = "Tracing already started",
 119         [ LTTCOMM_ERR_INDEX(LTTCOMM_TRACE_ALREADY_STOPPED) ] = "Tracing already stopped",
 120         [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_ENOSYS) ] = "Kernel event type not supported",
 121
 122         [ LTTCOMM_ERR_INDEX(CONSUMERD_COMMAND_SOCK_READY) ] = "consumerd command socket ready",
 123         [ LTTCOMM_ERR_INDEX(CONSUMERD_SUCCESS_RECV_FD) ] = "consumerd success on receiving fds",
 124         [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_FD) ] = "consumerd error on receiving fds",
 125         [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_CMD) ] = "consumerd error on receiving command",
 126         [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_ERROR) ] = "consumerd error in polling thread",
 127         [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_NVAL) ] = "consumerd polling on closed fd",
 128         [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_HUP) ] = "consumerd all fd hung up",
 129         [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_SUCCESS) ] = "consumerd exiting normally",
 130         [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_FAILURE) ] = "consumerd exiting on error",
 131         [ LTTCOMM_ERR_INDEX(CONSUMERD_OUTFD_ERROR) ] = "consumerd error opening the tracefile",
 132         [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EBADF) ] = "consumerd splice EBADF",
 133         [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EINVAL) ] = "consumerd splice EINVAL",
 134         [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ENOMEM) ] = "consumerd splice ENOMEM",
 135         [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ESPIPE) ] = "consumerd splice ESPIPE",
 136         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "Event not found",
 137         [ LTTCOMM_ERR_INDEX(LTTCOMM_INVALID) ] = "Invalid parameter",
 138         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_USTCONSUMERD) ] = "No UST consumer detected",
 139         [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_KERNCONSUMERD) ] = "No kernel consumer detected",
 140         [ LTTCOMM_ERR_INDEX(LTTCOMM_EVENT_EXIST_LOGLEVEL) ] = "Event already enabled with different loglevel",
 141 };
 142
 143 /*
 144  * Return ptr to string representing a human readable error code from the
 145  * lttcomm_return_code enum.
 146  *
 147  * These code MUST be negative in other to treat that as an error value.
 148  */
 149 const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
 150 {
 151         int tmp_code = -code;
 152
 153         if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
 154                 return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
 155         }
 156
 157         return "Unknown error code";
 158 }
 159
 160 /*
 161  * Alloc lttcomm socket and set protocol.
 162  */
 163 static struct lttcomm_sock *alloc_sock(enum lttcomm_sock_proto proto)
 164 {
 165         struct lttcomm_sock *sock;
 166
 167         sock = zmalloc(sizeof(struct lttcomm_sock));
 168         if (sock == NULL) {
 169                 PERROR("zmalloc create sock");
 170                 goto end;
 171         }
 172
 173         sock->proto = proto;
 174
 175 end:
 176         return sock;
 177 }
 178
 179 /*
 180  * Create socket from an already allocated lttcomm socket structure.
 181  */
 182 int lttcomm_create_sock(struct lttcomm_sock *sock,
 183                 enum lttcomm_sock_domain domain, enum lttcomm_sock_proto proto)
 184 {
 185         int ret, _sock_type, _sock_proto;
 186
 187         assert(sock);
 188
 189         switch (proto) {
 190                 case LTTCOMM_SOCK_UDP:
 191                         _sock_type = SOCK_DGRAM;
 192                         _sock_proto = IPPROTO_UDP;
 193                         break;
 194                 case LTTCOMM_SOCK_TCP:
 195                         _sock_type = SOCK_STREAM;
 196                         _sock_proto = IPPROTO_TCP;
 197                         break;
 198                 default:
 199                         ret = -1;
 200                         goto error;
 201         }
 202
 203         ret = net_families[domain].create(sock, _sock_type, _sock_proto);
 204         if (ret < 0) {
 205                 goto error;
 206         }
 207
 208         sock->proto = proto;
 209
 210 error:
 211         return ret;
 212 }
 213
 214 /*
 215  * Return allocated lttcomm socket structure.
 216  */
 217 struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_domain domain,
 218                 enum lttcomm_sock_proto proto)
 219 {
 220         int ret;
 221         struct lttcomm_sock *sock;
 222
 223         sock = alloc_sock(proto);
 224         if (sock == NULL) {
 225                 goto alloc_error;
 226         }
 227
 228         ret = lttcomm_create_sock(sock, domain, proto);
 229         if (ret < 0) {
 230                 goto error;
 231         }
 232
 233         return sock;
 234
 235 error:
 236         free(sock);
 237 alloc_error:
 238         return NULL;
 239 }
 240
 241 /*
 242  * Init IPv4 sockaddr structure.
 243  */
 244 int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr,
 245                 const char *ip, unsigned int port)
 246 {
 247         int ret;
 248
 249         assert(sockaddr);
 250         assert(ip);
 251         assert(port > 0 && port <= 65535);
 252
 253         memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));
 254
 255         sockaddr->type = LTTCOMM_INET;
 256         sockaddr->addr.sin.sin_family = AF_INET;
 257         sockaddr->addr.sin.sin_port = htons(port);
 258         ret = inet_pton(sockaddr->addr.sin.sin_family, ip,
 259                         &sockaddr->addr.sin.sin_addr);
 260         if (ret < 1) {
 261                 ret = -1;
 262                 goto error;
 263         }
 264         memset(sockaddr->addr.sin.sin_zero, 0, sizeof(sockaddr->addr.sin.sin_zero));
 265
 266 error:
 267         return ret;
 268 }
 269
 270 /*
 271  * Init IPv6 sockaddr structure.
 272  */
 273 int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr,
 274                 const char *ip, unsigned int port)
 275 {
 276         int ret;
 277
 278         assert(sockaddr);
 279         assert(ip);
 280         assert(port > 0 && port <= 65535);
 281
 282         memset(sockaddr, 0, sizeof(struct lttcomm_sockaddr));
 283
 284         sockaddr->type = LTTCOMM_INET6;
 285         sockaddr->addr.sin6.sin6_family = AF_INET6;
 286         sockaddr->addr.sin6.sin6_port = htons(port);
 287         ret = inet_pton(sockaddr->addr.sin6.sin6_family, ip,
 288                         &sockaddr->addr.sin6.sin6_addr);
 289         if (ret < 1) {
 290                 ret = -1;
 291                 goto error;
 292         }
 293
 294 error:
 295         return ret;
 296 }