eventpoll.c 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602
  1. /*
  2. * fs/eventpoll.c (Efficient event retrieval implementation)
  3. * Copyright (C) 2001,...,2009 Davide Libenzi
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * Davide Libenzi <davidel@xmailserver.org>
  11. *
  12. */
  13. #include <linux/init.h>
  14. #include <linux/kernel.h>
  15. #include <linux/sched.h>
  16. #include <linux/fs.h>
  17. #include <linux/file.h>
  18. #include <linux/signal.h>
  19. #include <linux/errno.h>
  20. #include <linux/mm.h>
  21. #include <linux/slab.h>
  22. #include <linux/poll.h>
  23. #include <linux/string.h>
  24. #include <linux/list.h>
  25. #include <linux/hash.h>
  26. #include <linux/spinlock.h>
  27. #include <linux/syscalls.h>
  28. #include <linux/rbtree.h>
  29. #include <linux/wait.h>
  30. #include <linux/eventpoll.h>
  31. #include <linux/mount.h>
  32. #include <linux/bitops.h>
  33. #include <linux/mutex.h>
  34. #include <linux/anon_inodes.h>
  35. #include <asm/uaccess.h>
  36. #include <asm/system.h>
  37. #include <asm/io.h>
  38. #include <asm/mman.h>
  39. #include <linux/atomic.h>
  40. /*
  41. * LOCKING:
  42. * There are three level of locking required by epoll :
  43. *
  44. * 1) epmutex (mutex)
  45. * 2) ep->mtx (mutex)
  46. * 3) ep->lock (spinlock)
  47. *
  48. * The acquire order is the one listed above, from 1 to 3.
  49. * We need a spinlock (ep->lock) because we manipulate objects
  50. * from inside the poll callback, that might be triggered from
  51. * a wake_up() that in turn might be called from IRQ context.
  52. * So we can't sleep inside the poll callback and hence we need
  53. * a spinlock. During the event transfer loop (from kernel to
  54. * user space) we could end up sleeping due a copy_to_user(), so
  55. * we need a lock that will allow us to sleep. This lock is a
  56. * mutex (ep->mtx). It is acquired during the event transfer loop,
  57. * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
  58. * Then we also need a global mutex to serialize eventpoll_release_file()
  59. * and ep_free().
  60. * This mutex is acquired by ep_free() during the epoll file
  61. * cleanup path and it is also acquired by eventpoll_release_file()
  62. * if a file has been pushed inside an epoll set and it is then
  63. * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
  64. * It is also acquired when inserting an epoll fd onto another epoll
  65. * fd. We do this so that we walk the epoll tree and ensure that this
  66. * insertion does not create a cycle of epoll file descriptors, which
  67. * could lead to deadlock. We need a global mutex to prevent two
  68. * simultaneous inserts (A into B and B into A) from racing and
  69. * constructing a cycle without either insert observing that it is
  70. * going to.
  71. * It is necessary to acquire multiple "ep->mtx"es at once in the
  72. * case when one epoll fd is added to another. In this case, we
  73. * always acquire the locks in the order of nesting (i.e. after
  74. * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
  75. * before e2->mtx). Since we disallow cycles of epoll file
  76. * descriptors, this ensures that the mutexes are well-ordered. In
  77. * order to communicate this nesting to lockdep, when walking a tree
  78. * of epoll file descriptors, we use the current recursion depth as
  79. * the lockdep subkey.
  80. * It is possible to drop the "ep->mtx" and to use the global
  81. * mutex "epmutex" (together with "ep->lock") to have it working,
  82. * but having "ep->mtx" will make the interface more scalable.
  83. * Events that require holding "epmutex" are very rare, while for
  84. * normal operations the epoll private "ep->mtx" will guarantee
  85. * a better scalability.
  86. */
  87. /* Epoll private bits inside the event mask */
  88. #define EP_PRIVATE_BITS (EPOLLONESHOT | EPOLLET)
  89. /* Maximum number of nesting allowed inside epoll sets */
  90. #define EP_MAX_NESTS 4
  91. #define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
  92. #define EP_UNACTIVE_PTR ((void *) -1L)
  93. #define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
  94. struct epoll_filefd {
  95. struct file *file;
  96. int fd;
  97. };
  98. /*
  99. * Structure used to track possible nested calls, for too deep recursions
  100. * and loop cycles.
  101. */
  102. struct nested_call_node {
  103. struct list_head llink;
  104. void *cookie;
  105. void *ctx;
  106. };
  107. /*
  108. * This structure is used as collector for nested calls, to check for
  109. * maximum recursion dept and loop cycles.
  110. */
  111. struct nested_calls {
  112. struct list_head tasks_call_list;
  113. spinlock_t lock;
  114. };
  115. /*
  116. * Each file descriptor added to the eventpoll interface will
  117. * have an entry of this type linked to the "rbr" RB tree.
  118. */
  119. struct epitem {
  120. /* RB tree node used to link this structure to the eventpoll RB tree */
  121. struct rb_node rbn;
  122. /* List header used to link this structure to the eventpoll ready list */
  123. struct list_head rdllink;
  124. /*
  125. * Works together "struct eventpoll"->ovflist in keeping the
  126. * single linked chain of items.
  127. */
  128. struct epitem *next;
  129. /* The file descriptor information this item refers to */
  130. struct epoll_filefd ffd;
  131. /* Number of active wait queue attached to poll operations */
  132. int nwait;
  133. /* List containing poll wait queues */
  134. struct list_head pwqlist;
  135. /* The "container" of this item */
  136. struct eventpoll *ep;
  137. /* List header used to link this item to the "struct file" items list */
  138. struct list_head fllink;
  139. /* The structure that describe the interested events and the source fd */
  140. struct epoll_event event;
  141. };
  142. /*
  143. * This structure is stored inside the "private_data" member of the file
  144. * structure and represents the main data structure for the eventpoll
  145. * interface.
  146. */
  147. struct eventpoll {
  148. /* Protect the access to this structure */
  149. spinlock_t lock;
  150. /*
  151. * This mutex is used to ensure that files are not removed
  152. * while epoll is using them. This is held during the event
  153. * collection loop, the file cleanup path, the epoll file exit
  154. * code and the ctl operations.
  155. */
  156. struct mutex mtx;
  157. /* Wait queue used by sys_epoll_wait() */
  158. wait_queue_head_t wq;
  159. /* Wait queue used by file->poll() */
  160. wait_queue_head_t poll_wait;
  161. /* List of ready file descriptors */
  162. struct list_head rdllist;
  163. /* RB tree root used to store monitored fd structs */
  164. struct rb_root rbr;
  165. /*
  166. * This is a single linked list that chains all the "struct epitem" that
  167. * happened while transferring ready events to userspace w/out
  168. * holding ->lock.
  169. */
  170. struct epitem *ovflist;
  171. /* The user that created the eventpoll descriptor */
  172. struct user_struct *user;
  173. };
  174. /* Wait structure used by the poll hooks */
  175. struct eppoll_entry {
  176. /* List header used to link this structure to the "struct epitem" */
  177. struct list_head llink;
  178. /* The "base" pointer is set to the container "struct epitem" */
  179. struct epitem *base;
  180. /*
  181. * Wait queue item that will be linked to the target file wait
  182. * queue head.
  183. */
  184. wait_queue_t wait;
  185. /* The wait queue head that linked the "wait" wait queue item */
  186. wait_queue_head_t *whead;
  187. };
  188. /* Wrapper struct used by poll queueing */
  189. struct ep_pqueue {
  190. poll_table pt;
  191. struct epitem *epi;
  192. };
  193. /* Used by the ep_send_events() function as callback private data */
  194. struct ep_send_events_data {
  195. int maxevents;
  196. struct epoll_event __user *events;
  197. };
  198. /*
  199. * Configuration options available inside /proc/sys/fs/epoll/
  200. */
  201. /* Maximum number of epoll watched descriptors, per user */
  202. static long max_user_watches __read_mostly;
  203. /*
  204. * This mutex is used to serialize ep_free() and eventpoll_release_file().
  205. */
  206. static DEFINE_MUTEX(epmutex);
  207. /* Used to check for epoll file descriptor inclusion loops */
  208. static struct nested_calls poll_loop_ncalls;
  209. /* Used for safe wake up implementation */
  210. static struct nested_calls poll_safewake_ncalls;
  211. /* Used to call file's f_op->poll() under the nested calls boundaries */
  212. static struct nested_calls poll_readywalk_ncalls;
  213. /* Slab cache used to allocate "struct epitem" */
  214. static struct kmem_cache *epi_cache __read_mostly;
  215. /* Slab cache used to allocate "struct eppoll_entry" */
  216. static struct kmem_cache *pwq_cache __read_mostly;
  217. #ifdef CONFIG_SYSCTL
  218. #include <linux/sysctl.h>
  219. static long zero;
  220. static long long_max = LONG_MAX;
  221. ctl_table epoll_table[] = {
  222. {
  223. .procname = "max_user_watches",
  224. .data = &max_user_watches,
  225. .maxlen = sizeof(max_user_watches),
  226. .mode = 0644,
  227. .proc_handler = proc_doulongvec_minmax,
  228. .extra1 = &zero,
  229. .extra2 = &long_max,
  230. },
  231. { }
  232. };
  233. #endif /* CONFIG_SYSCTL */
  234. /* Setup the structure that is used as key for the RB tree */
  235. static inline void ep_set_ffd(struct epoll_filefd *ffd,
  236. struct file *file, int fd)
  237. {
  238. ffd->file = file;
  239. ffd->fd = fd;
  240. }
  241. /* Compare RB tree keys */
  242. static inline int ep_cmp_ffd(struct epoll_filefd *p1,
  243. struct epoll_filefd *p2)
  244. {
  245. return (p1->file > p2->file ? +1:
  246. (p1->file < p2->file ? -1 : p1->fd - p2->fd));
  247. }
  248. /* Tells us if the item is currently linked */
  249. static inline int ep_is_linked(struct list_head *p)
  250. {
  251. return !list_empty(p);
  252. }
  253. /* Get the "struct epitem" from a wait queue pointer */
  254. static inline struct epitem *ep_item_from_wait(wait_queue_t *p)
  255. {
  256. return container_of(p, struct eppoll_entry, wait)->base;
  257. }
  258. /* Get the "struct epitem" from an epoll queue wrapper */
  259. static inline struct epitem *ep_item_from_epqueue(poll_table *p)
  260. {
  261. return container_of(p, struct ep_pqueue, pt)->epi;
  262. }
  263. /* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
  264. static inline int ep_op_has_event(int op)
  265. {
  266. return op != EPOLL_CTL_DEL;
  267. }
  268. /* Initialize the poll safe wake up structure */
  269. static void ep_nested_calls_init(struct nested_calls *ncalls)
  270. {
  271. INIT_LIST_HEAD(&ncalls->tasks_call_list);
  272. spin_lock_init(&ncalls->lock);
  273. }
  274. /**
  275. * ep_events_available - Checks if ready events might be available.
  276. *
  277. * @ep: Pointer to the eventpoll context.
  278. *
  279. * Returns: Returns a value different than zero if ready events are available,
  280. * or zero otherwise.
  281. */
  282. static inline int ep_events_available(struct eventpoll *ep)
  283. {
  284. return !list_empty(&ep->rdllist) || ep->ovflist != EP_UNACTIVE_PTR;
  285. }
  286. /**
  287. * ep_call_nested - Perform a bound (possibly) nested call, by checking
  288. * that the recursion limit is not exceeded, and that
  289. * the same nested call (by the meaning of same cookie) is
  290. * no re-entered.
  291. *
  292. * @ncalls: Pointer to the nested_calls structure to be used for this call.
  293. * @max_nests: Maximum number of allowed nesting calls.
  294. * @nproc: Nested call core function pointer.
  295. * @priv: Opaque data to be passed to the @nproc callback.
  296. * @cookie: Cookie to be used to identify this nested call.
  297. * @ctx: This instance context.
  298. *
  299. * Returns: Returns the code returned by the @nproc callback, or -1 if
  300. * the maximum recursion limit has been exceeded.
  301. */
  302. static int ep_call_nested(struct nested_calls *ncalls, int max_nests,
  303. int (*nproc)(void *, void *, int), void *priv,
  304. void *cookie, void *ctx)
  305. {
  306. int error, call_nests = 0;
  307. unsigned long flags;
  308. struct list_head *lsthead = &ncalls->tasks_call_list;
  309. struct nested_call_node *tncur;
  310. struct nested_call_node tnode;
  311. spin_lock_irqsave(&ncalls->lock, flags);
  312. /*
  313. * Try to see if the current task is already inside this wakeup call.
  314. * We use a list here, since the population inside this set is always
  315. * very much limited.
  316. */
  317. list_for_each_entry(tncur, lsthead, llink) {
  318. if (tncur->ctx == ctx &&
  319. (tncur->cookie == cookie || ++call_nests > max_nests)) {
  320. /*
  321. * Ops ... loop detected or maximum nest level reached.
  322. * We abort this wake by breaking the cycle itself.
  323. */
  324. error = -1;
  325. goto out_unlock;
  326. }
  327. }
  328. /* Add the current task and cookie to the list */
  329. tnode.ctx = ctx;
  330. tnode.cookie = cookie;
  331. list_add(&tnode.llink, lsthead);
  332. spin_unlock_irqrestore(&ncalls->lock, flags);
  333. /* Call the nested function */
  334. error = (*nproc)(priv, cookie, call_nests);
  335. /* Remove the current task from the list */
  336. spin_lock_irqsave(&ncalls->lock, flags);
  337. list_del(&tnode.llink);
  338. out_unlock:
  339. spin_unlock_irqrestore(&ncalls->lock, flags);
  340. return error;
  341. }
  342. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  343. static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
  344. unsigned long events, int subclass)
  345. {
  346. unsigned long flags;
  347. spin_lock_irqsave_nested(&wqueue->lock, flags, subclass);
  348. wake_up_locked_poll(wqueue, events);
  349. spin_unlock_irqrestore(&wqueue->lock, flags);
  350. }
  351. #else
  352. static inline void ep_wake_up_nested(wait_queue_head_t *wqueue,
  353. unsigned long events, int subclass)
  354. {
  355. wake_up_poll(wqueue, events);
  356. }
  357. #endif
  358. static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
  359. {
  360. ep_wake_up_nested((wait_queue_head_t *) cookie, POLLIN,
  361. 1 + call_nests);
  362. return 0;
  363. }
  364. /*
  365. * Perform a safe wake up of the poll wait list. The problem is that
  366. * with the new callback'd wake up system, it is possible that the
  367. * poll callback is reentered from inside the call to wake_up() done
  368. * on the poll wait queue head. The rule is that we cannot reenter the
  369. * wake up code from the same task more than EP_MAX_NESTS times,
  370. * and we cannot reenter the same wait queue head at all. This will
  371. * enable to have a hierarchy of epoll file descriptor of no more than
  372. * EP_MAX_NESTS deep.
  373. */
  374. static void ep_poll_safewake(wait_queue_head_t *wq)
  375. {
  376. int this_cpu = get_cpu();
  377. ep_call_nested(&poll_safewake_ncalls, EP_MAX_NESTS,
  378. ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
  379. put_cpu();
  380. }
  381. /*
  382. * This function unregisters poll callbacks from the associated file
  383. * descriptor. Must be called with "mtx" held (or "epmutex" if called from
  384. * ep_free).
  385. */
  386. static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
  387. {
  388. struct list_head *lsthead = &epi->pwqlist;
  389. struct eppoll_entry *pwq;
  390. while (!list_empty(lsthead)) {
  391. pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
  392. list_del(&pwq->llink);
  393. remove_wait_queue(pwq->whead, &pwq->wait);
  394. kmem_cache_free(pwq_cache, pwq);
  395. }
  396. }
  397. /**
  398. * ep_scan_ready_list - Scans the ready list in a way that makes possible for
  399. * the scan code, to call f_op->poll(). Also allows for
  400. * O(NumReady) performance.
  401. *
  402. * @ep: Pointer to the epoll private data structure.
  403. * @sproc: Pointer to the scan callback.
  404. * @priv: Private opaque data passed to the @sproc callback.
  405. * @depth: The current depth of recursive f_op->poll calls.
  406. *
  407. * Returns: The same integer error code returned by the @sproc callback.
  408. */
  409. static int ep_scan_ready_list(struct eventpoll *ep,
  410. int (*sproc)(struct eventpoll *,
  411. struct list_head *, void *),
  412. void *priv,
  413. int depth)
  414. {
  415. int error, pwake = 0;
  416. unsigned long flags;
  417. struct epitem *epi, *nepi;
  418. LIST_HEAD(txlist);
  419. /*
  420. * We need to lock this because we could be hit by
  421. * eventpoll_release_file() and epoll_ctl().
  422. */
  423. mutex_lock_nested(&ep->mtx, depth);
  424. /*
  425. * Steal the ready list, and re-init the original one to the
  426. * empty list. Also, set ep->ovflist to NULL so that events
  427. * happening while looping w/out locks, are not lost. We cannot
  428. * have the poll callback to queue directly on ep->rdllist,
  429. * because we want the "sproc" callback to be able to do it
  430. * in a lockless way.
  431. */
  432. spin_lock_irqsave(&ep->lock, flags);
  433. list_splice_init(&ep->rdllist, &txlist);
  434. ep->ovflist = NULL;
  435. spin_unlock_irqrestore(&ep->lock, flags);
  436. /*
  437. * Now call the callback function.
  438. */
  439. error = (*sproc)(ep, &txlist, priv);
  440. spin_lock_irqsave(&ep->lock, flags);
  441. /*
  442. * During the time we spent inside the "sproc" callback, some
  443. * other events might have been queued by the poll callback.
  444. * We re-insert them inside the main ready-list here.
  445. */
  446. for (nepi = ep->ovflist; (epi = nepi) != NULL;
  447. nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
  448. /*
  449. * We need to check if the item is already in the list.
  450. * During the "sproc" callback execution time, items are
  451. * queued into ->ovflist but the "txlist" might already
  452. * contain them, and the list_splice() below takes care of them.
  453. */
  454. if (!ep_is_linked(&epi->rdllink))
  455. list_add_tail(&epi->rdllink, &ep->rdllist);
  456. }
  457. /*
  458. * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
  459. * releasing the lock, events will be queued in the normal way inside
  460. * ep->rdllist.
  461. */
  462. ep->ovflist = EP_UNACTIVE_PTR;
  463. /*
  464. * Quickly re-inject items left on "txlist".
  465. */
  466. list_splice(&txlist, &ep->rdllist);
  467. if (!list_empty(&ep->rdllist)) {
  468. /*
  469. * Wake up (if active) both the eventpoll wait list and
  470. * the ->poll() wait list (delayed after we release the lock).
  471. */
  472. if (waitqueue_active(&ep->wq))
  473. wake_up_locked(&ep->wq);
  474. if (waitqueue_active(&ep->poll_wait))
  475. pwake++;
  476. }
  477. spin_unlock_irqrestore(&ep->lock, flags);
  478. mutex_unlock(&ep->mtx);
  479. /* We have to call this outside the lock */
  480. if (pwake)
  481. ep_poll_safewake(&ep->poll_wait);
  482. return error;
  483. }
  484. /*
  485. * Removes a "struct epitem" from the eventpoll RB tree and deallocates
  486. * all the associated resources. Must be called with "mtx" held.
  487. */
  488. static int ep_remove(struct eventpoll *ep, struct epitem *epi)
  489. {
  490. unsigned long flags;
  491. struct file *file = epi->ffd.file;
  492. /*
  493. * Removes poll wait queue hooks. We _have_ to do this without holding
  494. * the "ep->lock" otherwise a deadlock might occur. This because of the
  495. * sequence of the lock acquisition. Here we do "ep->lock" then the wait
  496. * queue head lock when unregistering the wait queue. The wakeup callback
  497. * will run by holding the wait queue head lock and will call our callback
  498. * that will try to get "ep->lock".
  499. */
  500. ep_unregister_pollwait(ep, epi);
  501. /* Remove the current item from the list of epoll hooks */
  502. spin_lock(&file->f_lock);
  503. if (ep_is_linked(&epi->fllink))
  504. list_del_init(&epi->fllink);
  505. spin_unlock(&file->f_lock);
  506. rb_erase(&epi->rbn, &ep->rbr);
  507. spin_lock_irqsave(&ep->lock, flags);
  508. if (ep_is_linked(&epi->rdllink))
  509. list_del_init(&epi->rdllink);
  510. spin_unlock_irqrestore(&ep->lock, flags);
  511. /* At this point it is safe to free the eventpoll item */
  512. kmem_cache_free(epi_cache, epi);
  513. atomic_long_dec(&ep->user->epoll_watches);
  514. return 0;
  515. }
  516. static void ep_free(struct eventpoll *ep)
  517. {
  518. struct rb_node *rbp;
  519. struct epitem *epi;
  520. /* We need to release all tasks waiting for these file */
  521. if (waitqueue_active(&ep->poll_wait))
  522. ep_poll_safewake(&ep->poll_wait);
  523. /*
  524. * We need to lock this because we could be hit by
  525. * eventpoll_release_file() while we're freeing the "struct eventpoll".
  526. * We do not need to hold "ep->mtx" here because the epoll file
  527. * is on the way to be removed and no one has references to it
  528. * anymore. The only hit might come from eventpoll_release_file() but
  529. * holding "epmutex" is sufficient here.
  530. */
  531. mutex_lock(&epmutex);
  532. /*
  533. * Walks through the whole tree by unregistering poll callbacks.
  534. */
  535. for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  536. epi = rb_entry(rbp, struct epitem, rbn);
  537. ep_unregister_pollwait(ep, epi);
  538. }
  539. /*
  540. * Walks through the whole tree by freeing each "struct epitem". At this
  541. * point we are sure no poll callbacks will be lingering around, and also by
  542. * holding "epmutex" we can be sure that no file cleanup code will hit
  543. * us during this operation. So we can avoid the lock on "ep->lock".
  544. */
  545. while ((rbp = rb_first(&ep->rbr)) != NULL) {
  546. epi = rb_entry(rbp, struct epitem, rbn);
  547. ep_remove(ep, epi);
  548. }
  549. mutex_unlock(&epmutex);
  550. mutex_destroy(&ep->mtx);
  551. free_uid(ep->user);
  552. kfree(ep);
  553. }
  554. static int ep_eventpoll_release(struct inode *inode, struct file *file)
  555. {
  556. struct eventpoll *ep = file->private_data;
  557. if (ep)
  558. ep_free(ep);
  559. return 0;
  560. }
  561. static int ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
  562. void *priv)
  563. {
  564. struct epitem *epi, *tmp;
  565. list_for_each_entry_safe(epi, tmp, head, rdllink) {
  566. if (epi->ffd.file->f_op->poll(epi->ffd.file, NULL) &
  567. epi->event.events)
  568. return POLLIN | POLLRDNORM;
  569. else {
  570. /*
  571. * Item has been dropped into the ready list by the poll
  572. * callback, but it's not actually ready, as far as
  573. * caller requested events goes. We can remove it here.
  574. */
  575. list_del_init(&epi->rdllink);
  576. }
  577. }
  578. return 0;
  579. }
  580. static int ep_poll_readyevents_proc(void *priv, void *cookie, int call_nests)
  581. {
  582. return ep_scan_ready_list(priv, ep_read_events_proc, NULL, call_nests + 1);
  583. }
  584. static unsigned int ep_eventpoll_poll(struct file *file, poll_table *wait)
  585. {
  586. int pollflags;
  587. struct eventpoll *ep = file->private_data;
  588. /* Insert inside our poll wait queue */
  589. poll_wait(file, &ep->poll_wait, wait);
  590. /*
  591. * Proceed to find out if wanted events are really available inside
  592. * the ready list. This need to be done under ep_call_nested()
  593. * supervision, since the call to f_op->poll() done on listed files
  594. * could re-enter here.
  595. */
  596. pollflags = ep_call_nested(&poll_readywalk_ncalls, EP_MAX_NESTS,
  597. ep_poll_readyevents_proc, ep, ep, current);
  598. return pollflags != -1 ? pollflags : 0;
  599. }
  600. /* File callbacks that implement the eventpoll file behaviour */
  601. static const struct file_operations eventpoll_fops = {
  602. .release = ep_eventpoll_release,
  603. .poll = ep_eventpoll_poll,
  604. .llseek = noop_llseek,
  605. };
  606. /* Fast test to see if the file is an eventpoll file */
  607. static inline int is_file_epoll(struct file *f)
  608. {
  609. return f->f_op == &eventpoll_fops;
  610. }
  611. /*
  612. * This is called from eventpoll_release() to unlink files from the eventpoll
  613. * interface. We need to have this facility to cleanup correctly files that are
  614. * closed without being removed from the eventpoll interface.
  615. */
  616. void eventpoll_release_file(struct file *file)
  617. {
  618. struct list_head *lsthead = &file->f_ep_links;
  619. struct eventpoll *ep;
  620. struct epitem *epi;
  621. /*
  622. * We don't want to get "file->f_lock" because it is not
  623. * necessary. It is not necessary because we're in the "struct file"
  624. * cleanup path, and this means that no one is using this file anymore.
  625. * So, for example, epoll_ctl() cannot hit here since if we reach this
  626. * point, the file counter already went to zero and fget() would fail.
  627. * The only hit might come from ep_free() but by holding the mutex
  628. * will correctly serialize the operation. We do need to acquire
  629. * "ep->mtx" after "epmutex" because ep_remove() requires it when called
  630. * from anywhere but ep_free().
  631. *
  632. * Besides, ep_remove() acquires the lock, so we can't hold it here.
  633. */
  634. mutex_lock(&epmutex);
  635. while (!list_empty(lsthead)) {
  636. epi = list_first_entry(lsthead, struct epitem, fllink);
  637. ep = epi->ep;
  638. list_del_init(&epi->fllink);
  639. mutex_lock_nested(&ep->mtx, 0);
  640. ep_remove(ep, epi);
  641. mutex_unlock(&ep->mtx);
  642. }
  643. mutex_unlock(&epmutex);
  644. }
  645. static int ep_alloc(struct eventpoll **pep)
  646. {
  647. int error;
  648. struct user_struct *user;
  649. struct eventpoll *ep;
  650. user = get_current_user();
  651. error = -ENOMEM;
  652. ep = kzalloc(sizeof(*ep), GFP_KERNEL);
  653. if (unlikely(!ep))
  654. goto free_uid;
  655. spin_lock_init(&ep->lock);
  656. mutex_init(&ep->mtx);
  657. init_waitqueue_head(&ep->wq);
  658. init_waitqueue_head(&ep->poll_wait);
  659. INIT_LIST_HEAD(&ep->rdllist);
  660. ep->rbr = RB_ROOT;
  661. ep->ovflist = EP_UNACTIVE_PTR;
  662. ep->user = user;
  663. *pep = ep;
  664. return 0;
  665. free_uid:
  666. free_uid(user);
  667. return error;
  668. }
  669. /*
  670. * Search the file inside the eventpoll tree. The RB tree operations
  671. * are protected by the "mtx" mutex, and ep_find() must be called with
  672. * "mtx" held.
  673. */
  674. static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
  675. {
  676. int kcmp;
  677. struct rb_node *rbp;
  678. struct epitem *epi, *epir = NULL;
  679. struct epoll_filefd ffd;
  680. ep_set_ffd(&ffd, file, fd);
  681. for (rbp = ep->rbr.rb_node; rbp; ) {
  682. epi = rb_entry(rbp, struct epitem, rbn);
  683. kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
  684. if (kcmp > 0)
  685. rbp = rbp->rb_right;
  686. else if (kcmp < 0)
  687. rbp = rbp->rb_left;
  688. else {
  689. epir = epi;
  690. break;
  691. }
  692. }
  693. return epir;
  694. }
  695. /*
  696. * This is the callback that is passed to the wait queue wakeup
  697. * mechanism. It is called by the stored file descriptors when they
  698. * have events to report.
  699. */
  700. static int ep_poll_callback(wait_queue_t *wait, unsigned mode, int sync, void *key)
  701. {
  702. int pwake = 0;
  703. unsigned long flags;
  704. struct epitem *epi = ep_item_from_wait(wait);
  705. struct eventpoll *ep = epi->ep;
  706. spin_lock_irqsave(&ep->lock, flags);
  707. /*
  708. * If the event mask does not contain any poll(2) event, we consider the
  709. * descriptor to be disabled. This condition is likely the effect of the
  710. * EPOLLONESHOT bit that disables the descriptor when an event is received,
  711. * until the next EPOLL_CTL_MOD will be issued.
  712. */
  713. if (!(epi->event.events & ~EP_PRIVATE_BITS))
  714. goto out_unlock;
  715. /*
  716. * Check the events coming with the callback. At this stage, not
  717. * every device reports the events in the "key" parameter of the
  718. * callback. We need to be able to handle both cases here, hence the
  719. * test for "key" != NULL before the event match test.
  720. */
  721. if (key && !((unsigned long) key & epi->event.events))
  722. goto out_unlock;
  723. /*
  724. * If we are transferring events to userspace, we can hold no locks
  725. * (because we're accessing user memory, and because of linux f_op->poll()
  726. * semantics). All the events that happen during that period of time are
  727. * chained in ep->ovflist and requeued later on.
  728. */
  729. if (unlikely(ep->ovflist != EP_UNACTIVE_PTR)) {
  730. if (epi->next == EP_UNACTIVE_PTR) {
  731. epi->next = ep->ovflist;
  732. ep->ovflist = epi;
  733. }
  734. goto out_unlock;
  735. }
  736. /* If this file is already in the ready list we exit soon */
  737. if (!ep_is_linked(&epi->rdllink))
  738. list_add_tail(&epi->rdllink, &ep->rdllist);
  739. /*
  740. * Wake up ( if active ) both the eventpoll wait list and the ->poll()
  741. * wait list.
  742. */
  743. if (waitqueue_active(&ep->wq))
  744. wake_up_locked(&ep->wq);
  745. if (waitqueue_active(&ep->poll_wait))
  746. pwake++;
  747. out_unlock:
  748. spin_unlock_irqrestore(&ep->lock, flags);
  749. /* We have to call this outside the lock */
  750. if (pwake)
  751. ep_poll_safewake(&ep->poll_wait);
  752. return 1;
  753. }
  754. /*
  755. * This is the callback that is used to add our wait queue to the
  756. * target file wakeup lists.
  757. */
  758. static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
  759. poll_table *pt)
  760. {
  761. struct epitem *epi = ep_item_from_epqueue(pt);
  762. struct eppoll_entry *pwq;
  763. if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
  764. init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
  765. pwq->whead = whead;
  766. pwq->base = epi;
  767. add_wait_queue(whead, &pwq->wait);
  768. list_add_tail(&pwq->llink, &epi->pwqlist);
  769. epi->nwait++;
  770. } else {
  771. /* We have to signal that an error occurred */
  772. epi->nwait = -1;
  773. }
  774. }
  775. static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
  776. {
  777. int kcmp;
  778. struct rb_node **p = &ep->rbr.rb_node, *parent = NULL;
  779. struct epitem *epic;
  780. while (*p) {
  781. parent = *p;
  782. epic = rb_entry(parent, struct epitem, rbn);
  783. kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
  784. if (kcmp > 0)
  785. p = &parent->rb_right;
  786. else
  787. p = &parent->rb_left;
  788. }
  789. rb_link_node(&epi->rbn, parent, p);
  790. rb_insert_color(&epi->rbn, &ep->rbr);
  791. }
  792. /*
  793. * Must be called with "mtx" held.
  794. */
  795. static int ep_insert(struct eventpoll *ep, struct epoll_event *event,
  796. struct file *tfile, int fd)
  797. {
  798. int error, revents, pwake = 0;
  799. unsigned long flags;
  800. long user_watches;
  801. struct epitem *epi;
  802. struct ep_pqueue epq;
  803. user_watches = atomic_long_read(&ep->user->epoll_watches);
  804. if (unlikely(user_watches >= max_user_watches))
  805. return -ENOSPC;
  806. if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
  807. return -ENOMEM;
  808. /* Item initialization follow here ... */
  809. INIT_LIST_HEAD(&epi->rdllink);
  810. INIT_LIST_HEAD(&epi->fllink);
  811. INIT_LIST_HEAD(&epi->pwqlist);
  812. epi->ep = ep;
  813. ep_set_ffd(&epi->ffd, tfile, fd);
  814. epi->event = *event;
  815. epi->nwait = 0;
  816. epi->next = EP_UNACTIVE_PTR;
  817. /* Initialize the poll table using the queue callback */
  818. epq.epi = epi;
  819. init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
  820. /*
  821. * Attach the item to the poll hooks and get current event bits.
  822. * We can safely use the file* here because its usage count has
  823. * been increased by the caller of this function. Note that after
  824. * this operation completes, the poll callback can start hitting
  825. * the new item.
  826. */
  827. revents = tfile->f_op->poll(tfile, &epq.pt);
  828. /*
  829. * We have to check if something went wrong during the poll wait queue
  830. * install process. Namely an allocation for a wait queue failed due
  831. * high memory pressure.
  832. */
  833. error = -ENOMEM;
  834. if (epi->nwait < 0)
  835. goto error_unregister;
  836. /* Add the current item to the list of active epoll hook for this file */
  837. spin_lock(&tfile->f_lock);
  838. list_add_tail(&epi->fllink, &tfile->f_ep_links);
  839. spin_unlock(&tfile->f_lock);
  840. /*
  841. * Add the current item to the RB tree. All RB tree operations are
  842. * protected by "mtx", and ep_insert() is called with "mtx" held.
  843. */
  844. ep_rbtree_insert(ep, epi);
  845. /* We have to drop the new item inside our item list to keep track of it */
  846. spin_lock_irqsave(&ep->lock, flags);
  847. /* If the file is already "ready" we drop it inside the ready list */
  848. if ((revents & event->events) && !ep_is_linked(&epi->rdllink)) {
  849. list_add_tail(&epi->rdllink, &ep->rdllist);
  850. /* Notify waiting tasks that events are available */
  851. if (waitqueue_active(&ep->wq))
  852. wake_up_locked(&ep->wq);
  853. if (waitqueue_active(&ep->poll_wait))
  854. pwake++;
  855. }
  856. spin_unlock_irqrestore(&ep->lock, flags);
  857. atomic_long_inc(&ep->user->epoll_watches);
  858. /* We have to call this outside the lock */
  859. if (pwake)
  860. ep_poll_safewake(&ep->poll_wait);
  861. return 0;
  862. error_unregister:
  863. ep_unregister_pollwait(ep, epi);
  864. /*
  865. * We need to do this because an event could have been arrived on some
  866. * allocated wait queue. Note that we don't care about the ep->ovflist
  867. * list, since that is used/cleaned only inside a section bound by "mtx".
  868. * And ep_insert() is called with "mtx" held.
  869. */
  870. spin_lock_irqsave(&ep->lock, flags);
  871. if (ep_is_linked(&epi->rdllink))
  872. list_del_init(&epi->rdllink);
  873. spin_unlock_irqrestore(&ep->lock, flags);
  874. kmem_cache_free(epi_cache, epi);
  875. return error;
  876. }
  877. /*
  878. * Modify the interest event mask by dropping an event if the new mask
  879. * has a match in the current file status. Must be called with "mtx" held.
  880. */
  881. static int ep_modify(struct eventpoll *ep, struct epitem *epi, struct epoll_event *event)
  882. {
  883. int pwake = 0;
  884. unsigned int revents;
  885. /*
  886. * Set the new event interest mask before calling f_op->poll();
  887. * otherwise we might miss an event that happens between the
  888. * f_op->poll() call and the new event set registering.
  889. */
  890. epi->event.events = event->events;
  891. epi->event.data = event->data; /* protected by mtx */
  892. /*
  893. * Get current event bits. We can safely use the file* here because
  894. * its usage count has been increased by the caller of this function.
  895. */
  896. revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL);
  897. /*
  898. * If the item is "hot" and it is not registered inside the ready
  899. * list, push it inside.
  900. */
  901. if (revents & event->events) {
  902. spin_lock_irq(&ep->lock);
  903. if (!ep_is_linked(&epi->rdllink)) {
  904. list_add_tail(&epi->rdllink, &ep->rdllist);
  905. /* Notify waiting tasks that events are available */
  906. if (waitqueue_active(&ep->wq))
  907. wake_up_locked(&ep->wq);
  908. if (waitqueue_active(&ep->poll_wait))
  909. pwake++;
  910. }
  911. spin_unlock_irq(&ep->lock);
  912. }
  913. /* We have to call this outside the lock */
  914. if (pwake)
  915. ep_poll_safewake(&ep->poll_wait);
  916. return 0;
  917. }
  918. static int ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
  919. void *priv)
  920. {
  921. struct ep_send_events_data *esed = priv;
  922. int eventcnt;
  923. unsigned int revents;
  924. struct epitem *epi;
  925. struct epoll_event __user *uevent;
  926. /*
  927. * We can loop without lock because we are passed a task private list.
  928. * Items cannot vanish during the loop because ep_scan_ready_list() is
  929. * holding "mtx" during this call.
  930. */
  931. for (eventcnt = 0, uevent = esed->events;
  932. !list_empty(head) && eventcnt < esed->maxevents;) {
  933. epi = list_first_entry(head, struct epitem, rdllink);
  934. list_del_init(&epi->rdllink);
  935. revents = epi->ffd.file->f_op->poll(epi->ffd.file, NULL) &
  936. epi->event.events;
  937. /*
  938. * If the event mask intersect the caller-requested one,
  939. * deliver the event to userspace. Again, ep_scan_ready_list()
  940. * is holding "mtx", so no operations coming from userspace
  941. * can change the item.
  942. */
  943. if (revents) {
  944. if (__put_user(revents, &uevent->events) ||
  945. __put_user(epi->event.data, &uevent->data)) {
  946. list_add(&epi->rdllink, head);
  947. return eventcnt ? eventcnt : -EFAULT;
  948. }
  949. eventcnt++;
  950. uevent++;
  951. if (epi->event.events & EPOLLONESHOT)
  952. epi->event.events &= EP_PRIVATE_BITS;
  953. else if (!(epi->event.events & EPOLLET)) {
  954. /*
  955. * If this file has been added with Level
  956. * Trigger mode, we need to insert back inside
  957. * the ready list, so that the next call to
  958. * epoll_wait() will check again the events
  959. * availability. At this point, no one can insert
  960. * into ep->rdllist besides us. The epoll_ctl()
  961. * callers are locked out by
  962. * ep_scan_ready_list() holding "mtx" and the
  963. * poll callback will queue them in ep->ovflist.
  964. */
  965. list_add_tail(&epi->rdllink, &ep->rdllist);
  966. }
  967. }
  968. }
  969. return eventcnt;
  970. }
  971. static int ep_send_events(struct eventpoll *ep,
  972. struct epoll_event __user *events, int maxevents)
  973. {
  974. struct ep_send_events_data esed;
  975. esed.maxevents = maxevents;
  976. esed.events = events;
  977. return ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0);
  978. }
  979. static inline struct timespec ep_set_mstimeout(long ms)
  980. {
  981. struct timespec now, ts = {
  982. .tv_sec = ms / MSEC_PER_SEC,
  983. .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
  984. };
  985. ktime_get_ts(&now);
  986. return timespec_add_safe(now, ts);
  987. }
  988. /**
  989. * ep_poll - Retrieves ready events, and delivers them to the caller supplied
  990. * event buffer.
  991. *
  992. * @ep: Pointer to the eventpoll context.
  993. * @events: Pointer to the userspace buffer where the ready events should be
  994. * stored.
  995. * @maxevents: Size (in terms of number of events) of the caller event buffer.
  996. * @timeout: Maximum timeout for the ready events fetch operation, in
  997. * milliseconds. If the @timeout is zero, the function will not block,
  998. * while if the @timeout is less than zero, the function will block
  999. * until at least one event has been retrieved (or an error
  1000. * occurred).
  1001. *
  1002. * Returns: Returns the number of ready events which have been fetched, or an
  1003. * error code, in case of error.
  1004. */
  1005. static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
  1006. int maxevents, long timeout)
  1007. {
  1008. int res = 0, eavail, timed_out = 0;
  1009. unsigned long flags;
  1010. long slack = 0;
  1011. wait_queue_t wait;
  1012. ktime_t expires, *to = NULL;
  1013. if (timeout > 0) {
  1014. struct timespec end_time = ep_set_mstimeout(timeout);
  1015. slack = select_estimate_accuracy(&end_time);
  1016. to = &expires;
  1017. *to = timespec_to_ktime(end_time);
  1018. } else if (timeout == 0) {
  1019. /*
  1020. * Avoid the unnecessary trip to the wait queue loop, if the
  1021. * caller specified a non blocking operation.
  1022. */
  1023. timed_out = 1;
  1024. spin_lock_irqsave(&ep->lock, flags);
  1025. goto check_events;
  1026. }
  1027. fetch_events:
  1028. spin_lock_irqsave(&ep->lock, flags);
  1029. if (!ep_events_available(ep)) {
  1030. /*
  1031. * We don't have any available event to return to the caller.
  1032. * We need to sleep here, and we will be wake up by
  1033. * ep_poll_callback() when events will become available.
  1034. */
  1035. init_waitqueue_entry(&wait, current);
  1036. __add_wait_queue_exclusive(&ep->wq, &wait);
  1037. for (;;) {
  1038. /*
  1039. * We don't want to sleep if the ep_poll_callback() sends us
  1040. * a wakeup in between. That's why we set the task state
  1041. * to TASK_INTERRUPTIBLE before doing the checks.
  1042. */
  1043. set_current_state(TASK_INTERRUPTIBLE);
  1044. if (ep_events_available(ep) || timed_out)
  1045. break;
  1046. if (signal_pending(current)) {
  1047. res = -EINTR;
  1048. break;
  1049. }
  1050. spin_unlock_irqrestore(&ep->lock, flags);
  1051. if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS))
  1052. timed_out = 1;
  1053. spin_lock_irqsave(&ep->lock, flags);
  1054. }
  1055. __remove_wait_queue(&ep->wq, &wait);
  1056. set_current_state(TASK_RUNNING);
  1057. }
  1058. check_events:
  1059. /* Is it worth to try to dig for events ? */
  1060. eavail = ep_events_available(ep);
  1061. spin_unlock_irqrestore(&ep->lock, flags);
  1062. /*
  1063. * Try to transfer events to user space. In case we get 0 events and
  1064. * there's still timeout left over, we go trying again in search of
  1065. * more luck.
  1066. */
  1067. if (!res && eavail &&
  1068. !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
  1069. goto fetch_events;
  1070. return res;
  1071. }
  1072. /**
  1073. * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
  1074. * API, to verify that adding an epoll file inside another
  1075. * epoll structure, does not violate the constraints, in
  1076. * terms of closed loops, or too deep chains (which can
  1077. * result in excessive stack usage).
  1078. *
  1079. * @priv: Pointer to the epoll file to be currently checked.
  1080. * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
  1081. * data structure pointer.
  1082. * @call_nests: Current dept of the @ep_call_nested() call stack.
  1083. *
  1084. * Returns: Returns zero if adding the epoll @file inside current epoll
  1085. * structure @ep does not violate the constraints, or -1 otherwise.
  1086. */
  1087. static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
  1088. {
  1089. int error = 0;
  1090. struct file *file = priv;
  1091. struct eventpoll *ep = file->private_data;
  1092. struct rb_node *rbp;
  1093. struct epitem *epi;
  1094. mutex_lock_nested(&ep->mtx, call_nests + 1);
  1095. for (rbp = rb_first(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  1096. epi = rb_entry(rbp, struct epitem, rbn);
  1097. if (unlikely(is_file_epoll(epi->ffd.file))) {
  1098. error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
  1099. ep_loop_check_proc, epi->ffd.file,
  1100. epi->ffd.file->private_data, current);
  1101. if (error != 0)
  1102. break;
  1103. }
  1104. }
  1105. mutex_unlock(&ep->mtx);
  1106. return error;
  1107. }
  1108. /**
  1109. * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
  1110. * another epoll file (represented by @ep) does not create
  1111. * closed loops or too deep chains.
  1112. *
  1113. * @ep: Pointer to the epoll private data structure.
  1114. * @file: Pointer to the epoll file to be checked.
  1115. *
  1116. * Returns: Returns zero if adding the epoll @file inside current epoll
  1117. * structure @ep does not violate the constraints, or -1 otherwise.
  1118. */
  1119. static int ep_loop_check(struct eventpoll *ep, struct file *file)
  1120. {
  1121. return ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
  1122. ep_loop_check_proc, file, ep, current);
  1123. }
  1124. /*
  1125. * Open an eventpoll file descriptor.
  1126. */
  1127. SYSCALL_DEFINE1(epoll_create1, int, flags)
  1128. {
  1129. int error;
  1130. struct eventpoll *ep = NULL;
  1131. /* Check the EPOLL_* constant for consistency. */
  1132. BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
  1133. if (flags & ~EPOLL_CLOEXEC)
  1134. return -EINVAL;
  1135. /*
  1136. * Create the internal data structure ("struct eventpoll").
  1137. */
  1138. error = ep_alloc(&ep);
  1139. if (error < 0)
  1140. return error;
  1141. /*
  1142. * Creates all the items needed to setup an eventpoll file. That is,
  1143. * a file structure and a free file descriptor.
  1144. */
  1145. error = anon_inode_getfd("[eventpoll]", &eventpoll_fops, ep,
  1146. O_RDWR | (flags & O_CLOEXEC));
  1147. if (error < 0)
  1148. ep_free(ep);
  1149. return error;
  1150. }
  1151. SYSCALL_DEFINE1(epoll_create, int, size)
  1152. {
  1153. if (size <= 0)
  1154. return -EINVAL;
  1155. return sys_epoll_create1(0);
  1156. }
  1157. /*
  1158. * The following function implements the controller interface for
  1159. * the eventpoll file that enables the insertion/removal/change of
  1160. * file descriptors inside the interest set.
  1161. */
  1162. SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
  1163. struct epoll_event __user *, event)
  1164. {
  1165. int error;
  1166. int did_lock_epmutex = 0;
  1167. struct file *file, *tfile;
  1168. struct eventpoll *ep;
  1169. struct epitem *epi;
  1170. struct epoll_event epds;
  1171. error = -EFAULT;
  1172. if (ep_op_has_event(op) &&
  1173. copy_from_user(&epds, event, sizeof(struct epoll_event)))
  1174. goto error_return;
  1175. /* Get the "struct file *" for the eventpoll file */
  1176. error = -EBADF;
  1177. file = fget(epfd);
  1178. if (!file)
  1179. goto error_return;
  1180. /* Get the "struct file *" for the target file */
  1181. tfile = fget(fd);
  1182. if (!tfile)
  1183. goto error_fput;
  1184. /* The target file descriptor must support poll */
  1185. error = -EPERM;
  1186. if (!tfile->f_op || !tfile->f_op->poll)
  1187. goto error_tgt_fput;
  1188. /*
  1189. * We have to check that the file structure underneath the file descriptor
  1190. * the user passed to us _is_ an eventpoll file. And also we do not permit
  1191. * adding an epoll file descriptor inside itself.
  1192. */
  1193. error = -EINVAL;
  1194. if (file == tfile || !is_file_epoll(file))
  1195. goto error_tgt_fput;
  1196. /*
  1197. * At this point it is safe to assume that the "private_data" contains
  1198. * our own data structure.
  1199. */
  1200. ep = file->private_data;
  1201. /*
  1202. * When we insert an epoll file descriptor, inside another epoll file
  1203. * descriptor, there is the change of creating closed loops, which are
  1204. * better be handled here, than in more critical paths.
  1205. *
  1206. * We hold epmutex across the loop check and the insert in this case, in
  1207. * order to prevent two separate inserts from racing and each doing the
  1208. * insert "at the same time" such that ep_loop_check passes on both
  1209. * before either one does the insert, thereby creating a cycle.
  1210. */
  1211. if (unlikely(is_file_epoll(tfile) && op == EPOLL_CTL_ADD)) {
  1212. mutex_lock(&epmutex);
  1213. did_lock_epmutex = 1;
  1214. error = -ELOOP;
  1215. if (ep_loop_check(ep, tfile) != 0)
  1216. goto error_tgt_fput;
  1217. }
  1218. mutex_lock_nested(&ep->mtx, 0);
  1219. /*
  1220. * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
  1221. * above, we can be sure to be able to use the item looked up by
  1222. * ep_find() till we release the mutex.
  1223. */
  1224. epi = ep_find(ep, tfile, fd);
  1225. error = -EINVAL;
  1226. switch (op) {
  1227. case EPOLL_CTL_ADD:
  1228. if (!epi) {
  1229. epds.events |= POLLERR | POLLHUP;
  1230. error = ep_insert(ep, &epds, tfile, fd);
  1231. } else
  1232. error = -EEXIST;
  1233. break;
  1234. case EPOLL_CTL_DEL:
  1235. if (epi)
  1236. error = ep_remove(ep, epi);
  1237. else
  1238. error = -ENOENT;
  1239. break;
  1240. case EPOLL_CTL_MOD:
  1241. if (epi) {
  1242. epds.events |= POLLERR | POLLHUP;
  1243. error = ep_modify(ep, epi, &epds);
  1244. } else
  1245. error = -ENOENT;
  1246. break;
  1247. }
  1248. mutex_unlock(&ep->mtx);
  1249. error_tgt_fput:
  1250. if (unlikely(did_lock_epmutex))
  1251. mutex_unlock(&epmutex);
  1252. fput(tfile);
  1253. error_fput:
  1254. fput(file);
  1255. error_return:
  1256. return error;
  1257. }
  1258. /*
  1259. * Implement the event wait interface for the eventpoll file. It is the kernel
  1260. * part of the user space epoll_wait(2).
  1261. */
  1262. SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
  1263. int, maxevents, int, timeout)
  1264. {
  1265. int error;
  1266. struct file *file;
  1267. struct eventpoll *ep;
  1268. /* The maximum number of event must be greater than zero */
  1269. if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
  1270. return -EINVAL;
  1271. /* Verify that the area passed by the user is writeable */
  1272. if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event))) {
  1273. error = -EFAULT;
  1274. goto error_return;
  1275. }
  1276. /* Get the "struct file *" for the eventpoll file */
  1277. error = -EBADF;
  1278. file = fget(epfd);
  1279. if (!file)
  1280. goto error_return;
  1281. /*
  1282. * We have to check that the file structure underneath the fd
  1283. * the user passed to us _is_ an eventpoll file.
  1284. */
  1285. error = -EINVAL;
  1286. if (!is_file_epoll(file))
  1287. goto error_fput;
  1288. /*
  1289. * At this point it is safe to assume that the "private_data" contains
  1290. * our own data structure.
  1291. */
  1292. ep = file->private_data;
  1293. /* Time to fish for events ... */
  1294. error = ep_poll(ep, events, maxevents, timeout);
  1295. error_fput:
  1296. fput(file);
  1297. error_return:
  1298. return error;
  1299. }
  1300. #ifdef HAVE_SET_RESTORE_SIGMASK
  1301. /*
  1302. * Implement the event wait interface for the eventpoll file. It is the kernel
  1303. * part of the user space epoll_pwait(2).
  1304. */
  1305. SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
  1306. int, maxevents, int, timeout, const sigset_t __user *, sigmask,
  1307. size_t, sigsetsize)
  1308. {
  1309. int error;
  1310. sigset_t ksigmask, sigsaved;
  1311. /*
  1312. * If the caller wants a certain signal mask to be set during the wait,
  1313. * we apply it here.
  1314. */
  1315. if (sigmask) {
  1316. if (sigsetsize != sizeof(sigset_t))
  1317. return -EINVAL;
  1318. if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
  1319. return -EFAULT;
  1320. sigdelsetmask(&ksigmask, sigmask(SIGKILL) | sigmask(SIGSTOP));
  1321. sigprocmask(SIG_SETMASK, &ksigmask, &sigsaved);
  1322. }
  1323. error = sys_epoll_wait(epfd, events, maxevents, timeout);
  1324. /*
  1325. * If we changed the signal mask, we need to restore the original one.
  1326. * In case we've got a signal while waiting, we do not restore the
  1327. * signal mask yet, and we allow do_signal() to deliver the signal on
  1328. * the way back to userspace, before the signal mask is restored.
  1329. */
  1330. if (sigmask) {
  1331. if (error == -EINTR) {
  1332. memcpy(&current->saved_sigmask, &sigsaved,
  1333. sizeof(sigsaved));
  1334. set_restore_sigmask();
  1335. } else
  1336. sigprocmask(SIG_SETMASK, &sigsaved, NULL);
  1337. }
  1338. return error;
  1339. }
  1340. #endif /* HAVE_SET_RESTORE_SIGMASK */
  1341. static int __init eventpoll_init(void)
  1342. {
  1343. struct sysinfo si;
  1344. si_meminfo(&si);
  1345. /*
  1346. * Allows top 4% of lomem to be allocated for epoll watches (per user).
  1347. */
  1348. max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
  1349. EP_ITEM_COST;
  1350. BUG_ON(max_user_watches < 0);
  1351. /*
  1352. * Initialize the structure used to perform epoll file descriptor
  1353. * inclusion loops checks.
  1354. */
  1355. ep_nested_calls_init(&poll_loop_ncalls);
  1356. /* Initialize the structure used to perform safe poll wait head wake ups */
  1357. ep_nested_calls_init(&poll_safewake_ncalls);
  1358. /* Initialize the structure used to perform file's f_op->poll() calls */
  1359. ep_nested_calls_init(&poll_readywalk_ncalls);
  1360. /* Allocates slab cache used to allocate "struct epitem" items */
  1361. epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
  1362. 0, SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
  1363. /* Allocates slab cache used to allocate "struct eppoll_entry" */
  1364. pwq_cache = kmem_cache_create("eventpoll_pwq",
  1365. sizeof(struct eppoll_entry), 0, SLAB_PANIC, NULL);
  1366. return 0;
  1367. }
  1368. fs_initcall(eventpoll_init);