splice.c 48 KB

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