lttng-abi.c

   1 /*
   2  * lttng-abi.c
   3  *
   4  * LTTng ABI
   5  *
   6  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; only
  11  * version 2.1 of the License.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  21  *
  22  *
  23  * Mimic system calls for:
  24  * - session creation, returns a file descriptor or failure.
  25  *   - channel creation, returns a file descriptor or failure.
  26  *     - Operates on a session file descriptor
  27  *     - Takes all channel options as parameters.
  28  *   - stream get, returns a file descriptor or failure.
  29  *     - Operates on a channel file descriptor.
  30  *   - stream notifier get, returns a file descriptor or failure.
  31  *     - Operates on a channel file descriptor.
  32  *   - event creation, returns a file descriptor or failure.
  33  *     - Operates on a channel file descriptor
  34  *     - Takes an event name as parameter
  35  *     - Takes an instrumentation source as parameter
  36  *       - e.g. tracepoints, dynamic_probes...
  37  *     - Takes instrumentation source specific arguments.
  38  */
  39
  40 #include <linux/module.h>
  41 #include <linux/proc_fs.h>
  42 #include <linux/anon_inodes.h>
  43 #include <linux/file.h>
  44 #include <linux/uaccess.h>
  45 #include <linux/slab.h>
  46 #include <linux/err.h>
  47 #include <wrapper/vmalloc.h>    /* for wrapper_vmalloc_sync_all() */
  48 #include <wrapper/ringbuffer/vfs.h>
  49 #include <wrapper/ringbuffer/backend.h>
  50 #include <wrapper/ringbuffer/frontend.h>
  51 #include <wrapper/poll.h>
  52 #include <wrapper/file.h>
  53 #include <wrapper/kref.h>
  54 #include <lttng-abi.h>
  55 #include <lttng-abi-old.h>
  56 #include <lttng-events.h>
  57 #include <lttng-tracer.h>
  58 #include <lib/ringbuffer/frontend_types.h>
  59
  60 /*
  61  * This is LTTng's own personal way to create a system call as an external
  62  * module. We use ioctl() on /proc/lttng.
  63  */
  64
  65 static struct proc_dir_entry *lttng_proc_dentry;
  66 static const struct file_operations lttng_fops;
  67 static const struct file_operations lttng_session_fops;
  68 static const struct file_operations lttng_channel_fops;
  69 static const struct file_operations lttng_metadata_fops;
  70 static const struct file_operations lttng_event_fops;
  71 static struct file_operations lttng_stream_ring_buffer_file_operations;
  72
  73 static int put_u64(uint64_t val, unsigned long arg);
  74
  75 /*
  76  * Teardown management: opened file descriptors keep a refcount on the module,
  77  * so it can only exit when all file descriptors are closed.
  78  */
  79
  80 static
  81 int lttng_abi_create_session(void)
  82 {
  83         struct lttng_session *session;
  84         struct file *session_file;
  85         int session_fd, ret;
  86
  87         session = lttng_session_create();
  88         if (!session)
  89                 return -ENOMEM;
  90         session_fd = lttng_get_unused_fd();
  91         if (session_fd < 0) {
  92                 ret = session_fd;
  93                 goto fd_error;
  94         }
  95         session_file = anon_inode_getfile("[lttng_session]",
  96                                           &lttng_session_fops,
  97                                           session, O_RDWR);
  98         if (IS_ERR(session_file)) {
  99                 ret = PTR_ERR(session_file);
 100                 goto file_error;
 101         }
 102         session->file = session_file;
 103         fd_install(session_fd, session_file);
 104         return session_fd;
 105
 106 file_error:
 107         put_unused_fd(session_fd);
 108 fd_error:
 109         lttng_session_destroy(session);
 110         return ret;
 111 }
 112
 113 static
 114 int lttng_abi_tracepoint_list(void)
 115 {
 116         struct file *tracepoint_list_file;
 117         int file_fd, ret;
 118
 119         file_fd = lttng_get_unused_fd();
 120         if (file_fd < 0) {
 121                 ret = file_fd;
 122                 goto fd_error;
 123         }
 124
 125         tracepoint_list_file = anon_inode_getfile("[lttng_tracepoint_list]",
 126                                           &lttng_tracepoint_list_fops,
 127                                           NULL, O_RDWR);
 128         if (IS_ERR(tracepoint_list_file)) {
 129                 ret = PTR_ERR(tracepoint_list_file);
 130                 goto file_error;
 131         }
 132         ret = lttng_tracepoint_list_fops.open(NULL, tracepoint_list_file);
 133         if (ret < 0)
 134                 goto open_error;
 135         fd_install(file_fd, tracepoint_list_file);
 136         return file_fd;
 137
 138 open_error:
 139         fput(tracepoint_list_file);
 140 file_error:
 141         put_unused_fd(file_fd);
 142 fd_error:
 143         return ret;
 144 }
 145
 146 #ifndef CONFIG_HAVE_SYSCALL_TRACEPOINTS
 147 static inline
 148 int lttng_abi_syscall_list(void)
 149 {
 150         return -ENOSYS;
 151 }
 152 #else
 153 static
 154 int lttng_abi_syscall_list(void)
 155 {
 156         struct file *syscall_list_file;
 157         int file_fd, ret;
 158
 159         file_fd = lttng_get_unused_fd();
 160         if (file_fd < 0) {
 161                 ret = file_fd;
 162                 goto fd_error;
 163         }
 164
 165         syscall_list_file = anon_inode_getfile("[lttng_syscall_list]",
 166                                           &lttng_syscall_list_fops,
 167                                           NULL, O_RDWR);
 168         if (IS_ERR(syscall_list_file)) {
 169                 ret = PTR_ERR(syscall_list_file);
 170                 goto file_error;
 171         }
 172         ret = lttng_syscall_list_fops.open(NULL, syscall_list_file);
 173         if (ret < 0)
 174                 goto open_error;
 175         fd_install(file_fd, syscall_list_file);
 176         return file_fd;
 177
 178 open_error:
 179         fput(syscall_list_file);
 180 file_error:
 181         put_unused_fd(file_fd);
 182 fd_error:
 183         return ret;
 184 }
 185 #endif
 186
 187 static
 188 void lttng_abi_tracer_version(struct lttng_kernel_tracer_version *v)
 189 {
 190         v->major = LTTNG_MODULES_MAJOR_VERSION;
 191         v->minor = LTTNG_MODULES_MINOR_VERSION;
 192         v->patchlevel = LTTNG_MODULES_PATCHLEVEL_VERSION;
 193 }
 194
 195 static
 196 void lttng_abi_tracer_abi_version(struct lttng_kernel_tracer_abi_version *v)
 197 {
 198         v->major = LTTNG_MODULES_ABI_MAJOR_VERSION;
 199         v->minor = LTTNG_MODULES_ABI_MINOR_VERSION;
 200 }
 201
 202 static
 203 long lttng_abi_add_context(struct file *file,
 204         struct lttng_kernel_context *context_param,
 205         struct lttng_ctx **ctx, struct lttng_session *session)
 206 {
 207
 208         if (session->been_active)
 209                 return -EPERM;
 210
 211         switch (context_param->ctx) {
 212         case LTTNG_KERNEL_CONTEXT_PID:
 213                 return lttng_add_pid_to_ctx(ctx);
 214         case LTTNG_KERNEL_CONTEXT_PRIO:
 215                 return lttng_add_prio_to_ctx(ctx);
 216         case LTTNG_KERNEL_CONTEXT_NICE:
 217                 return lttng_add_nice_to_ctx(ctx);
 218         case LTTNG_KERNEL_CONTEXT_VPID:
 219                 return lttng_add_vpid_to_ctx(ctx);
 220         case LTTNG_KERNEL_CONTEXT_TID:
 221                 return lttng_add_tid_to_ctx(ctx);
 222         case LTTNG_KERNEL_CONTEXT_VTID:
 223                 return lttng_add_vtid_to_ctx(ctx);
 224         case LTTNG_KERNEL_CONTEXT_PPID:
 225                 return lttng_add_ppid_to_ctx(ctx);
 226         case LTTNG_KERNEL_CONTEXT_VPPID:
 227                 return lttng_add_vppid_to_ctx(ctx);
 228         case LTTNG_KERNEL_CONTEXT_PERF_COUNTER:
 229                 context_param->u.perf_counter.name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
 230                 return lttng_add_perf_counter_to_ctx(context_param->u.perf_counter.type,
 231                                 context_param->u.perf_counter.config,
 232                                 context_param->u.perf_counter.name,
 233                                 ctx);
 234         case LTTNG_KERNEL_CONTEXT_PROCNAME:
 235                 return lttng_add_procname_to_ctx(ctx);
 236         case LTTNG_KERNEL_CONTEXT_HOSTNAME:
 237                 return lttng_add_hostname_to_ctx(ctx);
 238         case LTTNG_KERNEL_CONTEXT_CPU_ID:
 239                 return lttng_add_cpu_id_to_ctx(ctx);
 240         case LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE:
 241                 return lttng_add_interruptible_to_ctx(ctx);
 242         case LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE:
 243                 return lttng_add_need_reschedule_to_ctx(ctx);
 244         case LTTNG_KERNEL_CONTEXT_PREEMPTIBLE:
 245                 return lttng_add_preemptible_to_ctx(ctx);
 246         case LTTNG_KERNEL_CONTEXT_MIGRATABLE:
 247                 return lttng_add_migratable_to_ctx(ctx);
 248         default:
 249                 return -EINVAL;
 250         }
 251 }
 252
 253 /**
 254  *      lttng_ioctl - lttng syscall through ioctl
 255  *
 256  *      @file: the file
 257  *      @cmd: the command
 258  *      @arg: command arg
 259  *
 260  *      This ioctl implements lttng commands:
 261  *      LTTNG_KERNEL_SESSION
 262  *              Returns a LTTng trace session file descriptor
 263  *      LTTNG_KERNEL_TRACER_VERSION
 264  *              Returns the LTTng kernel tracer version
 265  *      LTTNG_KERNEL_TRACEPOINT_LIST
 266  *              Returns a file descriptor listing available tracepoints
 267  *      LTTNG_KERNEL_WAIT_QUIESCENT
 268  *              Returns after all previously running probes have completed
 269  *      LTTNG_KERNEL_TRACER_ABI_VERSION
 270  *              Returns the LTTng kernel tracer ABI version
 271  *
 272  * The returned session will be deleted when its file descriptor is closed.
 273  */
 274 static
 275 long lttng_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 276 {
 277         switch (cmd) {
 278         case LTTNG_KERNEL_OLD_SESSION:
 279         case LTTNG_KERNEL_SESSION:
 280                 return lttng_abi_create_session();
 281         case LTTNG_KERNEL_OLD_TRACER_VERSION:
 282         {
 283                 struct lttng_kernel_tracer_version v;
 284                 struct lttng_kernel_old_tracer_version oldv;
 285                 struct lttng_kernel_old_tracer_version *uversion =
 286                         (struct lttng_kernel_old_tracer_version __user *) arg;
 287
 288                 lttng_abi_tracer_version(&v);
 289                 oldv.major = v.major;
 290                 oldv.minor = v.minor;
 291                 oldv.patchlevel = v.patchlevel;
 292
 293                 if (copy_to_user(uversion, &oldv, sizeof(oldv)))
 294                         return -EFAULT;
 295                 return 0;
 296         }
 297         case LTTNG_KERNEL_TRACER_VERSION:
 298         {
 299                 struct lttng_kernel_tracer_version version;
 300                 struct lttng_kernel_tracer_version *uversion =
 301                         (struct lttng_kernel_tracer_version __user *) arg;
 302
 303                 lttng_abi_tracer_version(&version);
 304
 305                 if (copy_to_user(uversion, &version, sizeof(version)))
 306                         return -EFAULT;
 307                 return 0;
 308         }
 309         case LTTNG_KERNEL_TRACER_ABI_VERSION:
 310         {
 311                 struct lttng_kernel_tracer_abi_version version;
 312                 struct lttng_kernel_tracer_abi_version *uversion =
 313                         (struct lttng_kernel_tracer_abi_version __user *) arg;
 314
 315                 lttng_abi_tracer_abi_version(&version);
 316
 317                 if (copy_to_user(uversion, &version, sizeof(version)))
 318                         return -EFAULT;
 319                 return 0;
 320         }
 321         case LTTNG_KERNEL_OLD_TRACEPOINT_LIST:
 322         case LTTNG_KERNEL_TRACEPOINT_LIST:
 323                 return lttng_abi_tracepoint_list();
 324         case LTTNG_KERNEL_SYSCALL_LIST:
 325                 return lttng_abi_syscall_list();
 326         case LTTNG_KERNEL_OLD_WAIT_QUIESCENT:
 327         case LTTNG_KERNEL_WAIT_QUIESCENT:
 328                 synchronize_trace();
 329                 return 0;
 330         case LTTNG_KERNEL_OLD_CALIBRATE:
 331         {
 332                 struct lttng_kernel_old_calibrate __user *ucalibrate =
 333                         (struct lttng_kernel_old_calibrate __user *) arg;
 334                 struct lttng_kernel_old_calibrate old_calibrate;
 335                 struct lttng_kernel_calibrate calibrate;
 336                 int ret;
 337
 338                 if (copy_from_user(&old_calibrate, ucalibrate, sizeof(old_calibrate)))
 339                         return -EFAULT;
 340                 calibrate.type = old_calibrate.type;
 341                 ret = lttng_calibrate(&calibrate);
 342                 if (copy_to_user(ucalibrate, &old_calibrate, sizeof(old_calibrate)))
 343                         return -EFAULT;
 344                 return ret;
 345         }
 346         case LTTNG_KERNEL_CALIBRATE:
 347         {
 348                 struct lttng_kernel_calibrate __user *ucalibrate =
 349                         (struct lttng_kernel_calibrate __user *) arg;
 350                 struct lttng_kernel_calibrate calibrate;
 351                 int ret;
 352
 353                 if (copy_from_user(&calibrate, ucalibrate, sizeof(calibrate)))
 354                         return -EFAULT;
 355                 ret = lttng_calibrate(&calibrate);
 356                 if (copy_to_user(ucalibrate, &calibrate, sizeof(calibrate)))
 357                         return -EFAULT;
 358                 return ret;
 359         }
 360         default:
 361                 return -ENOIOCTLCMD;
 362         }
 363 }
 364
 365 static const struct file_operations lttng_fops = {
 366         .owner = THIS_MODULE,
 367         .unlocked_ioctl = lttng_ioctl,
 368 #ifdef CONFIG_COMPAT
 369         .compat_ioctl = lttng_ioctl,
 370 #endif
 371 };
 372
 373 static
 374 int lttng_abi_create_channel(struct file *session_file,
 375                              struct lttng_kernel_channel *chan_param,
 376                              enum channel_type channel_type)
 377 {
 378         struct lttng_session *session = session_file->private_data;
 379         const struct file_operations *fops = NULL;
 380         const char *transport_name;
 381         struct lttng_channel *chan;
 382         struct file *chan_file;
 383         int chan_fd;
 384         int ret = 0;
 385
 386         chan_fd = lttng_get_unused_fd();
 387         if (chan_fd < 0) {
 388                 ret = chan_fd;
 389                 goto fd_error;
 390         }
 391         switch (channel_type) {
 392         case PER_CPU_CHANNEL:
 393                 fops = &lttng_channel_fops;
 394                 break;
 395         case METADATA_CHANNEL:
 396                 fops = &lttng_metadata_fops;
 397                 break;
 398         }
 399
 400         chan_file = anon_inode_getfile("[lttng_channel]",
 401                                        fops,
 402                                        NULL, O_RDWR);
 403         if (IS_ERR(chan_file)) {
 404                 ret = PTR_ERR(chan_file);
 405                 goto file_error;
 406         }
 407         switch (channel_type) {
 408         case PER_CPU_CHANNEL:
 409                 if (chan_param->output == LTTNG_KERNEL_SPLICE) {
 410                         transport_name = chan_param->overwrite ?
 411                                 "relay-overwrite" : "relay-discard";
 412                 } else if (chan_param->output == LTTNG_KERNEL_MMAP) {
 413                         transport_name = chan_param->overwrite ?
 414                                 "relay-overwrite-mmap" : "relay-discard-mmap";
 415                 } else {
 416                         return -EINVAL;
 417                 }
 418                 break;
 419         case METADATA_CHANNEL:
 420                 if (chan_param->output == LTTNG_KERNEL_SPLICE)
 421                         transport_name = "relay-metadata";
 422                 else if (chan_param->output == LTTNG_KERNEL_MMAP)
 423                         transport_name = "relay-metadata-mmap";
 424                 else
 425                         return -EINVAL;
 426                 break;
 427         default:
 428                 transport_name = "<unknown>";
 429                 break;
 430         }
 431         if (atomic_long_add_unless(&session_file->f_count,
 432                 1, INT_MAX) == INT_MAX) {
 433                 goto refcount_error;
 434         }
 435         /*
 436          * We tolerate no failure path after channel creation. It will stay
 437          * invariant for the rest of the session.
 438          */
 439         chan = lttng_channel_create(session, transport_name, NULL,
 440                                   chan_param->subbuf_size,
 441                                   chan_param->num_subbuf,
 442                                   chan_param->switch_timer_interval,
 443                                   chan_param->read_timer_interval,
 444                                   channel_type);
 445         if (!chan) {
 446                 ret = -EINVAL;
 447                 goto chan_error;
 448         }
 449         chan->file = chan_file;
 450         chan_file->private_data = chan;
 451         fd_install(chan_fd, chan_file);
 452
 453         return chan_fd;
 454
 455 chan_error:
 456         atomic_long_dec(&session_file->f_count);
 457 refcount_error:
 458         fput(chan_file);
 459 file_error:
 460         put_unused_fd(chan_fd);
 461 fd_error:
 462         return ret;
 463 }
 464
 465 /**
 466  *      lttng_session_ioctl - lttng session fd ioctl
 467  *
 468  *      @file: the file
 469  *      @cmd: the command
 470  *      @arg: command arg
 471  *
 472  *      This ioctl implements lttng commands:
 473  *      LTTNG_KERNEL_CHANNEL
 474  *              Returns a LTTng channel file descriptor
 475  *      LTTNG_KERNEL_ENABLE
 476  *              Enables tracing for a session (weak enable)
 477  *      LTTNG_KERNEL_DISABLE
 478  *              Disables tracing for a session (strong disable)
 479  *      LTTNG_KERNEL_METADATA
 480  *              Returns a LTTng metadata file descriptor
 481  *      LTTNG_KERNEL_SESSION_TRACK_PID
 482  *              Add PID to session tracker
 483  *      LTTNG_KERNEL_SESSION_UNTRACK_PID
 484  *              Remove PID from session tracker
 485  *
 486  * The returned channel will be deleted when its file descriptor is closed.
 487  */
 488 static
 489 long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 490 {
 491         struct lttng_session *session = file->private_data;
 492
 493         switch (cmd) {
 494         case LTTNG_KERNEL_OLD_CHANNEL:
 495         {
 496                 struct lttng_kernel_channel chan_param;
 497                 struct lttng_kernel_old_channel old_chan_param;
 498
 499                 if (copy_from_user(&old_chan_param,
 500                                 (struct lttng_kernel_old_channel __user *) arg,
 501                                 sizeof(struct lttng_kernel_old_channel)))
 502                         return -EFAULT;
 503                 chan_param.overwrite = old_chan_param.overwrite;
 504                 chan_param.subbuf_size = old_chan_param.subbuf_size;
 505                 chan_param.num_subbuf = old_chan_param.num_subbuf;
 506                 chan_param.switch_timer_interval = old_chan_param.switch_timer_interval;
 507                 chan_param.read_timer_interval = old_chan_param.read_timer_interval;
 508                 chan_param.output = old_chan_param.output;
 509
 510                 return lttng_abi_create_channel(file, &chan_param,
 511                                 PER_CPU_CHANNEL);
 512         }
 513         case LTTNG_KERNEL_CHANNEL:
 514         {
 515                 struct lttng_kernel_channel chan_param;
 516
 517                 if (copy_from_user(&chan_param,
 518                                 (struct lttng_kernel_channel __user *) arg,
 519                                 sizeof(struct lttng_kernel_channel)))
 520                         return -EFAULT;
 521                 return lttng_abi_create_channel(file, &chan_param,
 522                                 PER_CPU_CHANNEL);
 523         }
 524         case LTTNG_KERNEL_OLD_SESSION_START:
 525         case LTTNG_KERNEL_OLD_ENABLE:
 526         case LTTNG_KERNEL_SESSION_START:
 527         case LTTNG_KERNEL_ENABLE:
 528                 return lttng_session_enable(session);
 529         case LTTNG_KERNEL_OLD_SESSION_STOP:
 530         case LTTNG_KERNEL_OLD_DISABLE:
 531         case LTTNG_KERNEL_SESSION_STOP:
 532         case LTTNG_KERNEL_DISABLE:
 533                 return lttng_session_disable(session);
 534         case LTTNG_KERNEL_OLD_METADATA:
 535         {
 536                 struct lttng_kernel_channel chan_param;
 537                 struct lttng_kernel_old_channel old_chan_param;
 538
 539                 if (copy_from_user(&old_chan_param,
 540                                 (struct lttng_kernel_old_channel __user *) arg,
 541                                 sizeof(struct lttng_kernel_old_channel)))
 542                         return -EFAULT;
 543                 chan_param.overwrite = old_chan_param.overwrite;
 544                 chan_param.subbuf_size = old_chan_param.subbuf_size;
 545                 chan_param.num_subbuf = old_chan_param.num_subbuf;
 546                 chan_param.switch_timer_interval = old_chan_param.switch_timer_interval;
 547                 chan_param.read_timer_interval = old_chan_param.read_timer_interval;
 548                 chan_param.output = old_chan_param.output;
 549
 550                 return lttng_abi_create_channel(file, &chan_param,
 551                                 METADATA_CHANNEL);
 552         }
 553         case LTTNG_KERNEL_METADATA:
 554         {
 555                 struct lttng_kernel_channel chan_param;
 556
 557                 if (copy_from_user(&chan_param,
 558                                         (struct lttng_kernel_channel __user *) arg,
 559                                         sizeof(struct lttng_kernel_channel)))
 560                         return -EFAULT;
 561                 return lttng_abi_create_channel(file, &chan_param,
 562                                 METADATA_CHANNEL);
 563         }
 564         case LTTNG_KERNEL_SESSION_TRACK_PID:
 565                 return lttng_session_track_pid(session, (int) arg);
 566         case LTTNG_KERNEL_SESSION_UNTRACK_PID:
 567                 return lttng_session_untrack_pid(session, (int) arg);
 568         case LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS:
 569                 return lttng_session_list_tracker_pids(session);
 570         case LTTNG_KERNEL_SESSION_METADATA_REGEN:
 571                 return lttng_session_metadata_regenerate(session);
 572         default:
 573                 return -ENOIOCTLCMD;
 574         }
 575 }
 576
 577 /*
 578  * Called when the last file reference is dropped.
 579  *
 580  * Big fat note: channels and events are invariant for the whole session after
 581  * their creation. So this session destruction also destroys all channel and
 582  * event structures specific to this session (they are not destroyed when their
 583  * individual file is released).
 584  */
 585 static
 586 int lttng_session_release(struct inode *inode, struct file *file)
 587 {
 588         struct lttng_session *session = file->private_data;
 589
 590         if (session)
 591                 lttng_session_destroy(session);
 592         return 0;
 593 }
 594
 595 static const struct file_operations lttng_session_fops = {
 596         .owner = THIS_MODULE,
 597         .release = lttng_session_release,
 598         .unlocked_ioctl = lttng_session_ioctl,
 599 #ifdef CONFIG_COMPAT
 600         .compat_ioctl = lttng_session_ioctl,
 601 #endif
 602 };
 603
 604 /**
 605  *      lttng_metadata_ring_buffer_poll - LTTng ring buffer poll file operation
 606  *      @filp: the file
 607  *      @wait: poll table
 608  *
 609  *      Handles the poll operations for the metadata channels.
 610  */
 611 static
 612 unsigned int lttng_metadata_ring_buffer_poll(struct file *filp,
 613                 poll_table *wait)
 614 {
 615         struct lttng_metadata_stream *stream = filp->private_data;
 616         struct lib_ring_buffer *buf = stream->priv;
 617         int finalized;
 618         unsigned int mask = 0;
 619
 620         if (filp->f_mode & FMODE_READ) {
 621                 poll_wait_set_exclusive(wait);
 622                 poll_wait(filp, &stream->read_wait, wait);
 623
 624                 finalized = stream->finalized;
 625
 626                 /*
 627                  * lib_ring_buffer_is_finalized() contains a smp_rmb()
 628                  * ordering finalized load before offsets loads.
 629                  */
 630                 WARN_ON(atomic_long_read(&buf->active_readers) != 1);
 631
 632                 if (finalized)
 633                         mask |= POLLHUP;
 634
 635                 mutex_lock(&stream->metadata_cache->lock);
 636                 if (stream->metadata_cache->metadata_written >
 637                                 stream->metadata_out)
 638                         mask |= POLLIN;
 639                 mutex_unlock(&stream->metadata_cache->lock);
 640         }
 641
 642         return mask;
 643 }
 644
 645 static
 646 void lttng_metadata_ring_buffer_ioctl_put_next_subbuf(struct file *filp,
 647                 unsigned int cmd, unsigned long arg)
 648 {
 649         struct lttng_metadata_stream *stream = filp->private_data;
 650
 651         stream->metadata_out = stream->metadata_in;
 652 }
 653
 654 static
 655 long lttng_metadata_ring_buffer_ioctl(struct file *filp,
 656                 unsigned int cmd, unsigned long arg)
 657 {
 658         int ret;
 659         struct lttng_metadata_stream *stream = filp->private_data;
 660         struct lib_ring_buffer *buf = stream->priv;
 661
 662         switch (cmd) {
 663         case RING_BUFFER_GET_NEXT_SUBBUF:
 664         {
 665                 struct lttng_metadata_stream *stream = filp->private_data;
 666                 struct lib_ring_buffer *buf = stream->priv;
 667                 struct channel *chan = buf->backend.chan;
 668
 669                 ret = lttng_metadata_output_channel(stream, chan);
 670                 if (ret > 0) {
 671                         lib_ring_buffer_switch_slow(buf, SWITCH_ACTIVE);
 672                         ret = 0;
 673                 } else if (ret < 0)
 674                         goto err;
 675                 break;
 676         }
 677         case RING_BUFFER_GET_SUBBUF:
 678         {
 679                 /*
 680                  * Random access is not allowed for metadata channel.
 681                  */
 682                 return -ENOSYS;
 683         }
 684         case RING_BUFFER_FLUSH:
 685         {
 686                 struct lttng_metadata_stream *stream = filp->private_data;
 687                 struct lib_ring_buffer *buf = stream->priv;
 688                 struct channel *chan = buf->backend.chan;
 689
 690                 /*
 691                  * Before doing the actual ring buffer flush, write up to one
 692                  * packet of metadata in the ring buffer.
 693                  */
 694                 ret = lttng_metadata_output_channel(stream, chan);
 695                 if (ret < 0)
 696                         goto err;
 697                 break;
 698         }
 699         case RING_BUFFER_GET_METADATA_VERSION:
 700         {
 701                 struct lttng_metadata_stream *stream = filp->private_data;
 702
 703                 return put_u64(stream->version, arg);
 704         }
 705         default:
 706                 break;
 707         }
 708         /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
 709
 710         /* Performing lib ring buffer ioctl after our own. */
 711         ret = lib_ring_buffer_ioctl(filp, cmd, arg, buf);
 712         if (ret < 0)
 713                 goto err;
 714
 715         switch (cmd) {
 716         case RING_BUFFER_PUT_NEXT_SUBBUF:
 717         {
 718                 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp,
 719                                 cmd, arg);
 720                 break;
 721         }
 722         default:
 723                 break;
 724         }
 725 err:
 726         return ret;
 727 }
 728
 729 #ifdef CONFIG_COMPAT
 730 static
 731 long lttng_metadata_ring_buffer_compat_ioctl(struct file *filp,
 732                 unsigned int cmd, unsigned long arg)
 733 {
 734         int ret;
 735         struct lttng_metadata_stream *stream = filp->private_data;
 736         struct lib_ring_buffer *buf = stream->priv;
 737
 738         switch (cmd) {
 739         case RING_BUFFER_GET_NEXT_SUBBUF:
 740         {
 741                 struct lttng_metadata_stream *stream = filp->private_data;
 742                 struct lib_ring_buffer *buf = stream->priv;
 743                 struct channel *chan = buf->backend.chan;
 744
 745                 ret = lttng_metadata_output_channel(stream, chan);
 746                 if (ret > 0) {
 747                         lib_ring_buffer_switch_slow(buf, SWITCH_ACTIVE);
 748                         ret = 0;
 749                 } else if (ret < 0)
 750                         goto err;
 751                 break;
 752         }
 753         case RING_BUFFER_GET_SUBBUF:
 754         {
 755                 /*
 756                  * Random access is not allowed for metadata channel.
 757                  */
 758                 return -ENOSYS;
 759         }
 760         default:
 761                 break;
 762         }
 763         /* PUT_SUBBUF is the one from lib ring buffer, unmodified. */
 764
 765         /* Performing lib ring buffer ioctl after our own. */
 766         ret = lib_ring_buffer_compat_ioctl(filp, cmd, arg, buf);
 767         if (ret < 0)
 768                 goto err;
 769
 770         switch (cmd) {
 771         case RING_BUFFER_PUT_NEXT_SUBBUF:
 772         {
 773                 lttng_metadata_ring_buffer_ioctl_put_next_subbuf(filp,
 774                                 cmd, arg);
 775                 break;
 776         }
 777         case RING_BUFFER_GET_METADATA_VERSION:
 778         {
 779                 struct lttng_metadata_stream *stream = filp->private_data;
 780
 781                 return put_u64(stream->version, arg);
 782         }
 783         default:
 784                 break;
 785         }
 786 err:
 787         return ret;
 788 }
 789 #endif
 790
 791 /*
 792  * This is not used by anonymous file descriptors. This code is left
 793  * there if we ever want to implement an inode with open() operation.
 794  */
 795 static
 796 int lttng_metadata_ring_buffer_open(struct inode *inode, struct file *file)
 797 {
 798         struct lttng_metadata_stream *stream = inode->i_private;
 799         struct lib_ring_buffer *buf = stream->priv;
 800
 801         file->private_data = buf;
 802         /*
 803          * Since life-time of metadata cache differs from that of
 804          * session, we need to keep our own reference on the transport.
 805          */
 806         if (!try_module_get(stream->transport->owner)) {
 807                 printk(KERN_WARNING "LTT : Can't lock transport module.\n");
 808                 return -EBUSY;
 809         }
 810         return lib_ring_buffer_open(inode, file, buf);
 811 }
 812
 813 static
 814 int lttng_metadata_ring_buffer_release(struct inode *inode, struct file *file)
 815 {
 816         struct lttng_metadata_stream *stream = file->private_data;
 817         struct lib_ring_buffer *buf = stream->priv;
 818
 819         kref_put(&stream->metadata_cache->refcount, metadata_cache_destroy);
 820         module_put(stream->transport->owner);
 821         return lib_ring_buffer_release(inode, file, buf);
 822 }
 823
 824 static
 825 ssize_t lttng_metadata_ring_buffer_splice_read(struct file *in, loff_t *ppos,
 826                 struct pipe_inode_info *pipe, size_t len,
 827                 unsigned int flags)
 828 {
 829         struct lttng_metadata_stream *stream = in->private_data;
 830         struct lib_ring_buffer *buf = stream->priv;
 831
 832         return lib_ring_buffer_splice_read(in, ppos, pipe, len,
 833                         flags, buf);
 834 }
 835
 836 static
 837 int lttng_metadata_ring_buffer_mmap(struct file *filp,
 838                 struct vm_area_struct *vma)
 839 {
 840         struct lttng_metadata_stream *stream = filp->private_data;
 841         struct lib_ring_buffer *buf = stream->priv;
 842
 843         return lib_ring_buffer_mmap(filp, vma, buf);
 844 }
 845
 846 static
 847 const struct file_operations lttng_metadata_ring_buffer_file_operations = {
 848         .owner = THIS_MODULE,
 849         .open = lttng_metadata_ring_buffer_open,
 850         .release = lttng_metadata_ring_buffer_release,
 851         .poll = lttng_metadata_ring_buffer_poll,
 852         .splice_read = lttng_metadata_ring_buffer_splice_read,
 853         .mmap = lttng_metadata_ring_buffer_mmap,
 854         .unlocked_ioctl = lttng_metadata_ring_buffer_ioctl,
 855         .llseek = vfs_lib_ring_buffer_no_llseek,
 856 #ifdef CONFIG_COMPAT
 857         .compat_ioctl = lttng_metadata_ring_buffer_compat_ioctl,
 858 #endif
 859 };
 860
 861 static
 862 int lttng_abi_create_stream_fd(struct file *channel_file, void *stream_priv,
 863                 const struct file_operations *fops)
 864 {
 865         int stream_fd, ret;
 866         struct file *stream_file;
 867
 868         stream_fd = lttng_get_unused_fd();
 869         if (stream_fd < 0) {
 870                 ret = stream_fd;
 871                 goto fd_error;
 872         }
 873         stream_file = anon_inode_getfile("[lttng_stream]", fops,
 874                         stream_priv, O_RDWR);
 875         if (IS_ERR(stream_file)) {
 876                 ret = PTR_ERR(stream_file);
 877                 goto file_error;
 878         }
 879         /*
 880          * OPEN_FMODE, called within anon_inode_getfile/alloc_file, don't honor
 881          * FMODE_LSEEK, FMODE_PREAD nor FMODE_PWRITE. We need to read from this
 882          * file descriptor, so we set FMODE_PREAD here.
 883          */
 884         stream_file->f_mode |= FMODE_PREAD;
 885         fd_install(stream_fd, stream_file);
 886         /*
 887          * The stream holds a reference to the channel within the generic ring
 888          * buffer library, so no need to hold a refcount on the channel and
 889          * session files here.
 890          */
 891         return stream_fd;
 892
 893 file_error:
 894         put_unused_fd(stream_fd);
 895 fd_error:
 896         return ret;
 897 }
 898
 899 static
 900 int lttng_abi_open_stream(struct file *channel_file)
 901 {
 902         struct lttng_channel *channel = channel_file->private_data;
 903         struct lib_ring_buffer *buf;
 904         int ret;
 905         void *stream_priv;
 906
 907         buf = channel->ops->buffer_read_open(channel->chan);
 908         if (!buf)
 909                 return -ENOENT;
 910
 911         stream_priv = buf;
 912         ret = lttng_abi_create_stream_fd(channel_file, stream_priv,
 913                         &lttng_stream_ring_buffer_file_operations);
 914         if (ret < 0)
 915                 goto fd_error;
 916
 917         return ret;
 918
 919 fd_error:
 920         channel->ops->buffer_read_close(buf);
 921         return ret;
 922 }
 923
 924 static
 925 int lttng_abi_open_metadata_stream(struct file *channel_file)
 926 {
 927         struct lttng_channel *channel = channel_file->private_data;
 928         struct lttng_session *session = channel->session;
 929         struct lib_ring_buffer *buf;
 930         int ret;
 931         struct lttng_metadata_stream *metadata_stream;
 932         void *stream_priv;
 933
 934         buf = channel->ops->buffer_read_open(channel->chan);
 935         if (!buf)
 936                 return -ENOENT;
 937
 938         metadata_stream = kzalloc(sizeof(struct lttng_metadata_stream),
 939                         GFP_KERNEL);
 940         if (!metadata_stream) {
 941                 ret = -ENOMEM;
 942                 goto nomem;
 943         }
 944         metadata_stream->metadata_cache = session->metadata_cache;
 945         init_waitqueue_head(&metadata_stream->read_wait);
 946         metadata_stream->priv = buf;
 947         stream_priv = metadata_stream;
 948         metadata_stream->transport = channel->transport;
 949
 950         /*
 951          * Since life-time of metadata cache differs from that of
 952          * session, we need to keep our own reference on the transport.
 953          */
 954         if (!try_module_get(metadata_stream->transport->owner)) {
 955                 printk(KERN_WARNING "LTT : Can't lock transport module.\n");
 956                 ret = -EINVAL;
 957                 goto notransport;
 958         }
 959
 960         if (!lttng_kref_get(&session->metadata_cache->refcount))
 961                 goto kref_error;
 962         ret = lttng_abi_create_stream_fd(channel_file, stream_priv,
 963                         &lttng_metadata_ring_buffer_file_operations);
 964         if (ret < 0)
 965                 goto fd_error;
 966
 967         list_add(&metadata_stream->list,
 968                 &session->metadata_cache->metadata_stream);
 969         return ret;
 970
 971 fd_error:
 972         kref_put(&session->metadata_cache->refcount, metadata_cache_destroy);
 973 kref_error:
 974         module_put(metadata_stream->transport->owner);
 975 notransport:
 976         kfree(metadata_stream);
 977 nomem:
 978         channel->ops->buffer_read_close(buf);
 979         return ret;
 980 }
 981
 982 static
 983 int lttng_abi_create_event(struct file *channel_file,
 984                            struct lttng_kernel_event *event_param)
 985 {
 986         struct lttng_channel *channel = channel_file->private_data;
 987         int event_fd, ret;
 988         struct file *event_file;
 989         void *priv;
 990
 991         event_param->name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
 992         switch (event_param->instrumentation) {
 993         case LTTNG_KERNEL_KRETPROBE:
 994                 event_param->u.kretprobe.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
 995                 break;
 996         case LTTNG_KERNEL_KPROBE:
 997                 event_param->u.kprobe.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
 998                 break;
 999         case LTTNG_KERNEL_FUNCTION:
1000                 event_param->u.ftrace.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
1001                 break;
1002         default:
1003                 break;
1004         }
1005         event_fd = lttng_get_unused_fd();
1006         if (event_fd < 0) {
1007                 ret = event_fd;
1008                 goto fd_error;
1009         }
1010         event_file = anon_inode_getfile("[lttng_event]",
1011                                         &lttng_event_fops,
1012                                         NULL, O_RDWR);
1013         if (IS_ERR(event_file)) {
1014                 ret = PTR_ERR(event_file);
1015                 goto file_error;
1016         }
1017         /* The event holds a reference on the channel */
1018         if (atomic_long_add_unless(&channel_file->f_count,
1019                 1, INT_MAX) == INT_MAX) {
1020                 ret = -EOVERFLOW;
1021                 goto refcount_error;
1022         }
1023         if (event_param->instrumentation == LTTNG_KERNEL_TRACEPOINT
1024                         || event_param->instrumentation == LTTNG_KERNEL_SYSCALL) {
1025                 struct lttng_enabler *enabler;
1026
1027                 if (event_param->name[strlen(event_param->name) - 1] == '*') {
1028                         enabler = lttng_enabler_create(LTTNG_ENABLER_WILDCARD,
1029                                 event_param, channel);
1030                 } else {
1031                         enabler = lttng_enabler_create(LTTNG_ENABLER_NAME,
1032                                 event_param, channel);
1033                 }
1034                 priv = enabler;
1035         } else {
1036                 struct lttng_event *event;
1037
1038                 /*
1039                  * We tolerate no failure path after event creation. It
1040                  * will stay invariant for the rest of the session.
1041                  */
1042                 event = lttng_event_create(channel, event_param,
1043                                 NULL, NULL,
1044                                 event_param->instrumentation);
1045                 WARN_ON_ONCE(!event);
1046                 if (IS_ERR(event)) {
1047                         ret = PTR_ERR(event);
1048                         goto event_error;
1049                 }
1050                 priv = event;
1051         }
1052         event_file->private_data = priv;
1053         fd_install(event_fd, event_file);
1054         return event_fd;
1055
1056 event_error:
1057         atomic_long_dec(&channel_file->f_count);
1058 refcount_error:
1059         fput(event_file);
1060 file_error:
1061         put_unused_fd(event_fd);
1062 fd_error:
1063         return ret;
1064 }
1065
1066 /**
1067  *      lttng_channel_ioctl - lttng syscall through ioctl
1068  *
1069  *      @file: the file
1070  *      @cmd: the command
1071  *      @arg: command arg
1072  *
1073  *      This ioctl implements lttng commands:
1074  *      LTTNG_KERNEL_STREAM
1075  *              Returns an event stream file descriptor or failure.
1076  *              (typically, one event stream records events from one CPU)
1077  *      LTTNG_KERNEL_EVENT
1078  *              Returns an event file descriptor or failure.
1079  *      LTTNG_KERNEL_CONTEXT
1080  *              Prepend a context field to each event in the channel
1081  *      LTTNG_KERNEL_ENABLE
1082  *              Enable recording for events in this channel (weak enable)
1083  *      LTTNG_KERNEL_DISABLE
1084  *              Disable recording for events in this channel (strong disable)
1085  *
1086  * Channel and event file descriptors also hold a reference on the session.
1087  */
1088 static
1089 long lttng_channel_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1090 {
1091         struct lttng_channel *channel = file->private_data;
1092
1093         switch (cmd) {
1094         case LTTNG_KERNEL_OLD_STREAM:
1095         case LTTNG_KERNEL_STREAM:
1096                 return lttng_abi_open_stream(file);
1097         case LTTNG_KERNEL_OLD_EVENT:
1098         {
1099                 struct lttng_kernel_event *uevent_param;
1100                 struct lttng_kernel_old_event *old_uevent_param;
1101                 int ret;
1102
1103                 uevent_param = kmalloc(sizeof(struct lttng_kernel_event),
1104                                 GFP_KERNEL);
1105                 if (!uevent_param) {
1106                         ret = -ENOMEM;
1107                         goto old_event_end;
1108                 }
1109                 old_uevent_param = kmalloc(
1110                                 sizeof(struct lttng_kernel_old_event),
1111                                 GFP_KERNEL);
1112                 if (!old_uevent_param) {
1113                         ret = -ENOMEM;
1114                         goto old_event_error_free_param;
1115                 }
1116                 if (copy_from_user(old_uevent_param,
1117                                 (struct lttng_kernel_old_event __user *) arg,
1118                                 sizeof(struct lttng_kernel_old_event))) {
1119                         ret = -EFAULT;
1120                         goto old_event_error_free_old_param;
1121                 }
1122
1123                 memcpy(uevent_param->name, old_uevent_param->name,
1124                                 sizeof(uevent_param->name));
1125                 uevent_param->instrumentation =
1126                         old_uevent_param->instrumentation;
1127
1128                 switch (old_uevent_param->instrumentation) {
1129                 case LTTNG_KERNEL_KPROBE:
1130                         uevent_param->u.kprobe.addr =
1131                                 old_uevent_param->u.kprobe.addr;
1132                         uevent_param->u.kprobe.offset =
1133                                 old_uevent_param->u.kprobe.offset;
1134                         memcpy(uevent_param->u.kprobe.symbol_name,
1135                                 old_uevent_param->u.kprobe.symbol_name,
1136                                 sizeof(uevent_param->u.kprobe.symbol_name));
1137                         break;
1138                 case LTTNG_KERNEL_KRETPROBE:
1139                         uevent_param->u.kretprobe.addr =
1140                                 old_uevent_param->u.kretprobe.addr;
1141                         uevent_param->u.kretprobe.offset =
1142                                 old_uevent_param->u.kretprobe.offset;
1143                         memcpy(uevent_param->u.kretprobe.symbol_name,
1144                                 old_uevent_param->u.kretprobe.symbol_name,
1145                                 sizeof(uevent_param->u.kretprobe.symbol_name));
1146                         break;
1147                 case LTTNG_KERNEL_FUNCTION:
1148                         memcpy(uevent_param->u.ftrace.symbol_name,
1149                                         old_uevent_param->u.ftrace.symbol_name,
1150                                         sizeof(uevent_param->u.ftrace.symbol_name));
1151                         break;
1152                 default:
1153                         break;
1154                 }
1155                 ret = lttng_abi_create_event(file, uevent_param);
1156
1157 old_event_error_free_old_param:
1158                 kfree(old_uevent_param);
1159 old_event_error_free_param:
1160                 kfree(uevent_param);
1161 old_event_end:
1162                 return ret;
1163         }
1164         case LTTNG_KERNEL_EVENT:
1165         {
1166                 struct lttng_kernel_event uevent_param;
1167
1168                 if (copy_from_user(&uevent_param,
1169                                 (struct lttng_kernel_event __user *) arg,
1170                                 sizeof(uevent_param)))
1171                         return -EFAULT;
1172                 return lttng_abi_create_event(file, &uevent_param);
1173         }
1174         case LTTNG_KERNEL_OLD_CONTEXT:
1175         {
1176                 struct lttng_kernel_context *ucontext_param;
1177                 struct lttng_kernel_old_context *old_ucontext_param;
1178                 int ret;
1179
1180                 ucontext_param = kmalloc(sizeof(struct lttng_kernel_context),
1181                                 GFP_KERNEL);
1182                 if (!ucontext_param) {
1183                         ret = -ENOMEM;
1184                         goto old_ctx_end;
1185                 }
1186                 old_ucontext_param = kmalloc(sizeof(struct lttng_kernel_old_context),
1187                                 GFP_KERNEL);
1188                 if (!old_ucontext_param) {
1189                         ret = -ENOMEM;
1190                         goto old_ctx_error_free_param;
1191                 }
1192
1193                 if (copy_from_user(old_ucontext_param,
1194                                 (struct lttng_kernel_old_context __user *) arg,
1195                                 sizeof(struct lttng_kernel_old_context))) {
1196                         ret = -EFAULT;
1197                         goto old_ctx_error_free_old_param;
1198                 }
1199                 ucontext_param->ctx = old_ucontext_param->ctx;
1200                 memcpy(ucontext_param->padding, old_ucontext_param->padding,
1201                                 sizeof(ucontext_param->padding));
1202                 /* only type that uses the union */
1203                 if (old_ucontext_param->ctx == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) {
1204                         ucontext_param->u.perf_counter.type =
1205                                 old_ucontext_param->u.perf_counter.type;
1206                         ucontext_param->u.perf_counter.config =
1207                                 old_ucontext_param->u.perf_counter.config;
1208                         memcpy(ucontext_param->u.perf_counter.name,
1209                                 old_ucontext_param->u.perf_counter.name,
1210                                 sizeof(ucontext_param->u.perf_counter.name));
1211                 }
1212
1213                 ret = lttng_abi_add_context(file,
1214                                 ucontext_param,
1215                                 &channel->ctx, channel->session);
1216
1217 old_ctx_error_free_old_param:
1218                 kfree(old_ucontext_param);
1219 old_ctx_error_free_param:
1220                 kfree(ucontext_param);
1221 old_ctx_end:
1222                 return ret;
1223         }
1224         case LTTNG_KERNEL_CONTEXT:
1225         {
1226                 struct lttng_kernel_context ucontext_param;
1227
1228                 if (copy_from_user(&ucontext_param,
1229                                 (struct lttng_kernel_context __user *) arg,
1230                                 sizeof(ucontext_param)))
1231                         return -EFAULT;
1232                 return lttng_abi_add_context(file,
1233                                 &ucontext_param,
1234                                 &channel->ctx, channel->session);
1235         }
1236         case LTTNG_KERNEL_OLD_ENABLE:
1237         case LTTNG_KERNEL_ENABLE:
1238                 return lttng_channel_enable(channel);
1239         case LTTNG_KERNEL_OLD_DISABLE:
1240         case LTTNG_KERNEL_DISABLE:
1241                 return lttng_channel_disable(channel);
1242         case LTTNG_KERNEL_SYSCALL_MASK:
1243                 return lttng_channel_syscall_mask(channel,
1244                         (struct lttng_kernel_syscall_mask __user *) arg);
1245         default:
1246                 return -ENOIOCTLCMD;
1247         }
1248
1249 }
1250
1251 /**
1252  *      lttng_metadata_ioctl - lttng syscall through ioctl
1253  *
1254  *      @file: the file
1255  *      @cmd: the command
1256  *      @arg: command arg
1257  *
1258  *      This ioctl implements lttng commands:
1259  *      LTTNG_KERNEL_STREAM
1260  *              Returns an event stream file descriptor or failure.
1261  *
1262  * Channel and event file descriptors also hold a reference on the session.
1263  */
1264 static
1265 long lttng_metadata_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1266 {
1267         switch (cmd) {
1268         case LTTNG_KERNEL_OLD_STREAM:
1269         case LTTNG_KERNEL_STREAM:
1270                 return lttng_abi_open_metadata_stream(file);
1271         default:
1272                 return -ENOIOCTLCMD;
1273         }
1274 }
1275
1276 /**
1277  *      lttng_channel_poll - lttng stream addition/removal monitoring
1278  *
1279  *      @file: the file
1280  *      @wait: poll table
1281  */
1282 unsigned int lttng_channel_poll(struct file *file, poll_table *wait)
1283 {
1284         struct lttng_channel *channel = file->private_data;
1285         unsigned int mask = 0;
1286
1287         if (file->f_mode & FMODE_READ) {
1288                 poll_wait_set_exclusive(wait);
1289                 poll_wait(file, channel->ops->get_hp_wait_queue(channel->chan),
1290                           wait);
1291
1292                 if (channel->ops->is_disabled(channel->chan))
1293                         return POLLERR;
1294                 if (channel->ops->is_finalized(channel->chan))
1295                         return POLLHUP;
1296                 if (channel->ops->buffer_has_read_closed_stream(channel->chan))
1297                         return POLLIN | POLLRDNORM;
1298                 return 0;
1299         }
1300         return mask;
1301
1302 }
1303
1304 static
1305 int lttng_channel_release(struct inode *inode, struct file *file)
1306 {
1307         struct lttng_channel *channel = file->private_data;
1308
1309         if (channel)
1310                 fput(channel->session->file);
1311         return 0;
1312 }
1313
1314 static
1315 int lttng_metadata_channel_release(struct inode *inode, struct file *file)
1316 {
1317         struct lttng_channel *channel = file->private_data;
1318
1319         if (channel) {
1320                 fput(channel->session->file);
1321                 lttng_metadata_channel_destroy(channel);
1322         }
1323
1324         return 0;
1325 }
1326
1327 static const struct file_operations lttng_channel_fops = {
1328         .owner = THIS_MODULE,
1329         .release = lttng_channel_release,
1330         .poll = lttng_channel_poll,
1331         .unlocked_ioctl = lttng_channel_ioctl,
1332 #ifdef CONFIG_COMPAT
1333         .compat_ioctl = lttng_channel_ioctl,
1334 #endif
1335 };
1336
1337 static const struct file_operations lttng_metadata_fops = {
1338         .owner = THIS_MODULE,
1339         .release = lttng_metadata_channel_release,
1340         .unlocked_ioctl = lttng_metadata_ioctl,
1341 #ifdef CONFIG_COMPAT
1342         .compat_ioctl = lttng_metadata_ioctl,
1343 #endif
1344 };
1345
1346 /**
1347  *      lttng_event_ioctl - lttng syscall through ioctl
1348  *
1349  *      @file: the file
1350  *      @cmd: the command
1351  *      @arg: command arg
1352  *
1353  *      This ioctl implements lttng commands:
1354  *      LTTNG_KERNEL_CONTEXT
1355  *              Prepend a context field to each record of this event
1356  *      LTTNG_KERNEL_ENABLE
1357  *              Enable recording for this event (weak enable)
1358  *      LTTNG_KERNEL_DISABLE
1359  *              Disable recording for this event (strong disable)
1360  */
1361 static
1362 long lttng_event_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
1363 {
1364         struct lttng_event *event;
1365         struct lttng_enabler *enabler;
1366         enum lttng_event_type *evtype = file->private_data;
1367
1368         switch (cmd) {
1369         case LTTNG_KERNEL_OLD_CONTEXT:
1370         {
1371                 /* Not implemented */
1372                 return -ENOSYS;
1373         }
1374         case LTTNG_KERNEL_CONTEXT:
1375         {
1376                 /* Not implemented */
1377                 return -ENOSYS;
1378         }
1379         case LTTNG_KERNEL_OLD_ENABLE:
1380         case LTTNG_KERNEL_ENABLE:
1381                 switch (*evtype) {
1382                 case LTTNG_TYPE_EVENT:
1383                         event = file->private_data;
1384                         return lttng_event_enable(event);
1385                 case LTTNG_TYPE_ENABLER:
1386                         enabler = file->private_data;
1387                         return lttng_enabler_enable(enabler);
1388                 default:
1389                         WARN_ON_ONCE(1);
1390                         return -ENOSYS;
1391                 }
1392         case LTTNG_KERNEL_OLD_DISABLE:
1393         case LTTNG_KERNEL_DISABLE:
1394                 switch (*evtype) {
1395                 case LTTNG_TYPE_EVENT:
1396                         event = file->private_data;
1397                         return lttng_event_disable(event);
1398                 case LTTNG_TYPE_ENABLER:
1399                         enabler = file->private_data;
1400                         return lttng_enabler_disable(enabler);
1401                 default:
1402                         WARN_ON_ONCE(1);
1403                         return -ENOSYS;
1404                 }
1405         case LTTNG_KERNEL_FILTER:
1406                 switch (*evtype) {
1407                 case LTTNG_TYPE_EVENT:
1408                         return -EINVAL;
1409                 case LTTNG_TYPE_ENABLER:
1410                 {
1411                         enabler = file->private_data;
1412                         return lttng_enabler_attach_bytecode(enabler,
1413                                 (struct lttng_kernel_filter_bytecode __user *) arg);
1414                 }
1415
1416                 }
1417         default:
1418                 return -ENOIOCTLCMD;
1419         }
1420 }
1421
1422 static
1423 int lttng_event_release(struct inode *inode, struct file *file)
1424 {
1425         struct lttng_event *event;
1426         struct lttng_enabler *enabler;
1427         enum lttng_event_type *evtype = file->private_data;
1428
1429         if (!evtype)
1430                 return 0;
1431
1432         switch (*evtype) {
1433         case LTTNG_TYPE_EVENT:
1434                 event = file->private_data;
1435                 if (event)
1436                         fput(event->chan->file);
1437                 break;
1438         case LTTNG_TYPE_ENABLER:
1439                 enabler = file->private_data;
1440                 if (enabler)
1441                         fput(enabler->chan->file);
1442                 break;
1443         default:
1444                 WARN_ON_ONCE(1);
1445                 break;
1446         }
1447
1448         return 0;
1449 }
1450
1451 /* TODO: filter control ioctl */
1452 static const struct file_operations lttng_event_fops = {
1453         .owner = THIS_MODULE,
1454         .release = lttng_event_release,
1455         .unlocked_ioctl = lttng_event_ioctl,
1456 #ifdef CONFIG_COMPAT
1457         .compat_ioctl = lttng_event_ioctl,
1458 #endif
1459 };
1460
1461 static int put_u64(uint64_t val, unsigned long arg)
1462 {
1463         return put_user(val, (uint64_t __user *) arg);
1464 }
1465
1466 static long lttng_stream_ring_buffer_ioctl(struct file *filp,
1467                 unsigned int cmd, unsigned long arg)
1468 {
1469         struct lib_ring_buffer *buf = filp->private_data;
1470         struct channel *chan = buf->backend.chan;
1471         const struct lib_ring_buffer_config *config = &chan->backend.config;
1472         const struct lttng_channel_ops *ops = chan->backend.priv_ops;
1473         int ret;
1474
1475         if (atomic_read(&chan->record_disabled))
1476                 return -EIO;
1477
1478         switch (cmd) {
1479         case LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN:
1480         {
1481                 uint64_t ts;
1482
1483                 ret = ops->timestamp_begin(config, buf, &ts);
1484                 if (ret < 0)
1485                         goto error;
1486                 return put_u64(ts, arg);
1487         }
1488         case LTTNG_RING_BUFFER_GET_TIMESTAMP_END:
1489         {
1490                 uint64_t ts;
1491
1492                 ret = ops->timestamp_end(config, buf, &ts);
1493                 if (ret < 0)
1494                         goto error;
1495                 return put_u64(ts, arg);
1496         }
1497         case LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED:
1498         {
1499                 uint64_t ed;
1500
1501                 ret = ops->events_discarded(config, buf, &ed);
1502                 if (ret < 0)
1503                         goto error;
1504                 return put_u64(ed, arg);
1505         }
1506         case LTTNG_RING_BUFFER_GET_CONTENT_SIZE:
1507         {
1508                 uint64_t cs;
1509
1510                 ret = ops->content_size(config, buf, &cs);
1511                 if (ret < 0)
1512                         goto error;
1513                 return put_u64(cs, arg);
1514         }
1515         case LTTNG_RING_BUFFER_GET_PACKET_SIZE:
1516         {
1517                 uint64_t ps;
1518
1519                 ret = ops->packet_size(config, buf, &ps);
1520                 if (ret < 0)
1521                         goto error;
1522                 return put_u64(ps, arg);
1523         }
1524         case LTTNG_RING_BUFFER_GET_STREAM_ID:
1525         {
1526                 uint64_t si;
1527
1528                 ret = ops->stream_id(config, buf, &si);
1529                 if (ret < 0)
1530                         goto error;
1531                 return put_u64(si, arg);
1532         }
1533         case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP:
1534         {
1535                 uint64_t ts;
1536
1537                 ret = ops->current_timestamp(config, buf, &ts);
1538                 if (ret < 0)
1539                         goto error;
1540                 return put_u64(ts, arg);
1541         }
1542         case LTTNG_RING_BUFFER_GET_SEQ_NUM:
1543         {
1544                 uint64_t seq;
1545
1546                 ret = ops->sequence_number(config, buf, &seq);
1547                 if (ret < 0)
1548                         goto error;
1549                 return put_u64(seq, arg);
1550         }
1551         case LTTNG_RING_BUFFER_INSTANCE_ID:
1552         {
1553                 uint64_t id;
1554
1555                 ret = ops->instance_id(config, buf, &id);
1556                 if (ret < 0)
1557                         goto error;
1558                 return put_u64(id, arg);
1559         }
1560         default:
1561                 return lib_ring_buffer_file_operations.unlocked_ioctl(filp,
1562                                 cmd, arg);
1563         }
1564
1565 error:
1566         return -ENOSYS;
1567 }
1568
1569 #ifdef CONFIG_COMPAT
1570 static long lttng_stream_ring_buffer_compat_ioctl(struct file *filp,
1571                 unsigned int cmd, unsigned long arg)
1572 {
1573         struct lib_ring_buffer *buf = filp->private_data;
1574         struct channel *chan = buf->backend.chan;
1575         const struct lib_ring_buffer_config *config = &chan->backend.config;
1576         const struct lttng_channel_ops *ops = chan->backend.priv_ops;
1577         int ret;
1578
1579         if (atomic_read(&chan->record_disabled))
1580                 return -EIO;
1581
1582         switch (cmd) {
1583         case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN:
1584         {
1585                 uint64_t ts;
1586
1587                 ret = ops->timestamp_begin(config, buf, &ts);
1588                 if (ret < 0)
1589                         goto error;
1590                 return put_u64(ts, arg);
1591         }
1592         case LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END:
1593         {
1594                 uint64_t ts;
1595
1596                 ret = ops->timestamp_end(config, buf, &ts);
1597                 if (ret < 0)
1598                         goto error;
1599                 return put_u64(ts, arg);
1600         }
1601         case LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED:
1602         {
1603                 uint64_t ed;
1604
1605                 ret = ops->events_discarded(config, buf, &ed);
1606                 if (ret < 0)
1607                         goto error;
1608                 return put_u64(ed, arg);
1609         }
1610         case LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE:
1611         {
1612                 uint64_t cs;
1613
1614                 ret = ops->content_size(config, buf, &cs);
1615                 if (ret < 0)
1616                         goto error;
1617                 return put_u64(cs, arg);
1618         }
1619         case LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE:
1620         {
1621                 uint64_t ps;
1622
1623                 ret = ops->packet_size(config, buf, &ps);
1624                 if (ret < 0)
1625                         goto error;
1626                 return put_u64(ps, arg);
1627         }
1628         case LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID:
1629         {
1630                 uint64_t si;
1631
1632                 ret = ops->stream_id(config, buf, &si);
1633                 if (ret < 0)
1634                         goto error;
1635                 return put_u64(si, arg);
1636         }
1637         case LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP:
1638         {
1639                 uint64_t ts;
1640
1641                 ret = ops->current_timestamp(config, buf, &ts);
1642                 if (ret < 0)
1643                         goto error;
1644                 return put_u64(ts, arg);
1645         }
1646         case LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM:
1647         {
1648                 uint64_t seq;
1649
1650                 ret = ops->sequence_number(config, buf, &seq);
1651                 if (ret < 0)
1652                         goto error;
1653                 return put_u64(seq, arg);
1654         }
1655         case LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID:
1656         {
1657                 uint64_t id;
1658
1659                 ret = ops->instance_id(config, buf, &id);
1660                 if (ret < 0)
1661                         goto error;
1662                 return put_u64(id, arg);
1663         }
1664         default:
1665                 return lib_ring_buffer_file_operations.compat_ioctl(filp,
1666                                 cmd, arg);
1667         }
1668
1669 error:
1670         return -ENOSYS;
1671 }
1672 #endif /* CONFIG_COMPAT */
1673
1674 static void lttng_stream_override_ring_buffer_fops(void)
1675 {
1676         lttng_stream_ring_buffer_file_operations.owner = THIS_MODULE;
1677         lttng_stream_ring_buffer_file_operations.open =
1678                 lib_ring_buffer_file_operations.open;
1679         lttng_stream_ring_buffer_file_operations.release =
1680                 lib_ring_buffer_file_operations.release;
1681         lttng_stream_ring_buffer_file_operations.poll =
1682                 lib_ring_buffer_file_operations.poll;
1683         lttng_stream_ring_buffer_file_operations.splice_read =
1684                 lib_ring_buffer_file_operations.splice_read;
1685         lttng_stream_ring_buffer_file_operations.mmap =
1686                 lib_ring_buffer_file_operations.mmap;
1687         lttng_stream_ring_buffer_file_operations.unlocked_ioctl =
1688                 lttng_stream_ring_buffer_ioctl;
1689         lttng_stream_ring_buffer_file_operations.llseek =
1690                 lib_ring_buffer_file_operations.llseek;
1691 #ifdef CONFIG_COMPAT
1692         lttng_stream_ring_buffer_file_operations.compat_ioctl =
1693                 lttng_stream_ring_buffer_compat_ioctl;
1694 #endif
1695 }
1696
1697 int __init lttng_abi_init(void)
1698 {
1699         int ret = 0;
1700
1701         wrapper_vmalloc_sync_all();
1702         lttng_clock_ref();
1703         lttng_proc_dentry = proc_create_data("lttng", S_IRUSR | S_IWUSR, NULL,
1704                                         &lttng_fops, NULL);
1705
1706         if (!lttng_proc_dentry) {
1707                 printk(KERN_ERR "Error creating LTTng control file\n");
1708                 ret = -ENOMEM;
1709                 goto error;
1710         }
1711         lttng_stream_override_ring_buffer_fops();
1712         return 0;
1713
1714 error:
1715         lttng_clock_unref();
1716         return ret;
1717 }
1718
1719 /* No __exit annotation because used by init error path too. */
1720 void lttng_abi_exit(void)
1721 {
1722         lttng_clock_unref();
1723         if (lttng_proc_dentry)
1724                 remove_proc_entry("lttng", NULL);
1725 }