src/common/runas.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 _LGPL_SOURCE
  20 #include <errno.h>
  21 #include <limits.h>
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <sys/wait.h>
  26 #include <sys/types.h>
  27 #include <sys/stat.h>
  28 #include <unistd.h>
  29 #include <fcntl.h>
  30 #include <sched.h>
  31 #include <signal.h>
  32 #include <assert.h>
  33 #include <signal.h>
  34
  35 #include <common/lttng-kernel.h>
  36 #include <common/common.h>
  37 #include <common/utils.h>
  38 #include <common/compat/getenv.h>
  39 #include <common/compat/prctl.h>
  40 #include <common/unix.h>
  41 #include <common/defaults.h>
  42 #include <common/lttng-elf.h>
  43
  44 #include <lttng/constant.h>
  45
  46 #include "runas.h"
  47
  48 struct run_as_data;
  49 struct run_as_ret;
  50 typedef int (*run_as_fct)(struct run_as_data *data, struct run_as_ret *ret_value);
  51
  52 struct run_as_mkdir_data {
  53         char path[PATH_MAX];
  54         mode_t mode;
  55 };
  56
  57 struct run_as_open_data {
  58         char path[PATH_MAX];
  59         int flags;
  60         mode_t mode;
  61 };
  62
  63 struct run_as_unlink_data {
  64         char path[PATH_MAX];
  65 };
  66
  67 struct run_as_rmdir_recursive_data {
  68         char path[PATH_MAX];
  69 };
  70
  71 struct run_as_extract_elf_symbol_offset_data {
  72         char function[LTTNG_SYMBOL_NAME_LEN];
  73 };
  74
  75 struct run_as_extract_sdt_probe_offsets_data {
  76         char probe_name[LTTNG_SYMBOL_NAME_LEN];
  77         char provider_name[LTTNG_SYMBOL_NAME_LEN];
  78 };
  79
  80 struct run_as_mkdir_ret {
  81         int ret;
  82 };
  83
  84 struct run_as_open_ret {
  85         int ret;
  86 };
  87
  88 struct run_as_unlink_ret {
  89         int ret;
  90 };
  91
  92 struct run_as_rmdir_recursive_ret {
  93         int ret;
  94 };
  95
  96 struct run_as_extract_elf_symbol_offset_ret {
  97         uint64_t offset;
  98 };
  99
 100 struct run_as_extract_sdt_probe_offsets_ret {
 101         uint32_t num_offset;
 102         uint64_t offsets[LTTNG_KERNEL_MAX_UPROBE_NUM];
 103 };
 104
 105 enum run_as_cmd {
 106         RUN_AS_MKDIR,
 107         RUN_AS_OPEN,
 108         RUN_AS_UNLINK,
 109         RUN_AS_RMDIR_RECURSIVE,
 110         RUN_AS_MKDIR_RECURSIVE,
 111         RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET,
 112         RUN_AS_EXTRACT_SDT_PROBE_OFFSETS,
 113 };
 114
 115 struct run_as_data {
 116         enum run_as_cmd cmd;
 117         int fd;
 118         union {
 119                 struct run_as_mkdir_data mkdir;
 120                 struct run_as_open_data open;
 121                 struct run_as_unlink_data unlink;
 122                 struct run_as_rmdir_recursive_data rmdir_recursive;
 123                 struct run_as_extract_elf_symbol_offset_data extract_elf_symbol_offset;
 124                 struct run_as_extract_sdt_probe_offsets_data extract_sdt_probe_offsets;
 125         } u;
 126         uid_t uid;
 127         gid_t gid;
 128 };
 129
 130 /*
 131  * The run_as_ret structure holds the returned value and status of the command.
 132  *
 133  * The `u` union field holds the return value of the command; in most cases it
 134  * represents the success or the failure of the command. In more complex
 135  * commands, it holds a computed value.
 136  *
 137  * The _errno field is the errno recorded after the execution of the command.
 138  *
 139  * The _error fields is used the signify that return status of the command. For
 140  * simple commands returning `int` the _error field will be the same as the
 141  * ret_int field. In complex commands, it signify the success or failure of the
 142  * command.
 143  *
 144  */
 145 struct run_as_ret {
 146         int fd;
 147         union {
 148                 struct run_as_mkdir_ret mkdir;
 149                 struct run_as_open_ret open;
 150                 struct run_as_unlink_ret unlink;
 151                 struct run_as_rmdir_recursive_ret rmdir_recursive;
 152                 struct run_as_extract_elf_symbol_offset_ret extract_elf_symbol_offset;
 153                 struct run_as_extract_sdt_probe_offsets_ret extract_sdt_probe_offsets;
 154         } u;
 155         int _errno;
 156         bool _error;
 157 };
 158
 159 struct run_as_worker {
 160         pid_t pid;      /* Worker PID. */
 161         int sockpair[2];
 162         char *procname;
 163 };
 164
 165 /* Single global worker per process (for now). */
 166 static struct run_as_worker *global_worker;
 167 /* Lock protecting the worker. */
 168 static pthread_mutex_t worker_lock = PTHREAD_MUTEX_INITIALIZER;
 169
 170 #ifdef VALGRIND
 171 static
 172 int use_clone(void)
 173 {
 174         return 0;
 175 }
 176 #else
 177 static
 178 int use_clone(void)
 179 {
 180         return !lttng_secure_getenv("LTTNG_DEBUG_NOCLONE");
 181 }
 182 #endif
 183
 184 LTTNG_HIDDEN
 185 int _utils_mkdir_recursive_unsafe(const char *path, mode_t mode);
 186
 187 /*
 188  * Create recursively directory using the FULL path.
 189  */
 190 static
 191 int _mkdir_recursive(struct run_as_data *data, struct run_as_ret *ret_value)
 192 {
 193         const char *path;
 194         mode_t mode;
 195
 196         path = data->u.mkdir.path;
 197         mode = data->u.mkdir.mode;
 198
 199         /* Safe to call as we have transitioned to the requested uid/gid. */
 200         ret_value->u.mkdir.ret = _utils_mkdir_recursive_unsafe(path, mode);
 201         ret_value->_errno = errno;
 202         ret_value->_error = (ret_value->u.mkdir.ret) ? true : false;
 203         return ret_value->u.mkdir.ret;
 204 }
 205
 206 static
 207 int _mkdir(struct run_as_data *data, struct run_as_ret *ret_value)
 208 {
 209         ret_value->u.mkdir.ret = mkdir(data->u.mkdir.path, data->u.mkdir.mode);
 210         ret_value->_errno = errno;
 211         ret_value->_error = (ret_value->u.mkdir.ret) ? true : false;
 212         return ret_value->u.mkdir.ret;
 213 }
 214
 215 static
 216 int _open(struct run_as_data *data, struct run_as_ret *ret_value)
 217 {
 218         ret_value->u.open.ret = open(data->u.open.path, data->u.open.flags, data->u.open.mode);
 219         ret_value->fd = ret_value->u.open.ret;
 220         ret_value->_errno = errno;
 221         ret_value->_error = (ret_value->u.open.ret) ? true : false;
 222         return ret_value->u.open.ret;
 223 }
 224
 225 static
 226 int _unlink(struct run_as_data *data, struct run_as_ret *ret_value)
 227 {
 228         ret_value->u.unlink.ret = unlink(data->u.unlink.path);
 229         ret_value->_errno = errno;
 230         ret_value->_error = (ret_value->u.unlink.ret) ? true : false;
 231         return ret_value->u.unlink.ret;
 232 }
 233
 234 static
 235 int _rmdir_recursive(struct run_as_data *data, struct run_as_ret *ret_value)
 236 {
 237         ret_value->u.rmdir_recursive.ret = utils_recursive_rmdir(data->u.rmdir_recursive.path);
 238         ret_value->_errno = errno;
 239         ret_value->_error = (ret_value->u.rmdir_recursive.ret) ? true : false;
 240         return ret_value->u.rmdir_recursive.ret;
 241 }
 242
 243 static
 244 int _extract_elf_symbol_offset(struct run_as_data *data,
 245                 struct run_as_ret *ret_value)
 246 {
 247         int ret = 0;
 248         ret_value->_error = false;
 249
 250         ret = lttng_elf_get_symbol_offset(data->fd,
 251                          data->u.extract_elf_symbol_offset.function,
 252                          &ret_value->u.extract_elf_symbol_offset.offset);
 253         if (ret) {
 254                 DBG("Failed to extract ELF function offset");
 255                 ret_value->_error = true;
 256         }
 257
 258         return ret;
 259 }
 260
 261 static
 262 int _extract_sdt_probe_offsets(struct run_as_data *data,
 263                 struct run_as_ret *ret_value)
 264 {
 265         int ret = 0;
 266         uint64_t *offsets = NULL;
 267         uint32_t num_offset;
 268
 269         ret_value->_error = false;
 270
 271         /* On success, this call allocates the offsets paramater. */
 272         ret = lttng_elf_get_sdt_probe_offsets(data->fd,
 273                         data->u.extract_sdt_probe_offsets.provider_name,
 274                         data->u.extract_sdt_probe_offsets.probe_name,
 275                         &offsets, &num_offset);
 276
 277         if (ret) {
 278                 DBG("Failed to extract SDT probe offsets");
 279                 ret_value->_error = true;
 280                 goto end;
 281         }
 282
 283         if (num_offset <= 0 || num_offset > LTTNG_KERNEL_MAX_UPROBE_NUM) {
 284                 DBG("Wrong number of probes.");
 285                 ret = -1;
 286                 ret_value->_error = true;
 287                 goto free_offset;
 288         }
 289
 290         /* Copy the content of the offsets array to the ret struct. */
 291         memcpy(ret_value->u.extract_sdt_probe_offsets.offsets,
 292                         offsets, num_offset * sizeof(uint64_t));
 293
 294         ret_value->u.extract_sdt_probe_offsets.num_offset = num_offset;
 295
 296 free_offset:
 297         free(offsets);
 298 end:
 299         return ret;
 300 }
 301
 302 static
 303 run_as_fct run_as_enum_to_fct(enum run_as_cmd cmd)
 304 {
 305         switch (cmd) {
 306         case RUN_AS_MKDIR:
 307                 return _mkdir;
 308         case RUN_AS_OPEN:
 309                 return _open;
 310         case RUN_AS_UNLINK:
 311                 return _unlink;
 312         case RUN_AS_RMDIR_RECURSIVE:
 313                 return _rmdir_recursive;
 314         case RUN_AS_MKDIR_RECURSIVE:
 315                 return _mkdir_recursive;
 316         case RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET:
 317                 return _extract_elf_symbol_offset;
 318         case RUN_AS_EXTRACT_SDT_PROBE_OFFSETS:
 319                 return _extract_sdt_probe_offsets;
 320         default:
 321                 ERR("Unknown command %d", (int) cmd);
 322                 return NULL;
 323         }
 324 }
 325
 326 static
 327 int do_send_fd(int sock, int fd)
 328 {
 329         ssize_t len;
 330
 331         if (fd < 0) {
 332                 ERR("Invalid file description");
 333                 return 0;
 334         }
 335
 336         len = lttcomm_send_fds_unix_sock(sock, &fd, 1);
 337         if (len < 0) {
 338                 PERROR("lttcomm_send_fds_unix_sock");
 339                 return -1;
 340         }
 341         return 0;
 342 }
 343
 344 static
 345 int do_recv_fd(int sock, int *fd)
 346 {
 347         ssize_t len;
 348
 349         if (*fd < 0) {
 350                 ERR("Invalid file description");
 351                 return 0;
 352         }
 353
 354         len = lttcomm_recv_fds_unix_sock(sock, fd, 1);
 355
 356         if (!len) {
 357                 return -1;
 358         } else if (len < 0) {
 359                 PERROR("lttcomm_recv_fds_unix_sock");
 360                 return -1;
 361         }
 362         return 0;
 363 }
 364
 365 static
 366 int send_fd_to_worker(struct run_as_worker *worker, enum run_as_cmd cmd, int fd)
 367 {
 368         int ret = 0;
 369
 370         switch (cmd) {
 371         case RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET:
 372         case RUN_AS_EXTRACT_SDT_PROBE_OFFSETS:
 373                 break;
 374         default:
 375                 return 0;
 376         }
 377
 378         ret = do_send_fd(worker->sockpair[0], fd);
 379         if (ret < 0) {
 380                 PERROR("do_send_fd");
 381                 ret = -1;
 382         }
 383
 384         return ret;
 385 }
 386
 387 static
 388 int send_fd_to_master(struct run_as_worker *worker, enum run_as_cmd cmd, int fd)
 389 {
 390         int ret = 0, ret_close = 0;
 391
 392         switch (cmd) {
 393         case RUN_AS_OPEN:
 394                 break;
 395         default:
 396                 return 0;
 397         }
 398
 399         ret = do_send_fd(worker->sockpair[1], fd);
 400         if (ret < 0) {
 401                 PERROR("do_send_fd error");
 402                 ret = -1;
 403         }
 404
 405         ret_close = close(fd);
 406         if (ret_close < 0) {
 407                 PERROR("close");
 408         }
 409
 410         return ret;
 411 }
 412
 413 static
 414 int recv_fd_from_worker(struct run_as_worker *worker, enum run_as_cmd cmd, int *fd)
 415 {
 416         int ret = 0;
 417
 418         switch (cmd) {
 419         case RUN_AS_OPEN:
 420                 break;
 421         default:
 422                 return 0;
 423         }
 424
 425         ret = do_recv_fd(worker->sockpair[0], fd);
 426         if (ret < 0) {
 427                 PERROR("do_recv_fd error");
 428                 ret = -1;
 429         }
 430
 431         return ret;
 432 }
 433
 434 static
 435 int recv_fd_from_master(struct run_as_worker *worker, enum run_as_cmd cmd, int *fd)
 436 {
 437         int ret = 0;
 438
 439         switch (cmd) {
 440         case RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET:
 441         case RUN_AS_EXTRACT_SDT_PROBE_OFFSETS:
 442                 break;
 443         default:
 444                 return 0;
 445         }
 446
 447         ret = do_recv_fd(worker->sockpair[1], fd);
 448         if (ret < 0) {
 449                 PERROR("do_recv_fd error");
 450                 ret = -1;
 451         }
 452
 453         return ret;
 454 }
 455
 456 static
 457 int cleanup_received_fd(enum run_as_cmd cmd, int fd)
 458 {
 459         int ret = 0;
 460
 461         switch (cmd) {
 462         case RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET:
 463         case RUN_AS_EXTRACT_SDT_PROBE_OFFSETS:
 464                 break;
 465         default:
 466                 return 0;
 467         }
 468
 469         ret = close(fd);
 470         if (ret < 0) {
 471                 PERROR("close error");
 472                 ret = -1;
 473         }
 474
 475         return ret;
 476 }
 477
 478 /*
 479  * Return < 0 on error, 0 if OK, 1 on hangup.
 480  */
 481 static
 482 int handle_one_cmd(struct run_as_worker *worker)
 483 {
 484         int ret = 0;
 485         struct run_as_data data;
 486         ssize_t readlen, writelen;
 487         struct run_as_ret sendret;
 488         run_as_fct cmd;
 489         uid_t prev_euid;
 490
 491         /*
 492          * Stage 1: Receive run_as_data struct from the master.
 493          * The structure contains the command type and all the parameters needed for
 494          * its execution
 495          */
 496         readlen = lttcomm_recv_unix_sock(worker->sockpair[1], &data,
 497                         sizeof(data));
 498         if (readlen == 0) {
 499                 /* hang up */
 500                 ret = 1;
 501                 goto end;
 502         }
 503         if (readlen < sizeof(data)) {
 504                 PERROR("lttcomm_recv_unix_sock error");
 505                 ret = -1;
 506                 goto end;
 507         }
 508
 509         cmd = run_as_enum_to_fct(data.cmd);
 510         if (!cmd) {
 511                 ret = -1;
 512                 goto end;
 513         }
 514
 515         /*
 516          * Stage 2: Receive file descriptor from master.
 517          * Some commands need a file descriptor as input so if it's needed we
 518          * receive the fd using the Unix socket.
 519          */
 520         ret = recv_fd_from_master(worker, data.cmd, &data.fd);
 521         if (ret < 0) {
 522                 PERROR("recv_fd_from_master error");
 523                 ret = -1;
 524                 goto end;
 525         }
 526
 527         prev_euid = getuid();
 528         if (data.gid != getegid()) {
 529                 ret = setegid(data.gid);
 530                 if (ret < 0) {
 531                         PERROR("setegid");
 532                         goto write_return;
 533                 }
 534         }
 535         if (data.uid != prev_euid) {
 536                 ret = seteuid(data.uid);
 537                 if (ret < 0) {
 538                         PERROR("seteuid");
 539                         goto write_return;
 540                 }
 541         }
 542
 543         /*
 544          * Also set umask to 0 for mkdir executable bit.
 545          */
 546         umask(0);
 547
 548         /*
 549          * Stage 3: Execute the command
 550          */
 551         ret = (*cmd)(&data, &sendret);
 552         if (ret < 0) {
 553                 DBG("Execution of command returned an error");
 554         }
 555
 556 write_return:
 557         ret = cleanup_received_fd(data.cmd, data.fd);
 558         if (ret < 0) {
 559                 ERR("Error cleaning up FD");
 560                 goto end;
 561         }
 562
 563         /*
 564          * Stage 4: Send run_as_ret structure to the master.
 565          * This structure contain the return value of the command and the errno.
 566          */
 567         writelen = lttcomm_send_unix_sock(worker->sockpair[1], &sendret,
 568                         sizeof(sendret));
 569         if (writelen < sizeof(sendret)) {
 570                 PERROR("lttcomm_send_unix_sock error");
 571                 ret = -1;
 572                 goto end;
 573         }
 574
 575         /*
 576          * Stage 5: Send file descriptor to the master
 577          * Some commands return a file descriptor so if it's needed we pass it back
 578          * to the master using the Unix socket.
 579          */
 580         ret = send_fd_to_master(worker, data.cmd, sendret.fd);
 581         if (ret < 0) {
 582                 DBG("Sending FD to master returned an error");
 583                 goto end;
 584         }
 585
 586         if (seteuid(prev_euid) < 0) {
 587                 PERROR("seteuid");
 588                 ret = -1;
 589                 goto end;
 590         }
 591         ret = 0;
 592 end:
 593         return ret;
 594 }
 595
 596 static
 597 int run_as_worker(struct run_as_worker *worker)
 598 {
 599         int ret;
 600         ssize_t writelen;
 601         struct run_as_ret sendret;
 602         size_t proc_orig_len;
 603
 604         /*
 605          * Initialize worker. Set a different process cmdline.
 606          */
 607         proc_orig_len = strlen(worker->procname);
 608         memset(worker->procname, 0, proc_orig_len);
 609         strncpy(worker->procname, DEFAULT_RUN_AS_WORKER_NAME, proc_orig_len);
 610
 611         ret = lttng_prctl(PR_SET_NAME,
 612                         (unsigned long) DEFAULT_RUN_AS_WORKER_NAME, 0, 0, 0);
 613         if (ret && ret != -ENOSYS) {
 614                 /* Don't fail as this is not essential. */
 615                 PERROR("prctl PR_SET_NAME");
 616         }
 617
 618         memset(&sendret, 0, sizeof(sendret));
 619
 620         writelen = lttcomm_send_unix_sock(worker->sockpair[1], &sendret,
 621                         sizeof(sendret));
 622         if (writelen < sizeof(sendret)) {
 623                 PERROR("lttcomm_send_unix_sock error");
 624                 ret = EXIT_FAILURE;
 625                 goto end;
 626         }
 627
 628         for (;;) {
 629                 ret = handle_one_cmd(worker);
 630                 if (ret < 0) {
 631                         ret = EXIT_FAILURE;
 632                         goto end;
 633                 } else if (ret > 0) {
 634                         break;
 635                 } else {
 636                         continue;       /* Next command. */
 637                 }
 638         }
 639         ret = EXIT_SUCCESS;
 640 end:
 641         return ret;
 642 }
 643
 644 static
 645 int run_as_cmd(struct run_as_worker *worker,
 646                 enum run_as_cmd cmd,
 647                 struct run_as_data *data,
 648                 struct run_as_ret *ret_value,
 649                 uid_t uid, gid_t gid)
 650 {
 651         int ret = 0;
 652         ssize_t readlen, writelen;
 653
 654         /*
 655          * If we are non-root, we can only deal with our own uid.
 656          */
 657         if (geteuid() != 0) {
 658                 if (uid != geteuid()) {
 659                         ret = -1;
 660                         ret_value->_errno = EPERM;
 661                         ERR("Client (%d)/Server (%d) UID mismatch (and sessiond is not root)",
 662                                 (int) uid, (int) geteuid());
 663                         goto end;
 664                 }
 665         }
 666
 667         data->cmd = cmd;
 668         data->uid = uid;
 669         data->gid = gid;
 670
 671         /*
 672          * Stage 1: Send the run_as_data struct to the worker process
 673          */
 674         writelen = lttcomm_send_unix_sock(worker->sockpair[0], data,
 675                         sizeof(*data));
 676         if (writelen < sizeof(*data)) {
 677                 PERROR("Error writing message to run_as");
 678                 ret = -1;
 679                 ret_value->_errno = EIO;
 680                 goto end;
 681         }
 682
 683         /*
 684          * Stage 2: Send file descriptor to the worker process if needed
 685          */
 686         ret = send_fd_to_worker(worker, data->cmd, data->fd);
 687         if (ret) {
 688                 PERROR("do_send_fd error");
 689                 ret = -1;
 690                 ret_value->_errno = EIO;
 691                 goto end;
 692         }
 693
 694         /*
 695          * Stage 3: Wait for the execution of the command
 696          */
 697
 698         /*
 699          * Stage 4: Receive the run_as_ret struct containing the return value and
 700          * errno
 701          */
 702         readlen = lttcomm_recv_unix_sock(worker->sockpair[0], ret_value,
 703                         sizeof(*ret_value));
 704         if (!readlen) {
 705                 ERR("Run-as worker has hung-up during run_as_cmd");
 706                 ret = -1;
 707                 ret_value->_errno = EIO;
 708                 goto end;
 709         } else if (readlen < sizeof(*ret_value)) {
 710                 PERROR("Error reading response from run_as");
 711                 ret = -1;
 712                 ret_value->_errno = errno;
 713                 goto end;
 714         }
 715
 716         /*
 717          * Stage 5: Receive file descriptor if needed
 718          */
 719         ret = recv_fd_from_worker(worker, data->cmd, &ret_value->fd);
 720         if (ret < 0) {
 721                 ERR("Error receiving fd");
 722                 ret = -1;
 723                 ret_value->_errno = EIO;
 724         }
 725
 726 end:
 727         return ret;
 728 }
 729
 730 /*
 731  * This is for debugging ONLY and should not be considered secure.
 732  */
 733 static
 734 int run_as_noworker(enum run_as_cmd cmd,
 735                 struct run_as_data *data, struct run_as_ret *ret_value,
 736                 uid_t uid, gid_t gid)
 737 {
 738         int ret, saved_errno;
 739         mode_t old_mask;
 740         run_as_fct fct;
 741
 742         fct = run_as_enum_to_fct(cmd);
 743         if (!fct) {
 744                 errno = -ENOSYS;
 745                 ret = -1;
 746                 goto end;
 747         }
 748         old_mask = umask(0);
 749         ret = fct(data, ret_value);
 750         saved_errno = ret_value->_errno;
 751         umask(old_mask);
 752         errno = saved_errno;
 753 end:
 754         return ret;
 755 }
 756
 757 static
 758 int run_as_restart_worker(struct run_as_worker *worker)
 759 {
 760         int ret = 0;
 761         char *procname = NULL;
 762
 763         procname = worker->procname;
 764
 765         /* Close socket to run_as worker process and clean up the zombie process */
 766         run_as_destroy_worker();
 767
 768         /* Create a new run_as worker process*/
 769         ret = run_as_create_worker(procname);
 770         if (ret < 0 ) {
 771                 ERR("Restarting the worker process failed");
 772                 ret = -1;
 773                 goto err;
 774         }
 775 err:
 776         return ret;
 777 }
 778
 779 static
 780 int run_as(enum run_as_cmd cmd, struct run_as_data *data,
 781                    struct run_as_ret *ret_value, uid_t uid, gid_t gid)
 782 {
 783         int ret, saved_errno;
 784
 785         if (use_clone()) {
 786                 DBG("Using run_as worker");
 787                 pthread_mutex_lock(&worker_lock);
 788                 assert(global_worker);
 789
 790                 ret = run_as_cmd(global_worker, cmd, data, ret_value, uid, gid);
 791                 saved_errno = ret_value->_errno;
 792
 793                 pthread_mutex_unlock(&worker_lock);
 794                 /*
 795                  * If the worker thread crashed the errno is set to EIO. we log
 796                  * the error and  start a new worker process.
 797                  */
 798                 if (ret == -1 && saved_errno == EIO) {
 799                         DBG("Socket closed unexpectedly... "
 800                                         "Restarting the worker process");
 801                         ret = run_as_restart_worker(global_worker);
 802
 803                         if (ret == -1) {
 804                                 ERR("Failed to restart worker process.");
 805                                 goto err;
 806                         }
 807                 }
 808         } else {
 809                 DBG("Using run_as without worker");
 810                 ret = run_as_noworker(cmd, data, ret_value, uid, gid);
 811         }
 812 err:
 813         return ret;
 814 }
 815
 816 LTTNG_HIDDEN
 817 int run_as_mkdir_recursive(const char *path, mode_t mode, uid_t uid, gid_t gid)
 818 {
 819         struct run_as_data data;
 820         struct run_as_ret ret;
 821
 822         memset(&data, 0, sizeof(data));
 823         memset(&ret, 0, sizeof(ret));
 824         DBG3("mkdir() recursive %s with mode %d for uid %d and gid %d",
 825                         path, (int) mode, (int) uid, (int) gid);
 826         strncpy(data.u.mkdir.path, path, PATH_MAX - 1);
 827         data.u.mkdir.path[PATH_MAX - 1] = '\0';
 828         data.u.mkdir.mode = mode;
 829
 830         run_as(RUN_AS_MKDIR_RECURSIVE, &data, &ret, uid, gid);
 831         errno = ret._errno;
 832         return ret.u.mkdir.ret;
 833 }
 834
 835 LTTNG_HIDDEN
 836 int run_as_mkdir(const char *path, mode_t mode, uid_t uid, gid_t gid)
 837 {
 838         struct run_as_data data;
 839         struct run_as_ret ret;
 840
 841         memset(&data, 0, sizeof(data));
 842         memset(&ret, 0, sizeof(ret));
 843
 844         DBG3("mkdir() %s with mode %d for uid %d and gid %d",
 845                         path, (int) mode, (int) uid, (int) gid);
 846         strncpy(data.u.mkdir.path, path, PATH_MAX - 1);
 847         data.u.mkdir.path[PATH_MAX - 1] = '\0';
 848         data.u.mkdir.mode = mode;
 849         run_as(RUN_AS_MKDIR, &data, &ret, uid, gid);
 850         errno = ret._errno;
 851         return ret.u.mkdir.ret;
 852 }
 853
 854 LTTNG_HIDDEN
 855 int run_as_open(const char *path, int flags, mode_t mode, uid_t uid, gid_t gid)
 856 {
 857         struct run_as_data data;
 858         struct run_as_ret ret;
 859
 860         memset(&data, 0, sizeof(data));
 861         memset(&ret, 0, sizeof(ret));
 862
 863         DBG3("open() %s with flags %X mode %d for uid %d and gid %d",
 864                         path, flags, (int) mode, (int) uid, (int) gid);
 865         strncpy(data.u.open.path, path, PATH_MAX - 1);
 866         data.u.open.path[PATH_MAX - 1] = '\0';
 867         data.u.open.flags = flags;
 868         data.u.open.mode = mode;
 869         run_as(RUN_AS_OPEN, &data, &ret, uid, gid);
 870         errno = ret._errno;
 871         ret.u.open.ret = ret.fd;
 872         return ret.u.open.ret;
 873 }
 874
 875 LTTNG_HIDDEN
 876 int run_as_unlink(const char *path, uid_t uid, gid_t gid)
 877 {
 878         struct run_as_data data;
 879         struct run_as_ret ret;
 880
 881         memset(&data, 0, sizeof(data));
 882         memset(&ret, 0, sizeof(ret));
 883
 884         DBG3("unlink() %s with for uid %d and gid %d",
 885                         path, (int) uid, (int) gid);
 886         strncpy(data.u.unlink.path, path, PATH_MAX - 1);
 887         data.u.unlink.path[PATH_MAX - 1] = '\0';
 888         run_as(RUN_AS_UNLINK, &data, &ret, uid, gid);
 889         errno = ret._errno;
 890         return ret.u.unlink.ret;
 891 }
 892
 893 LTTNG_HIDDEN
 894 int run_as_rmdir_recursive(const char *path, uid_t uid, gid_t gid)
 895 {
 896         struct run_as_data data;
 897         struct run_as_ret ret;
 898
 899         memset(&data, 0, sizeof(data));
 900         memset(&ret, 0, sizeof(ret));
 901
 902         DBG3("rmdir_recursive() %s with for uid %d and gid %d",
 903                         path, (int) uid, (int) gid);
 904         strncpy(data.u.rmdir_recursive.path, path, PATH_MAX - 1);
 905         data.u.rmdir_recursive.path[PATH_MAX - 1] = '\0';
 906         run_as(RUN_AS_RMDIR_RECURSIVE, &data, &ret, uid, gid);
 907         errno = ret._errno;
 908         return ret.u.rmdir_recursive.ret;
 909 }
 910
 911 LTTNG_HIDDEN
 912 int run_as_extract_elf_symbol_offset(int fd, const char* function,
 913                 uid_t uid, gid_t gid, uint64_t *offset)
 914 {
 915         struct run_as_data data;
 916         struct run_as_ret ret;
 917
 918         DBG3("extract_elf_symbol_offset() on fd=%d and function=%s "
 919                 "with for uid %d and gid %d", fd, function, (int) uid, (int) gid);
 920
 921         data.fd = fd;
 922
 923         strncpy(data.u.extract_elf_symbol_offset.function, function, LTTNG_SYMBOL_NAME_LEN - 1);
 924
 925         data.u.extract_elf_symbol_offset.function[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 926
 927         run_as(RUN_AS_EXTRACT_ELF_SYMBOL_OFFSET, &data, &ret, uid, gid);
 928
 929         errno = ret._errno;
 930
 931         if (ret._error) {
 932                 return -1;
 933         }
 934
 935         *offset = ret.u.extract_elf_symbol_offset.offset;
 936         return 0;
 937 }
 938
 939 LTTNG_HIDDEN
 940 int run_as_extract_sdt_probe_offsets(int fd, const char* provider_name,
 941                 const char* probe_name, uid_t uid, gid_t gid,
 942                 uint64_t **offsets, uint32_t *num_offset)
 943 {
 944         struct run_as_data data;
 945         struct run_as_ret ret;
 946
 947         DBG3("extract_sdt_probe_offsets() on fd=%d, probe_name=%s and "
 948                 "provider_name=%s with for uid %d and gid %d", fd, probe_name,
 949                 provider_name, (int) uid, (int) gid);
 950
 951         data.fd = fd;
 952
 953         strncpy(data.u.extract_sdt_probe_offsets.probe_name, probe_name, LTTNG_SYMBOL_NAME_LEN - 1);
 954         strncpy(data.u.extract_sdt_probe_offsets.provider_name, provider_name, LTTNG_SYMBOL_NAME_LEN - 1);
 955
 956         data.u.extract_sdt_probe_offsets.probe_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 957         data.u.extract_sdt_probe_offsets.provider_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
 958
 959         run_as(RUN_AS_EXTRACT_SDT_PROBE_OFFSETS, &data, &ret, uid, gid);
 960
 961         errno = ret._errno;
 962
 963         if (ret._error) {
 964                 return -1;
 965         }
 966
 967         *num_offset = ret.u.extract_sdt_probe_offsets.num_offset;
 968
 969         *offsets = zmalloc(*num_offset * sizeof(uint64_t));
 970         if (!*offsets) {
 971                 return -ENOMEM;
 972         }
 973
 974         memcpy(*offsets, ret.u.extract_sdt_probe_offsets.offsets, *num_offset * sizeof(uint64_t));
 975         return 0;
 976 }
 977
 978 static
 979 int reset_sighandler(void)
 980 {
 981         int sig;
 982
 983         DBG("Resetting run_as worker signal handlers to default");
 984         for (sig = 1; sig <= 31; sig++) {
 985                 (void) signal(sig, SIG_DFL);
 986         }
 987         return 0;
 988 }
 989
 990 static
 991 void worker_sighandler(int sig)
 992 {
 993         const char *signame;
 994
 995         /*
 996          * The worker will inherit its parent's signals since they are part of
 997          * the same process group. However, in the case of SIGINT and SIGTERM,
 998          * we want to give the worker a chance to teardown gracefully when its
 999          * parent closes the command socket.
1000          */
1001         switch (sig) {
1002         case SIGINT:
1003                 signame = "SIGINT";
1004                 break;
1005         case SIGTERM:
1006                 signame = "SIGTERM";
1007                 break;
1008         default:
1009                 signame = NULL;
1010         }
1011
1012         if (signame) {
1013                 DBG("run_as worker received signal %s", signame);
1014         } else {
1015                 DBG("run_as_worker received signal %d", sig);
1016         }
1017 }
1018
1019 static
1020 int set_worker_sighandlers(void)
1021 {
1022         int ret = 0;
1023         sigset_t sigset;
1024         struct sigaction sa;
1025
1026         if ((ret = sigemptyset(&sigset)) < 0) {
1027                 PERROR("sigemptyset");
1028                 goto end;
1029         }
1030
1031         sa.sa_handler = worker_sighandler;
1032         sa.sa_mask = sigset;
1033         sa.sa_flags = 0;
1034         if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
1035                 PERROR("sigaction SIGINT");
1036                 goto end;
1037         }
1038
1039         if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
1040                 PERROR("sigaction SIGTERM");
1041                 goto end;
1042         }
1043
1044         DBG("run_as signal handler set for SIGTERM and SIGINT");
1045 end:
1046         return ret;
1047 }
1048
1049 LTTNG_HIDDEN
1050 int run_as_create_worker(char *procname)
1051 {
1052         pid_t pid;
1053         int i, ret = 0;
1054         ssize_t readlen;
1055         struct run_as_ret recvret;
1056         struct run_as_worker *worker;
1057
1058         pthread_mutex_lock(&worker_lock);
1059         assert(!global_worker);
1060         if (!use_clone()) {
1061                 /*
1062                  * Don't initialize a worker, all run_as tasks will be performed
1063                  * in the current process.
1064                  */
1065                 ret = 0;
1066                 goto end;
1067         }
1068         worker = zmalloc(sizeof(*worker));
1069         if (!worker) {
1070                 ret = -ENOMEM;
1071                 goto end;
1072         }
1073         worker->procname = procname;
1074         /* Create unix socket. */
1075         if (lttcomm_create_anon_unix_socketpair(worker->sockpair) < 0) {
1076                 ret = -1;
1077                 goto error_sock;
1078         }
1079
1080         /* Fork worker. */
1081         pid = fork();
1082         if (pid < 0) {
1083                 PERROR("fork");
1084                 ret = -1;
1085                 goto error_fork;
1086         } else if (pid == 0) {
1087                 /* Child */
1088
1089                 reset_sighandler();
1090
1091                 set_worker_sighandlers();
1092
1093                 /* The child has no use for this lock. */
1094                 pthread_mutex_unlock(&worker_lock);
1095                 /* Just close, no shutdown. */
1096                 if (close(worker->sockpair[0])) {
1097                         PERROR("close");
1098                         exit(EXIT_FAILURE);
1099                 }
1100
1101                 /*
1102                  * Close all FDs aside from STDIN, STDOUT, STDERR and sockpair[1]
1103                  * Sockpair[1] is used as a control channel with the master
1104                  */
1105                 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
1106                         if (i != worker->sockpair[1]) {
1107                                 (void) close(i);
1108                         }
1109                 }
1110
1111                 worker->sockpair[0] = -1;
1112                 ret = run_as_worker(worker);
1113                 if (lttcomm_close_unix_sock(worker->sockpair[1])) {
1114                         PERROR("close");
1115                         ret = -1;
1116                 }
1117                 worker->sockpair[1] = -1;
1118                 LOG(ret ? PRINT_ERR : PRINT_DBG, "run_as worker exiting (ret = %d)", ret);
1119                 exit(ret ? EXIT_FAILURE : EXIT_SUCCESS);
1120         } else {
1121                 /* Parent */
1122
1123                 /* Just close, no shutdown. */
1124                 if (close(worker->sockpair[1])) {
1125                         PERROR("close");
1126                         ret = -1;
1127                         goto error_fork;
1128                 }
1129                 worker->sockpair[1] = -1;
1130                 worker->pid = pid;
1131                 /* Wait for worker to become ready. */
1132                 readlen = lttcomm_recv_unix_sock(worker->sockpair[0],
1133                                 &recvret, sizeof(recvret));
1134                 if (readlen < sizeof(recvret)) {
1135                         ERR("readlen: %zd", readlen);
1136                         PERROR("Error reading response from run_as at creation");
1137                         ret = -1;
1138                         goto error_fork;
1139                 }
1140                 global_worker = worker;
1141         }
1142 end:
1143         pthread_mutex_unlock(&worker_lock);
1144         return ret;
1145
1146         /* Error handling. */
1147 error_fork:
1148         for (i = 0; i < 2; i++) {
1149                 if (worker->sockpair[i] < 0) {
1150                         continue;
1151                 }
1152                 if (lttcomm_close_unix_sock(worker->sockpair[i])) {
1153                         PERROR("close");
1154                 }
1155                 worker->sockpair[i] = -1;
1156         }
1157 error_sock:
1158         free(worker);
1159         pthread_mutex_unlock(&worker_lock);
1160         return ret;
1161 }
1162
1163 LTTNG_HIDDEN
1164 void run_as_destroy_worker(void)
1165 {
1166         struct run_as_worker *worker = global_worker;
1167
1168         DBG("Destroying run_as worker");
1169         pthread_mutex_lock(&worker_lock);
1170         if (!worker) {
1171                 goto end;
1172         }
1173         /* Close unix socket */
1174         DBG("Closing run_as worker socket");
1175         if (lttcomm_close_unix_sock(worker->sockpair[0])) {
1176                 PERROR("close");
1177         }
1178         worker->sockpair[0] = -1;
1179         /* Wait for worker. */
1180         for (;;) {
1181                 int status;
1182                 pid_t wait_ret;
1183
1184                 wait_ret = waitpid(worker->pid, &status, 0);
1185                 if (wait_ret < 0) {
1186                         if (errno == EINTR) {
1187                                 continue;
1188                         }
1189                         PERROR("waitpid");
1190                         break;
1191                 }
1192
1193                 if (WIFEXITED(status)) {
1194                         LOG(WEXITSTATUS(status) == 0 ? PRINT_DBG : PRINT_ERR,
1195                                         DEFAULT_RUN_AS_WORKER_NAME " terminated with status code %d",
1196                                         WEXITSTATUS(status));
1197                         break;
1198                 } else if (WIFSIGNALED(status)) {
1199                         ERR(DEFAULT_RUN_AS_WORKER_NAME " was killed by signal %d",
1200                                         WTERMSIG(status));
1201                         break;
1202                 }
1203         }
1204         free(worker);
1205         global_worker = NULL;
1206 end:
1207         pthread_mutex_unlock(&worker_lock);
1208 }