cache.c 42 KB

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