cache.c 43 KB

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