nfs4recover.c 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. /*
  2. * linux/fs/nfsd/nfs4recover.c
  3. *
  4. * Copyright (c) 2004 The Regents of the University of Michigan.
  5. * All rights reserved.
  6. *
  7. * Andy Adamson <andros@citi.umich.edu>
  8. *
  9. * Redistribution and use in source and binary forms, with or without
  10. * modification, are permitted provided that the following conditions
  11. * are met:
  12. *
  13. * 1. Redistributions of source code must retain the above copyright
  14. * notice, this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright
  16. * notice, this list of conditions and the following disclaimer in the
  17. * documentation and/or other materials provided with the distribution.
  18. * 3. Neither the name of the University nor the names of its
  19. * contributors may be used to endorse or promote products derived
  20. * from this software without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  23. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28. * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  29. * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  30. * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  31. * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  32. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. */
  35. #include <linux/sunrpc/svc.h>
  36. #include <linux/nfsd/nfsd.h>
  37. #include <linux/nfs4.h>
  38. #include <linux/nfsd/state.h>
  39. #include <linux/nfsd/xdr4.h>
  40. #include <linux/param.h>
  41. #include <linux/file.h>
  42. #include <linux/namei.h>
  43. #include <asm/uaccess.h>
  44. #include <asm/scatterlist.h>
  45. #include <linux/crypto.h>
  46. #define NFSDDBG_FACILITY NFSDDBG_PROC
  47. /* Globals */
  48. static struct nameidata rec_dir;
  49. static int rec_dir_init = 0;
  50. static void
  51. nfs4_save_user(uid_t *saveuid, gid_t *savegid)
  52. {
  53. *saveuid = current->fsuid;
  54. *savegid = current->fsgid;
  55. current->fsuid = 0;
  56. current->fsgid = 0;
  57. }
  58. static void
  59. nfs4_reset_user(uid_t saveuid, gid_t savegid)
  60. {
  61. current->fsuid = saveuid;
  62. current->fsgid = savegid;
  63. }
  64. static void
  65. md5_to_hex(char *out, char *md5)
  66. {
  67. int i;
  68. for (i=0; i<16; i++) {
  69. unsigned char c = md5[i];
  70. *out++ = '0' + ((c&0xf0)>>4) + (c>=0xa0)*('a'-'9'-1);
  71. *out++ = '0' + (c&0x0f) + ((c&0x0f)>=0x0a)*('a'-'9'-1);
  72. }
  73. *out = '\0';
  74. }
  75. int
  76. nfs4_make_rec_clidname(char *dname, struct xdr_netobj *clname)
  77. {
  78. struct xdr_netobj cksum;
  79. struct crypto_tfm *tfm;
  80. struct scatterlist sg[1];
  81. int status = nfserr_resource;
  82. dprintk("NFSD: nfs4_make_rec_clidname for %.*s\n",
  83. clname->len, clname->data);
  84. tfm = crypto_alloc_tfm("md5", CRYPTO_TFM_REQ_MAY_SLEEP);
  85. if (tfm == NULL)
  86. goto out;
  87. cksum.len = crypto_tfm_alg_digestsize(tfm);
  88. cksum.data = kmalloc(cksum.len, GFP_KERNEL);
  89. if (cksum.data == NULL)
  90. goto out;
  91. crypto_digest_init(tfm);
  92. sg[0].page = virt_to_page(clname->data);
  93. sg[0].offset = offset_in_page(clname->data);
  94. sg[0].length = clname->len;
  95. crypto_digest_update(tfm, sg, 1);
  96. crypto_digest_final(tfm, cksum.data);
  97. md5_to_hex(dname, cksum.data);
  98. kfree(cksum.data);
  99. status = nfs_ok;
  100. out:
  101. crypto_free_tfm(tfm);
  102. return status;
  103. }
  104. static void
  105. nfsd4_sync_rec_dir(void)
  106. {
  107. mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
  108. nfsd_sync_dir(rec_dir.dentry);
  109. mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
  110. }
  111. int
  112. nfsd4_create_clid_dir(struct nfs4_client *clp)
  113. {
  114. char *dname = clp->cl_recdir;
  115. struct dentry *dentry;
  116. uid_t uid;
  117. gid_t gid;
  118. int status;
  119. dprintk("NFSD: nfsd4_create_clid_dir for \"%s\"\n", dname);
  120. if (!rec_dir_init || clp->cl_firststate)
  121. return 0;
  122. nfs4_save_user(&uid, &gid);
  123. /* lock the parent */
  124. mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
  125. dentry = lookup_one_len(dname, rec_dir.dentry, HEXDIR_LEN-1);
  126. if (IS_ERR(dentry)) {
  127. status = PTR_ERR(dentry);
  128. goto out_unlock;
  129. }
  130. status = -EEXIST;
  131. if (dentry->d_inode) {
  132. dprintk("NFSD: nfsd4_create_clid_dir: DIRECTORY EXISTS\n");
  133. goto out_put;
  134. }
  135. status = vfs_mkdir(rec_dir.dentry->d_inode, dentry, S_IRWXU);
  136. out_put:
  137. dput(dentry);
  138. out_unlock:
  139. mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
  140. if (status == 0) {
  141. clp->cl_firststate = 1;
  142. nfsd4_sync_rec_dir();
  143. }
  144. nfs4_reset_user(uid, gid);
  145. dprintk("NFSD: nfsd4_create_clid_dir returns %d\n", status);
  146. return status;
  147. }
  148. typedef int (recdir_func)(struct dentry *, struct dentry *);
  149. struct dentry_list {
  150. struct dentry *dentry;
  151. struct list_head list;
  152. };
  153. struct dentry_list_arg {
  154. struct list_head dentries;
  155. struct dentry *parent;
  156. };
  157. static int
  158. nfsd4_build_dentrylist(void *arg, const char *name, int namlen,
  159. loff_t offset, ino_t ino, unsigned int d_type)
  160. {
  161. struct dentry_list_arg *dla = arg;
  162. struct list_head *dentries = &dla->dentries;
  163. struct dentry *parent = dla->parent;
  164. struct dentry *dentry;
  165. struct dentry_list *child;
  166. if (name && isdotent(name, namlen))
  167. return nfs_ok;
  168. dentry = lookup_one_len(name, parent, namlen);
  169. if (IS_ERR(dentry))
  170. return PTR_ERR(dentry);
  171. child = kmalloc(sizeof(*child), GFP_KERNEL);
  172. if (child == NULL)
  173. return -ENOMEM;
  174. child->dentry = dentry;
  175. list_add(&child->list, dentries);
  176. return 0;
  177. }
  178. static int
  179. nfsd4_list_rec_dir(struct dentry *dir, recdir_func *f)
  180. {
  181. struct file *filp;
  182. struct dentry_list_arg dla = {
  183. .parent = dir,
  184. };
  185. struct list_head *dentries = &dla.dentries;
  186. struct dentry_list *child;
  187. uid_t uid;
  188. gid_t gid;
  189. int status;
  190. if (!rec_dir_init)
  191. return 0;
  192. nfs4_save_user(&uid, &gid);
  193. filp = dentry_open(dget(dir), mntget(rec_dir.mnt), O_RDONLY);
  194. status = PTR_ERR(filp);
  195. if (IS_ERR(filp))
  196. goto out;
  197. INIT_LIST_HEAD(dentries);
  198. status = vfs_readdir(filp, nfsd4_build_dentrylist, &dla);
  199. fput(filp);
  200. while (!list_empty(dentries)) {
  201. child = list_entry(dentries->next, struct dentry_list, list);
  202. status = f(dir, child->dentry);
  203. if (status)
  204. goto out;
  205. list_del(&child->list);
  206. dput(child->dentry);
  207. kfree(child);
  208. }
  209. out:
  210. while (!list_empty(dentries)) {
  211. child = list_entry(dentries->next, struct dentry_list, list);
  212. list_del(&child->list);
  213. dput(child->dentry);
  214. kfree(child);
  215. }
  216. nfs4_reset_user(uid, gid);
  217. return status;
  218. }
  219. static int
  220. nfsd4_remove_clid_file(struct dentry *dir, struct dentry *dentry)
  221. {
  222. int status;
  223. if (!S_ISREG(dir->d_inode->i_mode)) {
  224. printk("nfsd4: non-file found in client recovery directory\n");
  225. return -EINVAL;
  226. }
  227. mutex_lock(&dir->d_inode->i_mutex);
  228. status = vfs_unlink(dir->d_inode, dentry);
  229. mutex_unlock(&dir->d_inode->i_mutex);
  230. return status;
  231. }
  232. static int
  233. nfsd4_clear_clid_dir(struct dentry *dir, struct dentry *dentry)
  234. {
  235. int status;
  236. /* For now this directory should already be empty, but we empty it of
  237. * any regular files anyway, just in case the directory was created by
  238. * a kernel from the future.... */
  239. nfsd4_list_rec_dir(dentry, nfsd4_remove_clid_file);
  240. mutex_lock(&dir->d_inode->i_mutex);
  241. status = vfs_rmdir(dir->d_inode, dentry);
  242. mutex_unlock(&dir->d_inode->i_mutex);
  243. return status;
  244. }
  245. static int
  246. nfsd4_unlink_clid_dir(char *name, int namlen)
  247. {
  248. struct dentry *dentry;
  249. int status;
  250. dprintk("NFSD: nfsd4_unlink_clid_dir. name %.*s\n", namlen, name);
  251. mutex_lock(&rec_dir.dentry->d_inode->i_mutex);
  252. dentry = lookup_one_len(name, rec_dir.dentry, namlen);
  253. mutex_unlock(&rec_dir.dentry->d_inode->i_mutex);
  254. if (IS_ERR(dentry)) {
  255. status = PTR_ERR(dentry);
  256. return status;
  257. }
  258. status = -ENOENT;
  259. if (!dentry->d_inode)
  260. goto out;
  261. status = nfsd4_clear_clid_dir(rec_dir.dentry, dentry);
  262. out:
  263. dput(dentry);
  264. return status;
  265. }
  266. void
  267. nfsd4_remove_clid_dir(struct nfs4_client *clp)
  268. {
  269. uid_t uid;
  270. gid_t gid;
  271. int status;
  272. if (!rec_dir_init || !clp->cl_firststate)
  273. return;
  274. clp->cl_firststate = 0;
  275. nfs4_save_user(&uid, &gid);
  276. status = nfsd4_unlink_clid_dir(clp->cl_recdir, HEXDIR_LEN-1);
  277. nfs4_reset_user(uid, gid);
  278. if (status == 0)
  279. nfsd4_sync_rec_dir();
  280. if (status)
  281. printk("NFSD: Failed to remove expired client state directory"
  282. " %.*s\n", HEXDIR_LEN, clp->cl_recdir);
  283. return;
  284. }
  285. static int
  286. purge_old(struct dentry *parent, struct dentry *child)
  287. {
  288. int status;
  289. if (nfs4_has_reclaimed_state(child->d_name.name))
  290. return nfs_ok;
  291. status = nfsd4_clear_clid_dir(parent, child);
  292. if (status)
  293. printk("failed to remove client recovery directory %s\n",
  294. child->d_name.name);
  295. /* Keep trying, success or failure: */
  296. return nfs_ok;
  297. }
  298. void
  299. nfsd4_recdir_purge_old(void) {
  300. int status;
  301. if (!rec_dir_init)
  302. return;
  303. status = nfsd4_list_rec_dir(rec_dir.dentry, purge_old);
  304. if (status == 0)
  305. nfsd4_sync_rec_dir();
  306. if (status)
  307. printk("nfsd4: failed to purge old clients from recovery"
  308. " directory %s\n", rec_dir.dentry->d_name.name);
  309. return;
  310. }
  311. static int
  312. load_recdir(struct dentry *parent, struct dentry *child)
  313. {
  314. if (child->d_name.len != HEXDIR_LEN - 1) {
  315. printk("nfsd4: illegal name %s in recovery directory\n",
  316. child->d_name.name);
  317. /* Keep trying; maybe the others are OK: */
  318. return nfs_ok;
  319. }
  320. nfs4_client_to_reclaim(child->d_name.name);
  321. return nfs_ok;
  322. }
  323. int
  324. nfsd4_recdir_load(void) {
  325. int status;
  326. status = nfsd4_list_rec_dir(rec_dir.dentry, load_recdir);
  327. if (status)
  328. printk("nfsd4: failed loading clients from recovery"
  329. " directory %s\n", rec_dir.dentry->d_name.name);
  330. return status;
  331. }
  332. /*
  333. * Hold reference to the recovery directory.
  334. */
  335. void
  336. nfsd4_init_recdir(char *rec_dirname)
  337. {
  338. uid_t uid = 0;
  339. gid_t gid = 0;
  340. int status;
  341. printk("NFSD: Using %s as the NFSv4 state recovery directory\n",
  342. rec_dirname);
  343. BUG_ON(rec_dir_init);
  344. nfs4_save_user(&uid, &gid);
  345. status = path_lookup(rec_dirname, LOOKUP_FOLLOW | LOOKUP_DIRECTORY,
  346. &rec_dir);
  347. if (status)
  348. printk("NFSD: unable to find recovery directory %s\n",
  349. rec_dirname);
  350. if (!status)
  351. rec_dir_init = 1;
  352. nfs4_reset_user(uid, gid);
  353. }
  354. void
  355. nfsd4_shutdown_recdir(void)
  356. {
  357. if (!rec_dir_init)
  358. return;
  359. rec_dir_init = 0;
  360. path_release(&rec_dir);
  361. }