rpc_pipe.c 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215
  1. /*
  2. * net/sunrpc/rpc_pipe.c
  3. *
  4. * Userland/kernel interface for rpcauth_gss.
  5. * Code shamelessly plagiarized from fs/nfsd/nfsctl.c
  6. * and fs/sysfs/inode.c
  7. *
  8. * Copyright (c) 2002, Trond Myklebust <trond.myklebust@fys.uio.no>
  9. *
  10. */
  11. #include <linux/module.h>
  12. #include <linux/slab.h>
  13. #include <linux/string.h>
  14. #include <linux/pagemap.h>
  15. #include <linux/mount.h>
  16. #include <linux/namei.h>
  17. #include <linux/fsnotify.h>
  18. #include <linux/kernel.h>
  19. #include <linux/rcupdate.h>
  20. #include <asm/ioctls.h>
  21. #include <linux/poll.h>
  22. #include <linux/wait.h>
  23. #include <linux/seq_file.h>
  24. #include <linux/sunrpc/clnt.h>
  25. #include <linux/workqueue.h>
  26. #include <linux/sunrpc/rpc_pipe_fs.h>
  27. #include <linux/sunrpc/cache.h>
  28. #include <linux/nsproxy.h>
  29. #include <linux/notifier.h>
  30. #include "netns.h"
  31. #include "sunrpc.h"
  32. #define RPCDBG_FACILITY RPCDBG_DEBUG
  33. #define NET_NAME(net) ((net == &init_net) ? " (init_net)" : "")
  34. static struct file_system_type rpc_pipe_fs_type;
  35. static struct kmem_cache *rpc_inode_cachep __read_mostly;
  36. #define RPC_UPCALL_TIMEOUT (30*HZ)
  37. static BLOCKING_NOTIFIER_HEAD(rpc_pipefs_notifier_list);
  38. int rpc_pipefs_notifier_register(struct notifier_block *nb)
  39. {
  40. return blocking_notifier_chain_cond_register(&rpc_pipefs_notifier_list, nb);
  41. }
  42. EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_register);
  43. void rpc_pipefs_notifier_unregister(struct notifier_block *nb)
  44. {
  45. blocking_notifier_chain_unregister(&rpc_pipefs_notifier_list, nb);
  46. }
  47. EXPORT_SYMBOL_GPL(rpc_pipefs_notifier_unregister);
  48. static void rpc_purge_list(wait_queue_head_t *waitq, struct list_head *head,
  49. void (*destroy_msg)(struct rpc_pipe_msg *), int err)
  50. {
  51. struct rpc_pipe_msg *msg;
  52. if (list_empty(head))
  53. return;
  54. do {
  55. msg = list_entry(head->next, struct rpc_pipe_msg, list);
  56. list_del_init(&msg->list);
  57. msg->errno = err;
  58. destroy_msg(msg);
  59. } while (!list_empty(head));
  60. if (waitq)
  61. wake_up(waitq);
  62. }
  63. static void
  64. rpc_timeout_upcall_queue(struct work_struct *work)
  65. {
  66. LIST_HEAD(free_list);
  67. struct rpc_pipe *pipe =
  68. container_of(work, struct rpc_pipe, queue_timeout.work);
  69. void (*destroy_msg)(struct rpc_pipe_msg *);
  70. struct dentry *dentry;
  71. spin_lock(&pipe->lock);
  72. destroy_msg = pipe->ops->destroy_msg;
  73. if (pipe->nreaders == 0) {
  74. list_splice_init(&pipe->pipe, &free_list);
  75. pipe->pipelen = 0;
  76. }
  77. dentry = dget(pipe->dentry);
  78. spin_unlock(&pipe->lock);
  79. rpc_purge_list(dentry ? &RPC_I(dentry->d_inode)->waitq : NULL,
  80. &free_list, destroy_msg, -ETIMEDOUT);
  81. dput(dentry);
  82. }
  83. ssize_t rpc_pipe_generic_upcall(struct file *filp, struct rpc_pipe_msg *msg,
  84. char __user *dst, size_t buflen)
  85. {
  86. char *data = (char *)msg->data + msg->copied;
  87. size_t mlen = min(msg->len - msg->copied, buflen);
  88. unsigned long left;
  89. left = copy_to_user(dst, data, mlen);
  90. if (left == mlen) {
  91. msg->errno = -EFAULT;
  92. return -EFAULT;
  93. }
  94. mlen -= left;
  95. msg->copied += mlen;
  96. msg->errno = 0;
  97. return mlen;
  98. }
  99. EXPORT_SYMBOL_GPL(rpc_pipe_generic_upcall);
  100. /**
  101. * rpc_queue_upcall - queue an upcall message to userspace
  102. * @pipe: upcall pipe on which to queue given message
  103. * @msg: message to queue
  104. *
  105. * Call with an @inode created by rpc_mkpipe() to queue an upcall.
  106. * A userspace process may then later read the upcall by performing a
  107. * read on an open file for this inode. It is up to the caller to
  108. * initialize the fields of @msg (other than @msg->list) appropriately.
  109. */
  110. int
  111. rpc_queue_upcall(struct rpc_pipe *pipe, struct rpc_pipe_msg *msg)
  112. {
  113. int res = -EPIPE;
  114. struct dentry *dentry;
  115. spin_lock(&pipe->lock);
  116. if (pipe->nreaders) {
  117. list_add_tail(&msg->list, &pipe->pipe);
  118. pipe->pipelen += msg->len;
  119. res = 0;
  120. } else if (pipe->flags & RPC_PIPE_WAIT_FOR_OPEN) {
  121. if (list_empty(&pipe->pipe))
  122. queue_delayed_work(rpciod_workqueue,
  123. &pipe->queue_timeout,
  124. RPC_UPCALL_TIMEOUT);
  125. list_add_tail(&msg->list, &pipe->pipe);
  126. pipe->pipelen += msg->len;
  127. res = 0;
  128. }
  129. dentry = dget(pipe->dentry);
  130. spin_unlock(&pipe->lock);
  131. if (dentry) {
  132. wake_up(&RPC_I(dentry->d_inode)->waitq);
  133. dput(dentry);
  134. }
  135. return res;
  136. }
  137. EXPORT_SYMBOL_GPL(rpc_queue_upcall);
  138. static inline void
  139. rpc_inode_setowner(struct inode *inode, void *private)
  140. {
  141. RPC_I(inode)->private = private;
  142. }
  143. static void
  144. rpc_close_pipes(struct inode *inode)
  145. {
  146. struct rpc_pipe *pipe = RPC_I(inode)->pipe;
  147. int need_release;
  148. LIST_HEAD(free_list);
  149. mutex_lock(&inode->i_mutex);
  150. spin_lock(&pipe->lock);
  151. need_release = pipe->nreaders != 0 || pipe->nwriters != 0;
  152. pipe->nreaders = 0;
  153. list_splice_init(&pipe->in_upcall, &free_list);
  154. list_splice_init(&pipe->pipe, &free_list);
  155. pipe->pipelen = 0;
  156. pipe->dentry = NULL;
  157. spin_unlock(&pipe->lock);
  158. rpc_purge_list(&RPC_I(inode)->waitq, &free_list, pipe->ops->destroy_msg, -EPIPE);
  159. pipe->nwriters = 0;
  160. if (need_release && pipe->ops->release_pipe)
  161. pipe->ops->release_pipe(inode);
  162. cancel_delayed_work_sync(&pipe->queue_timeout);
  163. rpc_inode_setowner(inode, NULL);
  164. RPC_I(inode)->pipe = NULL;
  165. mutex_unlock(&inode->i_mutex);
  166. }
  167. static struct inode *
  168. rpc_alloc_inode(struct super_block *sb)
  169. {
  170. struct rpc_inode *rpci;
  171. rpci = (struct rpc_inode *)kmem_cache_alloc(rpc_inode_cachep, GFP_KERNEL);
  172. if (!rpci)
  173. return NULL;
  174. return &rpci->vfs_inode;
  175. }
  176. static void
  177. rpc_i_callback(struct rcu_head *head)
  178. {
  179. struct inode *inode = container_of(head, struct inode, i_rcu);
  180. kmem_cache_free(rpc_inode_cachep, RPC_I(inode));
  181. }
  182. static void
  183. rpc_destroy_inode(struct inode *inode)
  184. {
  185. call_rcu(&inode->i_rcu, rpc_i_callback);
  186. }
  187. static int
  188. rpc_pipe_open(struct inode *inode, struct file *filp)
  189. {
  190. struct net *net = inode->i_sb->s_fs_info;
  191. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  192. struct rpc_pipe *pipe;
  193. int first_open;
  194. int res = -ENXIO;
  195. mutex_lock(&inode->i_mutex);
  196. sn->gssd_running = 1;
  197. pipe = RPC_I(inode)->pipe;
  198. if (pipe == NULL)
  199. goto out;
  200. first_open = pipe->nreaders == 0 && pipe->nwriters == 0;
  201. if (first_open && pipe->ops->open_pipe) {
  202. res = pipe->ops->open_pipe(inode);
  203. if (res)
  204. goto out;
  205. }
  206. if (filp->f_mode & FMODE_READ)
  207. pipe->nreaders++;
  208. if (filp->f_mode & FMODE_WRITE)
  209. pipe->nwriters++;
  210. res = 0;
  211. out:
  212. mutex_unlock(&inode->i_mutex);
  213. return res;
  214. }
  215. static int
  216. rpc_pipe_release(struct inode *inode, struct file *filp)
  217. {
  218. struct rpc_pipe *pipe;
  219. struct rpc_pipe_msg *msg;
  220. int last_close;
  221. mutex_lock(&inode->i_mutex);
  222. pipe = RPC_I(inode)->pipe;
  223. if (pipe == NULL)
  224. goto out;
  225. msg = filp->private_data;
  226. if (msg != NULL) {
  227. spin_lock(&pipe->lock);
  228. msg->errno = -EAGAIN;
  229. list_del_init(&msg->list);
  230. spin_unlock(&pipe->lock);
  231. pipe->ops->destroy_msg(msg);
  232. }
  233. if (filp->f_mode & FMODE_WRITE)
  234. pipe->nwriters --;
  235. if (filp->f_mode & FMODE_READ) {
  236. pipe->nreaders --;
  237. if (pipe->nreaders == 0) {
  238. LIST_HEAD(free_list);
  239. spin_lock(&pipe->lock);
  240. list_splice_init(&pipe->pipe, &free_list);
  241. pipe->pipelen = 0;
  242. spin_unlock(&pipe->lock);
  243. rpc_purge_list(&RPC_I(inode)->waitq, &free_list,
  244. pipe->ops->destroy_msg, -EAGAIN);
  245. }
  246. }
  247. last_close = pipe->nwriters == 0 && pipe->nreaders == 0;
  248. if (last_close && pipe->ops->release_pipe)
  249. pipe->ops->release_pipe(inode);
  250. out:
  251. mutex_unlock(&inode->i_mutex);
  252. return 0;
  253. }
  254. static ssize_t
  255. rpc_pipe_read(struct file *filp, char __user *buf, size_t len, loff_t *offset)
  256. {
  257. struct inode *inode = file_inode(filp);
  258. struct rpc_pipe *pipe;
  259. struct rpc_pipe_msg *msg;
  260. int res = 0;
  261. mutex_lock(&inode->i_mutex);
  262. pipe = RPC_I(inode)->pipe;
  263. if (pipe == NULL) {
  264. res = -EPIPE;
  265. goto out_unlock;
  266. }
  267. msg = filp->private_data;
  268. if (msg == NULL) {
  269. spin_lock(&pipe->lock);
  270. if (!list_empty(&pipe->pipe)) {
  271. msg = list_entry(pipe->pipe.next,
  272. struct rpc_pipe_msg,
  273. list);
  274. list_move(&msg->list, &pipe->in_upcall);
  275. pipe->pipelen -= msg->len;
  276. filp->private_data = msg;
  277. msg->copied = 0;
  278. }
  279. spin_unlock(&pipe->lock);
  280. if (msg == NULL)
  281. goto out_unlock;
  282. }
  283. /* NOTE: it is up to the callback to update msg->copied */
  284. res = pipe->ops->upcall(filp, msg, buf, len);
  285. if (res < 0 || msg->len == msg->copied) {
  286. filp->private_data = NULL;
  287. spin_lock(&pipe->lock);
  288. list_del_init(&msg->list);
  289. spin_unlock(&pipe->lock);
  290. pipe->ops->destroy_msg(msg);
  291. }
  292. out_unlock:
  293. mutex_unlock(&inode->i_mutex);
  294. return res;
  295. }
  296. static ssize_t
  297. rpc_pipe_write(struct file *filp, const char __user *buf, size_t len, loff_t *offset)
  298. {
  299. struct inode *inode = file_inode(filp);
  300. int res;
  301. mutex_lock(&inode->i_mutex);
  302. res = -EPIPE;
  303. if (RPC_I(inode)->pipe != NULL)
  304. res = RPC_I(inode)->pipe->ops->downcall(filp, buf, len);
  305. mutex_unlock(&inode->i_mutex);
  306. return res;
  307. }
  308. static unsigned int
  309. rpc_pipe_poll(struct file *filp, struct poll_table_struct *wait)
  310. {
  311. struct inode *inode = file_inode(filp);
  312. struct rpc_inode *rpci = RPC_I(inode);
  313. unsigned int mask = POLLOUT | POLLWRNORM;
  314. poll_wait(filp, &rpci->waitq, wait);
  315. mutex_lock(&inode->i_mutex);
  316. if (rpci->pipe == NULL)
  317. mask |= POLLERR | POLLHUP;
  318. else if (filp->private_data || !list_empty(&rpci->pipe->pipe))
  319. mask |= POLLIN | POLLRDNORM;
  320. mutex_unlock(&inode->i_mutex);
  321. return mask;
  322. }
  323. static long
  324. rpc_pipe_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
  325. {
  326. struct inode *inode = file_inode(filp);
  327. struct rpc_pipe *pipe;
  328. int len;
  329. switch (cmd) {
  330. case FIONREAD:
  331. mutex_lock(&inode->i_mutex);
  332. pipe = RPC_I(inode)->pipe;
  333. if (pipe == NULL) {
  334. mutex_unlock(&inode->i_mutex);
  335. return -EPIPE;
  336. }
  337. spin_lock(&pipe->lock);
  338. len = pipe->pipelen;
  339. if (filp->private_data) {
  340. struct rpc_pipe_msg *msg;
  341. msg = filp->private_data;
  342. len += msg->len - msg->copied;
  343. }
  344. spin_unlock(&pipe->lock);
  345. mutex_unlock(&inode->i_mutex);
  346. return put_user(len, (int __user *)arg);
  347. default:
  348. return -EINVAL;
  349. }
  350. }
  351. static const struct file_operations rpc_pipe_fops = {
  352. .owner = THIS_MODULE,
  353. .llseek = no_llseek,
  354. .read = rpc_pipe_read,
  355. .write = rpc_pipe_write,
  356. .poll = rpc_pipe_poll,
  357. .unlocked_ioctl = rpc_pipe_ioctl,
  358. .open = rpc_pipe_open,
  359. .release = rpc_pipe_release,
  360. };
  361. static int
  362. rpc_show_info(struct seq_file *m, void *v)
  363. {
  364. struct rpc_clnt *clnt = m->private;
  365. rcu_read_lock();
  366. seq_printf(m, "RPC server: %s\n",
  367. rcu_dereference(clnt->cl_xprt)->servername);
  368. seq_printf(m, "service: %s (%d) version %d\n", clnt->cl_program->name,
  369. clnt->cl_prog, clnt->cl_vers);
  370. seq_printf(m, "address: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_ADDR));
  371. seq_printf(m, "protocol: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PROTO));
  372. seq_printf(m, "port: %s\n", rpc_peeraddr2str(clnt, RPC_DISPLAY_PORT));
  373. rcu_read_unlock();
  374. return 0;
  375. }
  376. static int
  377. rpc_info_open(struct inode *inode, struct file *file)
  378. {
  379. struct rpc_clnt *clnt = NULL;
  380. int ret = single_open(file, rpc_show_info, NULL);
  381. if (!ret) {
  382. struct seq_file *m = file->private_data;
  383. spin_lock(&file->f_path.dentry->d_lock);
  384. if (!d_unhashed(file->f_path.dentry))
  385. clnt = RPC_I(inode)->private;
  386. if (clnt != NULL && atomic_inc_not_zero(&clnt->cl_count)) {
  387. spin_unlock(&file->f_path.dentry->d_lock);
  388. m->private = clnt;
  389. } else {
  390. spin_unlock(&file->f_path.dentry->d_lock);
  391. single_release(inode, file);
  392. ret = -EINVAL;
  393. }
  394. }
  395. return ret;
  396. }
  397. static int
  398. rpc_info_release(struct inode *inode, struct file *file)
  399. {
  400. struct seq_file *m = file->private_data;
  401. struct rpc_clnt *clnt = (struct rpc_clnt *)m->private;
  402. if (clnt)
  403. rpc_release_client(clnt);
  404. return single_release(inode, file);
  405. }
  406. static const struct file_operations rpc_info_operations = {
  407. .owner = THIS_MODULE,
  408. .open = rpc_info_open,
  409. .read = seq_read,
  410. .llseek = seq_lseek,
  411. .release = rpc_info_release,
  412. };
  413. /*
  414. * Description of fs contents.
  415. */
  416. struct rpc_filelist {
  417. const char *name;
  418. const struct file_operations *i_fop;
  419. umode_t mode;
  420. };
  421. static int rpc_delete_dentry(const struct dentry *dentry)
  422. {
  423. return 1;
  424. }
  425. static const struct dentry_operations rpc_dentry_operations = {
  426. .d_delete = rpc_delete_dentry,
  427. };
  428. static struct inode *
  429. rpc_get_inode(struct super_block *sb, umode_t mode)
  430. {
  431. struct inode *inode = new_inode(sb);
  432. if (!inode)
  433. return NULL;
  434. inode->i_ino = get_next_ino();
  435. inode->i_mode = mode;
  436. inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
  437. switch (mode & S_IFMT) {
  438. case S_IFDIR:
  439. inode->i_fop = &simple_dir_operations;
  440. inode->i_op = &simple_dir_inode_operations;
  441. inc_nlink(inode);
  442. default:
  443. break;
  444. }
  445. return inode;
  446. }
  447. static int __rpc_create_common(struct inode *dir, struct dentry *dentry,
  448. umode_t mode,
  449. const struct file_operations *i_fop,
  450. void *private)
  451. {
  452. struct inode *inode;
  453. d_drop(dentry);
  454. inode = rpc_get_inode(dir->i_sb, mode);
  455. if (!inode)
  456. goto out_err;
  457. inode->i_ino = iunique(dir->i_sb, 100);
  458. if (i_fop)
  459. inode->i_fop = i_fop;
  460. if (private)
  461. rpc_inode_setowner(inode, private);
  462. d_add(dentry, inode);
  463. return 0;
  464. out_err:
  465. printk(KERN_WARNING "%s: %s failed to allocate inode for dentry %s\n",
  466. __FILE__, __func__, dentry->d_name.name);
  467. dput(dentry);
  468. return -ENOMEM;
  469. }
  470. static int __rpc_create(struct inode *dir, struct dentry *dentry,
  471. umode_t mode,
  472. const struct file_operations *i_fop,
  473. void *private)
  474. {
  475. int err;
  476. err = __rpc_create_common(dir, dentry, S_IFREG | mode, i_fop, private);
  477. if (err)
  478. return err;
  479. fsnotify_create(dir, dentry);
  480. return 0;
  481. }
  482. static int __rpc_mkdir(struct inode *dir, struct dentry *dentry,
  483. umode_t mode,
  484. const struct file_operations *i_fop,
  485. void *private)
  486. {
  487. int err;
  488. err = __rpc_create_common(dir, dentry, S_IFDIR | mode, i_fop, private);
  489. if (err)
  490. return err;
  491. inc_nlink(dir);
  492. fsnotify_mkdir(dir, dentry);
  493. return 0;
  494. }
  495. static void
  496. init_pipe(struct rpc_pipe *pipe)
  497. {
  498. pipe->nreaders = 0;
  499. pipe->nwriters = 0;
  500. INIT_LIST_HEAD(&pipe->in_upcall);
  501. INIT_LIST_HEAD(&pipe->in_downcall);
  502. INIT_LIST_HEAD(&pipe->pipe);
  503. pipe->pipelen = 0;
  504. INIT_DELAYED_WORK(&pipe->queue_timeout,
  505. rpc_timeout_upcall_queue);
  506. pipe->ops = NULL;
  507. spin_lock_init(&pipe->lock);
  508. pipe->dentry = NULL;
  509. }
  510. void rpc_destroy_pipe_data(struct rpc_pipe *pipe)
  511. {
  512. kfree(pipe);
  513. }
  514. EXPORT_SYMBOL_GPL(rpc_destroy_pipe_data);
  515. struct rpc_pipe *rpc_mkpipe_data(const struct rpc_pipe_ops *ops, int flags)
  516. {
  517. struct rpc_pipe *pipe;
  518. pipe = kzalloc(sizeof(struct rpc_pipe), GFP_KERNEL);
  519. if (!pipe)
  520. return ERR_PTR(-ENOMEM);
  521. init_pipe(pipe);
  522. pipe->ops = ops;
  523. pipe->flags = flags;
  524. return pipe;
  525. }
  526. EXPORT_SYMBOL_GPL(rpc_mkpipe_data);
  527. static int __rpc_mkpipe_dentry(struct inode *dir, struct dentry *dentry,
  528. umode_t mode,
  529. const struct file_operations *i_fop,
  530. void *private,
  531. struct rpc_pipe *pipe)
  532. {
  533. struct rpc_inode *rpci;
  534. int err;
  535. err = __rpc_create_common(dir, dentry, S_IFIFO | mode, i_fop, private);
  536. if (err)
  537. return err;
  538. rpci = RPC_I(dentry->d_inode);
  539. rpci->private = private;
  540. rpci->pipe = pipe;
  541. fsnotify_create(dir, dentry);
  542. return 0;
  543. }
  544. static int __rpc_rmdir(struct inode *dir, struct dentry *dentry)
  545. {
  546. int ret;
  547. dget(dentry);
  548. ret = simple_rmdir(dir, dentry);
  549. d_delete(dentry);
  550. dput(dentry);
  551. return ret;
  552. }
  553. int rpc_rmdir(struct dentry *dentry)
  554. {
  555. struct dentry *parent;
  556. struct inode *dir;
  557. int error;
  558. parent = dget_parent(dentry);
  559. dir = parent->d_inode;
  560. mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
  561. error = __rpc_rmdir(dir, dentry);
  562. mutex_unlock(&dir->i_mutex);
  563. dput(parent);
  564. return error;
  565. }
  566. EXPORT_SYMBOL_GPL(rpc_rmdir);
  567. static int __rpc_unlink(struct inode *dir, struct dentry *dentry)
  568. {
  569. int ret;
  570. dget(dentry);
  571. ret = simple_unlink(dir, dentry);
  572. d_delete(dentry);
  573. dput(dentry);
  574. return ret;
  575. }
  576. static int __rpc_rmpipe(struct inode *dir, struct dentry *dentry)
  577. {
  578. struct inode *inode = dentry->d_inode;
  579. rpc_close_pipes(inode);
  580. return __rpc_unlink(dir, dentry);
  581. }
  582. static struct dentry *__rpc_lookup_create_exclusive(struct dentry *parent,
  583. const char *name)
  584. {
  585. struct qstr q = QSTR_INIT(name, strlen(name));
  586. struct dentry *dentry = d_hash_and_lookup(parent, &q);
  587. if (!dentry) {
  588. dentry = d_alloc(parent, &q);
  589. if (!dentry)
  590. return ERR_PTR(-ENOMEM);
  591. }
  592. if (dentry->d_inode == NULL)
  593. return dentry;
  594. dput(dentry);
  595. return ERR_PTR(-EEXIST);
  596. }
  597. /*
  598. * FIXME: This probably has races.
  599. */
  600. static void __rpc_depopulate(struct dentry *parent,
  601. const struct rpc_filelist *files,
  602. int start, int eof)
  603. {
  604. struct inode *dir = parent->d_inode;
  605. struct dentry *dentry;
  606. struct qstr name;
  607. int i;
  608. for (i = start; i < eof; i++) {
  609. name.name = files[i].name;
  610. name.len = strlen(files[i].name);
  611. dentry = d_hash_and_lookup(parent, &name);
  612. if (dentry == NULL)
  613. continue;
  614. if (dentry->d_inode == NULL)
  615. goto next;
  616. switch (dentry->d_inode->i_mode & S_IFMT) {
  617. default:
  618. BUG();
  619. case S_IFREG:
  620. __rpc_unlink(dir, dentry);
  621. break;
  622. case S_IFDIR:
  623. __rpc_rmdir(dir, dentry);
  624. }
  625. next:
  626. dput(dentry);
  627. }
  628. }
  629. static void rpc_depopulate(struct dentry *parent,
  630. const struct rpc_filelist *files,
  631. int start, int eof)
  632. {
  633. struct inode *dir = parent->d_inode;
  634. mutex_lock_nested(&dir->i_mutex, I_MUTEX_CHILD);
  635. __rpc_depopulate(parent, files, start, eof);
  636. mutex_unlock(&dir->i_mutex);
  637. }
  638. static int rpc_populate(struct dentry *parent,
  639. const struct rpc_filelist *files,
  640. int start, int eof,
  641. void *private)
  642. {
  643. struct inode *dir = parent->d_inode;
  644. struct dentry *dentry;
  645. int i, err;
  646. mutex_lock(&dir->i_mutex);
  647. for (i = start; i < eof; i++) {
  648. dentry = __rpc_lookup_create_exclusive(parent, files[i].name);
  649. err = PTR_ERR(dentry);
  650. if (IS_ERR(dentry))
  651. goto out_bad;
  652. switch (files[i].mode & S_IFMT) {
  653. default:
  654. BUG();
  655. case S_IFREG:
  656. err = __rpc_create(dir, dentry,
  657. files[i].mode,
  658. files[i].i_fop,
  659. private);
  660. break;
  661. case S_IFDIR:
  662. err = __rpc_mkdir(dir, dentry,
  663. files[i].mode,
  664. NULL,
  665. private);
  666. }
  667. if (err != 0)
  668. goto out_bad;
  669. }
  670. mutex_unlock(&dir->i_mutex);
  671. return 0;
  672. out_bad:
  673. __rpc_depopulate(parent, files, start, eof);
  674. mutex_unlock(&dir->i_mutex);
  675. printk(KERN_WARNING "%s: %s failed to populate directory %s\n",
  676. __FILE__, __func__, parent->d_name.name);
  677. return err;
  678. }
  679. static struct dentry *rpc_mkdir_populate(struct dentry *parent,
  680. const char *name, umode_t mode, void *private,
  681. int (*populate)(struct dentry *, void *), void *args_populate)
  682. {
  683. struct dentry *dentry;
  684. struct inode *dir = parent->d_inode;
  685. int error;
  686. mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
  687. dentry = __rpc_lookup_create_exclusive(parent, name);
  688. if (IS_ERR(dentry))
  689. goto out;
  690. error = __rpc_mkdir(dir, dentry, mode, NULL, private);
  691. if (error != 0)
  692. goto out_err;
  693. if (populate != NULL) {
  694. error = populate(dentry, args_populate);
  695. if (error)
  696. goto err_rmdir;
  697. }
  698. out:
  699. mutex_unlock(&dir->i_mutex);
  700. return dentry;
  701. err_rmdir:
  702. __rpc_rmdir(dir, dentry);
  703. out_err:
  704. dentry = ERR_PTR(error);
  705. goto out;
  706. }
  707. static int rpc_rmdir_depopulate(struct dentry *dentry,
  708. void (*depopulate)(struct dentry *))
  709. {
  710. struct dentry *parent;
  711. struct inode *dir;
  712. int error;
  713. parent = dget_parent(dentry);
  714. dir = parent->d_inode;
  715. mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
  716. if (depopulate != NULL)
  717. depopulate(dentry);
  718. error = __rpc_rmdir(dir, dentry);
  719. mutex_unlock(&dir->i_mutex);
  720. dput(parent);
  721. return error;
  722. }
  723. /**
  724. * rpc_mkpipe - make an rpc_pipefs file for kernel<->userspace communication
  725. * @parent: dentry of directory to create new "pipe" in
  726. * @name: name of pipe
  727. * @private: private data to associate with the pipe, for the caller's use
  728. * @pipe: &rpc_pipe containing input parameters
  729. *
  730. * Data is made available for userspace to read by calls to
  731. * rpc_queue_upcall(). The actual reads will result in calls to
  732. * @ops->upcall, which will be called with the file pointer,
  733. * message, and userspace buffer to copy to.
  734. *
  735. * Writes can come at any time, and do not necessarily have to be
  736. * responses to upcalls. They will result in calls to @msg->downcall.
  737. *
  738. * The @private argument passed here will be available to all these methods
  739. * from the file pointer, via RPC_I(file_inode(file))->private.
  740. */
  741. struct dentry *rpc_mkpipe_dentry(struct dentry *parent, const char *name,
  742. void *private, struct rpc_pipe *pipe)
  743. {
  744. struct dentry *dentry;
  745. struct inode *dir = parent->d_inode;
  746. umode_t umode = S_IFIFO | S_IRUSR | S_IWUSR;
  747. int err;
  748. if (pipe->ops->upcall == NULL)
  749. umode &= ~S_IRUGO;
  750. if (pipe->ops->downcall == NULL)
  751. umode &= ~S_IWUGO;
  752. mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
  753. dentry = __rpc_lookup_create_exclusive(parent, name);
  754. if (IS_ERR(dentry))
  755. goto out;
  756. err = __rpc_mkpipe_dentry(dir, dentry, umode, &rpc_pipe_fops,
  757. private, pipe);
  758. if (err)
  759. goto out_err;
  760. out:
  761. mutex_unlock(&dir->i_mutex);
  762. return dentry;
  763. out_err:
  764. dentry = ERR_PTR(err);
  765. printk(KERN_WARNING "%s: %s() failed to create pipe %s/%s (errno = %d)\n",
  766. __FILE__, __func__, parent->d_name.name, name,
  767. err);
  768. goto out;
  769. }
  770. EXPORT_SYMBOL_GPL(rpc_mkpipe_dentry);
  771. /**
  772. * rpc_unlink - remove a pipe
  773. * @dentry: dentry for the pipe, as returned from rpc_mkpipe
  774. *
  775. * After this call, lookups will no longer find the pipe, and any
  776. * attempts to read or write using preexisting opens of the pipe will
  777. * return -EPIPE.
  778. */
  779. int
  780. rpc_unlink(struct dentry *dentry)
  781. {
  782. struct dentry *parent;
  783. struct inode *dir;
  784. int error = 0;
  785. parent = dget_parent(dentry);
  786. dir = parent->d_inode;
  787. mutex_lock_nested(&dir->i_mutex, I_MUTEX_PARENT);
  788. error = __rpc_rmpipe(dir, dentry);
  789. mutex_unlock(&dir->i_mutex);
  790. dput(parent);
  791. return error;
  792. }
  793. EXPORT_SYMBOL_GPL(rpc_unlink);
  794. enum {
  795. RPCAUTH_info,
  796. RPCAUTH_EOF
  797. };
  798. static const struct rpc_filelist authfiles[] = {
  799. [RPCAUTH_info] = {
  800. .name = "info",
  801. .i_fop = &rpc_info_operations,
  802. .mode = S_IFREG | S_IRUSR,
  803. },
  804. };
  805. static int rpc_clntdir_populate(struct dentry *dentry, void *private)
  806. {
  807. return rpc_populate(dentry,
  808. authfiles, RPCAUTH_info, RPCAUTH_EOF,
  809. private);
  810. }
  811. static void rpc_clntdir_depopulate(struct dentry *dentry)
  812. {
  813. rpc_depopulate(dentry, authfiles, RPCAUTH_info, RPCAUTH_EOF);
  814. }
  815. /**
  816. * rpc_create_client_dir - Create a new rpc_client directory in rpc_pipefs
  817. * @dentry: the parent of new directory
  818. * @name: the name of new directory
  819. * @rpc_client: rpc client to associate with this directory
  820. *
  821. * This creates a directory at the given @path associated with
  822. * @rpc_clnt, which will contain a file named "info" with some basic
  823. * information about the client, together with any "pipes" that may
  824. * later be created using rpc_mkpipe().
  825. */
  826. struct dentry *rpc_create_client_dir(struct dentry *dentry,
  827. const char *name,
  828. struct rpc_clnt *rpc_client)
  829. {
  830. return rpc_mkdir_populate(dentry, name, S_IRUGO | S_IXUGO, NULL,
  831. rpc_clntdir_populate, rpc_client);
  832. }
  833. /**
  834. * rpc_remove_client_dir - Remove a directory created with rpc_create_client_dir()
  835. * @dentry: dentry for the pipe
  836. */
  837. int rpc_remove_client_dir(struct dentry *dentry)
  838. {
  839. return rpc_rmdir_depopulate(dentry, rpc_clntdir_depopulate);
  840. }
  841. static const struct rpc_filelist cache_pipefs_files[3] = {
  842. [0] = {
  843. .name = "channel",
  844. .i_fop = &cache_file_operations_pipefs,
  845. .mode = S_IFREG|S_IRUSR|S_IWUSR,
  846. },
  847. [1] = {
  848. .name = "content",
  849. .i_fop = &content_file_operations_pipefs,
  850. .mode = S_IFREG|S_IRUSR,
  851. },
  852. [2] = {
  853. .name = "flush",
  854. .i_fop = &cache_flush_operations_pipefs,
  855. .mode = S_IFREG|S_IRUSR|S_IWUSR,
  856. },
  857. };
  858. static int rpc_cachedir_populate(struct dentry *dentry, void *private)
  859. {
  860. return rpc_populate(dentry,
  861. cache_pipefs_files, 0, 3,
  862. private);
  863. }
  864. static void rpc_cachedir_depopulate(struct dentry *dentry)
  865. {
  866. rpc_depopulate(dentry, cache_pipefs_files, 0, 3);
  867. }
  868. struct dentry *rpc_create_cache_dir(struct dentry *parent, const char *name,
  869. umode_t umode, struct cache_detail *cd)
  870. {
  871. return rpc_mkdir_populate(parent, name, umode, NULL,
  872. rpc_cachedir_populate, cd);
  873. }
  874. void rpc_remove_cache_dir(struct dentry *dentry)
  875. {
  876. rpc_rmdir_depopulate(dentry, rpc_cachedir_depopulate);
  877. }
  878. /*
  879. * populate the filesystem
  880. */
  881. static const struct super_operations s_ops = {
  882. .alloc_inode = rpc_alloc_inode,
  883. .destroy_inode = rpc_destroy_inode,
  884. .statfs = simple_statfs,
  885. };
  886. #define RPCAUTH_GSSMAGIC 0x67596969
  887. /*
  888. * We have a single directory with 1 node in it.
  889. */
  890. enum {
  891. RPCAUTH_lockd,
  892. RPCAUTH_mount,
  893. RPCAUTH_nfs,
  894. RPCAUTH_portmap,
  895. RPCAUTH_statd,
  896. RPCAUTH_nfsd4_cb,
  897. RPCAUTH_cache,
  898. RPCAUTH_nfsd,
  899. RPCAUTH_RootEOF
  900. };
  901. static const struct rpc_filelist files[] = {
  902. [RPCAUTH_lockd] = {
  903. .name = "lockd",
  904. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  905. },
  906. [RPCAUTH_mount] = {
  907. .name = "mount",
  908. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  909. },
  910. [RPCAUTH_nfs] = {
  911. .name = "nfs",
  912. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  913. },
  914. [RPCAUTH_portmap] = {
  915. .name = "portmap",
  916. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  917. },
  918. [RPCAUTH_statd] = {
  919. .name = "statd",
  920. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  921. },
  922. [RPCAUTH_nfsd4_cb] = {
  923. .name = "nfsd4_cb",
  924. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  925. },
  926. [RPCAUTH_cache] = {
  927. .name = "cache",
  928. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  929. },
  930. [RPCAUTH_nfsd] = {
  931. .name = "nfsd",
  932. .mode = S_IFDIR | S_IRUGO | S_IXUGO,
  933. },
  934. };
  935. /*
  936. * This call can be used only in RPC pipefs mount notification hooks.
  937. */
  938. struct dentry *rpc_d_lookup_sb(const struct super_block *sb,
  939. const unsigned char *dir_name)
  940. {
  941. struct qstr dir = QSTR_INIT(dir_name, strlen(dir_name));
  942. return d_hash_and_lookup(sb->s_root, &dir);
  943. }
  944. EXPORT_SYMBOL_GPL(rpc_d_lookup_sb);
  945. void rpc_pipefs_init_net(struct net *net)
  946. {
  947. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  948. mutex_init(&sn->pipefs_sb_lock);
  949. sn->gssd_running = 1;
  950. sn->pipe_version = -1;
  951. }
  952. /*
  953. * This call will be used for per network namespace operations calls.
  954. * Note: Function will be returned with pipefs_sb_lock taken if superblock was
  955. * found. This lock have to be released by rpc_put_sb_net() when all operations
  956. * will be completed.
  957. */
  958. struct super_block *rpc_get_sb_net(const struct net *net)
  959. {
  960. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  961. mutex_lock(&sn->pipefs_sb_lock);
  962. if (sn->pipefs_sb)
  963. return sn->pipefs_sb;
  964. mutex_unlock(&sn->pipefs_sb_lock);
  965. return NULL;
  966. }
  967. EXPORT_SYMBOL_GPL(rpc_get_sb_net);
  968. void rpc_put_sb_net(const struct net *net)
  969. {
  970. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  971. WARN_ON(sn->pipefs_sb == NULL);
  972. mutex_unlock(&sn->pipefs_sb_lock);
  973. }
  974. EXPORT_SYMBOL_GPL(rpc_put_sb_net);
  975. static int
  976. rpc_fill_super(struct super_block *sb, void *data, int silent)
  977. {
  978. struct inode *inode;
  979. struct dentry *root;
  980. struct net *net = data;
  981. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  982. int err;
  983. sb->s_blocksize = PAGE_CACHE_SIZE;
  984. sb->s_blocksize_bits = PAGE_CACHE_SHIFT;
  985. sb->s_magic = RPCAUTH_GSSMAGIC;
  986. sb->s_op = &s_ops;
  987. sb->s_d_op = &rpc_dentry_operations;
  988. sb->s_time_gran = 1;
  989. inode = rpc_get_inode(sb, S_IFDIR | S_IRUGO | S_IXUGO);
  990. sb->s_root = root = d_make_root(inode);
  991. if (!root)
  992. return -ENOMEM;
  993. if (rpc_populate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF, NULL))
  994. return -ENOMEM;
  995. dprintk("RPC: sending pipefs MOUNT notification for net %p%s\n",
  996. net, NET_NAME(net));
  997. mutex_lock(&sn->pipefs_sb_lock);
  998. sn->pipefs_sb = sb;
  999. err = blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
  1000. RPC_PIPEFS_MOUNT,
  1001. sb);
  1002. if (err)
  1003. goto err_depopulate;
  1004. sb->s_fs_info = get_net(net);
  1005. mutex_unlock(&sn->pipefs_sb_lock);
  1006. return 0;
  1007. err_depopulate:
  1008. blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
  1009. RPC_PIPEFS_UMOUNT,
  1010. sb);
  1011. sn->pipefs_sb = NULL;
  1012. __rpc_depopulate(root, files, RPCAUTH_lockd, RPCAUTH_RootEOF);
  1013. mutex_unlock(&sn->pipefs_sb_lock);
  1014. return err;
  1015. }
  1016. static struct dentry *
  1017. rpc_mount(struct file_system_type *fs_type,
  1018. int flags, const char *dev_name, void *data)
  1019. {
  1020. return mount_ns(fs_type, flags, current->nsproxy->net_ns, rpc_fill_super);
  1021. }
  1022. static void rpc_kill_sb(struct super_block *sb)
  1023. {
  1024. struct net *net = sb->s_fs_info;
  1025. struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
  1026. mutex_lock(&sn->pipefs_sb_lock);
  1027. if (sn->pipefs_sb != sb) {
  1028. mutex_unlock(&sn->pipefs_sb_lock);
  1029. goto out;
  1030. }
  1031. sn->pipefs_sb = NULL;
  1032. dprintk("RPC: sending pipefs UMOUNT notification for net %p%s\n",
  1033. net, NET_NAME(net));
  1034. blocking_notifier_call_chain(&rpc_pipefs_notifier_list,
  1035. RPC_PIPEFS_UMOUNT,
  1036. sb);
  1037. mutex_unlock(&sn->pipefs_sb_lock);
  1038. put_net(net);
  1039. out:
  1040. kill_litter_super(sb);
  1041. }
  1042. static struct file_system_type rpc_pipe_fs_type = {
  1043. .owner = THIS_MODULE,
  1044. .name = "rpc_pipefs",
  1045. .mount = rpc_mount,
  1046. .kill_sb = rpc_kill_sb,
  1047. };
  1048. MODULE_ALIAS_FS("rpc_pipefs");
  1049. MODULE_ALIAS("rpc_pipefs");
  1050. static void
  1051. init_once(void *foo)
  1052. {
  1053. struct rpc_inode *rpci = (struct rpc_inode *) foo;
  1054. inode_init_once(&rpci->vfs_inode);
  1055. rpci->private = NULL;
  1056. rpci->pipe = NULL;
  1057. init_waitqueue_head(&rpci->waitq);
  1058. }
  1059. int register_rpc_pipefs(void)
  1060. {
  1061. int err;
  1062. rpc_inode_cachep = kmem_cache_create("rpc_inode_cache",
  1063. sizeof(struct rpc_inode),
  1064. 0, (SLAB_HWCACHE_ALIGN|SLAB_RECLAIM_ACCOUNT|
  1065. SLAB_MEM_SPREAD),
  1066. init_once);
  1067. if (!rpc_inode_cachep)
  1068. return -ENOMEM;
  1069. err = rpc_clients_notifier_register();
  1070. if (err)
  1071. goto err_notifier;
  1072. err = register_filesystem(&rpc_pipe_fs_type);
  1073. if (err)
  1074. goto err_register;
  1075. return 0;
  1076. err_register:
  1077. rpc_clients_notifier_unregister();
  1078. err_notifier:
  1079. kmem_cache_destroy(rpc_inode_cachep);
  1080. return err;
  1081. }
  1082. void unregister_rpc_pipefs(void)
  1083. {
  1084. rpc_clients_notifier_unregister();
  1085. kmem_cache_destroy(rpc_inode_cachep);
  1086. unregister_filesystem(&rpc_pipe_fs_type);
  1087. }