splice.c 46 KB

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