src/common/fd-tracker/fd-tracker.c

   1 /*
   2  * Copyright (C) 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License, version 2 only, as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; if not, write to the Free Software Foundation, Inc., 51
  15  * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #include <urcu.h>
  19 #include <urcu/list.h>
  20 #include <urcu/rculfhash.h>
  21
  22 #include <sys/stat.h>
  23 #include <sys/types.h>
  24 #include <fcntl.h>
  25 #include <stdbool.h>
  26 #include <pthread.h>
  27 #include <inttypes.h>
  28
  29 #include "common/macros.h"
  30 #include "common/error.h"
  31 #include "common/defaults.h"
  32 #include "common/hashtable/utils.h"
  33 #include "common/hashtable/hashtable.h"
  34
  35 #include "fd-tracker.h"
  36 #include "inode.h"
  37
  38 /* Tracker lock must be taken by the user. */
  39 #define TRACKED_COUNT(tracker)                 \
  40         (tracker->count.suspendable.active +   \
  41         tracker->count.suspendable.suspended + \
  42         tracker->count.unsuspendable)
  43
  44 /* Tracker lock must be taken by the user. */
  45 #define ACTIVE_COUNT(tracker)                  \
  46         (tracker->count.suspendable.active +   \
  47         tracker->count.unsuspendable)
  48
  49 /* Tracker lock must be taken by the user. */
  50 #define SUSPENDED_COUNT(tracker)               \
  51         (tracker->count.suspendable.suspended)
  52
  53 /* Tracker lock must be taken by the user. */
  54 #define SUSPENDABLE_COUNT(tracker)             \
  55         (tracker->count.suspendable.active +   \
  56         tracker->count.suspendable.suspended)
  57
  58 /* Tracker lock must be taken by the user. */
  59 #define UNSUSPENDABLE_COUNT(tracker)           \
  60         (tracker->count.unsuspendable)
  61
  62 struct fd_tracker {
  63         pthread_mutex_t lock;
  64         struct {
  65                 struct {
  66                         unsigned int active;
  67                         unsigned int suspended;
  68                 } suspendable;
  69                 unsigned int unsuspendable;
  70         } count;
  71         unsigned int capacity;
  72         struct {
  73                 uint64_t uses;
  74                 uint64_t misses;
  75                 /* Failures to suspend or restore fs handles. */
  76                 uint64_t errors;
  77         } stats;
  78         /*
  79          * The head of the active_handles list is always the least recently
  80          * used active handle. When an handle is used, it is removed from the
  81          * list and added to the end. When a file has to be suspended, the
  82          * first element in the list is "popped", suspended, and added to the
  83          * list of suspended handles.
  84          */
  85         struct cds_list_head active_handles;
  86         struct cds_list_head suspended_handles;
  87         struct cds_lfht *unsuspendable_fds;
  88         struct lttng_inode_registry *inode_registry;
  89 };
  90
  91 struct open_properties {
  92         int flags;
  93         struct {
  94                 bool is_set;
  95                 mode_t value;
  96         } mode;
  97 };
  98
  99 /*
 100  * A fs_handle is not ref-counted. Therefore, it is assumed that a
 101  * handle is never in-use while it is being reclaimed. It can be
 102  * shared by multiple threads, but external synchronization is required
 103  * to ensure it is not still being used when it is reclaimed (close method).
 104  * In this respect, it is not different from a regular file descriptor.
 105  *
 106  * The fs_handle lock always nests _within_ the tracker's lock.
 107  */
 108 struct fs_handle {
 109         pthread_mutex_t lock;
 110         /*
 111          * Weak reference to the tracker. All fs_handles are assumed to have
 112          * been closed at the moment of the destruction of the fd_tracker.
 113          */
 114         struct fd_tracker *tracker;
 115         struct open_properties properties;
 116         struct lttng_inode *inode;
 117         int fd;
 118         /* inode number of the file at the time of the handle's creation. */
 119         uint64_t ino;
 120         bool in_use;
 121         /* Offset to which the file should be restored. */
 122         off_t offset;
 123         struct cds_list_head handles_list_node;
 124 };
 125
 126 struct unsuspendable_fd {
 127         /*
 128          * Accesses are only performed through the tracker, which is protected
 129          * by its own lock.
 130          */
 131         int fd;
 132         char *name;
 133         struct cds_lfht_node tracker_node;
 134         struct rcu_head rcu_head;
 135 };
 136
 137 static struct {
 138         pthread_mutex_t lock;
 139         bool initialized;
 140         unsigned long value;
 141 } seed = {
 142         .lock = PTHREAD_MUTEX_INITIALIZER,
 143 };
 144
 145 static int match_fd(struct cds_lfht_node *node, const void *key);
 146 static void unsuspendable_fd_destroy(struct unsuspendable_fd *entry);
 147 static struct unsuspendable_fd *unsuspendable_fd_create(const char *name,
 148                 int fd);
 149 static int open_from_properties(const char *path,
 150                 struct open_properties *properties);
 151
 152 static void fs_handle_log(struct fs_handle *handle);
 153 static int fs_handle_suspend(struct fs_handle *handle);
 154 static int fs_handle_restore(struct fs_handle *handle);
 155
 156 static void fd_tracker_track(struct fd_tracker *tracker,
 157                 struct fs_handle *handle);
 158 static void fd_tracker_untrack(struct fd_tracker *tracker,
 159                 struct fs_handle *handle);
 160 static int fd_tracker_suspend_handles(struct fd_tracker *tracker,
 161                 unsigned int count);
 162 static int fd_tracker_restore_handle(struct fd_tracker *tracker,
 163                 struct fs_handle *handle);
 164
 165 /* Match function of the tracker's unsuspendable_fds hash table. */
 166 static
 167 int match_fd(struct cds_lfht_node *node, const void *key)
 168 {
 169         struct unsuspendable_fd *entry =
 170                 caa_container_of(node, struct unsuspendable_fd, tracker_node);
 171
 172         return hash_match_key_ulong((void *) (unsigned long) entry->fd,
 173                         (void *) key);
 174 }
 175
 176 static
 177 void delete_unsuspendable_fd(struct rcu_head *head)
 178 {
 179         struct unsuspendable_fd *fd = caa_container_of(head,
 180                         struct unsuspendable_fd, rcu_head);
 181
 182         free(fd->name);
 183         free(fd);
 184 }
 185
 186 static
 187 void unsuspendable_fd_destroy(struct unsuspendable_fd *entry)
 188 {
 189         if (!entry) {
 190                 return;
 191         }
 192         call_rcu(&entry->rcu_head, delete_unsuspendable_fd);
 193 }
 194
 195 static
 196 struct unsuspendable_fd *unsuspendable_fd_create(const char *name, int fd)
 197 {
 198         struct unsuspendable_fd *entry =
 199                         zmalloc(sizeof(*entry));
 200
 201         if (!entry) {
 202                 goto error;
 203         }
 204         if (name) {
 205                 entry->name = strdup(name);
 206                 if (!entry->name) {
 207                         goto error;
 208                 }
 209         }
 210         cds_lfht_node_init(&entry->tracker_node);
 211         entry->fd = fd;
 212         return entry;
 213 error:
 214         unsuspendable_fd_destroy(entry);
 215         return NULL;
 216 }
 217
 218 static
 219 void fs_handle_log(struct fs_handle *handle)
 220 {
 221         const char *path;
 222
 223         pthread_mutex_lock(&handle->lock);
 224         path = lttng_inode_get_path(handle->inode);
 225
 226         if (handle->fd >= 0) {
 227                 DBG_NO_LOC("    %s [active, fd %d%s]",
 228                                 path,
 229                                 handle->fd,
 230                                 handle->in_use ? ", in use" : "");
 231         } else {
 232                 DBG_NO_LOC("    %s [suspended]", path);
 233         }
 234         pthread_mutex_unlock(&handle->lock);
 235 }
 236
 237 /* Tracker lock must be held by the caller. */
 238 static
 239 int fs_handle_suspend(struct fs_handle *handle)
 240 {
 241         int ret = 0;
 242         struct stat fs_stat;
 243         const char *path;
 244
 245         pthread_mutex_lock(&handle->lock);
 246         path = lttng_inode_get_path(handle->inode);
 247         assert(handle->fd >= 0);
 248         if (handle->in_use) {
 249                 /* This handle can't be suspended as it is currently in use. */
 250                 ret = -EAGAIN;
 251                 goto end;
 252         }
 253
 254         ret = stat(path, &fs_stat);
 255         if (ret) {
 256                 PERROR("Filesystem handle to %s cannot be suspended as stat() failed",
 257                                 path);
 258                 ret = -errno;
 259                 goto end;
 260         }
 261
 262         if (fs_stat.st_ino != handle->ino) {
 263                 /* Don't suspend as the handle would not be restorable. */
 264                 WARN("Filesystem handle to %s cannot be suspended as its inode changed",
 265                                 path);
 266                 ret = -ENOENT;
 267                 goto end;
 268         }
 269
 270         handle->offset = lseek(handle->fd, 0, SEEK_CUR);
 271         if (handle->offset == -1) {
 272                 WARN("Filesystem handle to %s cannot be suspended as lseek() failed to sample its current position",
 273                                 path);
 274                 ret = -errno;
 275                 goto end;
 276         }
 277
 278         ret = close(handle->fd);
 279         if (ret) {
 280                 PERROR("Filesystem handle to %s cannot be suspended as close() failed",
 281                                 path);
 282                 ret = -errno;
 283                 goto end;
 284         }
 285         DBG("Suspended filesystem handle to %s (fd %i) at position %" PRId64,
 286                         path, handle->fd, handle->offset);
 287         handle->fd = -1;
 288 end:
 289         if (ret) {
 290                 handle->tracker->stats.errors++;
 291         }
 292         pthread_mutex_unlock(&handle->lock);
 293         return ret;
 294 }
 295
 296 /* Caller must hold the tracker and handle's locks. */
 297 static
 298 int fs_handle_restore(struct fs_handle *handle)
 299 {
 300         int ret, fd = -1;
 301         const char *path = lttng_inode_get_path(handle->inode);
 302
 303         assert(handle->fd == -1);
 304         assert(path);
 305         ret = open_from_properties(path,
 306                         &handle->properties);
 307         if (ret < 0) {
 308                 PERROR("Failed to restore filesystem handle to %s, open() failed",
 309                                 path);
 310                 ret = -errno;
 311                 goto end;
 312         }
 313         fd = ret;
 314
 315         ret = lseek(fd, handle->offset, SEEK_SET);
 316         if (ret < 0) {
 317                 PERROR("Failed to restore filesystem handle to %s, lseek() failed",
 318                                 path);
 319                 ret = -errno;
 320                 goto end;
 321         }
 322         DBG("Restored filesystem handle to %s (fd %i) at position %" PRId64,
 323                         path, fd, handle->offset);
 324         ret = 0;
 325         handle->fd = fd;
 326         fd = -1;
 327 end:
 328         if (fd >= 0) {
 329                 (void) close(fd);
 330         }
 331         return ret;
 332 }
 333
 334 static
 335 int open_from_properties(const char *path, struct open_properties *properties)
 336 {
 337         int ret;
 338
 339         /*
 340          * open() ignores the 'flags' parameter unless the O_CREAT or O_TMPFILE
 341          * flags are set. O_TMPFILE would not make sense in the context of a
 342          * suspendable fs_handle as it would not be restorable (see OPEN(2)),
 343          * thus it is ignored here.
 344          */
 345         if ((properties->flags & O_CREAT) && properties->mode.is_set) {
 346                 ret = open(path, properties->flags,
 347                                 properties->mode.value);
 348         } else {
 349                 ret = open(path, properties->flags);
 350         }
 351         /*
 352          * Some flags should not be used beyond the initial open() of a
 353          * restorable file system handle. O_CREAT and O_TRUNC must
 354          * be cleared since it would be unexpected to re-use them
 355          * when the handle is retored:
 356          *  - O_CREAT should not be needed as the file has been created
 357          *    on the initial call to open(),
 358          *  - O_TRUNC would destroy the file's contents by truncating it
 359          *    to length 0.
 360          */
 361         properties->flags &= ~(O_CREAT | O_TRUNC);
 362         if (ret < 0) {
 363                 ret = -errno;
 364                 goto end;
 365         }
 366 end:
 367         return ret;
 368 }
 369
 370 struct fd_tracker *fd_tracker_create(unsigned int capacity)
 371 {
 372         struct fd_tracker *tracker = zmalloc(sizeof(struct fd_tracker));
 373
 374         if (!tracker) {
 375                 goto end;
 376         }
 377
 378         pthread_mutex_lock(&seed.lock);
 379         if (!seed.initialized) {
 380                 seed.value = (unsigned long) time(NULL);
 381                 seed.initialized = true;
 382         }
 383         pthread_mutex_unlock(&seed.lock);
 384
 385         CDS_INIT_LIST_HEAD(&tracker->active_handles);
 386         CDS_INIT_LIST_HEAD(&tracker->suspended_handles);
 387         tracker->capacity = capacity;
 388         tracker->unsuspendable_fds = cds_lfht_new(DEFAULT_HT_SIZE, 1, 0,
 389                         CDS_LFHT_AUTO_RESIZE | CDS_LFHT_ACCOUNTING, NULL);
 390         if (!tracker->unsuspendable_fds) {
 391                 ERR("Failed to create fd-tracker's unsuspendable_fds hash table");
 392                 goto error;
 393         }
 394         tracker->inode_registry = lttng_inode_registry_create();
 395         if (!tracker->inode_registry) {
 396                 ERR("Failed to create fd-tracker's inode registry");
 397                 goto error;
 398         }
 399         DBG("File descriptor tracker created with a limit of %u simultaneously-opened FDs",
 400                         capacity);
 401 end:
 402         return tracker;
 403 error:
 404         fd_tracker_destroy(tracker);
 405         return NULL;
 406 }
 407
 408 void fd_tracker_log(struct fd_tracker *tracker)
 409 {
 410         struct fs_handle *handle;
 411         struct unsuspendable_fd *unsuspendable_fd;
 412         struct cds_lfht_iter iter;
 413
 414         pthread_mutex_lock(&tracker->lock);
 415         DBG_NO_LOC("File descriptor tracker");
 416         DBG_NO_LOC("  Stats:");
 417         DBG_NO_LOC("    uses:            %" PRIu64, tracker->stats.uses);
 418         DBG_NO_LOC("    misses:          %" PRIu64, tracker->stats.misses);
 419         DBG_NO_LOC("    errors:          %" PRIu64, tracker->stats.errors);
 420         DBG_NO_LOC("  Tracked:           %u", TRACKED_COUNT(tracker));
 421         DBG_NO_LOC("    active:          %u", ACTIVE_COUNT(tracker));
 422         DBG_NO_LOC("      suspendable:   %u", SUSPENDABLE_COUNT(tracker));
 423         DBG_NO_LOC("      unsuspendable: %u", UNSUSPENDABLE_COUNT(tracker));
 424         DBG_NO_LOC("    suspended:       %u", SUSPENDED_COUNT(tracker));
 425         DBG_NO_LOC("    capacity:        %u", tracker->capacity);
 426
 427         DBG_NO_LOC("  Tracked suspendable file descriptors");
 428         cds_list_for_each_entry(handle, &tracker->active_handles,
 429                         handles_list_node) {
 430                 fs_handle_log(handle);
 431         }
 432         cds_list_for_each_entry(handle, &tracker->suspended_handles,
 433                         handles_list_node) {
 434                 fs_handle_log(handle);
 435         }
 436         if (!SUSPENDABLE_COUNT(tracker)) {
 437                 DBG_NO_LOC("    None");
 438         }
 439
 440         DBG_NO_LOC("  Tracked unsuspendable file descriptors");
 441         rcu_read_lock();
 442         cds_lfht_for_each_entry(tracker->unsuspendable_fds, &iter,
 443                         unsuspendable_fd, tracker_node) {
 444                 DBG_NO_LOC("    %s [active, fd %d]", unsuspendable_fd->name ? : "Unnamed",
 445                                 unsuspendable_fd->fd);
 446         }
 447         rcu_read_unlock();
 448         if (!UNSUSPENDABLE_COUNT(tracker)) {
 449                 DBG_NO_LOC("    None");
 450         }
 451
 452         pthread_mutex_unlock(&tracker->lock);
 453 }
 454
 455 int fd_tracker_destroy(struct fd_tracker *tracker)
 456 {
 457         int ret = 0;
 458
 459         /*
 460          * Refuse to destroy the tracker as fs_handles may still old
 461          * weak references to the tracker.
 462          */
 463         pthread_mutex_lock(&tracker->lock);
 464         if (TRACKED_COUNT(tracker)) {
 465                 ERR("A file descriptor leak has been detected: %u tracked file descriptors are still being tracked",
 466                                 TRACKED_COUNT(tracker));
 467                 pthread_mutex_unlock(&tracker->lock);
 468                 fd_tracker_log(tracker);
 469                 ret = -1;
 470                 goto end;
 471         }
 472         pthread_mutex_unlock(&tracker->lock);
 473
 474         if (tracker->unsuspendable_fds) {
 475                 ret = cds_lfht_destroy(tracker->unsuspendable_fds, NULL);
 476                 assert(!ret);
 477         }
 478
 479         lttng_inode_registry_destroy(tracker->inode_registry);
 480         pthread_mutex_destroy(&tracker->lock);
 481         free(tracker);
 482 end:
 483         return ret;
 484 }
 485
 486 struct fs_handle *fd_tracker_open_fs_handle(struct fd_tracker *tracker,
 487                 const char *path, int flags, mode_t *mode)
 488 {
 489         int ret;
 490         struct fs_handle *handle = NULL;
 491         struct stat fd_stat;
 492         struct open_properties properties = {
 493                 .flags = flags,
 494                 .mode.is_set = !!mode,
 495                 .mode.value = mode ? *mode : 0,
 496         };
 497
 498         pthread_mutex_lock(&tracker->lock);
 499         if (ACTIVE_COUNT(tracker) == tracker->capacity) {
 500                 if (tracker->count.suspendable.active > 0) {
 501                         ret = fd_tracker_suspend_handles(tracker, 1);
 502                         if (ret) {
 503                                 goto error_destroy;
 504                         }
 505                 } else {
 506                         /*
 507                          * There are not enough active suspendable file
 508                          * descriptors to open a new fd and still accomodate the
 509                          * tracker's capacity.
 510                          */
 511                         WARN("Cannot open file system handle, too many unsuspendable file descriptors are opened (%u)",
 512                                         tracker->count.unsuspendable);
 513                         ret = -EMFILE;
 514                         goto error_destroy;
 515                 }
 516         }
 517
 518         handle = zmalloc(sizeof(*handle));
 519         if (!handle) {
 520                 goto end;
 521         }
 522         handle->tracker = tracker;
 523
 524         ret = pthread_mutex_init(&handle->lock, NULL);
 525         if (ret) {
 526                 PERROR("Failed to initialize handle mutex while creating fs handle");
 527                 free(handle);
 528                 goto error_free;
 529         }
 530
 531         handle->fd = open_from_properties(path, &properties);
 532         if (handle->fd < 0) {
 533                 PERROR("Failed to open fs handle to %s, open() returned", path);
 534                 ret = -errno;
 535                 goto error_destroy;
 536         }
 537
 538         handle->properties = properties;
 539
 540         handle->inode = lttng_inode_registry_get_inode(tracker->inode_registry,
 541                         handle->fd, path);
 542         if (!handle->inode) {
 543                 ERR("Failed to get lttng_inode corresponding to file %s",
 544                                 path);
 545                 goto error_destroy;
 546         }
 547
 548         if (fstat(handle->fd, &fd_stat)) {
 549                 PERROR("Failed to retrieve file descriptor inode while creating fs handle, fstat() returned");
 550                 ret = -errno;
 551                 goto error_destroy;
 552         }
 553         handle->ino = fd_stat.st_ino;
 554
 555         fd_tracker_track(tracker, handle);
 556         pthread_mutex_unlock(&tracker->lock);
 557 end:
 558         return handle;
 559 error_destroy:
 560         pthread_mutex_destroy(&handle->lock);
 561 error_free:
 562         if (handle->inode) {
 563                 lttng_inode_put(handle->inode);
 564         }
 565         free(handle);
 566         pthread_mutex_unlock(&tracker->lock);
 567         handle = NULL;
 568         goto end;
 569 }
 570
 571 /* Caller must hold the tracker's lock. */
 572 static
 573 int fd_tracker_suspend_handles(struct fd_tracker *tracker,
 574                 unsigned int count)
 575 {
 576         unsigned int left_to_close = count;
 577         struct fs_handle *handle, *tmp;
 578
 579         cds_list_for_each_entry_safe(handle, tmp, &tracker->active_handles,
 580                         handles_list_node) {
 581                 int ret;
 582
 583                 fd_tracker_untrack(tracker, handle);
 584                 ret = fs_handle_suspend(handle);
 585                 fd_tracker_track(tracker, handle);
 586                 if (!ret) {
 587                         left_to_close--;
 588                 }
 589
 590                 if (!left_to_close) {
 591                         break;
 592                 }
 593         }
 594         return left_to_close ? -EMFILE : 0;
 595 }
 596
 597 int fd_tracker_open_unsuspendable_fd(struct fd_tracker *tracker,
 598                 int *out_fds, const char **names, unsigned int fd_count,
 599                 fd_open_cb open, void *user_data)
 600 {
 601         int ret, user_ret, i, fds_to_suspend;
 602         unsigned int active_fds;
 603         struct unsuspendable_fd *entries[fd_count];
 604
 605         memset(entries, 0, sizeof(entries));
 606
 607         pthread_mutex_lock(&tracker->lock);
 608
 609         active_fds = ACTIVE_COUNT(tracker);
 610         fds_to_suspend = (int) active_fds + (int) fd_count - (int) tracker->capacity;
 611         if (fds_to_suspend > 0) {
 612                 if (fds_to_suspend <= tracker->count.suspendable.active) {
 613                         ret = fd_tracker_suspend_handles(tracker, fds_to_suspend);
 614                         if (ret) {
 615                                 goto end;
 616                         }
 617                 } else {
 618                         /*
 619                          * There are not enough active suspendable file
 620                          * descriptors to open a new fd and still accomodate the
 621                          * tracker's capacity.
 622                          */
 623                         WARN("Cannot open unsuspendable fd, too many unsuspendable file descriptors are opened (%u)",
 624                                         tracker->count.unsuspendable);
 625                         ret = -EMFILE;
 626                         goto end;
 627                 }
 628         }
 629
 630         user_ret = open(user_data, out_fds);
 631         if (user_ret) {
 632                 ret = user_ret;
 633                 goto end;
 634         }
 635
 636         /*
 637          * Add the fds returned by the user's callback to the hashtable
 638          * of unsuspendable fds.
 639          */
 640         for (i = 0; i < fd_count; i++) {
 641                 struct unsuspendable_fd *entry =
 642                                 unsuspendable_fd_create(names ? names[i] : NULL,
 643                                                 out_fds[i]);
 644
 645                 if (!entry) {
 646                         ret = -1;
 647                         goto end_free_entries;
 648                 }
 649                 entries[i] = entry;
 650         }
 651
 652         rcu_read_lock();
 653         for (i = 0; i < fd_count; i++) {
 654                 struct cds_lfht_node *node;
 655                 struct unsuspendable_fd *entry = entries[i];
 656
 657                 node = cds_lfht_add_unique(
 658                                 tracker->unsuspendable_fds,
 659                                 hash_key_ulong((void *) (unsigned long) out_fds[i],
 660                                                 seed.value),
 661                                 match_fd,
 662                                 (void *) (unsigned long) out_fds[i],
 663                                 &entry->tracker_node);
 664
 665                 if (node != &entry->tracker_node) {
 666                         ret = -EEXIST;
 667                         rcu_read_unlock();
 668                         goto end_free_entries;
 669                 }
 670                 entries[i] = NULL;
 671         }
 672         tracker->count.unsuspendable += fd_count;
 673         rcu_read_unlock();
 674         ret = user_ret;
 675 end:
 676         pthread_mutex_unlock(&tracker->lock);
 677         return ret;
 678 end_free_entries:
 679         for (i = 0; i < fd_count; i++) {
 680                 unsuspendable_fd_destroy(entries[i]);
 681         }
 682         goto end;
 683 }
 684
 685 int fd_tracker_close_unsuspendable_fd(struct fd_tracker *tracker,
 686                 int *fds_in, unsigned int fd_count, fd_close_cb close,
 687                 void *user_data)
 688 {
 689         int i, ret, user_ret;
 690         int fds[fd_count];
 691
 692         /*
 693          * Maintain a local copy of fds_in as the user's callback may modify its
 694          * contents (e.g. setting the fd(s) to -1 after close).
 695          */
 696         memcpy(fds, fds_in, sizeof(*fds) * fd_count);
 697
 698         pthread_mutex_lock(&tracker->lock);
 699         rcu_read_lock();
 700
 701         /* Let the user close the file descriptors. */
 702         user_ret = close(user_data, fds_in);
 703         if (user_ret) {
 704                 ret = user_ret;
 705                 goto end;
 706         }
 707
 708         /* Untrack the fds that were just closed by the user's callback. */
 709         for (i = 0; i < fd_count; i++) {
 710                 struct cds_lfht_node *node;
 711                 struct cds_lfht_iter iter;
 712                 struct unsuspendable_fd *entry;
 713
 714                 cds_lfht_lookup(tracker->unsuspendable_fds,
 715                                 hash_key_ulong((void *) (unsigned long) fds[i],
 716                                                 seed.value),
 717                                 match_fd,
 718                                 (void *) (unsigned long) fds[i],
 719                                 &iter);
 720                 node = cds_lfht_iter_get_node(&iter);
 721                 if (!node) {
 722                         /* Unknown file descriptor. */
 723                         WARN("Untracked file descriptor %d passed to fd_tracker_close_unsuspendable_fd()",
 724                                         fds[i]);
 725                         ret = -EINVAL;
 726                         goto end;
 727                 }
 728                 entry = caa_container_of(node,
 729                                 struct unsuspendable_fd,
 730                                 tracker_node);
 731
 732                 cds_lfht_del(tracker->unsuspendable_fds, node);
 733                 unsuspendable_fd_destroy(entry);
 734                 fds[i] = -1;
 735         }
 736
 737         tracker->count.unsuspendable -= fd_count;
 738         ret = 0;
 739 end:
 740         rcu_read_unlock();
 741         pthread_mutex_unlock(&tracker->lock);
 742         return ret;
 743 }
 744
 745 /* Caller must have taken the tracker's and handle's locks. */
 746 static
 747 void fd_tracker_track(struct fd_tracker *tracker, struct fs_handle *handle)
 748 {
 749         if (handle->fd >= 0) {
 750                 tracker->count.suspendable.active++;
 751                 cds_list_add_tail(&handle->handles_list_node,
 752                                 &tracker->active_handles);
 753         } else {
 754                 tracker->count.suspendable.suspended++;
 755                 cds_list_add_tail(&handle->handles_list_node,
 756                                 &tracker->suspended_handles);
 757         }
 758 }
 759
 760 /* Caller must have taken the tracker's and handle's locks. */
 761 static
 762 void fd_tracker_untrack(struct fd_tracker *tracker, struct fs_handle *handle)
 763 {
 764         if (handle->fd >= 0) {
 765                 tracker->count.suspendable.active--;
 766         } else {
 767                 tracker->count.suspendable.suspended--;
 768         }
 769         cds_list_del(&handle->handles_list_node);
 770 }
 771
 772 /* Caller must have taken the tracker's and handle's locks. */
 773 static
 774 int fd_tracker_restore_handle(struct fd_tracker *tracker,
 775                 struct fs_handle *handle)
 776 {
 777         int ret;
 778
 779         fd_tracker_untrack(tracker, handle);
 780         if (ACTIVE_COUNT(tracker) >= tracker->capacity) {
 781                 ret = fd_tracker_suspend_handles(tracker, 1);
 782                 if (ret) {
 783                         goto end;
 784                 }
 785         }
 786         ret = fs_handle_restore(handle);
 787 end:
 788         fd_tracker_track(tracker, handle);
 789         return ret ? ret : handle->fd;
 790 }
 791
 792 int fs_handle_get_fd(struct fs_handle *handle)
 793 {
 794         int ret;
 795
 796         /*
 797          * TODO This should be optimized as it is a fairly hot path.
 798          * The fd-tracker's lock should only be taken when a fs_handle is
 799          * restored (slow path). On the fast path (fs_handle is active),
 800          * the only effect on the fd_tracker is marking the handle as the
 801          * most recently used. Currently, it is done by a call to the
 802          * track/untrack helpers, but it should be done atomically.
 803          *
 804          * Note that the lock's nesting order must still be respected here.
 805          * The handle's lock nests inside the tracker's lock.
 806          */
 807         pthread_mutex_lock(&handle->tracker->lock);
 808         pthread_mutex_lock(&handle->lock);
 809         assert(!handle->in_use);
 810
 811         handle->tracker->stats.uses++;
 812         if (handle->fd >= 0) {
 813                 ret = handle->fd;
 814                 /* Mark as most recently used. */
 815                 fd_tracker_untrack(handle->tracker, handle);
 816                 fd_tracker_track(handle->tracker, handle);
 817         } else {
 818                 handle->tracker->stats.misses++;
 819                 ret = fd_tracker_restore_handle(handle->tracker, handle);
 820                 if (ret < 0) {
 821                         handle->tracker->stats.errors++;
 822                         goto end;
 823                 }
 824         }
 825         handle->in_use = true;
 826 end:
 827         pthread_mutex_unlock(&handle->lock);
 828         pthread_mutex_unlock(&handle->tracker->lock);
 829         return ret;
 830 }
 831
 832 void fs_handle_put_fd(struct fs_handle *handle)
 833 {
 834         pthread_mutex_lock(&handle->lock);
 835         handle->in_use = false;
 836         pthread_mutex_unlock(&handle->lock);
 837 }
 838
 839 int fs_handle_unlink(struct fs_handle *handle)
 840 {
 841         int ret;
 842
 843         pthread_mutex_lock(&handle->tracker->lock);
 844         pthread_mutex_lock(&handle->lock);
 845         ret = lttng_inode_defer_unlink(handle->inode);
 846         pthread_mutex_unlock(&handle->lock);
 847         pthread_mutex_unlock(&handle->tracker->lock);
 848         return ret;
 849 }
 850
 851 int fs_handle_close(struct fs_handle *handle)
 852 {
 853         int ret = 0;
 854         const char *path = NULL;
 855
 856         if (!handle) {
 857                 ret = -EINVAL;
 858                 goto end;
 859         }
 860
 861         pthread_mutex_lock(&handle->tracker->lock);
 862         pthread_mutex_lock(&handle->lock);
 863         if (handle->inode) {
 864                 path = lttng_inode_get_path(handle->inode);
 865         }
 866         fd_tracker_untrack(handle->tracker, handle);
 867         if (handle->fd >= 0) {
 868                 /*
 869                  * The return value of close() is not propagated as there
 870                  * isn't much the user can do about it.
 871                  */
 872                 if (close(handle->fd)) {
 873                         PERROR("Failed to close the file descritptor (%d) of fs handle to %s, close() returned",
 874                                         handle->fd, path ? path : "Unknown");
 875                 }
 876                 handle->fd = -1;
 877         }
 878         lttng_inode_put(handle->inode);
 879         pthread_mutex_unlock(&handle->lock);
 880         pthread_mutex_destroy(&handle->lock);
 881         pthread_mutex_unlock(&handle->tracker->lock);
 882         free(handle);
 883 end:
 884         return ret;
 885 }