Branch data     Line data    Source code

       1                 :            : // SPDX-License-Identifier: GPL-2.0-or-later
       2                 :            : /*
       3                 :            :  * fs/inotify_user.c - inotify support for userspace
       4                 :            :  *
       5                 :            :  * Authors:
       6                 :            :  *      John McCutchan  <ttb@tentacle.dhs.org>
       7                 :            :  *      Robert Love     <rml@novell.com>
       8                 :            :  *
       9                 :            :  * Copyright (C) 2005 John McCutchan
      10                 :            :  * Copyright 2006 Hewlett-Packard Development Company, L.P.
      11                 :            :  *
      12                 :            :  * Copyright (C) 2009 Eric Paris <Red Hat Inc>
      13                 :            :  * inotify was largely rewriten to make use of the fsnotify infrastructure
      14                 :            :  */
      15                 :            : 
      16                 :            : #include <linux/dcache.h> /* d_unlinked */
      17                 :            : #include <linux/fs.h> /* struct inode */
      18                 :            : #include <linux/fsnotify_backend.h>
      19                 :            : #include <linux/inotify.h>
      20                 :            : #include <linux/path.h> /* struct path */
      21                 :            : #include <linux/slab.h> /* kmem_* */
      22                 :            : #include <linux/types.h>
      23                 :            : #include <linux/sched.h>
      24                 :            : #include <linux/sched/user.h>
      25                 :            : #include <linux/sched/mm.h>
      26                 :            : 
      27                 :            : #include "inotify.h"
      28                 :            : 
      29                 :            : /*
      30                 :            :  * Check if 2 events contain the same information.
      31                 :            :  */
      32                 :          3 : static bool event_compare(struct fsnotify_event *old_fsn,
      33                 :            :                           struct fsnotify_event *new_fsn)
      34                 :            : {
      35                 :            :         struct inotify_event_info *old, *new;
      36                 :            : 
      37                 :            :         old = INOTIFY_E(old_fsn);
      38                 :            :         new = INOTIFY_E(new_fsn);
      39                 :          3 :         if (old->mask & FS_IN_IGNORED)
      40                 :            :                 return false;
      41                 :          3 :         if ((old->mask == new->mask) &&
      42                 :          3 :             (old_fsn->objectid == new_fsn->objectid) &&
      43                 :          3 :             (old->name_len == new->name_len) &&
      44                 :          3 :             (!old->name_len || !strcmp(old->name, new->name)))
      45                 :            :                 return true;
      46                 :          3 :         return false;
      47                 :            : }
      48                 :            : 
      49                 :          3 : static int inotify_merge(struct list_head *list,
      50                 :            :                           struct fsnotify_event *event)
      51                 :            : {
      52                 :            :         struct fsnotify_event *last_event;
      53                 :            : 
      54                 :          3 :         last_event = list_entry(list->prev, struct fsnotify_event, list);
      55                 :          3 :         return event_compare(last_event, event);
      56                 :            : }
      57                 :            : 
      58                 :          3 : int inotify_handle_event(struct fsnotify_group *group,
      59                 :            :                          struct inode *inode,
      60                 :            :                          u32 mask, const void *data, int data_type,
      61                 :            :                          const struct qstr *file_name, u32 cookie,
      62                 :            :                          struct fsnotify_iter_info *iter_info)
      63                 :            : {
      64                 :            :         struct fsnotify_mark *inode_mark = fsnotify_iter_inode_mark(iter_info);
      65                 :            :         struct inotify_inode_mark *i_mark;
      66                 :            :         struct inotify_event_info *event;
      67                 :            :         struct fsnotify_event *fsn_event;
      68                 :            :         int ret;
      69                 :            :         int len = 0;
      70                 :            :         int alloc_len = sizeof(struct inotify_event_info);
      71                 :            : 
      72                 :          3 :         if (WARN_ON(fsnotify_iter_vfsmount_mark(iter_info)))
      73                 :            :                 return 0;
      74                 :            : 
      75                 :          3 :         if ((inode_mark->mask & FS_EXCL_UNLINK) &&
      76                 :            :             (data_type == FSNOTIFY_EVENT_PATH)) {
      77                 :            :                 const struct path *path = data;
      78                 :            : 
      79                 :          0 :                 if (d_unlinked(path->dentry))
      80                 :            :                         return 0;
      81                 :            :         }
      82                 :          3 :         if (file_name) {
      83                 :          3 :                 len = file_name->len;
      84                 :          3 :                 alloc_len += len + 1;
      85                 :            :         }
      86                 :            : 
      87                 :            :         pr_debug("%s: group=%p inode=%p mask=%x\n", __func__, group, inode,
      88                 :            :                  mask);
      89                 :            : 
      90                 :            :         i_mark = container_of(inode_mark, struct inotify_inode_mark,
      91                 :            :                               fsn_mark);
      92                 :            : 
      93                 :            :         /*
      94                 :            :          * Whoever is interested in the event, pays for the allocation. Do not
      95                 :            :          * trigger OOM killer in the target monitoring memcg as it may have
      96                 :            :          * security repercussion.
      97                 :            :          */
      98                 :          3 :         memalloc_use_memcg(group->memcg);
      99                 :          3 :         event = kmalloc(alloc_len, GFP_KERNEL_ACCOUNT | __GFP_RETRY_MAYFAIL);
     100                 :            :         memalloc_unuse_memcg();
     101                 :            : 
     102                 :          3 :         if (unlikely(!event)) {
     103                 :            :                 /*
     104                 :            :                  * Treat lost event due to ENOMEM the same way as queue
     105                 :            :                  * overflow to let userspace know event was lost.
     106                 :            :                  */
     107                 :            :                 fsnotify_queue_overflow(group);
     108                 :          0 :                 return -ENOMEM;
     109                 :            :         }
     110                 :            : 
     111                 :            :         /*
     112                 :            :          * We now report FS_ISDIR flag with MOVE_SELF and DELETE_SELF events
     113                 :            :          * for fanotify. inotify never reported IN_ISDIR with those events.
     114                 :            :          * It looks like an oversight, but to avoid the risk of breaking
     115                 :            :          * existing inotify programs, mask the flag out from those events.
     116                 :            :          */
     117                 :          3 :         if (mask & (IN_MOVE_SELF | IN_DELETE_SELF))
     118                 :          0 :                 mask &= ~IN_ISDIR;
     119                 :            : 
     120                 :          3 :         fsn_event = &event->fse;
     121                 :          3 :         fsnotify_init_event(fsn_event, (unsigned long)inode);
     122                 :          3 :         event->mask = mask;
     123                 :          3 :         event->wd = i_mark->wd;
     124                 :          3 :         event->sync_cookie = cookie;
     125                 :          3 :         event->name_len = len;
     126                 :          3 :         if (len)
     127                 :          3 :                 strcpy(event->name, file_name->name);
     128                 :            : 
     129                 :          3 :         ret = fsnotify_add_event(group, fsn_event, inotify_merge);
     130                 :          3 :         if (ret) {
     131                 :            :                 /* Our event wasn't used in the end. Free it. */
     132                 :          3 :                 fsnotify_destroy_event(group, fsn_event);
     133                 :            :         }
     134                 :            : 
     135                 :          3 :         if (inode_mark->mask & IN_ONESHOT)
     136                 :          0 :                 fsnotify_destroy_mark(inode_mark, group);
     137                 :            : 
     138                 :            :         return 0;
     139                 :            : }
     140                 :            : 
     141                 :          3 : static void inotify_freeing_mark(struct fsnotify_mark *fsn_mark, struct fsnotify_group *group)
     142                 :            : {
     143                 :          3 :         inotify_ignored_and_remove_idr(fsn_mark, group);
     144                 :          3 : }
     145                 :            : 
     146                 :            : /*
     147                 :            :  * This is NEVER supposed to be called.  Inotify marks should either have been
     148                 :            :  * removed from the idr when the watch was removed or in the
     149                 :            :  * fsnotify_destroy_mark_by_group() call when the inotify instance was being
     150                 :            :  * torn down.  This is only called if the idr is about to be freed but there
     151                 :            :  * are still marks in it.
     152                 :            :  */
     153                 :          0 : static int idr_callback(int id, void *p, void *data)
     154                 :            : {
     155                 :            :         struct fsnotify_mark *fsn_mark;
     156                 :            :         struct inotify_inode_mark *i_mark;
     157                 :            :         static bool warned = false;
     158                 :            : 
     159                 :          0 :         if (warned)
     160                 :            :                 return 0;
     161                 :            : 
     162                 :          0 :         warned = true;
     163                 :            :         fsn_mark = p;
     164                 :            :         i_mark = container_of(fsn_mark, struct inotify_inode_mark, fsn_mark);
     165                 :            : 
     166                 :          0 :         WARN(1, "inotify closing but id=%d for fsn_mark=%p in group=%p still in "
     167                 :            :                 "idr.  Probably leaking memory\n", id, p, data);
     168                 :            : 
     169                 :            :         /*
     170                 :            :          * I'm taking the liberty of assuming that the mark in question is a
     171                 :            :          * valid address and I'm dereferencing it.  This might help to figure
     172                 :            :          * out why we got here and the panic is no worse than the original
     173                 :            :          * BUG() that was here.
     174                 :            :          */
     175                 :          0 :         if (fsn_mark)
     176                 :          0 :                 printk(KERN_WARNING "fsn_mark->group=%p wd=%d\n",
     177                 :            :                         fsn_mark->group, i_mark->wd);
     178                 :            :         return 0;
     179                 :            : }
     180                 :            : 
     181                 :          3 : static void inotify_free_group_priv(struct fsnotify_group *group)
     182                 :            : {
     183                 :            :         /* ideally the idr is empty and we won't hit the BUG in the callback */
     184                 :          3 :         idr_for_each(&group->inotify_data.idr, idr_callback, group);
     185                 :          3 :         idr_destroy(&group->inotify_data.idr);
     186                 :          3 :         if (group->inotify_data.ucounts)
     187                 :            :                 dec_inotify_instances(group->inotify_data.ucounts);
     188                 :          3 : }
     189                 :            : 
     190                 :          3 : static void inotify_free_event(struct fsnotify_event *fsn_event)
     191                 :            : {
     192                 :          3 :         kfree(INOTIFY_E(fsn_event));
     193                 :          3 : }
     194                 :            : 
     195                 :            : /* ding dong the mark is dead */
     196                 :          3 : static void inotify_free_mark(struct fsnotify_mark *fsn_mark)
     197                 :            : {
     198                 :            :         struct inotify_inode_mark *i_mark;
     199                 :            : 
     200                 :            :         i_mark = container_of(fsn_mark, struct inotify_inode_mark, fsn_mark);
     201                 :            : 
     202                 :          3 :         kmem_cache_free(inotify_inode_mark_cachep, i_mark);
     203                 :          3 : }
     204                 :            : 
     205                 :            : const struct fsnotify_ops inotify_fsnotify_ops = {
     206                 :            :         .handle_event = inotify_handle_event,
     207                 :            :         .free_group_priv = inotify_free_group_priv,
     208                 :            :         .free_event = inotify_free_event,
     209                 :            :         .freeing_mark = inotify_freeing_mark,
     210                 :            :         .free_mark = inotify_free_mark,
     211                 :            : };