LCOV - code coverage report
Current view: top level - net/sunrpc - cache.c (source / functions) Hit Total Coverage
Test: coverage.info Lines: 114 698 16.3 %
Date: 2014-04-07 Functions: 20 78 25.6 %
Branches: 49 422 11.6 %

           Branch data     Line data    Source code
       1                 :            : /*
       2                 :            :  * net/sunrpc/cache.c
       3                 :            :  *
       4                 :            :  * Generic code for various authentication-related caches
       5                 :            :  * used by sunrpc clients and servers.
       6                 :            :  *
       7                 :            :  * Copyright (C) 2002 Neil Brown <neilb@cse.unsw.edu.au>
       8                 :            :  *
       9                 :            :  * Released under terms in GPL version 2.  See COPYING.
      10                 :            :  *
      11                 :            :  */
      12                 :            : 
      13                 :            : #include <linux/types.h>
      14                 :            : #include <linux/fs.h>
      15                 :            : #include <linux/file.h>
      16                 :            : #include <linux/slab.h>
      17                 :            : #include <linux/signal.h>
      18                 :            : #include <linux/sched.h>
      19                 :            : #include <linux/kmod.h>
      20                 :            : #include <linux/list.h>
      21                 :            : #include <linux/module.h>
      22                 :            : #include <linux/ctype.h>
      23                 :            : #include <asm/uaccess.h>
      24                 :            : #include <linux/poll.h>
      25                 :            : #include <linux/seq_file.h>
      26                 :            : #include <linux/proc_fs.h>
      27                 :            : #include <linux/net.h>
      28                 :            : #include <linux/workqueue.h>
      29                 :            : #include <linux/mutex.h>
      30                 :            : #include <linux/pagemap.h>
      31                 :            : #include <asm/ioctls.h>
      32                 :            : #include <linux/sunrpc/types.h>
      33                 :            : #include <linux/sunrpc/cache.h>
      34                 :            : #include <linux/sunrpc/stats.h>
      35                 :            : #include <linux/sunrpc/rpc_pipe_fs.h>
      36                 :            : #include "netns.h"
      37                 :            : 
      38                 :            : #define  RPCDBG_FACILITY RPCDBG_CACHE
      39                 :            : 
      40                 :            : static bool cache_defer_req(struct cache_req *req, struct cache_head *item);
      41                 :            : static void cache_revisit_request(struct cache_head *item);
      42                 :            : 
      43                 :          0 : static void cache_init(struct cache_head *h)
      44                 :            : {
      45                 :            :         time_t now = seconds_since_boot();
      46                 :          0 :         h->next = NULL;
      47                 :          0 :         h->flags = 0;
      48                 :            :         kref_init(&h->ref);
      49                 :          0 :         h->expiry_time = now + CACHE_NEW_EXPIRY;
      50                 :          0 :         h->last_refresh = now;
      51                 :          0 : }
      52                 :            : 
      53                 :          0 : struct cache_head *sunrpc_cache_lookup(struct cache_detail *detail,
      54                 :            :                                        struct cache_head *key, int hash)
      55                 :            : {
      56                 :            :         struct cache_head **head,  **hp;
      57                 :            :         struct cache_head *new = NULL, *freeme = NULL;
      58                 :            : 
      59                 :          0 :         head = &detail->hash_table[hash];
      60                 :            : 
      61                 :          0 :         read_lock(&detail->hash_lock);
      62                 :            : 
      63         [ #  # ]:          0 :         for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
      64                 :          0 :                 struct cache_head *tmp = *hp;
      65         [ #  # ]:          0 :                 if (detail->match(tmp, key)) {
      66         [ #  # ]:          0 :                         if (cache_is_expired(detail, tmp))
      67                 :            :                                 /* This entry is expired, we will discard it. */
      68                 :            :                                 break;
      69                 :            :                         cache_get(tmp);
      70                 :            :                         read_unlock(&detail->hash_lock);
      71                 :          0 :                         return tmp;
      72                 :            :                 }
      73                 :            :         }
      74                 :            :         read_unlock(&detail->hash_lock);
      75                 :            :         /* Didn't find anything, insert an empty entry */
      76                 :            : 
      77                 :          0 :         new = detail->alloc();
      78         [ #  # ]:          0 :         if (!new)
      79                 :            :                 return NULL;
      80                 :            :         /* must fully initialise 'new', else
      81                 :            :          * we might get lose if we need to
      82                 :            :          * cache_put it soon.
      83                 :            :          */
      84                 :          0 :         cache_init(new);
      85                 :          0 :         detail->init(new, key);
      86                 :            : 
      87                 :          0 :         write_lock(&detail->hash_lock);
      88                 :            : 
      89                 :            :         /* check if entry appeared while we slept */
      90         [ #  # ]:          0 :         for (hp=head; *hp != NULL ; hp = &(*hp)->next) {
      91                 :          0 :                 struct cache_head *tmp = *hp;
      92         [ #  # ]:          0 :                 if (detail->match(tmp, key)) {
      93         [ #  # ]:          0 :                         if (cache_is_expired(detail, tmp)) {
      94                 :          0 :                                 *hp = tmp->next;
      95                 :          0 :                                 tmp->next = NULL;
      96                 :          0 :                                 detail->entries --;
      97                 :            :                                 freeme = tmp;
      98                 :          0 :                                 break;
      99                 :            :                         }
     100                 :            :                         cache_get(tmp);
     101                 :            :                         write_unlock(&detail->hash_lock);
     102                 :            :                         cache_put(new, detail);
     103                 :          0 :                         return tmp;
     104                 :            :                 }
     105                 :            :         }
     106                 :          0 :         new->next = *head;
     107                 :          0 :         *head = new;
     108                 :          0 :         detail->entries++;
     109                 :            :         cache_get(new);
     110                 :            :         write_unlock(&detail->hash_lock);
     111                 :            : 
     112         [ #  # ]:          0 :         if (freeme)
     113                 :            :                 cache_put(freeme, detail);
     114                 :          0 :         return new;
     115                 :            : }
     116                 :            : EXPORT_SYMBOL_GPL(sunrpc_cache_lookup);
     117                 :            : 
     118                 :            : 
     119                 :            : static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch);
     120                 :            : 
     121                 :          0 : static void cache_fresh_locked(struct cache_head *head, time_t expiry)
     122                 :            : {
     123                 :          0 :         head->expiry_time = expiry;
     124                 :          0 :         head->last_refresh = seconds_since_boot();
     125                 :          0 :         smp_wmb(); /* paired with smp_rmb() in cache_is_valid() */
     126                 :          0 :         set_bit(CACHE_VALID, &head->flags);
     127                 :          0 : }
     128                 :            : 
     129                 :          0 : static void cache_fresh_unlocked(struct cache_head *head,
     130                 :            :                                  struct cache_detail *detail)
     131                 :            : {
     132         [ #  # ]:          0 :         if (test_and_clear_bit(CACHE_PENDING, &head->flags)) {
     133                 :          0 :                 cache_revisit_request(head);
     134                 :          0 :                 cache_dequeue(detail, head);
     135                 :            :         }
     136                 :          0 : }
     137                 :            : 
     138                 :          0 : struct cache_head *sunrpc_cache_update(struct cache_detail *detail,
     139                 :            :                                        struct cache_head *new, struct cache_head *old, int hash)
     140                 :            : {
     141                 :            :         /* The 'old' entry is to be replaced by 'new'.
     142                 :            :          * If 'old' is not VALID, we update it directly,
     143                 :            :          * otherwise we need to replace it
     144                 :            :          */
     145                 :            :         struct cache_head **head;
     146                 :            :         struct cache_head *tmp;
     147                 :            : 
     148         [ #  # ]:          0 :         if (!test_bit(CACHE_VALID, &old->flags)) {
     149                 :          0 :                 write_lock(&detail->hash_lock);
     150         [ #  # ]:          0 :                 if (!test_bit(CACHE_VALID, &old->flags)) {
     151         [ #  # ]:          0 :                         if (test_bit(CACHE_NEGATIVE, &new->flags))
     152                 :          0 :                                 set_bit(CACHE_NEGATIVE, &old->flags);
     153                 :            :                         else
     154                 :          0 :                                 detail->update(old, new);
     155                 :          0 :                         cache_fresh_locked(old, new->expiry_time);
     156                 :            :                         write_unlock(&detail->hash_lock);
     157                 :          0 :                         cache_fresh_unlocked(old, detail);
     158                 :          0 :                         return old;
     159                 :            :                 }
     160                 :            :                 write_unlock(&detail->hash_lock);
     161                 :            :         }
     162                 :            :         /* We need to insert a new entry */
     163                 :          0 :         tmp = detail->alloc();
     164         [ #  # ]:          0 :         if (!tmp) {
     165                 :            :                 cache_put(old, detail);
     166                 :            :                 return NULL;
     167                 :            :         }
     168                 :          0 :         cache_init(tmp);
     169                 :          0 :         detail->init(tmp, old);
     170                 :          0 :         head = &detail->hash_table[hash];
     171                 :            : 
     172                 :          0 :         write_lock(&detail->hash_lock);
     173         [ #  # ]:          0 :         if (test_bit(CACHE_NEGATIVE, &new->flags))
     174                 :          0 :                 set_bit(CACHE_NEGATIVE, &tmp->flags);
     175                 :            :         else
     176                 :          0 :                 detail->update(tmp, new);
     177                 :          0 :         tmp->next = *head;
     178                 :          0 :         *head = tmp;
     179                 :          0 :         detail->entries++;
     180                 :            :         cache_get(tmp);
     181                 :          0 :         cache_fresh_locked(tmp, new->expiry_time);
     182                 :          0 :         cache_fresh_locked(old, 0);
     183                 :            :         write_unlock(&detail->hash_lock);
     184                 :          0 :         cache_fresh_unlocked(tmp, detail);
     185                 :          0 :         cache_fresh_unlocked(old, detail);
     186                 :            :         cache_put(old, detail);
     187                 :          0 :         return tmp;
     188                 :            : }
     189                 :            : EXPORT_SYMBOL_GPL(sunrpc_cache_update);
     190                 :            : 
     191                 :          0 : static int cache_make_upcall(struct cache_detail *cd, struct cache_head *h)
     192                 :            : {
     193         [ #  # ]:          0 :         if (cd->cache_upcall)
     194                 :          0 :                 return cd->cache_upcall(cd, h);
     195                 :          0 :         return sunrpc_cache_pipe_upcall(cd, h);
     196                 :            : }
     197                 :            : 
     198                 :            : static inline int cache_is_valid(struct cache_head *h)
     199                 :            : {
     200         [ #  # ]:          0 :         if (!test_bit(CACHE_VALID, &h->flags))
           [ #  #  #  # ]
     201                 :            :                 return -EAGAIN;
     202                 :            :         else {
     203                 :            :                 /* entry is valid */
     204 [ #  # ][ #  # ]:          0 :                 if (test_bit(CACHE_NEGATIVE, &h->flags))
                 [ #  # ]
     205                 :            :                         return -ENOENT;
     206                 :            :                 else {
     207                 :            :                         /*
     208                 :            :                          * In combination with write barrier in
     209                 :            :                          * sunrpc_cache_update, ensures that anyone
     210                 :            :                          * using the cache entry after this sees the
     211                 :            :                          * updated contents:
     212                 :            :                          */
     213                 :          0 :                         smp_rmb();
     214                 :            :                         return 0;
     215                 :            :                 }
     216                 :            :         }
     217                 :            : }
     218                 :            : 
     219                 :          0 : static int try_to_negate_entry(struct cache_detail *detail, struct cache_head *h)
     220                 :            : {
     221                 :            :         int rv;
     222                 :            : 
     223                 :          0 :         write_lock(&detail->hash_lock);
     224                 :            :         rv = cache_is_valid(h);
     225         [ #  # ]:          0 :         if (rv == -EAGAIN) {
     226                 :          0 :                 set_bit(CACHE_NEGATIVE, &h->flags);
     227                 :          0 :                 cache_fresh_locked(h, seconds_since_boot()+CACHE_NEW_EXPIRY);
     228                 :            :                 rv = -ENOENT;
     229                 :            :         }
     230                 :            :         write_unlock(&detail->hash_lock);
     231                 :          0 :         cache_fresh_unlocked(h, detail);
     232                 :          0 :         return rv;
     233                 :            : }
     234                 :            : 
     235                 :            : /*
     236                 :            :  * This is the generic cache management routine for all
     237                 :            :  * the authentication caches.
     238                 :            :  * It checks the currency of a cache item and will (later)
     239                 :            :  * initiate an upcall to fill it if needed.
     240                 :            :  *
     241                 :            :  *
     242                 :            :  * Returns 0 if the cache_head can be used, or cache_puts it and returns
     243                 :            :  * -EAGAIN if upcall is pending and request has been queued
     244                 :            :  * -ETIMEDOUT if upcall failed or request could not be queue or
     245                 :            :  *           upcall completed but item is still invalid (implying that
     246                 :            :  *           the cache item has been replaced with a newer one).
     247                 :            :  * -ENOENT if cache entry was negative
     248                 :            :  */
     249                 :          0 : int cache_check(struct cache_detail *detail,
     250                 :            :                     struct cache_head *h, struct cache_req *rqstp)
     251                 :            : {
     252                 :            :         int rv;
     253                 :            :         long refresh_age, age;
     254                 :            : 
     255                 :            :         /* First decide return status as best we can */
     256                 :            :         rv = cache_is_valid(h);
     257                 :            : 
     258                 :            :         /* now see if we want to start an upcall */
     259                 :          0 :         refresh_age = (h->expiry_time - h->last_refresh);
     260                 :          0 :         age = seconds_since_boot() - h->last_refresh;
     261                 :            : 
     262         [ #  # ]:          0 :         if (rqstp == NULL) {
     263         [ #  # ]:          0 :                 if (rv == -EAGAIN)
     264                 :            :                         rv = -ENOENT;
     265 [ #  # ][ #  # ]:          0 :         } else if (rv == -EAGAIN ||
     266         [ #  # ]:          0 :                    (h->expiry_time != 0 && age > refresh_age/2)) {
     267                 :            :                 dprintk("RPC:       Want update, refage=%ld, age=%ld\n",
     268                 :            :                                 refresh_age, age);
     269         [ #  # ]:          0 :                 if (!test_and_set_bit(CACHE_PENDING, &h->flags)) {
     270      [ #  #  # ]:          0 :                         switch (cache_make_upcall(detail, h)) {
     271                 :            :                         case -EINVAL:
     272                 :          0 :                                 rv = try_to_negate_entry(detail, h);
     273                 :          0 :                                 break;
     274                 :            :                         case -EAGAIN:
     275                 :          0 :                                 cache_fresh_unlocked(h, detail);
     276                 :          0 :                                 break;
     277                 :            :                         }
     278                 :            :                 }
     279                 :            :         }
     280                 :            : 
     281         [ #  # ]:          0 :         if (rv == -EAGAIN) {
     282         [ #  # ]:          0 :                 if (!cache_defer_req(rqstp, h)) {
     283                 :            :                         /*
     284                 :            :                          * Request was not deferred; handle it as best
     285                 :            :                          * we can ourselves:
     286                 :            :                          */
     287                 :            :                         rv = cache_is_valid(h);
     288         [ #  # ]:          0 :                         if (rv == -EAGAIN)
     289                 :            :                                 rv = -ETIMEDOUT;
     290                 :            :                 }
     291                 :            :         }
     292         [ #  # ]:          0 :         if (rv)
     293                 :            :                 cache_put(h, detail);
     294                 :          0 :         return rv;
     295                 :            : }
     296                 :            : EXPORT_SYMBOL_GPL(cache_check);
     297                 :            : 
     298                 :            : /*
     299                 :            :  * caches need to be periodically cleaned.
     300                 :            :  * For this we maintain a list of cache_detail and
     301                 :            :  * a current pointer into that list and into the table
     302                 :            :  * for that entry.
     303                 :            :  *
     304                 :            :  * Each time cache_clean is called it finds the next non-empty entry
     305                 :            :  * in the current table and walks the list in that entry
     306                 :            :  * looking for entries that can be removed.
     307                 :            :  *
     308                 :            :  * An entry gets removed if:
     309                 :            :  * - The expiry is before current time
     310                 :            :  * - The last_refresh time is before the flush_time for that cache
     311                 :            :  *
     312                 :            :  * later we might drop old entries with non-NEVER expiry if that table
     313                 :            :  * is getting 'full' for some definition of 'full'
     314                 :            :  *
     315                 :            :  * The question of "how often to scan a table" is an interesting one
     316                 :            :  * and is answered in part by the use of the "nextcheck" field in the
     317                 :            :  * cache_detail.
     318                 :            :  * When a scan of a table begins, the nextcheck field is set to a time
     319                 :            :  * that is well into the future.
     320                 :            :  * While scanning, if an expiry time is found that is earlier than the
     321                 :            :  * current nextcheck time, nextcheck is set to that expiry time.
     322                 :            :  * If the flush_time is ever set to a time earlier than the nextcheck
     323                 :            :  * time, the nextcheck time is then set to that flush_time.
     324                 :            :  *
     325                 :            :  * A table is then only scanned if the current time is at least
     326                 :            :  * the nextcheck time.
     327                 :            :  *
     328                 :            :  */
     329                 :            : 
     330                 :            : static LIST_HEAD(cache_list);
     331                 :            : static DEFINE_SPINLOCK(cache_list_lock);
     332                 :            : static struct cache_detail *current_detail;
     333                 :            : static int current_index;
     334                 :            : 
     335                 :            : static void do_cache_clean(struct work_struct *work);
     336                 :            : static struct delayed_work cache_cleaner;
     337                 :            : 
     338                 :          0 : void sunrpc_init_cache_detail(struct cache_detail *cd)
     339                 :            : {
     340                 :          0 :         rwlock_init(&cd->hash_lock);
     341                 :          0 :         INIT_LIST_HEAD(&cd->queue);
     342                 :            :         spin_lock(&cache_list_lock);
     343                 :          0 :         cd->nextcheck = 0;
     344                 :          0 :         cd->entries = 0;
     345                 :          0 :         atomic_set(&cd->readers, 0);
     346                 :          0 :         cd->last_close = 0;
     347                 :          0 :         cd->last_warn = -1;
     348                 :          0 :         list_add(&cd->others, &cache_list);
     349                 :            :         spin_unlock(&cache_list_lock);
     350                 :            : 
     351                 :            :         /* start the cleaning process */
     352                 :            :         schedule_delayed_work(&cache_cleaner, 0);
     353                 :          0 : }
     354                 :            : EXPORT_SYMBOL_GPL(sunrpc_init_cache_detail);
     355                 :            : 
     356                 :          0 : void sunrpc_destroy_cache_detail(struct cache_detail *cd)
     357                 :            : {
     358                 :          0 :         cache_purge(cd);
     359                 :            :         spin_lock(&cache_list_lock);
     360                 :          0 :         write_lock(&cd->hash_lock);
     361 [ #  # ][ #  # ]:          0 :         if (cd->entries || atomic_read(&cd->inuse)) {
     362                 :            :                 write_unlock(&cd->hash_lock);
     363                 :            :                 spin_unlock(&cache_list_lock);
     364                 :            :                 goto out;
     365                 :            :         }
     366         [ #  # ]:          0 :         if (current_detail == cd)
     367                 :          0 :                 current_detail = NULL;
     368                 :          0 :         list_del_init(&cd->others);
     369                 :            :         write_unlock(&cd->hash_lock);
     370                 :            :         spin_unlock(&cache_list_lock);
     371         [ #  # ]:          0 :         if (list_empty(&cache_list)) {
     372                 :            :                 /* module must be being unloaded so its safe to kill the worker */
     373                 :          0 :                 cancel_delayed_work_sync(&cache_cleaner);
     374                 :            :         }
     375                 :          0 :         return;
     376                 :            : out:
     377                 :          0 :         printk(KERN_ERR "nfsd: failed to unregister %s cache\n", cd->name);
     378                 :            : }
     379                 :            : EXPORT_SYMBOL_GPL(sunrpc_destroy_cache_detail);
     380                 :            : 
     381                 :            : /* clean cache tries to find something to clean
     382                 :            :  * and cleans it.
     383                 :            :  * It returns 1 if it cleaned something,
     384                 :            :  *            0 if it didn't find anything this time
     385                 :            :  *           -1 if it fell off the end of the list.
     386                 :            :  */
     387                 :          0 : static int cache_clean(void)
     388                 :            : {
     389                 :            :         int rv = 0;
     390                 :            :         struct list_head *next;
     391                 :            : 
     392                 :            :         spin_lock(&cache_list_lock);
     393                 :            : 
     394                 :            :         /* find a suitable table if we don't already have one */
     395 [ +  + ][ +  + ]:      24767 :         while (current_detail == NULL ||
     396                 :      19880 :             current_index >= current_detail->hash_size) {
     397         [ +  + ]:      24435 :                 if (current_detail)
     398                 :      19548 :                         next = current_detail->others.next;
     399                 :            :                 else
     400                 :       4887 :                         next = cache_list.next;
     401         [ +  + ]:      24435 :                 if (next == &cache_list) {
     402                 :       4887 :                         current_detail = NULL;
     403                 :            :                         spin_unlock(&cache_list_lock);
     404                 :       4887 :                         return -1;
     405                 :            :                 }
     406                 :      19548 :                 current_detail = list_entry(next, struct cache_detail, others);
     407         [ +  + ]:      19548 :                 if (current_detail->nextcheck > seconds_since_boot())
     408                 :      19216 :                         current_index = current_detail->hash_size;
     409                 :            :                 else {
     410                 :        332 :                         current_index = 0;
     411                 :      19548 :                         current_detail->nextcheck = seconds_since_boot()+30*60;
     412                 :            :                 }
     413                 :            :         }
     414                 :            : 
     415                 :            :         /* find a non-empty bucket in the table */
     416 [ +  - ][ +  + ]:     133132 :         while (current_detail &&
     417         [ +  - ]:     132800 :                current_index < current_detail->hash_size &&
     418                 :     132800 :                current_detail->hash_table[current_index] == NULL)
     419                 :     132800 :                 current_index++;
     420                 :            : 
     421                 :            :         /* find a cleanable entry in the bucket and clean it, or set to next bucket */
     422                 :            : 
     423 [ +  - ][ -  + ]:        332 :         if (current_detail && current_index < current_detail->hash_size) {
     424                 :          0 :                 struct cache_head *ch, **cp;
     425                 :          0 :                 struct cache_detail *d;
     426                 :            : 
     427                 :          0 :                 write_lock(&current_detail->hash_lock);
     428                 :            : 
     429                 :            :                 /* Ok, now to clean this strand */
     430                 :            : 
     431                 :          0 :                 cp = & current_detail->hash_table[current_index];
     432         [ #  # ]:          0 :                 for (ch = *cp ; ch ; cp = & ch->next, ch = *cp) {
     433         [ #  # ]:          0 :                         if (current_detail->nextcheck > ch->expiry_time)
     434                 :          0 :                                 current_detail->nextcheck = ch->expiry_time+1;
     435         [ #  # ]:          0 :                         if (!cache_is_expired(current_detail, ch))
     436                 :          0 :                                 continue;
     437                 :            : 
     438                 :          0 :                         *cp = ch->next;
     439                 :          0 :                         ch->next = NULL;
     440                 :          0 :                         current_detail->entries--;
     441                 :            :                         rv = 1;
     442                 :          0 :                         break;
     443                 :            :                 }
     444                 :            : 
     445                 :          0 :                 write_unlock(&current_detail->hash_lock);
     446                 :          0 :                 d = current_detail;
     447         [ #  # ]:          0 :                 if (!ch)
     448                 :          0 :                         current_index ++;
     449                 :            :                 spin_unlock(&cache_list_lock);
     450         [ #  # ]:          0 :                 if (ch) {
     451                 :          0 :                         set_bit(CACHE_CLEANED, &ch->flags);
     452                 :          0 :                         cache_fresh_unlocked(ch, d);
     453                 :            :                         cache_put(ch, d);
     454                 :            :                 }
     455                 :            :         } else
     456                 :            :                 spin_unlock(&cache_list_lock);
     457                 :            : 
     458                 :        332 :         return rv;
     459                 :            : }
     460                 :            : 
     461                 :            : /*
     462                 :            :  * We want to regularly clean the cache, so we need to schedule some work ...
     463                 :            :  */
     464                 :          0 : static void do_cache_clean(struct work_struct *work)
     465                 :            : {
     466                 :            :         int delay = 5;
     467         [ +  + ]:       5219 :         if (cache_clean() == -1)
     468                 :       4887 :                 delay = round_jiffies_relative(30*HZ);
     469                 :            : 
     470         [ -  + ]:       5219 :         if (list_empty(&cache_list))
     471                 :            :                 delay = 0;
     472                 :            : 
     473         [ #  # ]:       5219 :         if (delay)
     474                 :       5219 :                 schedule_delayed_work(&cache_cleaner, delay);
     475                 :          0 : }
     476                 :            : 
     477                 :            : 
     478                 :            : /*
     479                 :            :  * Clean all caches promptly.  This just calls cache_clean
     480                 :            :  * repeatedly until we are sure that every cache has had a chance to
     481                 :            :  * be fully cleaned
     482                 :            :  */
     483                 :          0 : void cache_flush(void)
     484                 :            : {
     485         [ #  # ]:          0 :         while (cache_clean() != -1)
     486                 :          0 :                 cond_resched();
     487         [ #  # ]:          0 :         while (cache_clean() != -1)
     488                 :          0 :                 cond_resched();
     489                 :          0 : }
     490                 :            : EXPORT_SYMBOL_GPL(cache_flush);
     491                 :            : 
     492                 :          0 : void cache_purge(struct cache_detail *detail)
     493                 :            : {
     494                 :          0 :         detail->flush_time = LONG_MAX;
     495                 :          0 :         detail->nextcheck = seconds_since_boot();
     496                 :          0 :         cache_flush();
     497                 :          0 :         detail->flush_time = 1;
     498                 :          0 : }
     499                 :            : EXPORT_SYMBOL_GPL(cache_purge);
     500                 :            : 
     501                 :            : 
     502                 :            : /*
     503                 :            :  * Deferral and Revisiting of Requests.
     504                 :            :  *
     505                 :            :  * If a cache lookup finds a pending entry, we
     506                 :            :  * need to defer the request and revisit it later.
     507                 :            :  * All deferred requests are stored in a hash table,
     508                 :            :  * indexed by "struct cache_head *".
     509                 :            :  * As it may be wasteful to store a whole request
     510                 :            :  * structure, we allow the request to provide a
     511                 :            :  * deferred form, which must contain a
     512                 :            :  * 'struct cache_deferred_req'
     513                 :            :  * This cache_deferred_req contains a method to allow
     514                 :            :  * it to be revisited when cache info is available
     515                 :            :  */
     516                 :            : 
     517                 :            : #define DFR_HASHSIZE    (PAGE_SIZE/sizeof(struct list_head))
     518                 :            : #define DFR_HASH(item)  ((((long)item)>>4 ^ (((long)item)>>13)) % DFR_HASHSIZE)
     519                 :            : 
     520                 :            : #define DFR_MAX 300     /* ??? */
     521                 :            : 
     522                 :            : static DEFINE_SPINLOCK(cache_defer_lock);
     523                 :            : static LIST_HEAD(cache_defer_list);
     524                 :            : static struct hlist_head cache_defer_hash[DFR_HASHSIZE];
     525                 :            : static int cache_defer_cnt;
     526                 :            : 
     527                 :          0 : static void __unhash_deferred_req(struct cache_deferred_req *dreq)
     528                 :            : {
     529                 :            :         hlist_del_init(&dreq->hash);
     530         [ #  # ]:          0 :         if (!list_empty(&dreq->recent)) {
     531                 :            :                 list_del_init(&dreq->recent);
     532                 :          0 :                 cache_defer_cnt--;
     533                 :            :         }
     534                 :          0 : }
     535                 :            : 
     536                 :            : static void __hash_deferred_req(struct cache_deferred_req *dreq, struct cache_head *item)
     537                 :            : {
     538                 :          0 :         int hash = DFR_HASH(item);
     539                 :            : 
     540                 :          0 :         INIT_LIST_HEAD(&dreq->recent);
     541                 :          0 :         hlist_add_head(&dreq->hash, &cache_defer_hash[hash]);
     542                 :            : }
     543                 :            : 
     544                 :          0 : static void setup_deferral(struct cache_deferred_req *dreq,
     545                 :            :                            struct cache_head *item,
     546                 :            :                            int count_me)
     547                 :            : {
     548                 :            : 
     549                 :          0 :         dreq->item = item;
     550                 :            : 
     551                 :            :         spin_lock(&cache_defer_lock);
     552                 :            : 
     553                 :            :         __hash_deferred_req(dreq, item);
     554                 :            : 
     555         [ #  # ]:          0 :         if (count_me) {
     556                 :          0 :                 cache_defer_cnt++;
     557                 :            :                 list_add(&dreq->recent, &cache_defer_list);
     558                 :            :         }
     559                 :            : 
     560                 :            :         spin_unlock(&cache_defer_lock);
     561                 :            : 
     562                 :          0 : }
     563                 :            : 
     564                 :            : struct thread_deferred_req {
     565                 :            :         struct cache_deferred_req handle;
     566                 :            :         struct completion completion;
     567                 :            : };
     568                 :            : 
     569                 :          0 : static void cache_restart_thread(struct cache_deferred_req *dreq, int too_many)
     570                 :            : {
     571                 :            :         struct thread_deferred_req *dr =
     572                 :            :                 container_of(dreq, struct thread_deferred_req, handle);
     573                 :          0 :         complete(&dr->completion);
     574                 :          0 : }
     575                 :            : 
     576                 :          0 : static void cache_wait_req(struct cache_req *req, struct cache_head *item)
     577                 :            : {
     578                 :            :         struct thread_deferred_req sleeper;
     579                 :            :         struct cache_deferred_req *dreq = &sleeper.handle;
     580                 :            : 
     581                 :          0 :         sleeper.completion = COMPLETION_INITIALIZER_ONSTACK(sleeper.completion);
     582                 :          0 :         dreq->revisit = cache_restart_thread;
     583                 :            : 
     584                 :          0 :         setup_deferral(dreq, item, 0);
     585                 :            : 
     586   [ #  #  #  # ]:          0 :         if (!test_bit(CACHE_PENDING, &item->flags) ||
     587                 :          0 :             wait_for_completion_interruptible_timeout(
     588                 :          0 :                     &sleeper.completion, req->thread_wait) <= 0) {
     589                 :            :                 /* The completion wasn't completed, so we need
     590                 :            :                  * to clean up
     591                 :            :                  */
     592                 :            :                 spin_lock(&cache_defer_lock);
     593         [ #  # ]:          0 :                 if (!hlist_unhashed(&sleeper.handle.hash)) {
     594                 :          0 :                         __unhash_deferred_req(&sleeper.handle);
     595                 :            :                         spin_unlock(&cache_defer_lock);
     596                 :            :                 } else {
     597                 :            :                         /* cache_revisit_request already removed
     598                 :            :                          * this from the hash table, but hasn't
     599                 :            :                          * called ->revisit yet.  It will very soon
     600                 :            :                          * and we need to wait for it.
     601                 :            :                          */
     602                 :            :                         spin_unlock(&cache_defer_lock);
     603                 :          0 :                         wait_for_completion(&sleeper.completion);
     604                 :            :                 }
     605                 :            :         }
     606                 :          0 : }
     607                 :            : 
     608                 :          0 : static void cache_limit_defers(void)
     609                 :            : {
     610                 :            :         /* Make sure we haven't exceed the limit of allowed deferred
     611                 :            :          * requests.
     612                 :            :          */
     613                 :            :         struct cache_deferred_req *discard = NULL;
     614                 :            : 
     615         [ #  # ]:          0 :         if (cache_defer_cnt <= DFR_MAX)
     616                 :          0 :                 return;
     617                 :            : 
     618                 :            :         spin_lock(&cache_defer_lock);
     619                 :            : 
     620                 :            :         /* Consider removing either the first or the last */
     621         [ #  # ]:          0 :         if (cache_defer_cnt > DFR_MAX) {
     622         [ #  # ]:          0 :                 if (net_random() & 1)
     623                 :          0 :                         discard = list_entry(cache_defer_list.next,
     624                 :            :                                              struct cache_deferred_req, recent);
     625                 :            :                 else
     626                 :          0 :                         discard = list_entry(cache_defer_list.prev,
     627                 :            :                                              struct cache_deferred_req, recent);
     628                 :          0 :                 __unhash_deferred_req(discard);
     629                 :            :         }
     630                 :            :         spin_unlock(&cache_defer_lock);
     631         [ #  # ]:          0 :         if (discard)
     632                 :          0 :                 discard->revisit(discard, 1);
     633                 :            : }
     634                 :            : 
     635                 :            : /* Return true if and only if a deferred request is queued. */
     636                 :          0 : static bool cache_defer_req(struct cache_req *req, struct cache_head *item)
     637                 :            : {
     638                 :            :         struct cache_deferred_req *dreq;
     639                 :            : 
     640         [ #  # ]:          0 :         if (req->thread_wait) {
     641                 :          0 :                 cache_wait_req(req, item);
     642         [ #  # ]:          0 :                 if (!test_bit(CACHE_PENDING, &item->flags))
     643                 :            :                         return false;
     644                 :            :         }
     645                 :          0 :         dreq = req->defer(req);
     646         [ #  # ]:          0 :         if (dreq == NULL)
     647                 :            :                 return false;
     648                 :          0 :         setup_deferral(dreq, item, 1);
     649         [ #  # ]:          0 :         if (!test_bit(CACHE_PENDING, &item->flags))
     650                 :            :                 /* Bit could have been cleared before we managed to
     651                 :            :                  * set up the deferral, so need to revisit just in case
     652                 :            :                  */
     653                 :          0 :                 cache_revisit_request(item);
     654                 :            : 
     655                 :          0 :         cache_limit_defers();
     656                 :          0 :         return true;
     657                 :            : }
     658                 :            : 
     659                 :          0 : static void cache_revisit_request(struct cache_head *item)
     660                 :            : {
     661                 :            :         struct cache_deferred_req *dreq;
     662                 :            :         struct list_head pending;
     663                 :            :         struct hlist_node *tmp;
     664                 :          0 :         int hash = DFR_HASH(item);
     665                 :            : 
     666                 :            :         INIT_LIST_HEAD(&pending);
     667                 :            :         spin_lock(&cache_defer_lock);
     668                 :            : 
     669 [ #  # ][ #  # ]:          0 :         hlist_for_each_entry_safe(dreq, tmp, &cache_defer_hash[hash], hash)
                 [ #  # ]
     670         [ #  # ]:          0 :                 if (dreq->item == item) {
     671                 :          0 :                         __unhash_deferred_req(dreq);
     672                 :          0 :                         list_add(&dreq->recent, &pending);
     673                 :            :                 }
     674                 :            : 
     675                 :            :         spin_unlock(&cache_defer_lock);
     676                 :            : 
     677         [ #  # ]:          0 :         while (!list_empty(&pending)) {
     678                 :          0 :                 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
     679                 :          0 :                 list_del_init(&dreq->recent);
     680                 :          0 :                 dreq->revisit(dreq, 0);
     681                 :            :         }
     682                 :          0 : }
     683                 :            : 
     684                 :          0 : void cache_clean_deferred(void *owner)
     685                 :            : {
     686                 :            :         struct cache_deferred_req *dreq, *tmp;
     687                 :            :         struct list_head pending;
     688                 :            : 
     689                 :            : 
     690                 :            :         INIT_LIST_HEAD(&pending);
     691                 :            :         spin_lock(&cache_defer_lock);
     692                 :            : 
     693         [ #  # ]:          0 :         list_for_each_entry_safe(dreq, tmp, &cache_defer_list, recent) {
     694         [ #  # ]:          0 :                 if (dreq->owner == owner) {
     695                 :          0 :                         __unhash_deferred_req(dreq);
     696                 :            :                         list_add(&dreq->recent, &pending);
     697                 :            :                 }
     698                 :            :         }
     699                 :            :         spin_unlock(&cache_defer_lock);
     700                 :            : 
     701         [ #  # ]:          0 :         while (!list_empty(&pending)) {
     702                 :          0 :                 dreq = list_entry(pending.next, struct cache_deferred_req, recent);
     703                 :          0 :                 list_del_init(&dreq->recent);
     704                 :          0 :                 dreq->revisit(dreq, 1);
     705                 :            :         }
     706                 :          0 : }
     707                 :            : 
     708                 :            : /*
     709                 :            :  * communicate with user-space
     710                 :            :  *
     711                 :            :  * We have a magic /proc file - /proc/sunrpc/<cachename>/channel.
     712                 :            :  * On read, you get a full request, or block.
     713                 :            :  * On write, an update request is processed.
     714                 :            :  * Poll works if anything to read, and always allows write.
     715                 :            :  *
     716                 :            :  * Implemented by linked list of requests.  Each open file has
     717                 :            :  * a ->private that also exists in this list.  New requests are added
     718                 :            :  * to the end and may wakeup and preceding readers.
     719                 :            :  * New readers are added to the head.  If, on read, an item is found with
     720                 :            :  * CACHE_UPCALLING clear, we free it from the list.
     721                 :            :  *
     722                 :            :  */
     723                 :            : 
     724                 :            : static DEFINE_SPINLOCK(queue_lock);
     725                 :            : static DEFINE_MUTEX(queue_io_mutex);
     726                 :            : 
     727                 :            : struct cache_queue {
     728                 :            :         struct list_head        list;
     729                 :            :         int                     reader; /* if 0, then request */
     730                 :            : };
     731                 :            : struct cache_request {
     732                 :            :         struct cache_queue      q;
     733                 :            :         struct cache_head       *item;
     734                 :            :         char                    * buf;
     735                 :            :         int                     len;
     736                 :            :         int                     readers;
     737                 :            : };
     738                 :            : struct cache_reader {
     739                 :            :         struct cache_queue      q;
     740                 :            :         int                     offset; /* if non-0, we have a refcnt on next request */
     741                 :            : };
     742                 :            : 
     743                 :            : static int cache_request(struct cache_detail *detail,
     744                 :            :                                struct cache_request *crq)
     745                 :            : {
     746                 :          0 :         char *bp = crq->buf;
     747                 :          0 :         int len = PAGE_SIZE;
     748                 :            : 
     749                 :          0 :         detail->cache_request(detail, crq->item, &bp, &len);
     750         [ #  # ]:          0 :         if (len < 0)
     751                 :            :                 return -EAGAIN;
     752                 :          0 :         return PAGE_SIZE - len;
     753                 :            : }
     754                 :            : 
     755                 :          0 : static ssize_t cache_read(struct file *filp, char __user *buf, size_t count,
     756                 :          0 :                           loff_t *ppos, struct cache_detail *cd)
     757                 :            : {
     758                 :          4 :         struct cache_reader *rp = filp->private_data;
     759                 :          0 :         struct cache_request *rq;
     760                 :            :         struct inode *inode = file_inode(filp);
     761                 :            :         int err;
     762                 :            : 
     763         [ +  - ]:          4 :         if (count == 0)
     764                 :            :                 return 0;
     765                 :            : 
     766                 :          4 :         mutex_lock(&inode->i_mutex); /* protect against multiple concurrent
     767                 :            :                               * readers on this file */
     768                 :            :  again:
     769                 :            :         spin_lock(&queue_lock);
     770                 :            :         /* need to find next request */
     771 [ -  + ][ #  # ]:          4 :         while (rp->q.list.next != &cd->queue &&
     772                 :            :                list_entry(rp->q.list.next, struct cache_queue, list)
     773                 :          0 :                ->reader) {
     774                 :            :                 struct list_head *next = rp->q.list.next;
     775                 :          0 :                 list_move(&rp->q.list, next);
     776                 :            :         }
     777         [ +  - ]:          4 :         if (rp->q.list.next == &cd->queue) {
     778                 :            :                 spin_unlock(&queue_lock);
     779                 :          4 :                 mutex_unlock(&inode->i_mutex);
     780 [ -  + ][ #  # ]:          4 :                 WARN_ON_ONCE(rp->offset);
                 [ #  # ]
     781                 :            :                 return 0;
     782                 :            :         }
     783                 :            :         rq = container_of(rp->q.list.next, struct cache_request, q.list);
     784 [ #  # ][ #  # ]:          0 :         WARN_ON_ONCE(rq->q.reader);
                 [ #  # ]
     785         [ #  # ]:          0 :         if (rp->offset == 0)
     786                 :          0 :                 rq->readers++;
     787                 :            :         spin_unlock(&queue_lock);
     788                 :            : 
     789         [ #  # ]:          0 :         if (rq->len == 0) {
     790                 :            :                 err = cache_request(cd, rq);
     791         [ #  # ]:          0 :                 if (err < 0)
     792                 :            :                         goto out;
     793                 :          0 :                 rq->len = err;
     794                 :            :         }
     795                 :            : 
     796 [ #  # ][ #  # ]:          0 :         if (rp->offset == 0 && !test_bit(CACHE_PENDING, &rq->item->flags)) {
     797                 :            :                 err = -EAGAIN;
     798                 :            :                 spin_lock(&queue_lock);
     799                 :          0 :                 list_move(&rp->q.list, &rq->q.list);
     800                 :            :                 spin_unlock(&queue_lock);
     801                 :            :         } else {
     802         [ #  # ]:          0 :                 if (rp->offset + count > rq->len)
     803                 :          0 :                         count = rq->len - rp->offset;
     804                 :            :                 err = -EFAULT;
     805         [ #  # ]:          0 :                 if (copy_to_user(buf, rq->buf + rp->offset, count))
     806                 :            :                         goto out;
     807                 :          0 :                 rp->offset += count;
     808         [ #  # ]:          0 :                 if (rp->offset >= rq->len) {
     809                 :          0 :                         rp->offset = 0;
     810                 :            :                         spin_lock(&queue_lock);
     811                 :          0 :                         list_move(&rp->q.list, &rq->q.list);
     812                 :            :                         spin_unlock(&queue_lock);
     813                 :            :                 }
     814                 :            :                 err = 0;
     815                 :            :         }
     816                 :            :  out:
     817         [ #  # ]:          0 :         if (rp->offset == 0) {
     818                 :            :                 /* need to release rq */
     819                 :            :                 spin_lock(&queue_lock);
     820                 :          0 :                 rq->readers--;
     821 [ #  # ][ #  # ]:          0 :                 if (rq->readers == 0 &&
     822                 :          0 :                     !test_bit(CACHE_PENDING, &rq->item->flags)) {
     823                 :            :                         list_del(&rq->q.list);
     824                 :            :                         spin_unlock(&queue_lock);
     825                 :          0 :                         cache_put(rq->item, cd);
     826                 :          0 :                         kfree(rq->buf);
     827                 :          0 :                         kfree(rq);
     828                 :            :                 } else
     829                 :            :                         spin_unlock(&queue_lock);
     830                 :            :         }
     831         [ #  # ]:          0 :         if (err == -EAGAIN)
     832                 :            :                 goto again;
     833                 :          0 :         mutex_unlock(&inode->i_mutex);
     834         [ #  # ]:          0 :         return err ? err :  count;
     835                 :            : }
     836                 :            : 
     837                 :          0 : static ssize_t cache_do_downcall(char *kaddr, const char __user *buf,
     838                 :            :                                  size_t count, struct cache_detail *cd)
     839                 :            : {
     840                 :            :         ssize_t ret;
     841                 :            : 
     842         [ #  # ]:          0 :         if (count == 0)
     843                 :            :                 return -EINVAL;
     844         [ #  # ]:          0 :         if (copy_from_user(kaddr, buf, count))
     845                 :            :                 return -EFAULT;
     846                 :          0 :         kaddr[count] = '\0';
     847                 :          0 :         ret = cd->cache_parse(cd, kaddr, count);
     848         [ #  # ]:          0 :         if (!ret)
     849                 :            :                 ret = count;
     850                 :          0 :         return ret;
     851                 :            : }
     852                 :            : 
     853                 :          0 : static ssize_t cache_slow_downcall(const char __user *buf,
     854                 :            :                                    size_t count, struct cache_detail *cd)
     855                 :            : {
     856                 :            :         static char write_buf[8192]; /* protected by queue_io_mutex */
     857                 :            :         ssize_t ret = -EINVAL;
     858                 :            : 
     859         [ #  # ]:          0 :         if (count >= sizeof(write_buf))
     860                 :            :                 goto out;
     861                 :          0 :         mutex_lock(&queue_io_mutex);
     862                 :          0 :         ret = cache_do_downcall(write_buf, buf, count, cd);
     863                 :          0 :         mutex_unlock(&queue_io_mutex);
     864                 :            : out:
     865                 :          0 :         return ret;
     866                 :            : }
     867                 :            : 
     868                 :          0 : static ssize_t cache_downcall(struct address_space *mapping,
     869                 :            :                               const char __user *buf,
     870                 :            :                               size_t count, struct cache_detail *cd)
     871                 :            : {
     872                 :            :         struct page *page;
     873                 :            :         char *kaddr;
     874                 :            :         ssize_t ret = -ENOMEM;
     875                 :            : 
     876         [ #  # ]:          0 :         if (count >= PAGE_CACHE_SIZE)
     877                 :            :                 goto out_slow;
     878                 :            : 
     879                 :          0 :         page = find_or_create_page(mapping, 0, GFP_KERNEL);
     880         [ #  # ]:          0 :         if (!page)
     881                 :            :                 goto out_slow;
     882                 :            : 
     883                 :          0 :         kaddr = kmap(page);
     884                 :          0 :         ret = cache_do_downcall(kaddr, buf, count, cd);
     885                 :          0 :         kunmap(page);
     886                 :          0 :         unlock_page(page);
     887                 :          0 :         page_cache_release(page);
     888                 :          0 :         return ret;
     889                 :            : out_slow:
     890                 :          0 :         return cache_slow_downcall(buf, count, cd);
     891                 :            : }
     892                 :            : 
     893                 :          0 : static ssize_t cache_write(struct file *filp, const char __user *buf,
     894                 :            :                            size_t count, loff_t *ppos,
     895                 :            :                            struct cache_detail *cd)
     896                 :            : {
     897                 :          0 :         struct address_space *mapping = filp->f_mapping;
     898                 :            :         struct inode *inode = file_inode(filp);
     899                 :            :         ssize_t ret = -EINVAL;
     900                 :            : 
     901         [ #  # ]:          0 :         if (!cd->cache_parse)
     902                 :            :                 goto out;
     903                 :            : 
     904                 :          0 :         mutex_lock(&inode->i_mutex);
     905                 :          0 :         ret = cache_downcall(mapping, buf, count, cd);
     906                 :          0 :         mutex_unlock(&inode->i_mutex);
     907                 :            : out:
     908                 :          0 :         return ret;
     909                 :            : }
     910                 :            : 
     911                 :            : static DECLARE_WAIT_QUEUE_HEAD(queue_wait);
     912                 :            : 
     913                 :          0 : static unsigned int cache_poll(struct file *filp, poll_table *wait,
     914                 :            :                                struct cache_detail *cd)
     915                 :            : {
     916                 :            :         unsigned int mask;
     917                 :          0 :         struct cache_reader *rp = filp->private_data;
     918                 :            :         struct cache_queue *cq;
     919                 :            : 
     920                 :            :         poll_wait(filp, &queue_wait, wait);
     921                 :            : 
     922                 :            :         /* alway allow write */
     923                 :            :         mask = POLL_OUT | POLLWRNORM;
     924                 :            : 
     925         [ #  # ]:          0 :         if (!rp)
     926                 :            :                 return mask;
     927                 :            : 
     928                 :            :         spin_lock(&queue_lock);
     929                 :            : 
     930         [ #  # ]:          0 :         for (cq= &rp->q; &cq->list != &cd->queue;
     931                 :          0 :              cq = list_entry(cq->list.next, struct cache_queue, list))
     932         [ #  # ]:          0 :                 if (!cq->reader) {
     933                 :            :                         mask |= POLLIN | POLLRDNORM;
     934                 :            :                         break;
     935                 :            :                 }
     936                 :            :         spin_unlock(&queue_lock);
     937                 :          0 :         return mask;
     938                 :            : }
     939                 :            : 
     940                 :          0 : static int cache_ioctl(struct inode *ino, struct file *filp,
     941                 :            :                        unsigned int cmd, unsigned long arg,
     942                 :            :                        struct cache_detail *cd)
     943                 :            : {
     944                 :            :         int len = 0;
     945                 :          0 :         struct cache_reader *rp = filp->private_data;
     946                 :            :         struct cache_queue *cq;
     947                 :            : 
     948         [ #  # ]:          0 :         if (cmd != FIONREAD || !rp)
     949                 :            :                 return -EINVAL;
     950                 :            : 
     951                 :            :         spin_lock(&queue_lock);
     952                 :            : 
     953                 :            :         /* only find the length remaining in current request,
     954                 :            :          * or the length of the next request
     955                 :            :          */
     956         [ #  # ]:          0 :         for (cq= &rp->q; &cq->list != &cd->queue;
     957                 :          0 :              cq = list_entry(cq->list.next, struct cache_queue, list))
     958         [ #  # ]:          0 :                 if (!cq->reader) {
     959                 :            :                         struct cache_request *cr =
     960                 :            :                                 container_of(cq, struct cache_request, q);
     961                 :          0 :                         len = cr->len - rp->offset;
     962                 :            :                         break;
     963                 :            :                 }
     964                 :            :         spin_unlock(&queue_lock);
     965                 :            : 
     966                 :          0 :         return put_user(len, (int __user *)arg);
     967                 :            : }
     968                 :            : 
     969                 :          0 : static int cache_open(struct inode *inode, struct file *filp,
     970                 :            :                       struct cache_detail *cd)
     971                 :            : {
     972                 :            :         struct cache_reader *rp = NULL;
     973                 :            : 
     974 [ +  - ][ +  - ]:          4 :         if (!cd || !try_module_get(cd->owner))
     975                 :            :                 return -EACCES;
     976                 :          4 :         nonseekable_open(inode, filp);
     977         [ +  - ]:          4 :         if (filp->f_mode & FMODE_READ) {
     978                 :            :                 rp = kmalloc(sizeof(*rp), GFP_KERNEL);
     979         [ -  + ]:          4 :                 if (!rp) {
     980                 :          0 :                         module_put(cd->owner);
     981                 :          0 :                         return -ENOMEM;
     982                 :            :                 }
     983                 :          4 :                 rp->offset = 0;
     984                 :          4 :                 rp->q.reader = 1;
     985                 :          4 :                 atomic_inc(&cd->readers);
     986                 :            :                 spin_lock(&queue_lock);
     987                 :          4 :                 list_add(&rp->q.list, &cd->queue);
     988                 :            :                 spin_unlock(&queue_lock);
     989                 :            :         }
     990                 :          4 :         filp->private_data = rp;
     991                 :          4 :         return 0;
     992                 :            : }
     993                 :            : 
     994                 :          4 : static int cache_release(struct inode *inode, struct file *filp,
     995                 :            :                          struct cache_detail *cd)
     996                 :            : {
     997                 :          4 :         struct cache_reader *rp = filp->private_data;
     998                 :            : 
     999         [ +  - ]:          4 :         if (rp) {
    1000                 :            :                 spin_lock(&queue_lock);
    1001         [ +  - ]:          4 :                 if (rp->offset) {
    1002                 :            :                         struct cache_queue *cq;
    1003         [ #  # ]:          4 :                         for (cq= &rp->q; &cq->list != &cd->queue;
    1004                 :          0 :                              cq = list_entry(cq->list.next, struct cache_queue, list))
    1005         [ #  # ]:          0 :                                 if (!cq->reader) {
    1006                 :            :                                         container_of(cq, struct cache_request, q)
    1007                 :          0 :                                                 ->readers--;
    1008                 :            :                                         break;
    1009                 :            :                                 }
    1010                 :          0 :                         rp->offset = 0;
    1011                 :            :                 }
    1012                 :            :                 list_del(&rp->q.list);
    1013                 :            :                 spin_unlock(&queue_lock);
    1014                 :            : 
    1015                 :          4 :                 filp->private_data = NULL;
    1016                 :          4 :                 kfree(rp);
    1017                 :            : 
    1018                 :          4 :                 cd->last_close = seconds_since_boot();
    1019                 :          4 :                 atomic_dec(&cd->readers);
    1020                 :            :         }
    1021                 :          4 :         module_put(cd->owner);
    1022                 :          4 :         return 0;
    1023                 :            : }
    1024                 :            : 
    1025                 :            : 
    1026                 :            : 
    1027                 :          0 : static void cache_dequeue(struct cache_detail *detail, struct cache_head *ch)
    1028                 :            : {
    1029                 :            :         struct cache_queue *cq, *tmp;
    1030                 :            :         struct cache_request *cr;
    1031                 :            :         struct list_head dequeued;
    1032                 :            : 
    1033                 :            :         INIT_LIST_HEAD(&dequeued);
    1034                 :            :         spin_lock(&queue_lock);
    1035         [ #  # ]:          0 :         list_for_each_entry_safe(cq, tmp, &detail->queue, list)
    1036         [ #  # ]:          0 :                 if (!cq->reader) {
    1037                 :            :                         cr = container_of(cq, struct cache_request, q);
    1038         [ #  # ]:          0 :                         if (cr->item != ch)
    1039                 :          0 :                                 continue;
    1040         [ #  # ]:          0 :                         if (test_bit(CACHE_PENDING, &ch->flags))
    1041                 :            :                                 /* Lost a race and it is pending again */
    1042                 :            :                                 break;
    1043         [ #  # ]:          0 :                         if (cr->readers != 0)
    1044                 :          0 :                                 continue;
    1045                 :          0 :                         list_move(&cr->q.list, &dequeued);
    1046                 :            :                 }
    1047                 :            :         spin_unlock(&queue_lock);
    1048         [ #  # ]:          0 :         while (!list_empty(&dequeued)) {
    1049                 :            :                 cr = list_entry(dequeued.next, struct cache_request, q.list);
    1050                 :            :                 list_del(&cr->q.list);
    1051                 :          0 :                 cache_put(cr->item, detail);
    1052                 :          0 :                 kfree(cr->buf);
    1053                 :          0 :                 kfree(cr);
    1054                 :            :         }
    1055                 :          0 : }
    1056                 :            : 
    1057                 :            : /*
    1058                 :            :  * Support routines for text-based upcalls.
    1059                 :            :  * Fields are separated by spaces.
    1060                 :            :  * Fields are either mangled to quote space tab newline slosh with slosh
    1061                 :            :  * or a hexified with a leading \x
    1062                 :            :  * Record is terminated with newline.
    1063                 :            :  *
    1064                 :            :  */
    1065                 :            : 
    1066                 :          0 : void qword_add(char **bpp, int *lp, char *str)
    1067                 :            : {
    1068                 :          0 :         char *bp = *bpp;
    1069                 :          0 :         int len = *lp;
    1070                 :            :         char c;
    1071                 :            : 
    1072         [ #  # ]:          0 :         if (len < 0) return;
    1073                 :            : 
    1074 [ #  # ][ #  # ]:          0 :         while ((c=*str++) && len)
    1075         [ #  # ]:          0 :                 switch(c) {
    1076                 :            :                 case ' ':
    1077                 :            :                 case '\t':
    1078                 :            :                 case '\n':
    1079                 :            :                 case '\\':
    1080         [ #  # ]:          0 :                         if (len >= 4) {
    1081                 :          0 :                                 *bp++ = '\\';
    1082                 :          0 :                                 *bp++ = '0' + ((c & 0300)>>6);
    1083                 :          0 :                                 *bp++ = '0' + ((c & 0070)>>3);
    1084                 :          0 :                                 *bp++ = '0' + ((c & 0007)>>0);
    1085                 :            :                         }
    1086                 :          0 :                         len -= 4;
    1087                 :          0 :                         break;
    1088                 :            :                 default:
    1089                 :          0 :                         *bp++ = c;
    1090                 :          0 :                         len--;
    1091                 :            :                 }
    1092         [ #  # ]:          0 :         if (c || len <1) len = -1;
    1093                 :            :         else {
    1094                 :          0 :                 *bp++ = ' ';
    1095                 :          0 :                 len--;
    1096                 :            :         }
    1097                 :          0 :         *bpp = bp;
    1098                 :          0 :         *lp = len;
    1099                 :            : }
    1100                 :            : EXPORT_SYMBOL_GPL(qword_add);
    1101                 :            : 
    1102                 :          0 : void qword_addhex(char **bpp, int *lp, char *buf, int blen)
    1103                 :            : {
    1104                 :          0 :         char *bp = *bpp;
    1105                 :          0 :         int len = *lp;
    1106                 :            : 
    1107         [ #  # ]:          0 :         if (len < 0) return;
    1108                 :            : 
    1109         [ #  # ]:          0 :         if (len > 2) {
    1110                 :          0 :                 *bp++ = '\\';
    1111                 :          0 :                 *bp++ = 'x';
    1112                 :          0 :                 len -= 2;
    1113         [ #  # ]:          0 :                 while (blen && len >= 2) {
    1114                 :          0 :                         unsigned char c = *buf++;
    1115         [ #  # ]:          0 :                         *bp++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
    1116         [ #  # ]:          0 :                         *bp++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
    1117                 :          0 :                         len -= 2;
    1118                 :          0 :                         blen--;
    1119                 :            :                 }
    1120                 :            :         }
    1121         [ #  # ]:          0 :         if (blen || len<1) len = -1;
    1122                 :            :         else {
    1123                 :          0 :                 *bp++ = ' ';
    1124                 :          0 :                 len--;
    1125                 :            :         }
    1126                 :          0 :         *bpp = bp;
    1127                 :          0 :         *lp = len;
    1128                 :            : }
    1129                 :            : EXPORT_SYMBOL_GPL(qword_addhex);
    1130                 :            : 
    1131                 :            : static void warn_no_listener(struct cache_detail *detail)
    1132                 :            : {
    1133         [ #  # ]:          0 :         if (detail->last_warn != detail->last_close) {
    1134                 :          0 :                 detail->last_warn = detail->last_close;
    1135         [ #  # ]:          0 :                 if (detail->warn_no_listener)
    1136                 :          0 :                         detail->warn_no_listener(detail, detail->last_close != 0);
    1137                 :            :         }
    1138                 :            : }
    1139                 :            : 
    1140                 :          0 : static bool cache_listeners_exist(struct cache_detail *detail)
    1141                 :            : {
    1142         [ #  # ]:          0 :         if (atomic_read(&detail->readers))
    1143                 :            :                 return true;
    1144         [ #  # ]:          0 :         if (detail->last_close == 0)
    1145                 :            :                 /* This cache was never opened */
    1146                 :            :                 return false;
    1147         [ #  # ]:          0 :         if (detail->last_close < seconds_since_boot() - 30)
    1148                 :            :                 /*
    1149                 :            :                  * We allow for the possibility that someone might
    1150                 :            :                  * restart a userspace daemon without restarting the
    1151                 :            :                  * server; but after 30 seconds, we give up.
    1152                 :            :                  */
    1153                 :            :                  return false;
    1154                 :          0 :         return true;
    1155                 :            : }
    1156                 :            : 
    1157                 :            : /*
    1158                 :            :  * register an upcall request to user-space and queue it up for read() by the
    1159                 :            :  * upcall daemon.
    1160                 :            :  *
    1161                 :            :  * Each request is at most one page long.
    1162                 :            :  */
    1163                 :          0 : int sunrpc_cache_pipe_upcall(struct cache_detail *detail, struct cache_head *h)
    1164                 :            : {
    1165                 :            : 
    1166                 :            :         char *buf;
    1167                 :            :         struct cache_request *crq;
    1168                 :            :         int ret = 0;
    1169                 :            : 
    1170         [ #  # ]:          0 :         if (!detail->cache_request)
    1171                 :            :                 return -EINVAL;
    1172                 :            : 
    1173         [ #  # ]:          0 :         if (!cache_listeners_exist(detail)) {
    1174                 :            :                 warn_no_listener(detail);
    1175                 :            :                 return -EINVAL;
    1176                 :            :         }
    1177         [ #  # ]:          0 :         if (test_bit(CACHE_CLEANED, &h->flags))
    1178                 :            :                 /* Too late to make an upcall */
    1179                 :            :                 return -EAGAIN;
    1180                 :            : 
    1181                 :            :         buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
    1182         [ #  # ]:          0 :         if (!buf)
    1183                 :            :                 return -EAGAIN;
    1184                 :            : 
    1185                 :            :         crq = kmalloc(sizeof (*crq), GFP_KERNEL);
    1186         [ #  # ]:          0 :         if (!crq) {
    1187                 :          0 :                 kfree(buf);
    1188                 :          0 :                 return -EAGAIN;
    1189                 :            :         }
    1190                 :            : 
    1191                 :          0 :         crq->q.reader = 0;
    1192                 :          0 :         crq->item = cache_get(h);
    1193                 :          0 :         crq->buf = buf;
    1194                 :          0 :         crq->len = 0;
    1195                 :          0 :         crq->readers = 0;
    1196                 :            :         spin_lock(&queue_lock);
    1197         [ #  # ]:          0 :         if (test_bit(CACHE_PENDING, &h->flags))
    1198                 :          0 :                 list_add_tail(&crq->q.list, &detail->queue);
    1199                 :            :         else
    1200                 :            :                 /* Lost a race, no longer PENDING, so don't enqueue */
    1201                 :            :                 ret = -EAGAIN;
    1202                 :            :         spin_unlock(&queue_lock);
    1203                 :          0 :         wake_up(&queue_wait);
    1204         [ #  # ]:          0 :         if (ret == -EAGAIN) {
    1205                 :          0 :                 kfree(buf);
    1206                 :          0 :                 kfree(crq);
    1207                 :            :         }
    1208                 :          0 :         return ret;
    1209                 :            : }
    1210                 :            : EXPORT_SYMBOL_GPL(sunrpc_cache_pipe_upcall);
    1211                 :            : 
    1212                 :            : /*
    1213                 :            :  * parse a message from user-space and pass it
    1214                 :            :  * to an appropriate cache
    1215                 :            :  * Messages are, like requests, separated into fields by
    1216                 :            :  * spaces and dequotes as \xHEXSTRING or embedded \nnn octal
    1217                 :            :  *
    1218                 :            :  * Message is
    1219                 :            :  *   reply cachename expiry key ... content....
    1220                 :            :  *
    1221                 :            :  * key and content are both parsed by cache
    1222                 :            :  */
    1223                 :            : 
    1224                 :          0 : int qword_get(char **bpp, char *dest, int bufsize)
    1225                 :            : {
    1226                 :            :         /* return bytes copied, or -1 on error */
    1227                 :          0 :         char *bp = *bpp;
    1228                 :            :         int len = 0;
    1229                 :            : 
    1230         [ #  # ]:          0 :         while (*bp == ' ') bp++;
    1231                 :            : 
    1232 [ #  # ][ #  # ]:          0 :         if (bp[0] == '\\' && bp[1] == 'x') {
    1233                 :            :                 /* HEX STRING */
    1234                 :          0 :                 bp += 2;
    1235         [ #  # ]:          0 :                 while (len < bufsize) {
    1236                 :            :                         int h, l;
    1237                 :            : 
    1238                 :          0 :                         h = hex_to_bin(bp[0]);
    1239         [ #  # ]:          0 :                         if (h < 0)
    1240                 :            :                                 break;
    1241                 :            : 
    1242                 :          0 :                         l = hex_to_bin(bp[1]);
    1243         [ #  # ]:          0 :                         if (l < 0)
    1244                 :            :                                 break;
    1245                 :            : 
    1246                 :          0 :                         *dest++ = (h << 4) | l;
    1247                 :          0 :                         bp += 2;
    1248                 :          0 :                         len++;
    1249                 :            :                 }
    1250                 :            :         } else {
    1251                 :            :                 /* text with \nnn octal quoting */
    1252 [ #  # ][ #  # ]:          0 :                 while (*bp != ' ' && *bp != '\n' && *bp && len < bufsize-1) {
                 [ #  # ]
    1253 [ #  # ][ #  # ]:          0 :                         if (*bp == '\\' &&
    1254 [ #  # ][ #  # ]:          0 :                             isodigit(bp[1]) && (bp[1] <= '3') &&
    1255         [ #  # ]:          0 :                             isodigit(bp[2]) &&
    1256                 :          0 :                             isodigit(bp[3])) {
    1257                 :          0 :                                 int byte = (*++bp -'0');
    1258                 :            :                                 bp++;
    1259                 :          0 :                                 byte = (byte << 3) | (*bp++ - '0');
    1260                 :          0 :                                 byte = (byte << 3) | (*bp++ - '0');
    1261                 :          0 :                                 *dest++ = byte;
    1262                 :          0 :                                 len++;
    1263                 :            :                         } else {
    1264                 :          0 :                                 *dest++ = *bp++;
    1265                 :          0 :                                 len++;
    1266                 :            :                         }
    1267                 :            :                 }
    1268                 :            :         }
    1269                 :            : 
    1270 [ #  # ][ #  # ]:          0 :         if (*bp != ' ' && *bp != '\n' && *bp != '\0')
    1271                 :            :                 return -1;
    1272         [ #  # ]:          0 :         while (*bp == ' ') bp++;
    1273                 :          0 :         *bpp = bp;
    1274                 :          0 :         *dest = '\0';
    1275                 :          0 :         return len;
    1276                 :            : }
    1277                 :            : EXPORT_SYMBOL_GPL(qword_get);
    1278                 :            : 
    1279                 :            : 
    1280                 :            : /*
    1281                 :            :  * support /proc/sunrpc/cache/$CACHENAME/content
    1282                 :            :  * as a seqfile.
    1283                 :            :  * We call ->cache_show passing NULL for the item to
    1284                 :            :  * get a header, then pass each real item in the cache
    1285                 :            :  */
    1286                 :            : 
    1287                 :            : struct handle {
    1288                 :            :         struct cache_detail *cd;
    1289                 :            : };
    1290                 :            : 
    1291                 :          0 : static void *c_start(struct seq_file *m, loff_t *pos)
    1292                 :            :         __acquires(cd->hash_lock)
    1293                 :            : {
    1294                 :          4 :         loff_t n = *pos;
    1295                 :            :         unsigned int hash, entry;
    1296                 :            :         struct cache_head *ch;
    1297                 :          4 :         struct cache_detail *cd = ((struct handle*)m->private)->cd;
    1298                 :            : 
    1299                 :            : 
    1300                 :          4 :         read_lock(&cd->hash_lock);
    1301            [ + ]:          4 :         if (!n--)
    1302                 :            :                 return SEQ_START_TOKEN;
    1303                 :          2 :         hash = n >> 32;
    1304                 :          2 :         entry = n & ((1LL<<32) - 1);
    1305                 :            : 
    1306         [ -  + ]:          6 :         for (ch=cd->hash_table[hash]; ch; ch=ch->next)
    1307         [ #  # ]:          0 :                 if (!entry--)
    1308                 :            :                         return ch;
    1309                 :          2 :         n &= ~((1LL<<32) - 1);
    1310                 :            :         do {
    1311                 :        512 :                 hash++;
    1312                 :        512 :                 n += 1LL<<32;
    1313         [ +  - ]:        510 :         } while(hash < cd->hash_size &&
    1314         [ +  + ]:        512 :                 cd->hash_table[hash]==NULL);
    1315         [ -  + ]:          2 :         if (hash >= cd->hash_size)
    1316                 :            :                 return NULL;
    1317                 :          0 :         *pos = n+1;
    1318                 :          0 :         return cd->hash_table[hash];
    1319                 :            : }
    1320                 :            : 
    1321                 :          0 : static void *c_next(struct seq_file *m, void *p, loff_t *pos)
    1322                 :            : {
    1323                 :            :         struct cache_head *ch = p;
    1324                 :          2 :         int hash = (*pos >> 32);
    1325                 :          2 :         struct cache_detail *cd = ((struct handle*)m->private)->cd;
    1326                 :            : 
    1327         [ -  + ]:          2 :         if (p == SEQ_START_TOKEN)
    1328                 :            :                 hash = 0;
    1329         [ #  # ]:          0 :         else if (ch->next == NULL) {
    1330                 :          0 :                 hash++;
    1331                 :          0 :                 *pos += 1LL<<32;
    1332                 :            :         } else {
    1333                 :          0 :                 ++*pos;
    1334                 :          0 :                 return ch->next;
    1335                 :            :         }
    1336                 :          2 :         *pos &= ~((1LL<<32) - 1);
    1337 [ +  + ][ +  - ]:        514 :         while (hash < cd->hash_size &&
    1338                 :        512 :                cd->hash_table[hash] == NULL) {
    1339                 :        512 :                 hash++;
    1340                 :        512 :                 *pos += 1LL<<32;
    1341                 :            :         }
    1342         [ #  # ]:          2 :         if (hash >= cd->hash_size)
    1343                 :            :                 return NULL;
    1344                 :          0 :         ++*pos;
    1345                 :          0 :         return cd->hash_table[hash];
    1346                 :            : }
    1347                 :            : 
    1348                 :          0 : static void c_stop(struct seq_file *m, void *p)
    1349                 :            :         __releases(cd->hash_lock)
    1350                 :            : {
    1351                 :          4 :         struct cache_detail *cd = ((struct handle*)m->private)->cd;
    1352                 :            :         read_unlock(&cd->hash_lock);
    1353                 :          4 : }
    1354                 :            : 
    1355                 :          0 : static int c_show(struct seq_file *m, void *p)
    1356                 :            : {
    1357                 :          0 :         struct cache_head *cp = p;
    1358                 :          2 :         struct cache_detail *cd = ((struct handle*)m->private)->cd;
    1359                 :            : 
    1360         [ +  - ]:          2 :         if (p == SEQ_START_TOKEN)
    1361                 :          2 :                 return cd->cache_show(m, cd, NULL);
    1362                 :            : 
    1363                 :            :         ifdebug(CACHE)
    1364                 :            :                 seq_printf(m, "# expiry=%ld refcnt=%d flags=%lx\n",
    1365                 :            :                            convert_to_wallclock(cp->expiry_time),
    1366                 :            :                            atomic_read(&cp->ref.refcount), cp->flags);
    1367                 :            :         cache_get(cp);
    1368         [ #  # ]:          0 :         if (cache_check(cd, cp, NULL))
    1369                 :            :                 /* cache_check does a cache_put on failure */
    1370                 :          0 :                 seq_printf(m, "# ");
    1371                 :            :         else {
    1372         [ #  # ]:          0 :                 if (cache_is_expired(cd, cp))
    1373                 :          0 :                         seq_printf(m, "# ");
    1374                 :            :                 cache_put(cp, cd);
    1375                 :            :         }
    1376                 :            : 
    1377                 :          0 :         return cd->cache_show(m, cd, cp);
    1378                 :            : }
    1379                 :            : 
    1380                 :            : static const struct seq_operations cache_content_op = {
    1381                 :            :         .start  = c_start,
    1382                 :            :         .next   = c_next,
    1383                 :            :         .stop   = c_stop,
    1384                 :            :         .show   = c_show,
    1385                 :            : };
    1386                 :            : 
    1387                 :          2 : static int content_open(struct inode *inode, struct file *file,
    1388                 :            :                         struct cache_detail *cd)
    1389                 :            : {
    1390                 :            :         struct handle *han;
    1391                 :            : 
    1392 [ +  - ][ +  - ]:          2 :         if (!cd || !try_module_get(cd->owner))
    1393                 :            :                 return -EACCES;
    1394                 :          2 :         han = __seq_open_private(file, &cache_content_op, sizeof(*han));
    1395         [ -  + ]:          4 :         if (han == NULL) {
    1396                 :          0 :                 module_put(cd->owner);
    1397                 :            :                 return -ENOMEM;
    1398                 :            :         }
    1399                 :            : 
    1400                 :          2 :         han->cd = cd;
    1401                 :            :         return 0;
    1402                 :            : }
    1403                 :            : 
    1404                 :            : static int content_release(struct inode *inode, struct file *file,
    1405                 :            :                 struct cache_detail *cd)
    1406                 :            : {
    1407                 :          2 :         int ret = seq_release_private(inode, file);
    1408                 :          2 :         module_put(cd->owner);
    1409                 :            :         return ret;
    1410                 :            : }
    1411                 :            : 
    1412                 :          0 : static int open_flush(struct inode *inode, struct file *file,
    1413                 :            :                         struct cache_detail *cd)
    1414                 :            : {
    1415 [ +  - ][ +  - ]:          4 :         if (!cd || !try_module_get(cd->owner))
    1416                 :            :                 return -EACCES;
    1417                 :          4 :         return nonseekable_open(inode, file);
    1418                 :            : }
    1419                 :            : 
    1420                 :            : static int release_flush(struct inode *inode, struct file *file,
    1421                 :            :                         struct cache_detail *cd)
    1422                 :            : {
    1423                 :          4 :         module_put(cd->owner);
    1424                 :            :         return 0;
    1425                 :            : }
    1426                 :            : 
    1427                 :          0 : static ssize_t read_flush(struct file *file, char __user *buf,
    1428                 :            :                           size_t count, loff_t *ppos,
    1429                 :            :                           struct cache_detail *cd)
    1430                 :            : {
    1431                 :            :         char tbuf[22];
    1432                 :          8 :         unsigned long p = *ppos;
    1433                 :            :         size_t len;
    1434                 :            : 
    1435                 :         16 :         snprintf(tbuf, sizeof(tbuf), "%lu\n", convert_to_wallclock(cd->flush_time));
    1436                 :          8 :         len = strlen(tbuf);
    1437         [ +  + ]:          8 :         if (p >= len)
    1438                 :            :                 return 0;
    1439                 :          4 :         len -= p;
    1440         [ -  + ]:          4 :         if (len > count)
    1441                 :            :                 len = count;
    1442         [ +  - ]:         12 :         if (copy_to_user(buf, (void*)(tbuf+p), len))
    1443                 :            :                 return -EFAULT;
    1444                 :          4 :         *ppos += len;
    1445                 :          4 :         return len;
    1446                 :            : }
    1447                 :            : 
    1448                 :          0 : static ssize_t write_flush(struct file *file, const char __user *buf,
    1449                 :            :                            size_t count, loff_t *ppos,
    1450                 :            :                            struct cache_detail *cd)
    1451                 :            : {
    1452                 :            :         char tbuf[20];
    1453                 :            :         char *bp, *ep;
    1454                 :            : 
    1455 [ #  # ][ #  # ]:          0 :         if (*ppos || count > sizeof(tbuf)-1)
    1456                 :            :                 return -EINVAL;
    1457         [ #  # ]:          0 :         if (copy_from_user(tbuf, buf, count))
    1458                 :            :                 return -EFAULT;
    1459                 :          0 :         tbuf[count] = 0;
    1460                 :          0 :         simple_strtoul(tbuf, &ep, 0);
    1461         [ #  # ]:          0 :         if (*ep && *ep != '\n')
    1462                 :            :                 return -EINVAL;
    1463                 :            : 
    1464                 :          0 :         bp = tbuf;
    1465                 :          0 :         cd->flush_time = get_expiry(&bp);
    1466                 :          0 :         cd->nextcheck = seconds_since_boot();
    1467                 :          0 :         cache_flush();
    1468                 :            : 
    1469                 :          0 :         *ppos += count;
    1470                 :          0 :         return count;
    1471                 :            : }
    1472                 :            : 
    1473                 :          0 : static ssize_t cache_read_procfs(struct file *filp, char __user *buf,
    1474                 :            :                                  size_t count, loff_t *ppos)
    1475                 :            : {
    1476                 :          4 :         struct cache_detail *cd = PDE_DATA(file_inode(filp));
    1477                 :            : 
    1478                 :          4 :         return cache_read(filp, buf, count, ppos, cd);
    1479                 :            : }
    1480                 :            : 
    1481                 :          0 : static ssize_t cache_write_procfs(struct file *filp, const char __user *buf,
    1482                 :            :                                   size_t count, loff_t *ppos)
    1483                 :            : {
    1484                 :          0 :         struct cache_detail *cd = PDE_DATA(file_inode(filp));
    1485                 :            : 
    1486                 :          0 :         return cache_write(filp, buf, count, ppos, cd);
    1487                 :            : }
    1488                 :            : 
    1489                 :          0 : static unsigned int cache_poll_procfs(struct file *filp, poll_table *wait)
    1490                 :            : {
    1491                 :          0 :         struct cache_detail *cd = PDE_DATA(file_inode(filp));
    1492                 :            : 
    1493                 :          0 :         return cache_poll(filp, wait, cd);
    1494                 :            : }
    1495                 :            : 
    1496                 :          0 : static long cache_ioctl_procfs(struct file *filp,
    1497                 :            :                                unsigned int cmd, unsigned long arg)
    1498                 :            : {
    1499                 :            :         struct inode *inode = file_inode(filp);
    1500                 :          0 :         struct cache_detail *cd = PDE_DATA(inode);
    1501                 :            : 
    1502                 :          0 :         return cache_ioctl(inode, filp, cmd, arg, cd);
    1503                 :            : }
    1504                 :            : 
    1505                 :          0 : static int cache_open_procfs(struct inode *inode, struct file *filp)
    1506                 :            : {
    1507                 :          4 :         struct cache_detail *cd = PDE_DATA(inode);
    1508                 :            : 
    1509                 :          4 :         return cache_open(inode, filp, cd);
    1510                 :            : }
    1511                 :            : 
    1512                 :          0 : static int cache_release_procfs(struct inode *inode, struct file *filp)
    1513                 :            : {
    1514                 :          4 :         struct cache_detail *cd = PDE_DATA(inode);
    1515                 :            : 
    1516                 :          4 :         return cache_release(inode, filp, cd);
    1517                 :            : }
    1518                 :            : 
    1519                 :            : static const struct file_operations cache_file_operations_procfs = {
    1520                 :            :         .owner          = THIS_MODULE,
    1521                 :            :         .llseek         = no_llseek,
    1522                 :            :         .read           = cache_read_procfs,
    1523                 :            :         .write          = cache_write_procfs,
    1524                 :            :         .poll           = cache_poll_procfs,
    1525                 :            :         .unlocked_ioctl = cache_ioctl_procfs, /* for FIONREAD */
    1526                 :            :         .open           = cache_open_procfs,
    1527                 :            :         .release        = cache_release_procfs,
    1528                 :            : };
    1529                 :            : 
    1530                 :          0 : static int content_open_procfs(struct inode *inode, struct file *filp)
    1531                 :            : {
    1532                 :          2 :         struct cache_detail *cd = PDE_DATA(inode);
    1533                 :            : 
    1534                 :          2 :         return content_open(inode, filp, cd);
    1535                 :            : }
    1536                 :            : 
    1537                 :          0 : static int content_release_procfs(struct inode *inode, struct file *filp)
    1538                 :            : {
    1539                 :          2 :         struct cache_detail *cd = PDE_DATA(inode);
    1540                 :            : 
    1541                 :          2 :         return content_release(inode, filp, cd);
    1542                 :            : }
    1543                 :            : 
    1544                 :            : static const struct file_operations content_file_operations_procfs = {
    1545                 :            :         .open           = content_open_procfs,
    1546                 :            :         .read           = seq_read,
    1547                 :            :         .llseek         = seq_lseek,
    1548                 :            :         .release        = content_release_procfs,
    1549                 :            : };
    1550                 :            : 
    1551                 :          0 : static int open_flush_procfs(struct inode *inode, struct file *filp)
    1552                 :            : {
    1553                 :          4 :         struct cache_detail *cd = PDE_DATA(inode);
    1554                 :            : 
    1555                 :          4 :         return open_flush(inode, filp, cd);
    1556                 :            : }
    1557                 :            : 
    1558                 :          0 : static int release_flush_procfs(struct inode *inode, struct file *filp)
    1559                 :            : {
    1560                 :          4 :         struct cache_detail *cd = PDE_DATA(inode);
    1561                 :            : 
    1562                 :          4 :         return release_flush(inode, filp, cd);
    1563                 :            : }
    1564                 :            : 
    1565                 :          0 : static ssize_t read_flush_procfs(struct file *filp, char __user *buf,
    1566                 :            :                             size_t count, loff_t *ppos)
    1567                 :            : {
    1568                 :          8 :         struct cache_detail *cd = PDE_DATA(file_inode(filp));
    1569                 :            : 
    1570                 :          8 :         return read_flush(filp, buf, count, ppos, cd);
    1571                 :            : }
    1572                 :            : 
    1573                 :          0 : static ssize_t write_flush_procfs(struct file *filp,
    1574                 :            :                                   const char __user *buf,
    1575                 :            :                                   size_t count, loff_t *ppos)
    1576                 :            : {
    1577                 :          0 :         struct cache_detail *cd = PDE_DATA(file_inode(filp));
    1578                 :            : 
    1579                 :          0 :         return write_flush(filp, buf, count, ppos, cd);
    1580                 :            : }
    1581                 :            : 
    1582                 :            : static const struct file_operations cache_flush_operations_procfs = {
    1583                 :            :         .open           = open_flush_procfs,
    1584                 :            :         .read           = read_flush_procfs,
    1585                 :            :         .write          = write_flush_procfs,
    1586                 :            :         .release        = release_flush_procfs,
    1587                 :            :         .llseek         = no_llseek,
    1588                 :            : };
    1589                 :            : 
    1590                 :          0 : static void remove_cache_proc_entries(struct cache_detail *cd, struct net *net)
    1591                 :            : {
    1592                 :            :         struct sunrpc_net *sn;
    1593                 :            : 
    1594         [ #  # ]:          0 :         if (cd->u.procfs.proc_ent == NULL)
    1595                 :          0 :                 return;
    1596         [ #  # ]:          0 :         if (cd->u.procfs.flush_ent)
    1597                 :          0 :                 remove_proc_entry("flush", cd->u.procfs.proc_ent);
    1598         [ #  # ]:          0 :         if (cd->u.procfs.channel_ent)
    1599                 :          0 :                 remove_proc_entry("channel", cd->u.procfs.proc_ent);
    1600         [ #  # ]:          0 :         if (cd->u.procfs.content_ent)
    1601                 :          0 :                 remove_proc_entry("content", cd->u.procfs.proc_ent);
    1602                 :          0 :         cd->u.procfs.proc_ent = NULL;
    1603                 :          0 :         sn = net_generic(net, sunrpc_net_id);
    1604                 :          0 :         remove_proc_entry(cd->name, sn->proc_net_rpc);
    1605                 :            : }
    1606                 :            : 
    1607                 :            : #ifdef CONFIG_PROC_FS
    1608                 :          0 : static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
    1609                 :            : {
    1610                 :            :         struct proc_dir_entry *p;
    1611                 :            :         struct sunrpc_net *sn;
    1612                 :            : 
    1613                 :          0 :         sn = net_generic(net, sunrpc_net_id);
    1614                 :          0 :         cd->u.procfs.proc_ent = proc_mkdir(cd->name, sn->proc_net_rpc);
    1615         [ #  # ]:          0 :         if (cd->u.procfs.proc_ent == NULL)
    1616                 :            :                 goto out_nomem;
    1617                 :          0 :         cd->u.procfs.channel_ent = NULL;
    1618                 :          0 :         cd->u.procfs.content_ent = NULL;
    1619                 :            : 
    1620                 :          0 :         p = proc_create_data("flush", S_IFREG|S_IRUSR|S_IWUSR,
    1621                 :            :                              cd->u.procfs.proc_ent,
    1622                 :            :                              &cache_flush_operations_procfs, cd);
    1623                 :          0 :         cd->u.procfs.flush_ent = p;
    1624         [ #  # ]:          0 :         if (p == NULL)
    1625                 :            :                 goto out_nomem;
    1626                 :            : 
    1627 [ #  # ][ #  # ]:          0 :         if (cd->cache_request || cd->cache_parse) {
    1628                 :          0 :                 p = proc_create_data("channel", S_IFREG|S_IRUSR|S_IWUSR,
    1629                 :            :                                      cd->u.procfs.proc_ent,
    1630                 :            :                                      &cache_file_operations_procfs, cd);
    1631                 :          0 :                 cd->u.procfs.channel_ent = p;
    1632         [ #  # ]:          0 :                 if (p == NULL)
    1633                 :            :                         goto out_nomem;
    1634                 :            :         }
    1635         [ #  # ]:          0 :         if (cd->cache_show) {
    1636                 :          0 :                 p = proc_create_data("content", S_IFREG|S_IRUSR,
    1637                 :            :                                 cd->u.procfs.proc_ent,
    1638                 :            :                                 &content_file_operations_procfs, cd);
    1639                 :          0 :                 cd->u.procfs.content_ent = p;
    1640         [ #  # ]:          0 :                 if (p == NULL)
    1641                 :            :                         goto out_nomem;
    1642                 :            :         }
    1643                 :            :         return 0;
    1644                 :            : out_nomem:
    1645                 :          0 :         remove_cache_proc_entries(cd, net);
    1646                 :          0 :         return -ENOMEM;
    1647                 :            : }
    1648                 :            : #else /* CONFIG_PROC_FS */
    1649                 :            : static int create_cache_proc_entries(struct cache_detail *cd, struct net *net)
    1650                 :            : {
    1651                 :            :         return 0;
    1652                 :            : }
    1653                 :            : #endif
    1654                 :            : 
    1655                 :          0 : void __init cache_initialize(void)
    1656                 :            : {
    1657                 :          0 :         INIT_DEFERRABLE_WORK(&cache_cleaner, do_cache_clean);
    1658                 :          0 : }
    1659                 :            : 
    1660                 :          0 : int cache_register_net(struct cache_detail *cd, struct net *net)
    1661                 :            : {
    1662                 :            :         int ret;
    1663                 :            : 
    1664                 :          0 :         sunrpc_init_cache_detail(cd);
    1665                 :          0 :         ret = create_cache_proc_entries(cd, net);
    1666         [ #  # ]:          0 :         if (ret)
    1667                 :          0 :                 sunrpc_destroy_cache_detail(cd);
    1668                 :          0 :         return ret;
    1669                 :            : }
    1670                 :            : EXPORT_SYMBOL_GPL(cache_register_net);
    1671                 :            : 
    1672                 :          0 : void cache_unregister_net(struct cache_detail *cd, struct net *net)
    1673                 :            : {
    1674                 :          0 :         remove_cache_proc_entries(cd, net);
    1675                 :          0 :         sunrpc_destroy_cache_detail(cd);
    1676                 :          0 : }
    1677                 :            : EXPORT_SYMBOL_GPL(cache_unregister_net);
    1678                 :            : 
    1679                 :          0 : struct cache_detail *cache_create_net(struct cache_detail *tmpl, struct net *net)
    1680                 :            : {
    1681                 :            :         struct cache_detail *cd;
    1682                 :            : 
    1683                 :          0 :         cd = kmemdup(tmpl, sizeof(struct cache_detail), GFP_KERNEL);
    1684         [ #  # ]:          0 :         if (cd == NULL)
    1685                 :            :                 return ERR_PTR(-ENOMEM);
    1686                 :            : 
    1687                 :          0 :         cd->hash_table = kzalloc(cd->hash_size * sizeof(struct cache_head *),
    1688                 :            :                                  GFP_KERNEL);
    1689         [ #  # ]:          0 :         if (cd->hash_table == NULL) {
    1690                 :          0 :                 kfree(cd);
    1691                 :          0 :                 return ERR_PTR(-ENOMEM);
    1692                 :            :         }
    1693                 :          0 :         cd->net = net;
    1694                 :          0 :         return cd;
    1695                 :            : }
    1696                 :            : EXPORT_SYMBOL_GPL(cache_create_net);
    1697                 :            : 
    1698                 :          0 : void cache_destroy_net(struct cache_detail *cd, struct net *net)
    1699                 :            : {
    1700                 :          0 :         kfree(cd->hash_table);
    1701                 :          0 :         kfree(cd);
    1702                 :          0 : }
    1703                 :            : EXPORT_SYMBOL_GPL(cache_destroy_net);
    1704                 :            : 
    1705                 :          0 : static ssize_t cache_read_pipefs(struct file *filp, char __user *buf,
    1706                 :            :                                  size_t count, loff_t *ppos)
    1707                 :            : {
    1708                 :          0 :         struct cache_detail *cd = RPC_I(file_inode(filp))->private;
    1709                 :            : 
    1710                 :          0 :         return cache_read(filp, buf, count, ppos, cd);
    1711                 :            : }
    1712                 :            : 
    1713                 :          0 : static ssize_t cache_write_pipefs(struct file *filp, const char __user *buf,
    1714                 :            :                                   size_t count, loff_t *ppos)
    1715                 :            : {
    1716                 :          0 :         struct cache_detail *cd = RPC_I(file_inode(filp))->private;
    1717                 :            : 
    1718                 :          0 :         return cache_write(filp, buf, count, ppos, cd);
    1719                 :            : }
    1720                 :            : 
    1721                 :          0 : static unsigned int cache_poll_pipefs(struct file *filp, poll_table *wait)
    1722                 :            : {
    1723                 :          0 :         struct cache_detail *cd = RPC_I(file_inode(filp))->private;
    1724                 :            : 
    1725                 :          0 :         return cache_poll(filp, wait, cd);
    1726                 :            : }
    1727                 :            : 
    1728                 :          0 : static long cache_ioctl_pipefs(struct file *filp,
    1729                 :            :                               unsigned int cmd, unsigned long arg)
    1730                 :            : {
    1731                 :            :         struct inode *inode = file_inode(filp);
    1732                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1733                 :            : 
    1734                 :          0 :         return cache_ioctl(inode, filp, cmd, arg, cd);
    1735                 :            : }
    1736                 :            : 
    1737                 :          0 : static int cache_open_pipefs(struct inode *inode, struct file *filp)
    1738                 :            : {
    1739                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1740                 :            : 
    1741                 :          0 :         return cache_open(inode, filp, cd);
    1742                 :            : }
    1743                 :            : 
    1744                 :          0 : static int cache_release_pipefs(struct inode *inode, struct file *filp)
    1745                 :            : {
    1746                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1747                 :            : 
    1748                 :          0 :         return cache_release(inode, filp, cd);
    1749                 :            : }
    1750                 :            : 
    1751                 :            : const struct file_operations cache_file_operations_pipefs = {
    1752                 :            :         .owner          = THIS_MODULE,
    1753                 :            :         .llseek         = no_llseek,
    1754                 :            :         .read           = cache_read_pipefs,
    1755                 :            :         .write          = cache_write_pipefs,
    1756                 :            :         .poll           = cache_poll_pipefs,
    1757                 :            :         .unlocked_ioctl = cache_ioctl_pipefs, /* for FIONREAD */
    1758                 :            :         .open           = cache_open_pipefs,
    1759                 :            :         .release        = cache_release_pipefs,
    1760                 :            : };
    1761                 :            : 
    1762                 :          0 : static int content_open_pipefs(struct inode *inode, struct file *filp)
    1763                 :            : {
    1764                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1765                 :            : 
    1766                 :          0 :         return content_open(inode, filp, cd);
    1767                 :            : }
    1768                 :            : 
    1769                 :          0 : static int content_release_pipefs(struct inode *inode, struct file *filp)
    1770                 :            : {
    1771                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1772                 :            : 
    1773                 :          0 :         return content_release(inode, filp, cd);
    1774                 :            : }
    1775                 :            : 
    1776                 :            : const struct file_operations content_file_operations_pipefs = {
    1777                 :            :         .open           = content_open_pipefs,
    1778                 :            :         .read           = seq_read,
    1779                 :            :         .llseek         = seq_lseek,
    1780                 :            :         .release        = content_release_pipefs,
    1781                 :            : };
    1782                 :            : 
    1783                 :          0 : static int open_flush_pipefs(struct inode *inode, struct file *filp)
    1784                 :            : {
    1785                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1786                 :            : 
    1787                 :          0 :         return open_flush(inode, filp, cd);
    1788                 :            : }
    1789                 :            : 
    1790                 :          0 : static int release_flush_pipefs(struct inode *inode, struct file *filp)
    1791                 :            : {
    1792                 :          0 :         struct cache_detail *cd = RPC_I(inode)->private;
    1793                 :            : 
    1794                 :          0 :         return release_flush(inode, filp, cd);
    1795                 :            : }
    1796                 :            : 
    1797                 :          0 : static ssize_t read_flush_pipefs(struct file *filp, char __user *buf,
    1798                 :            :                             size_t count, loff_t *ppos)
    1799                 :            : {
    1800                 :          0 :         struct cache_detail *cd = RPC_I(file_inode(filp))->private;
    1801                 :            : 
    1802                 :          0 :         return read_flush(filp, buf, count, ppos, cd);
    1803                 :            : }
    1804                 :            : 
    1805                 :          0 : static ssize_t write_flush_pipefs(struct file *filp,
    1806                 :            :                                   const char __user *buf,
    1807                 :            :                                   size_t count, loff_t *ppos)
    1808                 :            : {
    1809                 :          0 :         struct cache_detail *cd = RPC_I(file_inode(filp))->private;
    1810                 :            : 
    1811                 :          0 :         return write_flush(filp, buf, count, ppos, cd);
    1812                 :            : }
    1813                 :            : 
    1814                 :            : const struct file_operations cache_flush_operations_pipefs = {
    1815                 :            :         .open           = open_flush_pipefs,
    1816                 :            :         .read           = read_flush_pipefs,
    1817                 :            :         .write          = write_flush_pipefs,
    1818                 :            :         .release        = release_flush_pipefs,
    1819                 :            :         .llseek         = no_llseek,
    1820                 :            : };
    1821                 :            : 
    1822                 :          0 : int sunrpc_cache_register_pipefs(struct dentry *parent,
    1823                 :            :                                  const char *name, umode_t umode,
    1824                 :            :                                  struct cache_detail *cd)
    1825                 :            : {
    1826                 :          0 :         struct dentry *dir = rpc_create_cache_dir(parent, name, umode, cd);
    1827         [ #  # ]:          0 :         if (IS_ERR(dir))
    1828                 :          0 :                 return PTR_ERR(dir);
    1829                 :          0 :         cd->u.pipefs.dir = dir;
    1830                 :          0 :         return 0;
    1831                 :            : }
    1832                 :            : EXPORT_SYMBOL_GPL(sunrpc_cache_register_pipefs);
    1833                 :            : 
    1834                 :          0 : void sunrpc_cache_unregister_pipefs(struct cache_detail *cd)
    1835                 :            : {
    1836                 :          0 :         rpc_remove_cache_dir(cd->u.pipefs.dir);
    1837                 :          0 :         cd->u.pipefs.dir = NULL;
    1838                 :          0 : }
    1839                 :            : EXPORT_SYMBOL_GPL(sunrpc_cache_unregister_pipefs);
    1840                 :            : 

Generated by: LCOV version 1.9