splice.c 46 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047
  1. /*
  2. * "splice": joining two ropes together by interweaving their strands.
  3. *
  4. * This is the "extended pipe" functionality, where a pipe is used as
  5. * an arbitrary in-memory buffer. Think of a pipe as a small kernel
  6. * buffer that you can use to transfer data from one end to the other.
  7. *
  8. * The traditional unix read/write is extended with a "splice()" operation
  9. * that transfers data buffers to or from a pipe buffer.
  10. *
  11. * Named by Larry McVoy, original implementation from Linus, extended by
  12. * Jens to support splicing to files, network, direct splicing, etc and
  13. * fixing lots of bugs.
  14. *
  15. * Copyright (C) 2005-2006 Jens Axboe <axboe@kernel.dk>
  16. * Copyright (C) 2005-2006 Linus Torvalds <torvalds@osdl.org>
  17. * Copyright (C) 2006 Ingo Molnar <mingo@elte.hu>
  18. *
  19. */
  20. #include <linux/fs.h>
  21. #include <linux/file.h>
  22. #include <linux/pagemap.h>
  23. #include <linux/splice.h>
  24. #include <linux/memcontrol.h>
  25. #include <linux/mm_inline.h>
  26. #include <linux/swap.h>
  27. #include <linux/writeback.h>
  28. #include <linux/buffer_head.h>
  29. #include <linux/module.h>
  30. #include <linux/syscalls.h>
  31. #include <linux/uio.h>
  32. #include <linux/security.h>
  33. #include <linux/gfp.h>
  34. /*
  35. * Attempt to steal a page from a pipe buffer. This should perhaps go into
  36. * a vm helper function, it's already simplified quite a bit by the
  37. * addition of remove_mapping(). If success is returned, the caller may
  38. * attempt to reuse this page for another destination.
  39. */
  40. static int page_cache_pipe_buf_steal(struct pipe_inode_info *pipe,
  41. struct pipe_buffer *buf)
  42. {
  43. struct page *page = buf->page;
  44. struct address_space *mapping;
  45. lock_page(page);
  46. mapping = page_mapping(page);
  47. if (mapping) {
  48. WARN_ON(!PageUptodate(page));
  49. /*
  50. * At least for ext2 with nobh option, we need to wait on
  51. * writeback completing on this page, since we'll remove it
  52. * from the pagecache. Otherwise truncate wont wait on the
  53. * page, allowing the disk blocks to be reused by someone else
  54. * before we actually wrote our data to them. fs corruption
  55. * ensues.
  56. */
  57. wait_on_page_writeback(page);
  58. if (page_has_private(page) &&
  59. !try_to_release_page(page, GFP_KERNEL))
  60. goto out_unlock;
  61. /*
  62. * If we succeeded in removing the mapping, set LRU flag
  63. * and return good.
  64. */
  65. if (remove_mapping(mapping, page)) {
  66. buf->flags |= PIPE_BUF_FLAG_LRU;
  67. return 0;
  68. }
  69. }
  70. /*
  71. * Raced with truncate or failed to remove page from current
  72. * address space, unlock and return failure.
  73. */
  74. out_unlock:
  75. unlock_page(page);
  76. return 1;
  77. }
  78. static void page_cache_pipe_buf_release(struct pipe_inode_info *pipe,
  79. struct pipe_buffer *buf)
  80. {
  81. page_cache_release(buf->page);
  82. buf->flags &= ~PIPE_BUF_FLAG_LRU;
  83. }
  84. /*
  85. * Check whether the contents of buf is OK to access. Since the content
  86. * is a page cache page, IO may be in flight.
  87. */
  88. static int page_cache_pipe_buf_confirm(struct pipe_inode_info *pipe,
  89. struct pipe_buffer *buf)
  90. {
  91. struct page *page = buf->page;
  92. int err;
  93. if (!PageUptodate(page)) {
  94. lock_page(page);
  95. /*
  96. * Page got truncated/unhashed. This will cause a 0-byte
  97. * splice, if this is the first page.
  98. */
  99. if (!page->mapping) {
  100. err = -ENODATA;
  101. goto error;
  102. }
  103. /*
  104. * Uh oh, read-error from disk.
  105. */
  106. if (!PageUptodate(page)) {
  107. err = -EIO;
  108. goto error;
  109. }
  110. /*
  111. * Page is ok afterall, we are done.
  112. */
  113. unlock_page(page);
  114. }
  115. return 0;
  116. error:
  117. unlock_page(page);
  118. return err;
  119. }
  120. static const struct pipe_buf_operations page_cache_pipe_buf_ops = {
  121. .can_merge = 0,
  122. .map = generic_pipe_buf_map,
  123. .unmap = generic_pipe_buf_unmap,
  124. .confirm = page_cache_pipe_buf_confirm,
  125. .release = page_cache_pipe_buf_release,
  126. .steal = page_cache_pipe_buf_steal,
  127. .get = generic_pipe_buf_get,
  128. };
  129. static int user_page_pipe_buf_steal(struct pipe_inode_info *pipe,
  130. struct pipe_buffer *buf)
  131. {
  132. if (!(buf->flags & PIPE_BUF_FLAG_GIFT))
  133. return 1;
  134. buf->flags |= PIPE_BUF_FLAG_LRU;
  135. return generic_pipe_buf_steal(pipe, buf);
  136. }
  137. static const struct pipe_buf_operations user_page_pipe_buf_ops = {
  138. .can_merge = 0,
  139. .map = generic_pipe_buf_map,
  140. .unmap = generic_pipe_buf_unmap,
  141. .confirm = generic_pipe_buf_confirm,
  142. .release = page_cache_pipe_buf_release,
  143. .steal = user_page_pipe_buf_steal,
  144. .get = generic_pipe_buf_get,
  145. };
  146. /**
  147. * splice_to_pipe - fill passed data into a pipe
  148. * @pipe: pipe to fill
  149. * @spd: data to fill
  150. *
  151. * Description:
  152. * @spd contains a map of pages and len/offset tuples, along with
  153. * the struct pipe_buf_operations associated with these pages. This
  154. * function will link that data to the pipe.
  155. *
  156. */
  157. ssize_t splice_to_pipe(struct pipe_inode_info *pipe,
  158. struct splice_pipe_desc *spd)
  159. {
  160. unsigned int spd_pages = spd->nr_pages;
  161. int ret, do_wakeup, page_nr;
  162. ret = 0;
  163. do_wakeup = 0;
  164. page_nr = 0;
  165. pipe_lock(pipe);
  166. for (;;) {
  167. if (!pipe->readers) {
  168. send_sig(SIGPIPE, current, 0);
  169. if (!ret)
  170. ret = -EPIPE;
  171. break;
  172. }
  173. if (pipe->nrbufs < pipe->buffers) {
  174. int newbuf = (pipe->curbuf + pipe->nrbufs) & (pipe->buffers - 1);
  175. struct pipe_buffer *buf = pipe->bufs + newbuf;
  176. buf->page = spd->pages[page_nr];
  177. buf->offset = spd->partial[page_nr].offset;
  178. buf->len = spd->partial[page_nr].len;
  179. buf->private = spd->partial[page_nr].private;
  180. buf->ops = spd->ops;
  181. if (spd->flags & SPLICE_F_GIFT)
  182. buf->flags |= PIPE_BUF_FLAG_GIFT;
  183. pipe->nrbufs++;
  184. page_nr++;
  185. ret += buf->len;
  186. if (pipe->inode)
  187. do_wakeup = 1;
  188. if (!--spd->nr_pages)
  189. break;
  190. if (pipe->nrbufs < pipe->buffers)
  191. continue;
  192. break;
  193. }
  194. if (spd->flags & SPLICE_F_NONBLOCK) {
  195. if (!ret)
  196. ret = -EAGAIN;
  197. break;
  198. }
  199. if (signal_pending(current)) {
  200. if (!ret)
  201. ret = -ERESTARTSYS;
  202. break;
  203. }
  204. if (do_wakeup) {
  205. smp_mb();
  206. if (waitqueue_active(&pipe->wait))
  207. wake_up_interruptible_sync(&pipe->wait);
  208. kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
  209. do_wakeup = 0;
  210. }
  211. pipe->waiting_writers++;
  212. pipe_wait(pipe);
  213. pipe->waiting_writers--;
  214. }
  215. pipe_unlock(pipe);
  216. if (do_wakeup) {
  217. smp_mb();
  218. if (waitqueue_active(&pipe->wait))
  219. wake_up_interruptible(&pipe->wait);
  220. kill_fasync(&pipe->fasync_readers, SIGIO, POLL_IN);
  221. }
  222. while (page_nr < spd_pages)
  223. spd->spd_release(spd, page_nr++);
  224. return ret;
  225. }
  226. static void spd_release_page(struct splice_pipe_desc *spd, unsigned int i)
  227. {
  228. page_cache_release(spd->pages[i]);
  229. }
  230. /*
  231. * Check if we need to grow the arrays holding pages and partial page
  232. * descriptions.
  233. */
  234. int splice_grow_spd(struct pipe_inode_info *pipe, struct splice_pipe_desc *spd)
  235. {
  236. if (pipe->buffers <= PIPE_DEF_BUFFERS)
  237. return 0;
  238. spd->pages = kmalloc(pipe->buffers * sizeof(struct page *), GFP_KERNEL);
  239. spd->partial = kmalloc(pipe->buffers * sizeof(struct partial_page), GFP_KERNEL);
  240. if (spd->pages && spd->partial)
  241. return 0;
  242. kfree(spd->pages);
  243. kfree(spd->partial);
  244. return -ENOMEM;
  245. }
  246. void splice_shrink_spd(struct pipe_inode_info *pipe,
  247. struct splice_pipe_desc *spd)
  248. {
  249. if (pipe->buffers <= PIPE_DEF_BUFFERS)
  250. return;
  251. kfree(spd->pages);
  252. kfree(spd->partial);
  253. }
  254. static int
  255. __generic_file_splice_read(struct file *in, loff_t *ppos,
  256. struct pipe_inode_info *pipe, size_t len,
  257. unsigned int flags)
  258. {
  259. struct address_space *mapping = in->f_mapping;
  260. unsigned int loff, nr_pages, req_pages;
  261. struct page *pages[PIPE_DEF_BUFFERS];
  262. struct partial_page partial[PIPE_DEF_BUFFERS];
  263. struct page *page;
  264. pgoff_t index, end_index;
  265. loff_t isize;
  266. int error, page_nr;
  267. struct splice_pipe_desc spd = {
  268. .pages = pages,
  269. .partial = partial,
  270. .flags = flags,
  271. .ops = &page_cache_pipe_buf_ops,
  272. .spd_release = spd_release_page,
  273. };
  274. if (splice_grow_spd(pipe, &spd))
  275. return -ENOMEM;
  276. index = *ppos >> PAGE_CACHE_SHIFT;
  277. loff = *ppos & ~PAGE_CACHE_MASK;
  278. req_pages = (len + loff + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
  279. nr_pages = min(req_pages, pipe->buffers);
  280. /*
  281. * Lookup the (hopefully) full range of pages we need.
  282. */
  283. spd.nr_pages = find_get_pages_contig(mapping, index, nr_pages, spd.pages);
  284. index += spd.nr_pages;
  285. /*
  286. * If find_get_pages_contig() returned fewer pages than we needed,
  287. * readahead/allocate the rest and fill in the holes.
  288. */
  289. if (spd.nr_pages < nr_pages)
  290. page_cache_sync_readahead(mapping, &in->f_ra, in,
  291. index, req_pages - spd.nr_pages);
  292. error = 0;
  293. while (spd.nr_pages < nr_pages) {
  294. /*
  295. * Page could be there, find_get_pages_contig() breaks on
  296. * the first hole.
  297. */
  298. page = find_get_page(mapping, index);
  299. if (!page) {
  300. /*
  301. * page didn't exist, allocate one.
  302. */
  303. page = page_cache_alloc_cold(mapping);
  304. if (!page)
  305. break;
  306. error = add_to_page_cache_lru(page, mapping, index,
  307. GFP_KERNEL);
  308. if (unlikely(error)) {
  309. page_cache_release(page);
  310. if (error == -EEXIST)
  311. continue;
  312. break;
  313. }
  314. /*
  315. * add_to_page_cache() locks the page, unlock it
  316. * to avoid convoluting the logic below even more.
  317. */
  318. unlock_page(page);
  319. }
  320. spd.pages[spd.nr_pages++] = page;
  321. index++;
  322. }
  323. /*
  324. * Now loop over the map and see if we need to start IO on any
  325. * pages, fill in the partial map, etc.
  326. */
  327. index = *ppos >> PAGE_CACHE_SHIFT;
  328. nr_pages = spd.nr_pages;
  329. spd.nr_pages = 0;
  330. for (page_nr = 0; page_nr < nr_pages; page_nr++) {
  331. unsigned int this_len;
  332. if (!len)
  333. break;
  334. /*
  335. * this_len is the max we'll use from this page
  336. */
  337. this_len = min_t(unsigned long, len, PAGE_CACHE_SIZE - loff);
  338. page = spd.pages[page_nr];
  339. if (PageReadahead(page))
  340. page_cache_async_readahead(mapping, &in->f_ra, in,
  341. page, index, req_pages - page_nr);
  342. /*
  343. * If the page isn't uptodate, we may need to start io on it
  344. */
  345. if (!PageUptodate(page)) {
  346. lock_page(page);
  347. /*
  348. * Page was truncated, or invalidated by the
  349. * filesystem. Redo the find/create, but this time the
  350. * page is kept locked, so there's no chance of another
  351. * race with truncate/invalidate.
  352. */
  353. if (!page->mapping) {
  354. unlock_page(page);
  355. page = find_or_create_page(mapping, index,
  356. mapping_gfp_mask(mapping));
  357. if (!page) {
  358. error = -ENOMEM;
  359. break;
  360. }
  361. page_cache_release(spd.pages[page_nr]);
  362. spd.pages[page_nr] = page;
  363. }
  364. /*
  365. * page was already under io and is now done, great
  366. */
  367. if (PageUptodate(page)) {
  368. unlock_page(page);
  369. goto fill_it;
  370. }
  371. /*
  372. * need to read in the page
  373. */
  374. error = mapping->a_ops->readpage(in, page);
  375. if (unlikely(error)) {
  376. /*
  377. * We really should re-lookup the page here,
  378. * but it complicates things a lot. Instead
  379. * lets just do what we already stored, and
  380. * we'll get it the next time we are called.
  381. */
  382. if (error == AOP_TRUNCATED_PAGE)
  383. error = 0;
  384. break;
  385. }
  386. }
  387. fill_it:
  388. /*
  389. * i_size must be checked after PageUptodate.
  390. */
  391. isize = i_size_read(mapping->host);
  392. end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
  393. if (unlikely(!isize || index > end_index))
  394. break;
  395. /*
  396. * if this is the last page, see if we need to shrink
  397. * the length and stop
  398. */
  399. if (end_index == index) {
  400. unsigned int plen;
  401. /*
  402. * max good bytes in this page
  403. */
  404. plen = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
  405. if (plen <= loff)
  406. break;
  407. /*
  408. * force quit after adding this page
  409. */
  410. this_len = min(this_len, plen - loff);
  411. len = this_len;
  412. }
  413. spd.partial[page_nr].offset = loff;
  414. spd.partial[page_nr].len = this_len;
  415. len -= this_len;
  416. loff = 0;
  417. spd.nr_pages++;
  418. index++;
  419. }
  420. /*
  421. * Release any pages at the end, if we quit early. 'page_nr' is how far
  422. * we got, 'nr_pages' is how many pages are in the map.
  423. */
  424. while (page_nr < nr_pages)
  425. page_cache_release(spd.pages[page_nr++]);
  426. in->f_ra.prev_pos = (loff_t)index << PAGE_CACHE_SHIFT;
  427. if (spd.nr_pages)
  428. error = splice_to_pipe(pipe, &spd);
  429. splice_shrink_spd(pipe, &spd);
  430. return error;
  431. }
  432. /**
  433. * generic_file_splice_read - splice data from file to a pipe
  434. * @in: file to splice from
  435. * @ppos: position in @in
  436. * @pipe: pipe to splice to
  437. * @len: number of bytes to splice
  438. * @flags: splice modifier flags
  439. *
  440. * Description:
  441. * Will read pages from given file and fill them into a pipe. Can be
  442. * used as long as the address_space operations for the source implements
  443. * a readpage() hook.
  444. *
  445. */
  446. ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,
  447. struct pipe_inode_info *pipe, size_t len,
  448. unsigned int flags)
  449. {
  450. loff_t isize, left;
  451. int ret;
  452. isize = i_size_read(in->f_mapping->host);
  453. if (unlikely(*ppos >= isize))
  454. return 0;
  455. left = isize - *ppos;
  456. if (unlikely(left < len))
  457. len = left;
  458. ret = __generic_file_splice_read(in, ppos, pipe, len, flags);
  459. if (ret > 0) {
  460. *ppos += ret;
  461. file_accessed(in);
  462. }
  463. return ret;
  464. }
  465. EXPORT_SYMBOL(generic_file_splice_read);
  466. static const struct pipe_buf_operations default_pipe_buf_ops = {
  467. .can_merge = 0,
  468. .map = generic_pipe_buf_map,
  469. .unmap = generic_pipe_buf_unmap,
  470. .confirm = generic_pipe_buf_confirm,
  471. .release = generic_pipe_buf_release,
  472. .steal = generic_pipe_buf_steal,
  473. .get = generic_pipe_buf_get,
  474. };
  475. static ssize_t kernel_readv(struct file *file, const struct iovec *vec,
  476. unsigned long vlen, loff_t offset)
  477. {
  478. mm_segment_t old_fs;
  479. loff_t pos = offset;
  480. ssize_t res;
  481. old_fs = get_fs();
  482. set_fs(get_ds());
  483. /* The cast to a user pointer is valid due to the set_fs() */
  484. res = vfs_readv(file, (const struct iovec __user *)vec, vlen, &pos);
  485. set_fs(old_fs);
  486. return res;
  487. }
  488. static ssize_t kernel_write(struct file *file, const char *buf, size_t count,
  489. loff_t pos)
  490. {
  491. mm_segment_t old_fs;
  492. ssize_t res;
  493. old_fs = get_fs();
  494. set_fs(get_ds());
  495. /* The cast to a user pointer is valid due to the set_fs() */
  496. res = vfs_write(file, (const char __user *)buf, count, &pos);
  497. set_fs(old_fs);
  498. return res;
  499. }
  500. ssize_t default_file_splice_read(struct file *in, loff_t *ppos,
  501. struct pipe_inode_info *pipe, size_t len,
  502. unsigned int flags)
  503. {
  504. unsigned int nr_pages;
  505. unsigned int nr_freed;
  506. size_t offset;
  507. struct page *pages[PIPE_DEF_BUFFERS];
  508. struct partial_page partial[PIPE_DEF_BUFFERS];
  509. struct iovec *vec, __vec[PIPE_DEF_BUFFERS];
  510. ssize_t res;
  511. size_t this_len;
  512. int error;
  513. int i;
  514. struct splice_pipe_desc spd = {
  515. .pages = pages,
  516. .partial = partial,
  517. .flags = flags,
  518. .ops = &default_pipe_buf_ops,
  519. .spd_release = spd_release_page,
  520. };
  521. if (splice_grow_spd(pipe, &spd))
  522. return -ENOMEM;
  523. res = -ENOMEM;
  524. vec = __vec;
  525. if (pipe->buffers > PIPE_DEF_BUFFERS) {
  526. vec = kmalloc(pipe->buffers * sizeof(struct iovec), GFP_KERNEL);
  527. if (!vec)
  528. goto shrink_ret;
  529. }
  530. offset = *ppos & ~PAGE_CACHE_MASK;
  531. nr_pages = (len + offset + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
  532. for (i = 0; i < nr_pages && i < pipe->buffers && len; i++) {
  533. struct page *page;
  534. page = alloc_page(GFP_USER);
  535. error = -ENOMEM;
  536. if (!page)
  537. goto err;
  538. this_len = min_t(size_t, len, PAGE_CACHE_SIZE - offset);
  539. vec[i].iov_base = (void __user *) page_address(page);
  540. vec[i].iov_len = this_len;
  541. spd.pages[i] = page;
  542. spd.nr_pages++;
  543. len -= this_len;
  544. offset = 0;
  545. }
  546. res = kernel_readv(in, vec, spd.nr_pages, *ppos);
  547. if (res < 0) {
  548. error = res;
  549. goto err;
  550. }
  551. error = 0;
  552. if (!res)
  553. goto err;
  554. nr_freed = 0;
  555. for (i = 0; i < spd.nr_pages; i++) {
  556. this_len = min_t(size_t, vec[i].iov_len, res);
  557. spd.partial[i].offset = 0;
  558. spd.partial[i].len = this_len;
  559. if (!this_len) {
  560. __free_page(spd.pages[i]);
  561. spd.pages[i] = NULL;
  562. nr_freed++;
  563. }
  564. res -= this_len;
  565. }
  566. spd.nr_pages -= nr_freed;
  567. res = splice_to_pipe(pipe, &spd);
  568. if (res > 0)
  569. *ppos += res;
  570. shrink_ret:
  571. if (vec != __vec)
  572. kfree(vec);
  573. splice_shrink_spd(pipe, &spd);
  574. return res;
  575. err:
  576. for (i = 0; i < spd.nr_pages; i++)
  577. __free_page(spd.pages[i]);
  578. res = error;
  579. goto shrink_ret;
  580. }
  581. EXPORT_SYMBOL(default_file_splice_read);
  582. /*
  583. * Send 'sd->len' bytes to socket from 'sd->file' at position 'sd->pos'
  584. * using sendpage(). Return the number of bytes sent.
  585. */
  586. static int pipe_to_sendpage(struct pipe_inode_info *pipe,
  587. struct pipe_buffer *buf, struct splice_desc *sd)
  588. {
  589. struct file *file = sd->u.file;
  590. loff_t pos = sd->pos;
  591. int more;
  592. if (!likely(file->f_op && file->f_op->sendpage))
  593. return -EINVAL;
  594. more = (sd->flags & SPLICE_F_MORE) || sd->len < sd->total_len;
  595. return file->f_op->sendpage(file, buf->page, buf->offset,
  596. sd->len, &pos, more);
  597. }
  598. /*
  599. * This is a little more tricky than the file -> pipe splicing. There are
  600. * basically three cases:
  601. *
  602. * - Destination page already exists in the address space and there
  603. * are users of it. For that case we have no other option that
  604. * copying the data. Tough luck.
  605. * - Destination page already exists in the address space, but there
  606. * are no users of it. Make sure it's uptodate, then drop it. Fall
  607. * through to last case.
  608. * - Destination page does not exist, we can add the pipe page to
  609. * the page cache and avoid the copy.
  610. *
  611. * If asked to move pages to the output file (SPLICE_F_MOVE is set in
  612. * sd->flags), we attempt to migrate pages from the pipe to the output
  613. * file address space page cache. This is possible if no one else has
  614. * the pipe page referenced outside of the pipe and page cache. If
  615. * SPLICE_F_MOVE isn't set, or we cannot move the page, we simply create
  616. * a new page in the output file page cache and fill/dirty that.
  617. */
  618. int pipe_to_file(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
  619. struct splice_desc *sd)
  620. {
  621. struct file *file = sd->u.file;
  622. struct address_space *mapping = file->f_mapping;
  623. unsigned int offset, this_len;
  624. struct page *page;
  625. void *fsdata;
  626. int ret;
  627. offset = sd->pos & ~PAGE_CACHE_MASK;
  628. this_len = sd->len;
  629. if (this_len + offset > PAGE_CACHE_SIZE)
  630. this_len = PAGE_CACHE_SIZE - offset;
  631. ret = pagecache_write_begin(file, mapping, sd->pos, this_len,
  632. AOP_FLAG_UNINTERRUPTIBLE, &page, &fsdata);
  633. if (unlikely(ret))
  634. goto out;
  635. if (buf->page != page) {
  636. /*
  637. * Careful, ->map() uses KM_USER0!
  638. */
  639. char *src = buf->ops->map(pipe, buf, 1);
  640. char *dst = kmap_atomic(page, KM_USER1);
  641. memcpy(dst + offset, src + buf->offset, this_len);
  642. flush_dcache_page(page);
  643. kunmap_atomic(dst, KM_USER1);
  644. buf->ops->unmap(pipe, buf, src);
  645. }
  646. ret = pagecache_write_end(file, mapping, sd->pos, this_len, this_len,
  647. page, fsdata);
  648. out:
  649. return ret;
  650. }
  651. EXPORT_SYMBOL(pipe_to_file);
  652. static void wakeup_pipe_writers(struct pipe_inode_info *pipe)
  653. {
  654. smp_mb();
  655. if (waitqueue_active(&pipe->wait))
  656. wake_up_interruptible(&pipe->wait);
  657. kill_fasync(&pipe->fasync_writers, SIGIO, POLL_OUT);
  658. }
  659. /**
  660. * splice_from_pipe_feed - feed available data from a pipe to a file
  661. * @pipe: pipe to splice from
  662. * @sd: information to @actor
  663. * @actor: handler that splices the data
  664. *
  665. * Description:
  666. * This function loops over the pipe and calls @actor to do the
  667. * actual moving of a single struct pipe_buffer to the desired
  668. * destination. It returns when there's no more buffers left in
  669. * the pipe or if the requested number of bytes (@sd->total_len)
  670. * have been copied. It returns a positive number (one) if the
  671. * pipe needs to be filled with more data, zero if the required
  672. * number of bytes have been copied and -errno on error.
  673. *
  674. * This, together with splice_from_pipe_{begin,end,next}, may be
  675. * used to implement the functionality of __splice_from_pipe() when
  676. * locking is required around copying the pipe buffers to the
  677. * destination.
  678. */
  679. int splice_from_pipe_feed(struct pipe_inode_info *pipe, struct splice_desc *sd,
  680. splice_actor *actor)
  681. {
  682. int ret;
  683. while (pipe->nrbufs) {
  684. struct pipe_buffer *buf = pipe->bufs + pipe->curbuf;
  685. const struct pipe_buf_operations *ops = buf->ops;
  686. sd->len = buf->len;
  687. if (sd->len > sd->total_len)
  688. sd->len = sd->total_len;
  689. ret = buf->ops->confirm(pipe, buf);
  690. if (unlikely(ret)) {
  691. if (ret == -ENODATA)
  692. ret = 0;
  693. return ret;
  694. }
  695. ret = actor(pipe, buf, sd);
  696. if (ret <= 0)
  697. return ret;
  698. buf->offset += ret;
  699. buf->len -= ret;
  700. sd->num_spliced += ret;
  701. sd->len -= ret;
  702. sd->pos += ret;
  703. sd->total_len -= ret;
  704. if (!buf->len) {
  705. buf->ops = NULL;
  706. ops->release(pipe, buf);
  707. pipe->curbuf = (pipe->curbuf + 1) & (pipe->buffers - 1);
  708. pipe->nrbufs--;
  709. if (pipe->inode)
  710. sd->need_wakeup = true;
  711. }
  712. if (!sd->total_len)
  713. return 0;
  714. }
  715. return 1;
  716. }
  717. EXPORT_SYMBOL(splice_from_pipe_feed);
  718. /**
  719. * splice_from_pipe_next - wait for some data to splice from
  720. * @pipe: pipe to splice from
  721. * @sd: information about the splice operation
  722. *
  723. * Description:
  724. * This function will wait for some data and return a positive
  725. * value (one) if pipe buffers are available. It will return zero
  726. * or -errno if no more data needs to be spliced.
  727. */
  728. int splice_from_pipe_next(struct pipe_inode_info *pipe, struct splice_desc *sd)
  729. {
  730. while (!pipe->nrbufs) {
  731. if (!pipe->writers)
  732. return 0;
  733. if (!pipe->waiting_writers && sd->num_spliced)
  734. return 0;
  735. if (sd->flags & SPLICE_F_NONBLOCK)
  736. return -EAGAIN;
  737. if (signal_pending(current))
  738. return -ERESTARTSYS;
  739. if (sd->need_wakeup) {
  740. wakeup_pipe_writers(pipe);
  741. sd->need_wakeup = false;
  742. }
  743. pipe_wait(pipe);
  744. }
  745. return 1;
  746. }
  747. EXPORT_SYMBOL(splice_from_pipe_next);
  748. /**
  749. * splice_from_pipe_begin - start splicing from pipe
  750. * @sd: information about the splice operation
  751. *
  752. * Description:
  753. * This function should be called before a loop containing
  754. * splice_from_pipe_next() and splice_from_pipe_feed() to
  755. * initialize the necessary fields of @sd.
  756. */
  757. void splice_from_pipe_begin(struct splice_desc *sd)
  758. {
  759. sd->num_spliced = 0;
  760. sd->need_wakeup = false;
  761. }
  762. EXPORT_SYMBOL(splice_from_pipe_begin);
  763. /**
  764. * splice_from_pipe_end - finish splicing from pipe
  765. * @pipe: pipe to splice from
  766. * @sd: information about the splice operation
  767. *
  768. * Description:
  769. * This function will wake up pipe writers if necessary. It should
  770. * be called after a loop containing splice_from_pipe_next() and
  771. * splice_from_pipe_feed().
  772. */
  773. void splice_from_pipe_end(struct pipe_inode_info *pipe, struct splice_desc *sd)
  774. {
  775. if (sd->need_wakeup)
  776. wakeup_pipe_writers(pipe);
  777. }
  778. EXPORT_SYMBOL(splice_from_pipe_end);
  779. /**
  780. * __splice_from_pipe - splice data from a pipe to given actor
  781. * @pipe: pipe to splice from
  782. * @sd: information to @actor
  783. * @actor: handler that splices the data
  784. *
  785. * Description:
  786. * This function does little more than loop over the pipe and call
  787. * @actor to do the actual moving of a single struct pipe_buffer to
  788. * the desired destination. See pipe_to_file, pipe_to_sendpage, or
  789. * pipe_to_user.
  790. *
  791. */
  792. ssize_t __splice_from_pipe(struct pipe_inode_info *pipe, struct splice_desc *sd,
  793. splice_actor *actor)
  794. {
  795. int ret;
  796. splice_from_pipe_begin(sd);
  797. do {
  798. ret = splice_from_pipe_next(pipe, sd);
  799. if (ret > 0)
  800. ret = splice_from_pipe_feed(pipe, sd, actor);
  801. } while (ret > 0);
  802. splice_from_pipe_end(pipe, sd);
  803. return sd->num_spliced ? sd->num_spliced : ret;
  804. }
  805. EXPORT_SYMBOL(__splice_from_pipe);
  806. /**
  807. * splice_from_pipe - splice data from a pipe to a file
  808. * @pipe: pipe to splice from
  809. * @out: file to splice to
  810. * @ppos: position in @out
  811. * @len: how many bytes to splice
  812. * @flags: splice modifier flags
  813. * @actor: handler that splices the data
  814. *
  815. * Description:
  816. * See __splice_from_pipe. This function locks the pipe inode,
  817. * otherwise it's identical to __splice_from_pipe().
  818. *
  819. */
  820. ssize_t splice_from_pipe(struct pipe_inode_info *pipe, struct file *out,
  821. loff_t *ppos, size_t len, unsigned int flags,
  822. splice_actor *actor)
  823. {
  824. ssize_t ret;
  825. struct splice_desc sd = {
  826. .total_len = len,
  827. .flags = flags,
  828. .pos = *ppos,
  829. .u.file = out,
  830. };
  831. pipe_lock(pipe);
  832. ret = __splice_from_pipe(pipe, &sd, actor);
  833. pipe_unlock(pipe);
  834. return ret;
  835. }
  836. /**
  837. * generic_file_splice_write - splice data from a pipe to a file
  838. * @pipe: pipe info
  839. * @out: file to write to
  840. * @ppos: position in @out
  841. * @len: number of bytes to splice
  842. * @flags: splice modifier flags
  843. *
  844. * Description:
  845. * Will either move or copy pages (determined by @flags options) from
  846. * the given pipe inode to the given file.
  847. *
  848. */
  849. ssize_t
  850. generic_file_splice_write(struct pipe_inode_info *pipe, struct file *out,
  851. loff_t *ppos, size_t len, unsigned int flags)
  852. {
  853. struct address_space *mapping = out->f_mapping;
  854. struct inode *inode = mapping->host;
  855. struct splice_desc sd = {
  856. .total_len = len,
  857. .flags = flags,
  858. .pos = *ppos,
  859. .u.file = out,
  860. };
  861. ssize_t ret;
  862. pipe_lock(pipe);
  863. splice_from_pipe_begin(&sd);
  864. do {
  865. ret = splice_from_pipe_next(pipe, &sd);
  866. if (ret <= 0)
  867. break;
  868. mutex_lock_nested(&inode->i_mutex, I_MUTEX_CHILD);
  869. ret = file_remove_suid(out);
  870. if (!ret) {
  871. file_update_time(out);
  872. ret = splice_from_pipe_feed(pipe, &sd, pipe_to_file);
  873. }
  874. mutex_unlock(&inode->i_mutex);
  875. } while (ret > 0);
  876. splice_from_pipe_end(pipe, &sd);
  877. pipe_unlock(pipe);
  878. if (sd.num_spliced)
  879. ret = sd.num_spliced;
  880. if (ret > 0) {
  881. unsigned long nr_pages;
  882. int err;
  883. nr_pages = (ret + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
  884. err = generic_write_sync(out, *ppos, ret);
  885. if (err)
  886. ret = err;
  887. else
  888. *ppos += ret;
  889. balance_dirty_pages_ratelimited_nr(mapping, nr_pages);
  890. }
  891. return ret;
  892. }
  893. EXPORT_SYMBOL(generic_file_splice_write);
  894. static int write_pipe_buf(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
  895. struct splice_desc *sd)
  896. {
  897. int ret;
  898. void *data;
  899. data = buf->ops->map(pipe, buf, 0);
  900. ret = kernel_write(sd->u.file, data + buf->offset, sd->len, sd->pos);
  901. buf->ops->unmap(pipe, buf, data);
  902. return ret;
  903. }
  904. static ssize_t default_file_splice_write(struct pipe_inode_info *pipe,
  905. struct file *out, loff_t *ppos,
  906. size_t len, unsigned int flags)
  907. {
  908. ssize_t ret;
  909. ret = splice_from_pipe(pipe, out, ppos, len, flags, write_pipe_buf);
  910. if (ret > 0)
  911. *ppos += ret;
  912. return ret;
  913. }
  914. /**
  915. * generic_splice_sendpage - splice data from a pipe to a socket
  916. * @pipe: pipe to splice from
  917. * @out: socket to write to
  918. * @ppos: position in @out
  919. * @len: number of bytes to splice
  920. * @flags: splice modifier flags
  921. *
  922. * Description:
  923. * Will send @len bytes from the pipe to a network socket. No data copying
  924. * is involved.
  925. *
  926. */
  927. ssize_t generic_splice_sendpage(struct pipe_inode_info *pipe, struct file *out,
  928. loff_t *ppos, size_t len, unsigned int flags)
  929. {
  930. return splice_from_pipe(pipe, out, ppos, len, flags, pipe_to_sendpage);
  931. }
  932. EXPORT_SYMBOL(generic_splice_sendpage);
  933. /*
  934. * Attempt to initiate a splice from pipe to file.
  935. */
  936. static long do_splice_from(struct pipe_inode_info *pipe, struct file *out,
  937. loff_t *ppos, size_t len, unsigned int flags)
  938. {
  939. ssize_t (*splice_write)(struct pipe_inode_info *, struct file *,
  940. loff_t *, size_t, unsigned int);
  941. int ret;
  942. if (unlikely(!(out->f_mode & FMODE_WRITE)))
  943. return -EBADF;
  944. if (unlikely(out->f_flags & O_APPEND))
  945. return -EINVAL;
  946. ret = rw_verify_area(WRITE, out, ppos, len);
  947. if (unlikely(ret < 0))
  948. return ret;
  949. if (out->f_op && out->f_op->splice_write)
  950. splice_write = out->f_op->splice_write;
  951. else
  952. splice_write = default_file_splice_write;
  953. return splice_write(pipe, out, ppos, len, flags);
  954. }
  955. /*
  956. * Attempt to initiate a splice from a file to a pipe.
  957. */
  958. static long do_splice_to(struct file *in, loff_t *ppos,
  959. struct pipe_inode_info *pipe, size_t len,
  960. unsigned int flags)
  961. {
  962. ssize_t (*splice_read)(struct file *, loff_t *,
  963. struct pipe_inode_info *, size_t, unsigned int);
  964. int ret;
  965. if (unlikely(!(in->f_mode & FMODE_READ)))
  966. return -EBADF;
  967. ret = rw_verify_area(READ, in, ppos, len);
  968. if (unlikely(ret < 0))
  969. return ret;
  970. if (in->f_op && in->f_op->splice_read)
  971. splice_read = in->f_op->splice_read;
  972. else
  973. splice_read = default_file_splice_read;
  974. return splice_read(in, ppos, pipe, len, flags);
  975. }
  976. /**
  977. * splice_direct_to_actor - splices data directly between two non-pipes
  978. * @in: file to splice from
  979. * @sd: actor information on where to splice to
  980. * @actor: handles the data splicing
  981. *
  982. * Description:
  983. * This is a special case helper to splice directly between two
  984. * points, without requiring an explicit pipe. Internally an allocated
  985. * pipe is cached in the process, and reused during the lifetime of
  986. * that process.
  987. *
  988. */
  989. ssize_t splice_direct_to_actor(struct file *in, struct splice_desc *sd,
  990. splice_direct_actor *actor)
  991. {
  992. struct pipe_inode_info *pipe;
  993. long ret, bytes;
  994. umode_t i_mode;
  995. size_t len;
  996. int i, flags;
  997. /*
  998. * We require the input being a regular file, as we don't want to
  999. * randomly drop data for eg socket -> socket splicing. Use the
  1000. * piped splicing for that!
  1001. */
  1002. i_mode = in->f_path.dentry->d_inode->i_mode;
  1003. if (unlikely(!S_ISREG(i_mode) && !S_ISBLK(i_mode)))
  1004. return -EINVAL;
  1005. /*
  1006. * neither in nor out is a pipe, setup an internal pipe attached to
  1007. * 'out' and transfer the wanted data from 'in' to 'out' through that
  1008. */
  1009. pipe = current->splice_pipe;
  1010. if (unlikely(!pipe)) {
  1011. pipe = alloc_pipe_info(NULL);
  1012. if (!pipe)
  1013. return -ENOMEM;
  1014. /*
  1015. * We don't have an immediate reader, but we'll read the stuff
  1016. * out of the pipe right after the splice_to_pipe(). So set
  1017. * PIPE_READERS appropriately.
  1018. */
  1019. pipe->readers = 1;
  1020. current->splice_pipe = pipe;
  1021. }
  1022. /*
  1023. * Do the splice.
  1024. */
  1025. ret = 0;
  1026. bytes = 0;
  1027. len = sd->total_len;
  1028. flags = sd->flags;
  1029. /*
  1030. * Don't block on output, we have to drain the direct pipe.
  1031. */
  1032. sd->flags &= ~SPLICE_F_NONBLOCK;
  1033. while (len) {
  1034. size_t read_len;
  1035. loff_t pos = sd->pos, prev_pos = pos;
  1036. ret = do_splice_to(in, &pos, pipe, len, flags);
  1037. if (unlikely(ret <= 0))
  1038. goto out_release;
  1039. read_len = ret;
  1040. sd->total_len = read_len;
  1041. /*
  1042. * NOTE: nonblocking mode only applies to the input. We
  1043. * must not do the output in nonblocking mode as then we
  1044. * could get stuck data in the internal pipe:
  1045. */
  1046. ret = actor(pipe, sd);
  1047. if (unlikely(ret <= 0)) {
  1048. sd->pos = prev_pos;
  1049. goto out_release;
  1050. }
  1051. bytes += ret;
  1052. len -= ret;
  1053. sd->pos = pos;
  1054. if (ret < read_len) {
  1055. sd->pos = prev_pos + ret;
  1056. goto out_release;
  1057. }
  1058. }
  1059. done:
  1060. pipe->nrbufs = pipe->curbuf = 0;
  1061. file_accessed(in);
  1062. return bytes;
  1063. out_release:
  1064. /*
  1065. * If we did an incomplete transfer we must release
  1066. * the pipe buffers in question:
  1067. */
  1068. for (i = 0; i < pipe->buffers; i++) {
  1069. struct pipe_buffer *buf = pipe->bufs + i;
  1070. if (buf->ops) {
  1071. buf->ops->release(pipe, buf);
  1072. buf->ops = NULL;
  1073. }
  1074. }
  1075. if (!bytes)
  1076. bytes = ret;
  1077. goto done;
  1078. }
  1079. EXPORT_SYMBOL(splice_direct_to_actor);
  1080. static int direct_splice_actor(struct pipe_inode_info *pipe,
  1081. struct splice_desc *sd)
  1082. {
  1083. struct file *file = sd->u.file;
  1084. return do_splice_from(pipe, file, &file->f_pos, sd->total_len,
  1085. sd->flags);
  1086. }
  1087. /**
  1088. * do_splice_direct - splices data directly between two files
  1089. * @in: file to splice from
  1090. * @ppos: input file offset
  1091. * @out: file to splice to
  1092. * @len: number of bytes to splice
  1093. * @flags: splice modifier flags
  1094. *
  1095. * Description:
  1096. * For use by do_sendfile(). splice can easily emulate sendfile, but
  1097. * doing it in the application would incur an extra system call
  1098. * (splice in + splice out, as compared to just sendfile()). So this helper
  1099. * can splice directly through a process-private pipe.
  1100. *
  1101. */
  1102. long do_splice_direct(struct file *in, loff_t *ppos, struct file *out,
  1103. size_t len, unsigned int flags)
  1104. {
  1105. struct splice_desc sd = {
  1106. .len = len,
  1107. .total_len = len,
  1108. .flags = flags,
  1109. .pos = *ppos,
  1110. .u.file = out,
  1111. };
  1112. long ret;
  1113. ret = splice_direct_to_actor(in, &sd, direct_splice_actor);
  1114. if (ret > 0)
  1115. *ppos = sd.pos;
  1116. return ret;
  1117. }
  1118. static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
  1119. struct pipe_inode_info *opipe,
  1120. size_t len, unsigned int flags);
  1121. /*
  1122. * Determine where to splice to/from.
  1123. */
  1124. static long do_splice(struct file *in, loff_t __user *off_in,
  1125. struct file *out, loff_t __user *off_out,
  1126. size_t len, unsigned int flags)
  1127. {
  1128. struct pipe_inode_info *ipipe;
  1129. struct pipe_inode_info *opipe;
  1130. loff_t offset, *off;
  1131. long ret;
  1132. ipipe = get_pipe_info(in);
  1133. opipe = get_pipe_info(out);
  1134. if (ipipe && opipe) {
  1135. if (off_in || off_out)
  1136. return -ESPIPE;
  1137. if (!(in->f_mode & FMODE_READ))
  1138. return -EBADF;
  1139. if (!(out->f_mode & FMODE_WRITE))
  1140. return -EBADF;
  1141. /* Splicing to self would be fun, but... */
  1142. if (ipipe == opipe)
  1143. return -EINVAL;
  1144. return splice_pipe_to_pipe(ipipe, opipe, len, flags);
  1145. }
  1146. if (ipipe) {
  1147. if (off_in)
  1148. return -ESPIPE;
  1149. if (off_out) {
  1150. if (!(out->f_mode & FMODE_PWRITE))
  1151. return -EINVAL;
  1152. if (copy_from_user(&offset, off_out, sizeof(loff_t)))
  1153. return -EFAULT;
  1154. off = &offset;
  1155. } else
  1156. off = &out->f_pos;
  1157. ret = do_splice_from(ipipe, out, off, len, flags);
  1158. if (off_out && copy_to_user(off_out, off, sizeof(loff_t)))
  1159. ret = -EFAULT;
  1160. return ret;
  1161. }
  1162. if (opipe) {
  1163. if (off_out)
  1164. return -ESPIPE;
  1165. if (off_in) {
  1166. if (!(in->f_mode & FMODE_PREAD))
  1167. return -EINVAL;
  1168. if (copy_from_user(&offset, off_in, sizeof(loff_t)))
  1169. return -EFAULT;
  1170. off = &offset;
  1171. } else
  1172. off = &in->f_pos;
  1173. ret = do_splice_to(in, off, opipe, len, flags);
  1174. if (off_in && copy_to_user(off_in, off, sizeof(loff_t)))
  1175. ret = -EFAULT;
  1176. return ret;
  1177. }
  1178. return -EINVAL;
  1179. }
  1180. /*
  1181. * Map an iov into an array of pages and offset/length tupples. With the
  1182. * partial_page structure, we can map several non-contiguous ranges into
  1183. * our ones pages[] map instead of splitting that operation into pieces.
  1184. * Could easily be exported as a generic helper for other users, in which
  1185. * case one would probably want to add a 'max_nr_pages' parameter as well.
  1186. */
  1187. static int get_iovec_page_array(const struct iovec __user *iov,
  1188. unsigned int nr_vecs, struct page **pages,
  1189. struct partial_page *partial, int aligned,
  1190. unsigned int pipe_buffers)
  1191. {
  1192. int buffers = 0, error = 0;
  1193. while (nr_vecs) {
  1194. unsigned long off, npages;
  1195. struct iovec entry;
  1196. void __user *base;
  1197. size_t len;
  1198. int i;
  1199. error = -EFAULT;
  1200. if (copy_from_user(&entry, iov, sizeof(entry)))
  1201. break;
  1202. base = entry.iov_base;
  1203. len = entry.iov_len;
  1204. /*
  1205. * Sanity check this iovec. 0 read succeeds.
  1206. */
  1207. error = 0;
  1208. if (unlikely(!len))
  1209. break;
  1210. error = -EFAULT;
  1211. if (!access_ok(VERIFY_READ, base, len))
  1212. break;
  1213. /*
  1214. * Get this base offset and number of pages, then map
  1215. * in the user pages.
  1216. */
  1217. off = (unsigned long) base & ~PAGE_MASK;
  1218. /*
  1219. * If asked for alignment, the offset must be zero and the
  1220. * length a multiple of the PAGE_SIZE.
  1221. */
  1222. error = -EINVAL;
  1223. if (aligned && (off || len & ~PAGE_MASK))
  1224. break;
  1225. npages = (off + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
  1226. if (npages > pipe_buffers - buffers)
  1227. npages = pipe_buffers - buffers;
  1228. error = get_user_pages_fast((unsigned long)base, npages,
  1229. 0, &pages[buffers]);
  1230. if (unlikely(error <= 0))
  1231. break;
  1232. /*
  1233. * Fill this contiguous range into the partial page map.
  1234. */
  1235. for (i = 0; i < error; i++) {
  1236. const int plen = min_t(size_t, len, PAGE_SIZE - off);
  1237. partial[buffers].offset = off;
  1238. partial[buffers].len = plen;
  1239. off = 0;
  1240. len -= plen;
  1241. buffers++;
  1242. }
  1243. /*
  1244. * We didn't complete this iov, stop here since it probably
  1245. * means we have to move some of this into a pipe to
  1246. * be able to continue.
  1247. */
  1248. if (len)
  1249. break;
  1250. /*
  1251. * Don't continue if we mapped fewer pages than we asked for,
  1252. * or if we mapped the max number of pages that we have
  1253. * room for.
  1254. */
  1255. if (error < npages || buffers == pipe_buffers)
  1256. break;
  1257. nr_vecs--;
  1258. iov++;
  1259. }
  1260. if (buffers)
  1261. return buffers;
  1262. return error;
  1263. }
  1264. static int pipe_to_user(struct pipe_inode_info *pipe, struct pipe_buffer *buf,
  1265. struct splice_desc *sd)
  1266. {
  1267. char *src;
  1268. int ret;
  1269. /*
  1270. * See if we can use the atomic maps, by prefaulting in the
  1271. * pages and doing an atomic copy
  1272. */
  1273. if (!fault_in_pages_writeable(sd->u.userptr, sd->len)) {
  1274. src = buf->ops->map(pipe, buf, 1);
  1275. ret = __copy_to_user_inatomic(sd->u.userptr, src + buf->offset,
  1276. sd->len);
  1277. buf->ops->unmap(pipe, buf, src);
  1278. if (!ret) {
  1279. ret = sd->len;
  1280. goto out;
  1281. }
  1282. }
  1283. /*
  1284. * No dice, use slow non-atomic map and copy
  1285. */
  1286. src = buf->ops->map(pipe, buf, 0);
  1287. ret = sd->len;
  1288. if (copy_to_user(sd->u.userptr, src + buf->offset, sd->len))
  1289. ret = -EFAULT;
  1290. buf->ops->unmap(pipe, buf, src);
  1291. out:
  1292. if (ret > 0)
  1293. sd->u.userptr += ret;
  1294. return ret;
  1295. }
  1296. /*
  1297. * For lack of a better implementation, implement vmsplice() to userspace
  1298. * as a simple copy of the pipes pages to the user iov.
  1299. */
  1300. static long vmsplice_to_user(struct file *file, const struct iovec __user *iov,
  1301. unsigned long nr_segs, unsigned int flags)
  1302. {
  1303. struct pipe_inode_info *pipe;
  1304. struct splice_desc sd;
  1305. ssize_t size;
  1306. int error;
  1307. long ret;
  1308. pipe = get_pipe_info(file);
  1309. if (!pipe)
  1310. return -EBADF;
  1311. pipe_lock(pipe);
  1312. error = ret = 0;
  1313. while (nr_segs) {
  1314. void __user *base;
  1315. size_t len;
  1316. /*
  1317. * Get user address base and length for this iovec.
  1318. */
  1319. error = get_user(base, &iov->iov_base);
  1320. if (unlikely(error))
  1321. break;
  1322. error = get_user(len, &iov->iov_len);
  1323. if (unlikely(error))
  1324. break;
  1325. /*
  1326. * Sanity check this iovec. 0 read succeeds.
  1327. */
  1328. if (unlikely(!len))
  1329. break;
  1330. if (unlikely(!base)) {
  1331. error = -EFAULT;
  1332. break;
  1333. }
  1334. if (unlikely(!access_ok(VERIFY_WRITE, base, len))) {
  1335. error = -EFAULT;
  1336. break;
  1337. }
  1338. sd.len = 0;
  1339. sd.total_len = len;
  1340. sd.flags = flags;
  1341. sd.u.userptr = base;
  1342. sd.pos = 0;
  1343. size = __splice_from_pipe(pipe, &sd, pipe_to_user);
  1344. if (size < 0) {
  1345. if (!ret)
  1346. ret = size;
  1347. break;
  1348. }
  1349. ret += size;
  1350. if (size < len)
  1351. break;
  1352. nr_segs--;
  1353. iov++;
  1354. }
  1355. pipe_unlock(pipe);
  1356. if (!ret)
  1357. ret = error;
  1358. return ret;
  1359. }
  1360. /*
  1361. * vmsplice splices a user address range into a pipe. It can be thought of
  1362. * as splice-from-memory, where the regular splice is splice-from-file (or
  1363. * to file). In both cases the output is a pipe, naturally.
  1364. */
  1365. static long vmsplice_to_pipe(struct file *file, const struct iovec __user *iov,
  1366. unsigned long nr_segs, unsigned int flags)
  1367. {
  1368. struct pipe_inode_info *pipe;
  1369. struct page *pages[PIPE_DEF_BUFFERS];
  1370. struct partial_page partial[PIPE_DEF_BUFFERS];
  1371. struct splice_pipe_desc spd = {
  1372. .pages = pages,
  1373. .partial = partial,
  1374. .flags = flags,
  1375. .ops = &user_page_pipe_buf_ops,
  1376. .spd_release = spd_release_page,
  1377. };
  1378. long ret;
  1379. pipe = get_pipe_info(file);
  1380. if (!pipe)
  1381. return -EBADF;
  1382. if (splice_grow_spd(pipe, &spd))
  1383. return -ENOMEM;
  1384. spd.nr_pages = get_iovec_page_array(iov, nr_segs, spd.pages,
  1385. spd.partial, flags & SPLICE_F_GIFT,
  1386. pipe->buffers);
  1387. if (spd.nr_pages <= 0)
  1388. ret = spd.nr_pages;
  1389. else
  1390. ret = splice_to_pipe(pipe, &spd);
  1391. splice_shrink_spd(pipe, &spd);
  1392. return ret;
  1393. }
  1394. /*
  1395. * Note that vmsplice only really supports true splicing _from_ user memory
  1396. * to a pipe, not the other way around. Splicing from user memory is a simple
  1397. * operation that can be supported without any funky alignment restrictions
  1398. * or nasty vm tricks. We simply map in the user memory and fill them into
  1399. * a pipe. The reverse isn't quite as easy, though. There are two possible
  1400. * solutions for that:
  1401. *
  1402. * - memcpy() the data internally, at which point we might as well just
  1403. * do a regular read() on the buffer anyway.
  1404. * - Lots of nasty vm tricks, that are neither fast nor flexible (it
  1405. * has restriction limitations on both ends of the pipe).
  1406. *
  1407. * Currently we punt and implement it as a normal copy, see pipe_to_user().
  1408. *
  1409. */
  1410. SYSCALL_DEFINE4(vmsplice, int, fd, const struct iovec __user *, iov,
  1411. unsigned long, nr_segs, unsigned int, flags)
  1412. {
  1413. struct file *file;
  1414. long error;
  1415. int fput;
  1416. if (unlikely(nr_segs > UIO_MAXIOV))
  1417. return -EINVAL;
  1418. else if (unlikely(!nr_segs))
  1419. return 0;
  1420. error = -EBADF;
  1421. file = fget_light(fd, &fput);
  1422. if (file) {
  1423. if (file->f_mode & FMODE_WRITE)
  1424. error = vmsplice_to_pipe(file, iov, nr_segs, flags);
  1425. else if (file->f_mode & FMODE_READ)
  1426. error = vmsplice_to_user(file, iov, nr_segs, flags);
  1427. fput_light(file, fput);
  1428. }
  1429. return error;
  1430. }
  1431. SYSCALL_DEFINE6(splice, int, fd_in, loff_t __user *, off_in,
  1432. int, fd_out, loff_t __user *, off_out,
  1433. size_t, len, unsigned int, flags)
  1434. {
  1435. long error;
  1436. struct file *in, *out;
  1437. int fput_in, fput_out;
  1438. if (unlikely(!len))
  1439. return 0;
  1440. error = -EBADF;
  1441. in = fget_light(fd_in, &fput_in);
  1442. if (in) {
  1443. if (in->f_mode & FMODE_READ) {
  1444. out = fget_light(fd_out, &fput_out);
  1445. if (out) {
  1446. if (out->f_mode & FMODE_WRITE)
  1447. error = do_splice(in, off_in,
  1448. out, off_out,
  1449. len, flags);
  1450. fput_light(out, fput_out);
  1451. }
  1452. }
  1453. fput_light(in, fput_in);
  1454. }
  1455. return error;
  1456. }
  1457. /*
  1458. * Make sure there's data to read. Wait for input if we can, otherwise
  1459. * return an appropriate error.
  1460. */
  1461. static int ipipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
  1462. {
  1463. int ret;
  1464. /*
  1465. * Check ->nrbufs without the inode lock first. This function
  1466. * is speculative anyways, so missing one is ok.
  1467. */
  1468. if (pipe->nrbufs)
  1469. return 0;
  1470. ret = 0;
  1471. pipe_lock(pipe);
  1472. while (!pipe->nrbufs) {
  1473. if (signal_pending(current)) {
  1474. ret = -ERESTARTSYS;
  1475. break;
  1476. }
  1477. if (!pipe->writers)
  1478. break;
  1479. if (!pipe->waiting_writers) {
  1480. if (flags & SPLICE_F_NONBLOCK) {
  1481. ret = -EAGAIN;
  1482. break;
  1483. }
  1484. }
  1485. pipe_wait(pipe);
  1486. }
  1487. pipe_unlock(pipe);
  1488. return ret;
  1489. }
  1490. /*
  1491. * Make sure there's writeable room. Wait for room if we can, otherwise
  1492. * return an appropriate error.
  1493. */
  1494. static int opipe_prep(struct pipe_inode_info *pipe, unsigned int flags)
  1495. {
  1496. int ret;
  1497. /*
  1498. * Check ->nrbufs without the inode lock first. This function
  1499. * is speculative anyways, so missing one is ok.
  1500. */
  1501. if (pipe->nrbufs < pipe->buffers)
  1502. return 0;
  1503. ret = 0;
  1504. pipe_lock(pipe);
  1505. while (pipe->nrbufs >= pipe->buffers) {
  1506. if (!pipe->readers) {
  1507. send_sig(SIGPIPE, current, 0);
  1508. ret = -EPIPE;
  1509. break;
  1510. }
  1511. if (flags & SPLICE_F_NONBLOCK) {
  1512. ret = -EAGAIN;
  1513. break;
  1514. }
  1515. if (signal_pending(current)) {
  1516. ret = -ERESTARTSYS;
  1517. break;
  1518. }
  1519. pipe->waiting_writers++;
  1520. pipe_wait(pipe);
  1521. pipe->waiting_writers--;
  1522. }
  1523. pipe_unlock(pipe);
  1524. return ret;
  1525. }
  1526. /*
  1527. * Splice contents of ipipe to opipe.
  1528. */
  1529. static int splice_pipe_to_pipe(struct pipe_inode_info *ipipe,
  1530. struct pipe_inode_info *opipe,
  1531. size_t len, unsigned int flags)
  1532. {
  1533. struct pipe_buffer *ibuf, *obuf;
  1534. int ret = 0, nbuf;
  1535. bool input_wakeup = false;
  1536. retry:
  1537. ret = ipipe_prep(ipipe, flags);
  1538. if (ret)
  1539. return ret;
  1540. ret = opipe_prep(opipe, flags);
  1541. if (ret)
  1542. return ret;
  1543. /*
  1544. * Potential ABBA deadlock, work around it by ordering lock
  1545. * grabbing by pipe info address. Otherwise two different processes
  1546. * could deadlock (one doing tee from A -> B, the other from B -> A).
  1547. */
  1548. pipe_double_lock(ipipe, opipe);
  1549. do {
  1550. if (!opipe->readers) {
  1551. send_sig(SIGPIPE, current, 0);
  1552. if (!ret)
  1553. ret = -EPIPE;
  1554. break;
  1555. }
  1556. if (!ipipe->nrbufs && !ipipe->writers)
  1557. break;
  1558. /*
  1559. * Cannot make any progress, because either the input
  1560. * pipe is empty or the output pipe is full.
  1561. */
  1562. if (!ipipe->nrbufs || opipe->nrbufs >= opipe->buffers) {
  1563. /* Already processed some buffers, break */
  1564. if (ret)
  1565. break;
  1566. if (flags & SPLICE_F_NONBLOCK) {
  1567. ret = -EAGAIN;
  1568. break;
  1569. }
  1570. /*
  1571. * We raced with another reader/writer and haven't
  1572. * managed to process any buffers. A zero return
  1573. * value means EOF, so retry instead.
  1574. */
  1575. pipe_unlock(ipipe);
  1576. pipe_unlock(opipe);
  1577. goto retry;
  1578. }
  1579. ibuf = ipipe->bufs + ipipe->curbuf;
  1580. nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
  1581. obuf = opipe->bufs + nbuf;
  1582. if (len >= ibuf->len) {
  1583. /*
  1584. * Simply move the whole buffer from ipipe to opipe
  1585. */
  1586. *obuf = *ibuf;
  1587. ibuf->ops = NULL;
  1588. opipe->nrbufs++;
  1589. ipipe->curbuf = (ipipe->curbuf + 1) & (ipipe->buffers - 1);
  1590. ipipe->nrbufs--;
  1591. input_wakeup = true;
  1592. } else {
  1593. /*
  1594. * Get a reference to this pipe buffer,
  1595. * so we can copy the contents over.
  1596. */
  1597. ibuf->ops->get(ipipe, ibuf);
  1598. *obuf = *ibuf;
  1599. /*
  1600. * Don't inherit the gift flag, we need to
  1601. * prevent multiple steals of this page.
  1602. */
  1603. obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
  1604. obuf->len = len;
  1605. opipe->nrbufs++;
  1606. ibuf->offset += obuf->len;
  1607. ibuf->len -= obuf->len;
  1608. }
  1609. ret += obuf->len;
  1610. len -= obuf->len;
  1611. } while (len);
  1612. pipe_unlock(ipipe);
  1613. pipe_unlock(opipe);
  1614. /*
  1615. * If we put data in the output pipe, wakeup any potential readers.
  1616. */
  1617. if (ret > 0) {
  1618. smp_mb();
  1619. if (waitqueue_active(&opipe->wait))
  1620. wake_up_interruptible(&opipe->wait);
  1621. kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
  1622. }
  1623. if (input_wakeup)
  1624. wakeup_pipe_writers(ipipe);
  1625. return ret;
  1626. }
  1627. /*
  1628. * Link contents of ipipe to opipe.
  1629. */
  1630. static int link_pipe(struct pipe_inode_info *ipipe,
  1631. struct pipe_inode_info *opipe,
  1632. size_t len, unsigned int flags)
  1633. {
  1634. struct pipe_buffer *ibuf, *obuf;
  1635. int ret = 0, i = 0, nbuf;
  1636. /*
  1637. * Potential ABBA deadlock, work around it by ordering lock
  1638. * grabbing by pipe info address. Otherwise two different processes
  1639. * could deadlock (one doing tee from A -> B, the other from B -> A).
  1640. */
  1641. pipe_double_lock(ipipe, opipe);
  1642. do {
  1643. if (!opipe->readers) {
  1644. send_sig(SIGPIPE, current, 0);
  1645. if (!ret)
  1646. ret = -EPIPE;
  1647. break;
  1648. }
  1649. /*
  1650. * If we have iterated all input buffers or ran out of
  1651. * output room, break.
  1652. */
  1653. if (i >= ipipe->nrbufs || opipe->nrbufs >= opipe->buffers)
  1654. break;
  1655. ibuf = ipipe->bufs + ((ipipe->curbuf + i) & (ipipe->buffers-1));
  1656. nbuf = (opipe->curbuf + opipe->nrbufs) & (opipe->buffers - 1);
  1657. /*
  1658. * Get a reference to this pipe buffer,
  1659. * so we can copy the contents over.
  1660. */
  1661. ibuf->ops->get(ipipe, ibuf);
  1662. obuf = opipe->bufs + nbuf;
  1663. *obuf = *ibuf;
  1664. /*
  1665. * Don't inherit the gift flag, we need to
  1666. * prevent multiple steals of this page.
  1667. */
  1668. obuf->flags &= ~PIPE_BUF_FLAG_GIFT;
  1669. if (obuf->len > len)
  1670. obuf->len = len;
  1671. opipe->nrbufs++;
  1672. ret += obuf->len;
  1673. len -= obuf->len;
  1674. i++;
  1675. } while (len);
  1676. /*
  1677. * return EAGAIN if we have the potential of some data in the
  1678. * future, otherwise just return 0
  1679. */
  1680. if (!ret && ipipe->waiting_writers && (flags & SPLICE_F_NONBLOCK))
  1681. ret = -EAGAIN;
  1682. pipe_unlock(ipipe);
  1683. pipe_unlock(opipe);
  1684. /*
  1685. * If we put data in the output pipe, wakeup any potential readers.
  1686. */
  1687. if (ret > 0) {
  1688. smp_mb();
  1689. if (waitqueue_active(&opipe->wait))
  1690. wake_up_interruptible(&opipe->wait);
  1691. kill_fasync(&opipe->fasync_readers, SIGIO, POLL_IN);
  1692. }
  1693. return ret;
  1694. }
  1695. /*
  1696. * This is a tee(1) implementation that works on pipes. It doesn't copy
  1697. * any data, it simply references the 'in' pages on the 'out' pipe.
  1698. * The 'flags' used are the SPLICE_F_* variants, currently the only
  1699. * applicable one is SPLICE_F_NONBLOCK.
  1700. */
  1701. static long do_tee(struct file *in, struct file *out, size_t len,
  1702. unsigned int flags)
  1703. {
  1704. struct pipe_inode_info *ipipe = get_pipe_info(in);
  1705. struct pipe_inode_info *opipe = get_pipe_info(out);
  1706. int ret = -EINVAL;
  1707. /*
  1708. * Duplicate the contents of ipipe to opipe without actually
  1709. * copying the data.
  1710. */
  1711. if (ipipe && opipe && ipipe != opipe) {
  1712. /*
  1713. * Keep going, unless we encounter an error. The ipipe/opipe
  1714. * ordering doesn't really matter.
  1715. */
  1716. ret = ipipe_prep(ipipe, flags);
  1717. if (!ret) {
  1718. ret = opipe_prep(opipe, flags);
  1719. if (!ret)
  1720. ret = link_pipe(ipipe, opipe, len, flags);
  1721. }
  1722. }
  1723. return ret;
  1724. }
  1725. SYSCALL_DEFINE4(tee, int, fdin, int, fdout, size_t, len, unsigned int, flags)
  1726. {
  1727. struct file *in;
  1728. int error, fput_in;
  1729. if (unlikely(!len))
  1730. return 0;
  1731. error = -EBADF;
  1732. in = fget_light(fdin, &fput_in);
  1733. if (in) {
  1734. if (in->f_mode & FMODE_READ) {
  1735. int fput_out;
  1736. struct file *out = fget_light(fdout, &fput_out);
  1737. if (out) {
  1738. if (out->f_mode & FMODE_WRITE)
  1739. error = do_tee(in, out, len, flags);
  1740. fput_light(out, fput_out);
  1741. }
  1742. }
  1743. fput_light(in, fput_in);
  1744. }
  1745. return error;
  1746. }