splice.c 46 KB

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