eventpoll.c 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331
  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/signal.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 <linux/device.h>
  36. #include <linux/uaccess.h>
  37. #include <asm/io.h>
  38. #include <asm/mman.h>
  39. #include <linux/atomic.h>
  40. #include <linux/proc_fs.h>
  41. #include <linux/seq_file.h>
  42. #include <linux/compat.h>
  43. #include <linux/rculist.h>
  44. #include <net/busy_poll.h>
  45. /*
  46. * LOCKING:
  47. * There are three level of locking required by epoll :
  48. *
  49. * 1) epmutex (mutex)
  50. * 2) ep->mtx (mutex)
  51. * 3) ep->lock (spinlock)
  52. *
  53. * The acquire order is the one listed above, from 1 to 3.
  54. * We need a spinlock (ep->lock) because we manipulate objects
  55. * from inside the poll callback, that might be triggered from
  56. * a wake_up() that in turn might be called from IRQ context.
  57. * So we can't sleep inside the poll callback and hence we need
  58. * a spinlock. During the event transfer loop (from kernel to
  59. * user space) we could end up sleeping due a copy_to_user(), so
  60. * we need a lock that will allow us to sleep. This lock is a
  61. * mutex (ep->mtx). It is acquired during the event transfer loop,
  62. * during epoll_ctl(EPOLL_CTL_DEL) and during eventpoll_release_file().
  63. * Then we also need a global mutex to serialize eventpoll_release_file()
  64. * and ep_free().
  65. * This mutex is acquired by ep_free() during the epoll file
  66. * cleanup path and it is also acquired by eventpoll_release_file()
  67. * if a file has been pushed inside an epoll set and it is then
  68. * close()d without a previous call to epoll_ctl(EPOLL_CTL_DEL).
  69. * It is also acquired when inserting an epoll fd onto another epoll
  70. * fd. We do this so that we walk the epoll tree and ensure that this
  71. * insertion does not create a cycle of epoll file descriptors, which
  72. * could lead to deadlock. We need a global mutex to prevent two
  73. * simultaneous inserts (A into B and B into A) from racing and
  74. * constructing a cycle without either insert observing that it is
  75. * going to.
  76. * It is necessary to acquire multiple "ep->mtx"es at once in the
  77. * case when one epoll fd is added to another. In this case, we
  78. * always acquire the locks in the order of nesting (i.e. after
  79. * epoll_ctl(e1, EPOLL_CTL_ADD, e2), e1->mtx will always be acquired
  80. * before e2->mtx). Since we disallow cycles of epoll file
  81. * descriptors, this ensures that the mutexes are well-ordered. In
  82. * order to communicate this nesting to lockdep, when walking a tree
  83. * of epoll file descriptors, we use the current recursion depth as
  84. * the lockdep subkey.
  85. * It is possible to drop the "ep->mtx" and to use the global
  86. * mutex "epmutex" (together with "ep->lock") to have it working,
  87. * but having "ep->mtx" will make the interface more scalable.
  88. * Events that require holding "epmutex" are very rare, while for
  89. * normal operations the epoll private "ep->mtx" will guarantee
  90. * a better scalability.
  91. */
  92. /* Epoll private bits inside the event mask */
  93. #define EP_PRIVATE_BITS (EPOLLWAKEUP | EPOLLONESHOT | EPOLLET | EPOLLEXCLUSIVE)
  94. #define EPOLLINOUT_BITS (EPOLLIN | EPOLLOUT)
  95. #define EPOLLEXCLUSIVE_OK_BITS (EPOLLINOUT_BITS | EPOLLERR | EPOLLHUP | \
  96. EPOLLWAKEUP | EPOLLET | EPOLLEXCLUSIVE)
  97. /* Maximum number of nesting allowed inside epoll sets */
  98. #define EP_MAX_NESTS 4
  99. #define EP_MAX_EVENTS (INT_MAX / sizeof(struct epoll_event))
  100. #define EP_UNACTIVE_PTR ((void *) -1L)
  101. #define EP_ITEM_COST (sizeof(struct epitem) + sizeof(struct eppoll_entry))
  102. struct epoll_filefd {
  103. struct file *file;
  104. int fd;
  105. } __packed;
  106. /*
  107. * Structure used to track possible nested calls, for too deep recursions
  108. * and loop cycles.
  109. */
  110. struct nested_call_node {
  111. struct list_head llink;
  112. void *cookie;
  113. void *ctx;
  114. };
  115. /*
  116. * This structure is used as collector for nested calls, to check for
  117. * maximum recursion dept and loop cycles.
  118. */
  119. struct nested_calls {
  120. struct list_head tasks_call_list;
  121. spinlock_t lock;
  122. };
  123. /*
  124. * Each file descriptor added to the eventpoll interface will
  125. * have an entry of this type linked to the "rbr" RB tree.
  126. * Avoid increasing the size of this struct, there can be many thousands
  127. * of these on a server and we do not want this to take another cache line.
  128. */
  129. struct epitem {
  130. union {
  131. /* RB tree node links this structure to the eventpoll RB tree */
  132. struct rb_node rbn;
  133. /* Used to free the struct epitem */
  134. struct rcu_head rcu;
  135. };
  136. /* List header used to link this structure to the eventpoll ready list */
  137. struct list_head rdllink;
  138. /*
  139. * Works together "struct eventpoll"->ovflist in keeping the
  140. * single linked chain of items.
  141. */
  142. struct epitem *next;
  143. /* The file descriptor information this item refers to */
  144. struct epoll_filefd ffd;
  145. /* Number of active wait queue attached to poll operations */
  146. int nwait;
  147. /* List containing poll wait queues */
  148. struct list_head pwqlist;
  149. /* The "container" of this item */
  150. struct eventpoll *ep;
  151. /* List header used to link this item to the "struct file" items list */
  152. struct list_head fllink;
  153. /* wakeup_source used when EPOLLWAKEUP is set */
  154. struct wakeup_source __rcu *ws;
  155. /* The structure that describe the interested events and the source fd */
  156. struct epoll_event event;
  157. };
  158. /*
  159. * This structure is stored inside the "private_data" member of the file
  160. * structure and represents the main data structure for the eventpoll
  161. * interface.
  162. */
  163. struct eventpoll {
  164. /* Protect the access to this structure */
  165. spinlock_t lock;
  166. /*
  167. * This mutex is used to ensure that files are not removed
  168. * while epoll is using them. This is held during the event
  169. * collection loop, the file cleanup path, the epoll file exit
  170. * code and the ctl operations.
  171. */
  172. struct mutex mtx;
  173. /* Wait queue used by sys_epoll_wait() */
  174. wait_queue_head_t wq;
  175. /* Wait queue used by file->poll() */
  176. wait_queue_head_t poll_wait;
  177. /* List of ready file descriptors */
  178. struct list_head rdllist;
  179. /* RB tree root used to store monitored fd structs */
  180. struct rb_root_cached rbr;
  181. /*
  182. * This is a single linked list that chains all the "struct epitem" that
  183. * happened while transferring ready events to userspace w/out
  184. * holding ->lock.
  185. */
  186. struct epitem *ovflist;
  187. /* wakeup_source used when ep_scan_ready_list is running */
  188. struct wakeup_source *ws;
  189. /* The user that created the eventpoll descriptor */
  190. struct user_struct *user;
  191. struct file *file;
  192. /* used to optimize loop detection check */
  193. int visited;
  194. struct list_head visited_list_link;
  195. #ifdef CONFIG_NET_RX_BUSY_POLL
  196. /* used to track busy poll napi_id */
  197. unsigned int napi_id;
  198. #endif
  199. };
  200. /* Wait structure used by the poll hooks */
  201. struct eppoll_entry {
  202. /* List header used to link this structure to the "struct epitem" */
  203. struct list_head llink;
  204. /* The "base" pointer is set to the container "struct epitem" */
  205. struct epitem *base;
  206. /*
  207. * Wait queue item that will be linked to the target file wait
  208. * queue head.
  209. */
  210. wait_queue_entry_t wait;
  211. /* The wait queue head that linked the "wait" wait queue item */
  212. wait_queue_head_t *whead;
  213. };
  214. /* Wrapper struct used by poll queueing */
  215. struct ep_pqueue {
  216. poll_table pt;
  217. struct epitem *epi;
  218. };
  219. /* Used by the ep_send_events() function as callback private data */
  220. struct ep_send_events_data {
  221. int maxevents;
  222. struct epoll_event __user *events;
  223. int res;
  224. };
  225. /*
  226. * Configuration options available inside /proc/sys/fs/epoll/
  227. */
  228. /* Maximum number of epoll watched descriptors, per user */
  229. static long max_user_watches __read_mostly;
  230. /*
  231. * This mutex is used to serialize ep_free() and eventpoll_release_file().
  232. */
  233. static DEFINE_MUTEX(epmutex);
  234. /* Used to check for epoll file descriptor inclusion loops */
  235. static struct nested_calls poll_loop_ncalls;
  236. /* Slab cache used to allocate "struct epitem" */
  237. static struct kmem_cache *epi_cache __read_mostly;
  238. /* Slab cache used to allocate "struct eppoll_entry" */
  239. static struct kmem_cache *pwq_cache __read_mostly;
  240. /* Visited nodes during ep_loop_check(), so we can unset them when we finish */
  241. static LIST_HEAD(visited_list);
  242. /*
  243. * List of files with newly added links, where we may need to limit the number
  244. * of emanating paths. Protected by the epmutex.
  245. */
  246. static LIST_HEAD(tfile_check_list);
  247. #ifdef CONFIG_SYSCTL
  248. #include <linux/sysctl.h>
  249. static long zero;
  250. static long long_max = LONG_MAX;
  251. struct ctl_table epoll_table[] = {
  252. {
  253. .procname = "max_user_watches",
  254. .data = &max_user_watches,
  255. .maxlen = sizeof(max_user_watches),
  256. .mode = 0644,
  257. .proc_handler = proc_doulongvec_minmax,
  258. .extra1 = &zero,
  259. .extra2 = &long_max,
  260. },
  261. { }
  262. };
  263. #endif /* CONFIG_SYSCTL */
  264. static const struct file_operations eventpoll_fops;
  265. static inline int is_file_epoll(struct file *f)
  266. {
  267. return f->f_op == &eventpoll_fops;
  268. }
  269. /* Setup the structure that is used as key for the RB tree */
  270. static inline void ep_set_ffd(struct epoll_filefd *ffd,
  271. struct file *file, int fd)
  272. {
  273. ffd->file = file;
  274. ffd->fd = fd;
  275. }
  276. /* Compare RB tree keys */
  277. static inline int ep_cmp_ffd(struct epoll_filefd *p1,
  278. struct epoll_filefd *p2)
  279. {
  280. return (p1->file > p2->file ? +1:
  281. (p1->file < p2->file ? -1 : p1->fd - p2->fd));
  282. }
  283. /* Tells us if the item is currently linked */
  284. static inline int ep_is_linked(struct list_head *p)
  285. {
  286. return !list_empty(p);
  287. }
  288. static inline struct eppoll_entry *ep_pwq_from_wait(wait_queue_entry_t *p)
  289. {
  290. return container_of(p, struct eppoll_entry, wait);
  291. }
  292. /* Get the "struct epitem" from a wait queue pointer */
  293. static inline struct epitem *ep_item_from_wait(wait_queue_entry_t *p)
  294. {
  295. return container_of(p, struct eppoll_entry, wait)->base;
  296. }
  297. /* Get the "struct epitem" from an epoll queue wrapper */
  298. static inline struct epitem *ep_item_from_epqueue(poll_table *p)
  299. {
  300. return container_of(p, struct ep_pqueue, pt)->epi;
  301. }
  302. /* Tells if the epoll_ctl(2) operation needs an event copy from userspace */
  303. static inline int ep_op_has_event(int op)
  304. {
  305. return op != EPOLL_CTL_DEL;
  306. }
  307. /* Initialize the poll safe wake up structure */
  308. static void ep_nested_calls_init(struct nested_calls *ncalls)
  309. {
  310. INIT_LIST_HEAD(&ncalls->tasks_call_list);
  311. spin_lock_init(&ncalls->lock);
  312. }
  313. /**
  314. * ep_events_available - Checks if ready events might be available.
  315. *
  316. * @ep: Pointer to the eventpoll context.
  317. *
  318. * Returns: Returns a value different than zero if ready events are available,
  319. * or zero otherwise.
  320. */
  321. static inline int ep_events_available(struct eventpoll *ep)
  322. {
  323. return !list_empty(&ep->rdllist) || ep->ovflist != EP_UNACTIVE_PTR;
  324. }
  325. #ifdef CONFIG_NET_RX_BUSY_POLL
  326. static bool ep_busy_loop_end(void *p, unsigned long start_time)
  327. {
  328. struct eventpoll *ep = p;
  329. return ep_events_available(ep) || busy_loop_timeout(start_time);
  330. }
  331. #endif /* CONFIG_NET_RX_BUSY_POLL */
  332. /*
  333. * Busy poll if globally on and supporting sockets found && no events,
  334. * busy loop will return if need_resched or ep_events_available.
  335. *
  336. * we must do our busy polling with irqs enabled
  337. */
  338. static void ep_busy_loop(struct eventpoll *ep, int nonblock)
  339. {
  340. #ifdef CONFIG_NET_RX_BUSY_POLL
  341. unsigned int napi_id = READ_ONCE(ep->napi_id);
  342. if ((napi_id >= MIN_NAPI_ID) && net_busy_loop_on())
  343. napi_busy_loop(napi_id, nonblock ? NULL : ep_busy_loop_end, ep);
  344. #endif
  345. }
  346. static inline void ep_reset_busy_poll_napi_id(struct eventpoll *ep)
  347. {
  348. #ifdef CONFIG_NET_RX_BUSY_POLL
  349. if (ep->napi_id)
  350. ep->napi_id = 0;
  351. #endif
  352. }
  353. /*
  354. * Set epoll busy poll NAPI ID from sk.
  355. */
  356. static inline void ep_set_busy_poll_napi_id(struct epitem *epi)
  357. {
  358. #ifdef CONFIG_NET_RX_BUSY_POLL
  359. struct eventpoll *ep;
  360. unsigned int napi_id;
  361. struct socket *sock;
  362. struct sock *sk;
  363. int err;
  364. if (!net_busy_loop_on())
  365. return;
  366. sock = sock_from_file(epi->ffd.file, &err);
  367. if (!sock)
  368. return;
  369. sk = sock->sk;
  370. if (!sk)
  371. return;
  372. napi_id = READ_ONCE(sk->sk_napi_id);
  373. ep = epi->ep;
  374. /* Non-NAPI IDs can be rejected
  375. * or
  376. * Nothing to do if we already have this ID
  377. */
  378. if (napi_id < MIN_NAPI_ID || napi_id == ep->napi_id)
  379. return;
  380. /* record NAPI ID for use in next busy poll */
  381. ep->napi_id = napi_id;
  382. #endif
  383. }
  384. /**
  385. * ep_call_nested - Perform a bound (possibly) nested call, by checking
  386. * that the recursion limit is not exceeded, and that
  387. * the same nested call (by the meaning of same cookie) is
  388. * no re-entered.
  389. *
  390. * @ncalls: Pointer to the nested_calls structure to be used for this call.
  391. * @max_nests: Maximum number of allowed nesting calls.
  392. * @nproc: Nested call core function pointer.
  393. * @priv: Opaque data to be passed to the @nproc callback.
  394. * @cookie: Cookie to be used to identify this nested call.
  395. * @ctx: This instance context.
  396. *
  397. * Returns: Returns the code returned by the @nproc callback, or -1 if
  398. * the maximum recursion limit has been exceeded.
  399. */
  400. static int ep_call_nested(struct nested_calls *ncalls, int max_nests,
  401. int (*nproc)(void *, void *, int), void *priv,
  402. void *cookie, void *ctx)
  403. {
  404. int error, call_nests = 0;
  405. unsigned long flags;
  406. struct list_head *lsthead = &ncalls->tasks_call_list;
  407. struct nested_call_node *tncur;
  408. struct nested_call_node tnode;
  409. spin_lock_irqsave(&ncalls->lock, flags);
  410. /*
  411. * Try to see if the current task is already inside this wakeup call.
  412. * We use a list here, since the population inside this set is always
  413. * very much limited.
  414. */
  415. list_for_each_entry(tncur, lsthead, llink) {
  416. if (tncur->ctx == ctx &&
  417. (tncur->cookie == cookie || ++call_nests > max_nests)) {
  418. /*
  419. * Ops ... loop detected or maximum nest level reached.
  420. * We abort this wake by breaking the cycle itself.
  421. */
  422. error = -1;
  423. goto out_unlock;
  424. }
  425. }
  426. /* Add the current task and cookie to the list */
  427. tnode.ctx = ctx;
  428. tnode.cookie = cookie;
  429. list_add(&tnode.llink, lsthead);
  430. spin_unlock_irqrestore(&ncalls->lock, flags);
  431. /* Call the nested function */
  432. error = (*nproc)(priv, cookie, call_nests);
  433. /* Remove the current task from the list */
  434. spin_lock_irqsave(&ncalls->lock, flags);
  435. list_del(&tnode.llink);
  436. out_unlock:
  437. spin_unlock_irqrestore(&ncalls->lock, flags);
  438. return error;
  439. }
  440. /*
  441. * As described in commit 0ccf831cb lockdep: annotate epoll
  442. * the use of wait queues used by epoll is done in a very controlled
  443. * manner. Wake ups can nest inside each other, but are never done
  444. * with the same locking. For example:
  445. *
  446. * dfd = socket(...);
  447. * efd1 = epoll_create();
  448. * efd2 = epoll_create();
  449. * epoll_ctl(efd1, EPOLL_CTL_ADD, dfd, ...);
  450. * epoll_ctl(efd2, EPOLL_CTL_ADD, efd1, ...);
  451. *
  452. * When a packet arrives to the device underneath "dfd", the net code will
  453. * issue a wake_up() on its poll wake list. Epoll (efd1) has installed a
  454. * callback wakeup entry on that queue, and the wake_up() performed by the
  455. * "dfd" net code will end up in ep_poll_callback(). At this point epoll
  456. * (efd1) notices that it may have some event ready, so it needs to wake up
  457. * the waiters on its poll wait list (efd2). So it calls ep_poll_safewake()
  458. * that ends up in another wake_up(), after having checked about the
  459. * recursion constraints. That are, no more than EP_MAX_POLLWAKE_NESTS, to
  460. * avoid stack blasting.
  461. *
  462. * When CONFIG_DEBUG_LOCK_ALLOC is enabled, make sure lockdep can handle
  463. * this special case of epoll.
  464. */
  465. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  466. static struct nested_calls poll_safewake_ncalls;
  467. static int ep_poll_wakeup_proc(void *priv, void *cookie, int call_nests)
  468. {
  469. unsigned long flags;
  470. wait_queue_head_t *wqueue = (wait_queue_head_t *)cookie;
  471. spin_lock_irqsave_nested(&wqueue->lock, flags, call_nests + 1);
  472. wake_up_locked_poll(wqueue, EPOLLIN);
  473. spin_unlock_irqrestore(&wqueue->lock, flags);
  474. return 0;
  475. }
  476. static void ep_poll_safewake(wait_queue_head_t *wq)
  477. {
  478. int this_cpu = get_cpu();
  479. ep_call_nested(&poll_safewake_ncalls, EP_MAX_NESTS,
  480. ep_poll_wakeup_proc, NULL, wq, (void *) (long) this_cpu);
  481. put_cpu();
  482. }
  483. #else
  484. static void ep_poll_safewake(wait_queue_head_t *wq)
  485. {
  486. wake_up_poll(wq, EPOLLIN);
  487. }
  488. #endif
  489. static void ep_remove_wait_queue(struct eppoll_entry *pwq)
  490. {
  491. wait_queue_head_t *whead;
  492. rcu_read_lock();
  493. /*
  494. * If it is cleared by POLLFREE, it should be rcu-safe.
  495. * If we read NULL we need a barrier paired with
  496. * smp_store_release() in ep_poll_callback(), otherwise
  497. * we rely on whead->lock.
  498. */
  499. whead = smp_load_acquire(&pwq->whead);
  500. if (whead)
  501. remove_wait_queue(whead, &pwq->wait);
  502. rcu_read_unlock();
  503. }
  504. /*
  505. * This function unregisters poll callbacks from the associated file
  506. * descriptor. Must be called with "mtx" held (or "epmutex" if called from
  507. * ep_free).
  508. */
  509. static void ep_unregister_pollwait(struct eventpoll *ep, struct epitem *epi)
  510. {
  511. struct list_head *lsthead = &epi->pwqlist;
  512. struct eppoll_entry *pwq;
  513. while (!list_empty(lsthead)) {
  514. pwq = list_first_entry(lsthead, struct eppoll_entry, llink);
  515. list_del(&pwq->llink);
  516. ep_remove_wait_queue(pwq);
  517. kmem_cache_free(pwq_cache, pwq);
  518. }
  519. }
  520. /* call only when ep->mtx is held */
  521. static inline struct wakeup_source *ep_wakeup_source(struct epitem *epi)
  522. {
  523. return rcu_dereference_check(epi->ws, lockdep_is_held(&epi->ep->mtx));
  524. }
  525. /* call only when ep->mtx is held */
  526. static inline void ep_pm_stay_awake(struct epitem *epi)
  527. {
  528. struct wakeup_source *ws = ep_wakeup_source(epi);
  529. if (ws)
  530. __pm_stay_awake(ws);
  531. }
  532. static inline bool ep_has_wakeup_source(struct epitem *epi)
  533. {
  534. return rcu_access_pointer(epi->ws) ? true : false;
  535. }
  536. /* call when ep->mtx cannot be held (ep_poll_callback) */
  537. static inline void ep_pm_stay_awake_rcu(struct epitem *epi)
  538. {
  539. struct wakeup_source *ws;
  540. rcu_read_lock();
  541. ws = rcu_dereference(epi->ws);
  542. if (ws)
  543. __pm_stay_awake(ws);
  544. rcu_read_unlock();
  545. }
  546. /**
  547. * ep_scan_ready_list - Scans the ready list in a way that makes possible for
  548. * the scan code, to call f_op->poll(). Also allows for
  549. * O(NumReady) performance.
  550. *
  551. * @ep: Pointer to the epoll private data structure.
  552. * @sproc: Pointer to the scan callback.
  553. * @priv: Private opaque data passed to the @sproc callback.
  554. * @depth: The current depth of recursive f_op->poll calls.
  555. * @ep_locked: caller already holds ep->mtx
  556. *
  557. * Returns: The same integer error code returned by the @sproc callback.
  558. */
  559. static __poll_t ep_scan_ready_list(struct eventpoll *ep,
  560. __poll_t (*sproc)(struct eventpoll *,
  561. struct list_head *, void *),
  562. void *priv, int depth, bool ep_locked)
  563. {
  564. __poll_t res;
  565. int pwake = 0;
  566. unsigned long flags;
  567. struct epitem *epi, *nepi;
  568. LIST_HEAD(txlist);
  569. /*
  570. * We need to lock this because we could be hit by
  571. * eventpoll_release_file() and epoll_ctl().
  572. */
  573. if (!ep_locked)
  574. mutex_lock_nested(&ep->mtx, depth);
  575. /*
  576. * Steal the ready list, and re-init the original one to the
  577. * empty list. Also, set ep->ovflist to NULL so that events
  578. * happening while looping w/out locks, are not lost. We cannot
  579. * have the poll callback to queue directly on ep->rdllist,
  580. * because we want the "sproc" callback to be able to do it
  581. * in a lockless way.
  582. */
  583. spin_lock_irqsave(&ep->lock, flags);
  584. list_splice_init(&ep->rdllist, &txlist);
  585. ep->ovflist = NULL;
  586. spin_unlock_irqrestore(&ep->lock, flags);
  587. /*
  588. * Now call the callback function.
  589. */
  590. res = (*sproc)(ep, &txlist, priv);
  591. spin_lock_irqsave(&ep->lock, flags);
  592. /*
  593. * During the time we spent inside the "sproc" callback, some
  594. * other events might have been queued by the poll callback.
  595. * We re-insert them inside the main ready-list here.
  596. */
  597. for (nepi = ep->ovflist; (epi = nepi) != NULL;
  598. nepi = epi->next, epi->next = EP_UNACTIVE_PTR) {
  599. /*
  600. * We need to check if the item is already in the list.
  601. * During the "sproc" callback execution time, items are
  602. * queued into ->ovflist but the "txlist" might already
  603. * contain them, and the list_splice() below takes care of them.
  604. */
  605. if (!ep_is_linked(&epi->rdllink)) {
  606. list_add_tail(&epi->rdllink, &ep->rdllist);
  607. ep_pm_stay_awake(epi);
  608. }
  609. }
  610. /*
  611. * We need to set back ep->ovflist to EP_UNACTIVE_PTR, so that after
  612. * releasing the lock, events will be queued in the normal way inside
  613. * ep->rdllist.
  614. */
  615. ep->ovflist = EP_UNACTIVE_PTR;
  616. /*
  617. * Quickly re-inject items left on "txlist".
  618. */
  619. list_splice(&txlist, &ep->rdllist);
  620. __pm_relax(ep->ws);
  621. if (!list_empty(&ep->rdllist)) {
  622. /*
  623. * Wake up (if active) both the eventpoll wait list and
  624. * the ->poll() wait list (delayed after we release the lock).
  625. */
  626. if (waitqueue_active(&ep->wq))
  627. wake_up_locked(&ep->wq);
  628. if (waitqueue_active(&ep->poll_wait))
  629. pwake++;
  630. }
  631. spin_unlock_irqrestore(&ep->lock, flags);
  632. if (!ep_locked)
  633. mutex_unlock(&ep->mtx);
  634. /* We have to call this outside the lock */
  635. if (pwake)
  636. ep_poll_safewake(&ep->poll_wait);
  637. return res;
  638. }
  639. static void epi_rcu_free(struct rcu_head *head)
  640. {
  641. struct epitem *epi = container_of(head, struct epitem, rcu);
  642. kmem_cache_free(epi_cache, epi);
  643. }
  644. /*
  645. * Removes a "struct epitem" from the eventpoll RB tree and deallocates
  646. * all the associated resources. Must be called with "mtx" held.
  647. */
  648. static int ep_remove(struct eventpoll *ep, struct epitem *epi)
  649. {
  650. unsigned long flags;
  651. struct file *file = epi->ffd.file;
  652. /*
  653. * Removes poll wait queue hooks. We _have_ to do this without holding
  654. * the "ep->lock" otherwise a deadlock might occur. This because of the
  655. * sequence of the lock acquisition. Here we do "ep->lock" then the wait
  656. * queue head lock when unregistering the wait queue. The wakeup callback
  657. * will run by holding the wait queue head lock and will call our callback
  658. * that will try to get "ep->lock".
  659. */
  660. ep_unregister_pollwait(ep, epi);
  661. /* Remove the current item from the list of epoll hooks */
  662. spin_lock(&file->f_lock);
  663. list_del_rcu(&epi->fllink);
  664. spin_unlock(&file->f_lock);
  665. rb_erase_cached(&epi->rbn, &ep->rbr);
  666. spin_lock_irqsave(&ep->lock, flags);
  667. if (ep_is_linked(&epi->rdllink))
  668. list_del_init(&epi->rdllink);
  669. spin_unlock_irqrestore(&ep->lock, flags);
  670. wakeup_source_unregister(ep_wakeup_source(epi));
  671. /*
  672. * At this point it is safe to free the eventpoll item. Use the union
  673. * field epi->rcu, since we are trying to minimize the size of
  674. * 'struct epitem'. The 'rbn' field is no longer in use. Protected by
  675. * ep->mtx. The rcu read side, reverse_path_check_proc(), does not make
  676. * use of the rbn field.
  677. */
  678. call_rcu(&epi->rcu, epi_rcu_free);
  679. atomic_long_dec(&ep->user->epoll_watches);
  680. return 0;
  681. }
  682. static void ep_free(struct eventpoll *ep)
  683. {
  684. struct rb_node *rbp;
  685. struct epitem *epi;
  686. /* We need to release all tasks waiting for these file */
  687. if (waitqueue_active(&ep->poll_wait))
  688. ep_poll_safewake(&ep->poll_wait);
  689. /*
  690. * We need to lock this because we could be hit by
  691. * eventpoll_release_file() while we're freeing the "struct eventpoll".
  692. * We do not need to hold "ep->mtx" here because the epoll file
  693. * is on the way to be removed and no one has references to it
  694. * anymore. The only hit might come from eventpoll_release_file() but
  695. * holding "epmutex" is sufficient here.
  696. */
  697. mutex_lock(&epmutex);
  698. /*
  699. * Walks through the whole tree by unregistering poll callbacks.
  700. */
  701. for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  702. epi = rb_entry(rbp, struct epitem, rbn);
  703. ep_unregister_pollwait(ep, epi);
  704. cond_resched();
  705. }
  706. /*
  707. * Walks through the whole tree by freeing each "struct epitem". At this
  708. * point we are sure no poll callbacks will be lingering around, and also by
  709. * holding "epmutex" we can be sure that no file cleanup code will hit
  710. * us during this operation. So we can avoid the lock on "ep->lock".
  711. * We do not need to lock ep->mtx, either, we only do it to prevent
  712. * a lockdep warning.
  713. */
  714. mutex_lock(&ep->mtx);
  715. while ((rbp = rb_first_cached(&ep->rbr)) != NULL) {
  716. epi = rb_entry(rbp, struct epitem, rbn);
  717. ep_remove(ep, epi);
  718. cond_resched();
  719. }
  720. mutex_unlock(&ep->mtx);
  721. mutex_unlock(&epmutex);
  722. mutex_destroy(&ep->mtx);
  723. free_uid(ep->user);
  724. wakeup_source_unregister(ep->ws);
  725. kfree(ep);
  726. }
  727. static int ep_eventpoll_release(struct inode *inode, struct file *file)
  728. {
  729. struct eventpoll *ep = file->private_data;
  730. if (ep)
  731. ep_free(ep);
  732. return 0;
  733. }
  734. static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
  735. void *priv);
  736. static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
  737. poll_table *pt);
  738. /*
  739. * Differs from ep_eventpoll_poll() in that internal callers already have
  740. * the ep->mtx so we need to start from depth=1, such that mutex_lock_nested()
  741. * is correctly annotated.
  742. */
  743. static __poll_t ep_item_poll(const struct epitem *epi, poll_table *pt,
  744. int depth)
  745. {
  746. struct eventpoll *ep;
  747. bool locked;
  748. pt->_key = epi->event.events;
  749. if (!is_file_epoll(epi->ffd.file))
  750. return epi->ffd.file->f_op->poll(epi->ffd.file, pt) &
  751. epi->event.events;
  752. ep = epi->ffd.file->private_data;
  753. poll_wait(epi->ffd.file, &ep->poll_wait, pt);
  754. locked = pt && (pt->_qproc == ep_ptable_queue_proc);
  755. return ep_scan_ready_list(epi->ffd.file->private_data,
  756. ep_read_events_proc, &depth, depth,
  757. locked) & epi->event.events;
  758. }
  759. static __poll_t ep_read_events_proc(struct eventpoll *ep, struct list_head *head,
  760. void *priv)
  761. {
  762. struct epitem *epi, *tmp;
  763. poll_table pt;
  764. int depth = *(int *)priv;
  765. init_poll_funcptr(&pt, NULL);
  766. depth++;
  767. list_for_each_entry_safe(epi, tmp, head, rdllink) {
  768. if (ep_item_poll(epi, &pt, depth)) {
  769. return EPOLLIN | EPOLLRDNORM;
  770. } else {
  771. /*
  772. * Item has been dropped into the ready list by the poll
  773. * callback, but it's not actually ready, as far as
  774. * caller requested events goes. We can remove it here.
  775. */
  776. __pm_relax(ep_wakeup_source(epi));
  777. list_del_init(&epi->rdllink);
  778. }
  779. }
  780. return 0;
  781. }
  782. static __poll_t ep_eventpoll_poll(struct file *file, poll_table *wait)
  783. {
  784. struct eventpoll *ep = file->private_data;
  785. int depth = 0;
  786. /* Insert inside our poll wait queue */
  787. poll_wait(file, &ep->poll_wait, wait);
  788. /*
  789. * Proceed to find out if wanted events are really available inside
  790. * the ready list.
  791. */
  792. return ep_scan_ready_list(ep, ep_read_events_proc,
  793. &depth, depth, false);
  794. }
  795. #ifdef CONFIG_PROC_FS
  796. static void ep_show_fdinfo(struct seq_file *m, struct file *f)
  797. {
  798. struct eventpoll *ep = f->private_data;
  799. struct rb_node *rbp;
  800. mutex_lock(&ep->mtx);
  801. for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  802. struct epitem *epi = rb_entry(rbp, struct epitem, rbn);
  803. struct inode *inode = file_inode(epi->ffd.file);
  804. seq_printf(m, "tfd: %8d events: %8x data: %16llx "
  805. " pos:%lli ino:%lx sdev:%x\n",
  806. epi->ffd.fd, epi->event.events,
  807. (long long)epi->event.data,
  808. (long long)epi->ffd.file->f_pos,
  809. inode->i_ino, inode->i_sb->s_dev);
  810. if (seq_has_overflowed(m))
  811. break;
  812. }
  813. mutex_unlock(&ep->mtx);
  814. }
  815. #endif
  816. /* File callbacks that implement the eventpoll file behaviour */
  817. static const struct file_operations eventpoll_fops = {
  818. #ifdef CONFIG_PROC_FS
  819. .show_fdinfo = ep_show_fdinfo,
  820. #endif
  821. .release = ep_eventpoll_release,
  822. .poll = ep_eventpoll_poll,
  823. .llseek = noop_llseek,
  824. };
  825. /*
  826. * This is called from eventpoll_release() to unlink files from the eventpoll
  827. * interface. We need to have this facility to cleanup correctly files that are
  828. * closed without being removed from the eventpoll interface.
  829. */
  830. void eventpoll_release_file(struct file *file)
  831. {
  832. struct eventpoll *ep;
  833. struct epitem *epi, *next;
  834. /*
  835. * We don't want to get "file->f_lock" because it is not
  836. * necessary. It is not necessary because we're in the "struct file"
  837. * cleanup path, and this means that no one is using this file anymore.
  838. * So, for example, epoll_ctl() cannot hit here since if we reach this
  839. * point, the file counter already went to zero and fget() would fail.
  840. * The only hit might come from ep_free() but by holding the mutex
  841. * will correctly serialize the operation. We do need to acquire
  842. * "ep->mtx" after "epmutex" because ep_remove() requires it when called
  843. * from anywhere but ep_free().
  844. *
  845. * Besides, ep_remove() acquires the lock, so we can't hold it here.
  846. */
  847. mutex_lock(&epmutex);
  848. list_for_each_entry_safe(epi, next, &file->f_ep_links, fllink) {
  849. ep = epi->ep;
  850. mutex_lock_nested(&ep->mtx, 0);
  851. ep_remove(ep, epi);
  852. mutex_unlock(&ep->mtx);
  853. }
  854. mutex_unlock(&epmutex);
  855. }
  856. static int ep_alloc(struct eventpoll **pep)
  857. {
  858. int error;
  859. struct user_struct *user;
  860. struct eventpoll *ep;
  861. user = get_current_user();
  862. error = -ENOMEM;
  863. ep = kzalloc(sizeof(*ep), GFP_KERNEL);
  864. if (unlikely(!ep))
  865. goto free_uid;
  866. spin_lock_init(&ep->lock);
  867. mutex_init(&ep->mtx);
  868. init_waitqueue_head(&ep->wq);
  869. init_waitqueue_head(&ep->poll_wait);
  870. INIT_LIST_HEAD(&ep->rdllist);
  871. ep->rbr = RB_ROOT_CACHED;
  872. ep->ovflist = EP_UNACTIVE_PTR;
  873. ep->user = user;
  874. *pep = ep;
  875. return 0;
  876. free_uid:
  877. free_uid(user);
  878. return error;
  879. }
  880. /*
  881. * Search the file inside the eventpoll tree. The RB tree operations
  882. * are protected by the "mtx" mutex, and ep_find() must be called with
  883. * "mtx" held.
  884. */
  885. static struct epitem *ep_find(struct eventpoll *ep, struct file *file, int fd)
  886. {
  887. int kcmp;
  888. struct rb_node *rbp;
  889. struct epitem *epi, *epir = NULL;
  890. struct epoll_filefd ffd;
  891. ep_set_ffd(&ffd, file, fd);
  892. for (rbp = ep->rbr.rb_root.rb_node; rbp; ) {
  893. epi = rb_entry(rbp, struct epitem, rbn);
  894. kcmp = ep_cmp_ffd(&ffd, &epi->ffd);
  895. if (kcmp > 0)
  896. rbp = rbp->rb_right;
  897. else if (kcmp < 0)
  898. rbp = rbp->rb_left;
  899. else {
  900. epir = epi;
  901. break;
  902. }
  903. }
  904. return epir;
  905. }
  906. #ifdef CONFIG_CHECKPOINT_RESTORE
  907. static struct epitem *ep_find_tfd(struct eventpoll *ep, int tfd, unsigned long toff)
  908. {
  909. struct rb_node *rbp;
  910. struct epitem *epi;
  911. for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  912. epi = rb_entry(rbp, struct epitem, rbn);
  913. if (epi->ffd.fd == tfd) {
  914. if (toff == 0)
  915. return epi;
  916. else
  917. toff--;
  918. }
  919. cond_resched();
  920. }
  921. return NULL;
  922. }
  923. struct file *get_epoll_tfile_raw_ptr(struct file *file, int tfd,
  924. unsigned long toff)
  925. {
  926. struct file *file_raw;
  927. struct eventpoll *ep;
  928. struct epitem *epi;
  929. if (!is_file_epoll(file))
  930. return ERR_PTR(-EINVAL);
  931. ep = file->private_data;
  932. mutex_lock(&ep->mtx);
  933. epi = ep_find_tfd(ep, tfd, toff);
  934. if (epi)
  935. file_raw = epi->ffd.file;
  936. else
  937. file_raw = ERR_PTR(-ENOENT);
  938. mutex_unlock(&ep->mtx);
  939. return file_raw;
  940. }
  941. #endif /* CONFIG_CHECKPOINT_RESTORE */
  942. /*
  943. * This is the callback that is passed to the wait queue wakeup
  944. * mechanism. It is called by the stored file descriptors when they
  945. * have events to report.
  946. */
  947. static int ep_poll_callback(wait_queue_entry_t *wait, unsigned mode, int sync, void *key)
  948. {
  949. int pwake = 0;
  950. unsigned long flags;
  951. struct epitem *epi = ep_item_from_wait(wait);
  952. struct eventpoll *ep = epi->ep;
  953. __poll_t pollflags = key_to_poll(key);
  954. int ewake = 0;
  955. spin_lock_irqsave(&ep->lock, flags);
  956. ep_set_busy_poll_napi_id(epi);
  957. /*
  958. * If the event mask does not contain any poll(2) event, we consider the
  959. * descriptor to be disabled. This condition is likely the effect of the
  960. * EPOLLONESHOT bit that disables the descriptor when an event is received,
  961. * until the next EPOLL_CTL_MOD will be issued.
  962. */
  963. if (!(epi->event.events & ~EP_PRIVATE_BITS))
  964. goto out_unlock;
  965. /*
  966. * Check the events coming with the callback. At this stage, not
  967. * every device reports the events in the "key" parameter of the
  968. * callback. We need to be able to handle both cases here, hence the
  969. * test for "key" != NULL before the event match test.
  970. */
  971. if (pollflags && !(pollflags & epi->event.events))
  972. goto out_unlock;
  973. /*
  974. * If we are transferring events to userspace, we can hold no locks
  975. * (because we're accessing user memory, and because of linux f_op->poll()
  976. * semantics). All the events that happen during that period of time are
  977. * chained in ep->ovflist and requeued later on.
  978. */
  979. if (unlikely(ep->ovflist != EP_UNACTIVE_PTR)) {
  980. if (epi->next == EP_UNACTIVE_PTR) {
  981. epi->next = ep->ovflist;
  982. ep->ovflist = epi;
  983. if (epi->ws) {
  984. /*
  985. * Activate ep->ws since epi->ws may get
  986. * deactivated at any time.
  987. */
  988. __pm_stay_awake(ep->ws);
  989. }
  990. }
  991. goto out_unlock;
  992. }
  993. /* If this file is already in the ready list we exit soon */
  994. if (!ep_is_linked(&epi->rdllink)) {
  995. list_add_tail(&epi->rdllink, &ep->rdllist);
  996. ep_pm_stay_awake_rcu(epi);
  997. }
  998. /*
  999. * Wake up ( if active ) both the eventpoll wait list and the ->poll()
  1000. * wait list.
  1001. */
  1002. if (waitqueue_active(&ep->wq)) {
  1003. if ((epi->event.events & EPOLLEXCLUSIVE) &&
  1004. !(pollflags & POLLFREE)) {
  1005. switch (pollflags & EPOLLINOUT_BITS) {
  1006. case EPOLLIN:
  1007. if (epi->event.events & EPOLLIN)
  1008. ewake = 1;
  1009. break;
  1010. case EPOLLOUT:
  1011. if (epi->event.events & EPOLLOUT)
  1012. ewake = 1;
  1013. break;
  1014. case 0:
  1015. ewake = 1;
  1016. break;
  1017. }
  1018. }
  1019. wake_up_locked(&ep->wq);
  1020. }
  1021. if (waitqueue_active(&ep->poll_wait))
  1022. pwake++;
  1023. out_unlock:
  1024. spin_unlock_irqrestore(&ep->lock, flags);
  1025. /* We have to call this outside the lock */
  1026. if (pwake)
  1027. ep_poll_safewake(&ep->poll_wait);
  1028. if (!(epi->event.events & EPOLLEXCLUSIVE))
  1029. ewake = 1;
  1030. if (pollflags & POLLFREE) {
  1031. /*
  1032. * If we race with ep_remove_wait_queue() it can miss
  1033. * ->whead = NULL and do another remove_wait_queue() after
  1034. * us, so we can't use __remove_wait_queue().
  1035. */
  1036. list_del_init(&wait->entry);
  1037. /*
  1038. * ->whead != NULL protects us from the race with ep_free()
  1039. * or ep_remove(), ep_remove_wait_queue() takes whead->lock
  1040. * held by the caller. Once we nullify it, nothing protects
  1041. * ep/epi or even wait.
  1042. */
  1043. smp_store_release(&ep_pwq_from_wait(wait)->whead, NULL);
  1044. }
  1045. return ewake;
  1046. }
  1047. /*
  1048. * This is the callback that is used to add our wait queue to the
  1049. * target file wakeup lists.
  1050. */
  1051. static void ep_ptable_queue_proc(struct file *file, wait_queue_head_t *whead,
  1052. poll_table *pt)
  1053. {
  1054. struct epitem *epi = ep_item_from_epqueue(pt);
  1055. struct eppoll_entry *pwq;
  1056. if (epi->nwait >= 0 && (pwq = kmem_cache_alloc(pwq_cache, GFP_KERNEL))) {
  1057. init_waitqueue_func_entry(&pwq->wait, ep_poll_callback);
  1058. pwq->whead = whead;
  1059. pwq->base = epi;
  1060. if (epi->event.events & EPOLLEXCLUSIVE)
  1061. add_wait_queue_exclusive(whead, &pwq->wait);
  1062. else
  1063. add_wait_queue(whead, &pwq->wait);
  1064. list_add_tail(&pwq->llink, &epi->pwqlist);
  1065. epi->nwait++;
  1066. } else {
  1067. /* We have to signal that an error occurred */
  1068. epi->nwait = -1;
  1069. }
  1070. }
  1071. static void ep_rbtree_insert(struct eventpoll *ep, struct epitem *epi)
  1072. {
  1073. int kcmp;
  1074. struct rb_node **p = &ep->rbr.rb_root.rb_node, *parent = NULL;
  1075. struct epitem *epic;
  1076. bool leftmost = true;
  1077. while (*p) {
  1078. parent = *p;
  1079. epic = rb_entry(parent, struct epitem, rbn);
  1080. kcmp = ep_cmp_ffd(&epi->ffd, &epic->ffd);
  1081. if (kcmp > 0) {
  1082. p = &parent->rb_right;
  1083. leftmost = false;
  1084. } else
  1085. p = &parent->rb_left;
  1086. }
  1087. rb_link_node(&epi->rbn, parent, p);
  1088. rb_insert_color_cached(&epi->rbn, &ep->rbr, leftmost);
  1089. }
  1090. #define PATH_ARR_SIZE 5
  1091. /*
  1092. * These are the number paths of length 1 to 5, that we are allowing to emanate
  1093. * from a single file of interest. For example, we allow 1000 paths of length
  1094. * 1, to emanate from each file of interest. This essentially represents the
  1095. * potential wakeup paths, which need to be limited in order to avoid massive
  1096. * uncontrolled wakeup storms. The common use case should be a single ep which
  1097. * is connected to n file sources. In this case each file source has 1 path
  1098. * of length 1. Thus, the numbers below should be more than sufficient. These
  1099. * path limits are enforced during an EPOLL_CTL_ADD operation, since a modify
  1100. * and delete can't add additional paths. Protected by the epmutex.
  1101. */
  1102. static const int path_limits[PATH_ARR_SIZE] = { 1000, 500, 100, 50, 10 };
  1103. static int path_count[PATH_ARR_SIZE];
  1104. static int path_count_inc(int nests)
  1105. {
  1106. /* Allow an arbitrary number of depth 1 paths */
  1107. if (nests == 0)
  1108. return 0;
  1109. if (++path_count[nests] > path_limits[nests])
  1110. return -1;
  1111. return 0;
  1112. }
  1113. static void path_count_init(void)
  1114. {
  1115. int i;
  1116. for (i = 0; i < PATH_ARR_SIZE; i++)
  1117. path_count[i] = 0;
  1118. }
  1119. static int reverse_path_check_proc(void *priv, void *cookie, int call_nests)
  1120. {
  1121. int error = 0;
  1122. struct file *file = priv;
  1123. struct file *child_file;
  1124. struct epitem *epi;
  1125. /* CTL_DEL can remove links here, but that can't increase our count */
  1126. rcu_read_lock();
  1127. list_for_each_entry_rcu(epi, &file->f_ep_links, fllink) {
  1128. child_file = epi->ep->file;
  1129. if (is_file_epoll(child_file)) {
  1130. if (list_empty(&child_file->f_ep_links)) {
  1131. if (path_count_inc(call_nests)) {
  1132. error = -1;
  1133. break;
  1134. }
  1135. } else {
  1136. error = ep_call_nested(&poll_loop_ncalls,
  1137. EP_MAX_NESTS,
  1138. reverse_path_check_proc,
  1139. child_file, child_file,
  1140. current);
  1141. }
  1142. if (error != 0)
  1143. break;
  1144. } else {
  1145. printk(KERN_ERR "reverse_path_check_proc: "
  1146. "file is not an ep!\n");
  1147. }
  1148. }
  1149. rcu_read_unlock();
  1150. return error;
  1151. }
  1152. /**
  1153. * reverse_path_check - The tfile_check_list is list of file *, which have
  1154. * links that are proposed to be newly added. We need to
  1155. * make sure that those added links don't add too many
  1156. * paths such that we will spend all our time waking up
  1157. * eventpoll objects.
  1158. *
  1159. * Returns: Returns zero if the proposed links don't create too many paths,
  1160. * -1 otherwise.
  1161. */
  1162. static int reverse_path_check(void)
  1163. {
  1164. int error = 0;
  1165. struct file *current_file;
  1166. /* let's call this for all tfiles */
  1167. list_for_each_entry(current_file, &tfile_check_list, f_tfile_llink) {
  1168. path_count_init();
  1169. error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
  1170. reverse_path_check_proc, current_file,
  1171. current_file, current);
  1172. if (error)
  1173. break;
  1174. }
  1175. return error;
  1176. }
  1177. static int ep_create_wakeup_source(struct epitem *epi)
  1178. {
  1179. const char *name;
  1180. struct wakeup_source *ws;
  1181. if (!epi->ep->ws) {
  1182. epi->ep->ws = wakeup_source_register("eventpoll");
  1183. if (!epi->ep->ws)
  1184. return -ENOMEM;
  1185. }
  1186. name = epi->ffd.file->f_path.dentry->d_name.name;
  1187. ws = wakeup_source_register(name);
  1188. if (!ws)
  1189. return -ENOMEM;
  1190. rcu_assign_pointer(epi->ws, ws);
  1191. return 0;
  1192. }
  1193. /* rare code path, only used when EPOLL_CTL_MOD removes a wakeup source */
  1194. static noinline void ep_destroy_wakeup_source(struct epitem *epi)
  1195. {
  1196. struct wakeup_source *ws = ep_wakeup_source(epi);
  1197. RCU_INIT_POINTER(epi->ws, NULL);
  1198. /*
  1199. * wait for ep_pm_stay_awake_rcu to finish, synchronize_rcu is
  1200. * used internally by wakeup_source_remove, too (called by
  1201. * wakeup_source_unregister), so we cannot use call_rcu
  1202. */
  1203. synchronize_rcu();
  1204. wakeup_source_unregister(ws);
  1205. }
  1206. /*
  1207. * Must be called with "mtx" held.
  1208. */
  1209. static int ep_insert(struct eventpoll *ep, const struct epoll_event *event,
  1210. struct file *tfile, int fd, int full_check)
  1211. {
  1212. int error, pwake = 0;
  1213. __poll_t revents;
  1214. unsigned long flags;
  1215. long user_watches;
  1216. struct epitem *epi;
  1217. struct ep_pqueue epq;
  1218. user_watches = atomic_long_read(&ep->user->epoll_watches);
  1219. if (unlikely(user_watches >= max_user_watches))
  1220. return -ENOSPC;
  1221. if (!(epi = kmem_cache_alloc(epi_cache, GFP_KERNEL)))
  1222. return -ENOMEM;
  1223. /* Item initialization follow here ... */
  1224. INIT_LIST_HEAD(&epi->rdllink);
  1225. INIT_LIST_HEAD(&epi->fllink);
  1226. INIT_LIST_HEAD(&epi->pwqlist);
  1227. epi->ep = ep;
  1228. ep_set_ffd(&epi->ffd, tfile, fd);
  1229. epi->event = *event;
  1230. epi->nwait = 0;
  1231. epi->next = EP_UNACTIVE_PTR;
  1232. if (epi->event.events & EPOLLWAKEUP) {
  1233. error = ep_create_wakeup_source(epi);
  1234. if (error)
  1235. goto error_create_wakeup_source;
  1236. } else {
  1237. RCU_INIT_POINTER(epi->ws, NULL);
  1238. }
  1239. /* Initialize the poll table using the queue callback */
  1240. epq.epi = epi;
  1241. init_poll_funcptr(&epq.pt, ep_ptable_queue_proc);
  1242. /*
  1243. * Attach the item to the poll hooks and get current event bits.
  1244. * We can safely use the file* here because its usage count has
  1245. * been increased by the caller of this function. Note that after
  1246. * this operation completes, the poll callback can start hitting
  1247. * the new item.
  1248. */
  1249. revents = ep_item_poll(epi, &epq.pt, 1);
  1250. /*
  1251. * We have to check if something went wrong during the poll wait queue
  1252. * install process. Namely an allocation for a wait queue failed due
  1253. * high memory pressure.
  1254. */
  1255. error = -ENOMEM;
  1256. if (epi->nwait < 0)
  1257. goto error_unregister;
  1258. /* Add the current item to the list of active epoll hook for this file */
  1259. spin_lock(&tfile->f_lock);
  1260. list_add_tail_rcu(&epi->fllink, &tfile->f_ep_links);
  1261. spin_unlock(&tfile->f_lock);
  1262. /*
  1263. * Add the current item to the RB tree. All RB tree operations are
  1264. * protected by "mtx", and ep_insert() is called with "mtx" held.
  1265. */
  1266. ep_rbtree_insert(ep, epi);
  1267. /* now check if we've created too many backpaths */
  1268. error = -EINVAL;
  1269. if (full_check && reverse_path_check())
  1270. goto error_remove_epi;
  1271. /* We have to drop the new item inside our item list to keep track of it */
  1272. spin_lock_irqsave(&ep->lock, flags);
  1273. /* record NAPI ID of new item if present */
  1274. ep_set_busy_poll_napi_id(epi);
  1275. /* If the file is already "ready" we drop it inside the ready list */
  1276. if (revents && !ep_is_linked(&epi->rdllink)) {
  1277. list_add_tail(&epi->rdllink, &ep->rdllist);
  1278. ep_pm_stay_awake(epi);
  1279. /* Notify waiting tasks that events are available */
  1280. if (waitqueue_active(&ep->wq))
  1281. wake_up_locked(&ep->wq);
  1282. if (waitqueue_active(&ep->poll_wait))
  1283. pwake++;
  1284. }
  1285. spin_unlock_irqrestore(&ep->lock, flags);
  1286. atomic_long_inc(&ep->user->epoll_watches);
  1287. /* We have to call this outside the lock */
  1288. if (pwake)
  1289. ep_poll_safewake(&ep->poll_wait);
  1290. return 0;
  1291. error_remove_epi:
  1292. spin_lock(&tfile->f_lock);
  1293. list_del_rcu(&epi->fllink);
  1294. spin_unlock(&tfile->f_lock);
  1295. rb_erase_cached(&epi->rbn, &ep->rbr);
  1296. error_unregister:
  1297. ep_unregister_pollwait(ep, epi);
  1298. /*
  1299. * We need to do this because an event could have been arrived on some
  1300. * allocated wait queue. Note that we don't care about the ep->ovflist
  1301. * list, since that is used/cleaned only inside a section bound by "mtx".
  1302. * And ep_insert() is called with "mtx" held.
  1303. */
  1304. spin_lock_irqsave(&ep->lock, flags);
  1305. if (ep_is_linked(&epi->rdllink))
  1306. list_del_init(&epi->rdllink);
  1307. spin_unlock_irqrestore(&ep->lock, flags);
  1308. wakeup_source_unregister(ep_wakeup_source(epi));
  1309. error_create_wakeup_source:
  1310. kmem_cache_free(epi_cache, epi);
  1311. return error;
  1312. }
  1313. /*
  1314. * Modify the interest event mask by dropping an event if the new mask
  1315. * has a match in the current file status. Must be called with "mtx" held.
  1316. */
  1317. static int ep_modify(struct eventpoll *ep, struct epitem *epi,
  1318. const struct epoll_event *event)
  1319. {
  1320. int pwake = 0;
  1321. poll_table pt;
  1322. init_poll_funcptr(&pt, NULL);
  1323. /*
  1324. * Set the new event interest mask before calling f_op->poll();
  1325. * otherwise we might miss an event that happens between the
  1326. * f_op->poll() call and the new event set registering.
  1327. */
  1328. epi->event.events = event->events; /* need barrier below */
  1329. epi->event.data = event->data; /* protected by mtx */
  1330. if (epi->event.events & EPOLLWAKEUP) {
  1331. if (!ep_has_wakeup_source(epi))
  1332. ep_create_wakeup_source(epi);
  1333. } else if (ep_has_wakeup_source(epi)) {
  1334. ep_destroy_wakeup_source(epi);
  1335. }
  1336. /*
  1337. * The following barrier has two effects:
  1338. *
  1339. * 1) Flush epi changes above to other CPUs. This ensures
  1340. * we do not miss events from ep_poll_callback if an
  1341. * event occurs immediately after we call f_op->poll().
  1342. * We need this because we did not take ep->lock while
  1343. * changing epi above (but ep_poll_callback does take
  1344. * ep->lock).
  1345. *
  1346. * 2) We also need to ensure we do not miss _past_ events
  1347. * when calling f_op->poll(). This barrier also
  1348. * pairs with the barrier in wq_has_sleeper (see
  1349. * comments for wq_has_sleeper).
  1350. *
  1351. * This barrier will now guarantee ep_poll_callback or f_op->poll
  1352. * (or both) will notice the readiness of an item.
  1353. */
  1354. smp_mb();
  1355. /*
  1356. * Get current event bits. We can safely use the file* here because
  1357. * its usage count has been increased by the caller of this function.
  1358. * If the item is "hot" and it is not registered inside the ready
  1359. * list, push it inside.
  1360. */
  1361. if (ep_item_poll(epi, &pt, 1)) {
  1362. spin_lock_irq(&ep->lock);
  1363. if (!ep_is_linked(&epi->rdllink)) {
  1364. list_add_tail(&epi->rdllink, &ep->rdllist);
  1365. ep_pm_stay_awake(epi);
  1366. /* Notify waiting tasks that events are available */
  1367. if (waitqueue_active(&ep->wq))
  1368. wake_up_locked(&ep->wq);
  1369. if (waitqueue_active(&ep->poll_wait))
  1370. pwake++;
  1371. }
  1372. spin_unlock_irq(&ep->lock);
  1373. }
  1374. /* We have to call this outside the lock */
  1375. if (pwake)
  1376. ep_poll_safewake(&ep->poll_wait);
  1377. return 0;
  1378. }
  1379. static __poll_t ep_send_events_proc(struct eventpoll *ep, struct list_head *head,
  1380. void *priv)
  1381. {
  1382. struct ep_send_events_data *esed = priv;
  1383. __poll_t revents;
  1384. struct epitem *epi;
  1385. struct epoll_event __user *uevent;
  1386. struct wakeup_source *ws;
  1387. poll_table pt;
  1388. init_poll_funcptr(&pt, NULL);
  1389. /*
  1390. * We can loop without lock because we are passed a task private list.
  1391. * Items cannot vanish during the loop because ep_scan_ready_list() is
  1392. * holding "mtx" during this call.
  1393. */
  1394. for (esed->res = 0, uevent = esed->events;
  1395. !list_empty(head) && esed->res < esed->maxevents;) {
  1396. epi = list_first_entry(head, struct epitem, rdllink);
  1397. /*
  1398. * Activate ep->ws before deactivating epi->ws to prevent
  1399. * triggering auto-suspend here (in case we reactive epi->ws
  1400. * below).
  1401. *
  1402. * This could be rearranged to delay the deactivation of epi->ws
  1403. * instead, but then epi->ws would temporarily be out of sync
  1404. * with ep_is_linked().
  1405. */
  1406. ws = ep_wakeup_source(epi);
  1407. if (ws) {
  1408. if (ws->active)
  1409. __pm_stay_awake(ep->ws);
  1410. __pm_relax(ws);
  1411. }
  1412. list_del_init(&epi->rdllink);
  1413. revents = ep_item_poll(epi, &pt, 1);
  1414. /*
  1415. * If the event mask intersect the caller-requested one,
  1416. * deliver the event to userspace. Again, ep_scan_ready_list()
  1417. * is holding "mtx", so no operations coming from userspace
  1418. * can change the item.
  1419. */
  1420. if (revents) {
  1421. if (__put_user(revents, &uevent->events) ||
  1422. __put_user(epi->event.data, &uevent->data)) {
  1423. list_add(&epi->rdllink, head);
  1424. ep_pm_stay_awake(epi);
  1425. if (!esed->res)
  1426. esed->res = -EFAULT;
  1427. return 0;
  1428. }
  1429. esed->res++;
  1430. uevent++;
  1431. if (epi->event.events & EPOLLONESHOT)
  1432. epi->event.events &= EP_PRIVATE_BITS;
  1433. else if (!(epi->event.events & EPOLLET)) {
  1434. /*
  1435. * If this file has been added with Level
  1436. * Trigger mode, we need to insert back inside
  1437. * the ready list, so that the next call to
  1438. * epoll_wait() will check again the events
  1439. * availability. At this point, no one can insert
  1440. * into ep->rdllist besides us. The epoll_ctl()
  1441. * callers are locked out by
  1442. * ep_scan_ready_list() holding "mtx" and the
  1443. * poll callback will queue them in ep->ovflist.
  1444. */
  1445. list_add_tail(&epi->rdllink, &ep->rdllist);
  1446. ep_pm_stay_awake(epi);
  1447. }
  1448. }
  1449. }
  1450. return 0;
  1451. }
  1452. static int ep_send_events(struct eventpoll *ep,
  1453. struct epoll_event __user *events, int maxevents)
  1454. {
  1455. struct ep_send_events_data esed;
  1456. esed.maxevents = maxevents;
  1457. esed.events = events;
  1458. ep_scan_ready_list(ep, ep_send_events_proc, &esed, 0, false);
  1459. return esed.res;
  1460. }
  1461. static inline struct timespec64 ep_set_mstimeout(long ms)
  1462. {
  1463. struct timespec64 now, ts = {
  1464. .tv_sec = ms / MSEC_PER_SEC,
  1465. .tv_nsec = NSEC_PER_MSEC * (ms % MSEC_PER_SEC),
  1466. };
  1467. ktime_get_ts64(&now);
  1468. return timespec64_add_safe(now, ts);
  1469. }
  1470. /**
  1471. * ep_poll - Retrieves ready events, and delivers them to the caller supplied
  1472. * event buffer.
  1473. *
  1474. * @ep: Pointer to the eventpoll context.
  1475. * @events: Pointer to the userspace buffer where the ready events should be
  1476. * stored.
  1477. * @maxevents: Size (in terms of number of events) of the caller event buffer.
  1478. * @timeout: Maximum timeout for the ready events fetch operation, in
  1479. * milliseconds. If the @timeout is zero, the function will not block,
  1480. * while if the @timeout is less than zero, the function will block
  1481. * until at least one event has been retrieved (or an error
  1482. * occurred).
  1483. *
  1484. * Returns: Returns the number of ready events which have been fetched, or an
  1485. * error code, in case of error.
  1486. */
  1487. static int ep_poll(struct eventpoll *ep, struct epoll_event __user *events,
  1488. int maxevents, long timeout)
  1489. {
  1490. int res = 0, eavail, timed_out = 0;
  1491. unsigned long flags;
  1492. u64 slack = 0;
  1493. wait_queue_entry_t wait;
  1494. ktime_t expires, *to = NULL;
  1495. if (timeout > 0) {
  1496. struct timespec64 end_time = ep_set_mstimeout(timeout);
  1497. slack = select_estimate_accuracy(&end_time);
  1498. to = &expires;
  1499. *to = timespec64_to_ktime(end_time);
  1500. } else if (timeout == 0) {
  1501. /*
  1502. * Avoid the unnecessary trip to the wait queue loop, if the
  1503. * caller specified a non blocking operation.
  1504. */
  1505. timed_out = 1;
  1506. spin_lock_irqsave(&ep->lock, flags);
  1507. goto check_events;
  1508. }
  1509. fetch_events:
  1510. if (!ep_events_available(ep))
  1511. ep_busy_loop(ep, timed_out);
  1512. spin_lock_irqsave(&ep->lock, flags);
  1513. if (!ep_events_available(ep)) {
  1514. /*
  1515. * Busy poll timed out. Drop NAPI ID for now, we can add
  1516. * it back in when we have moved a socket with a valid NAPI
  1517. * ID onto the ready list.
  1518. */
  1519. ep_reset_busy_poll_napi_id(ep);
  1520. /*
  1521. * We don't have any available event to return to the caller.
  1522. * We need to sleep here, and we will be wake up by
  1523. * ep_poll_callback() when events will become available.
  1524. */
  1525. init_waitqueue_entry(&wait, current);
  1526. __add_wait_queue_exclusive(&ep->wq, &wait);
  1527. for (;;) {
  1528. /*
  1529. * We don't want to sleep if the ep_poll_callback() sends us
  1530. * a wakeup in between. That's why we set the task state
  1531. * to TASK_INTERRUPTIBLE before doing the checks.
  1532. */
  1533. set_current_state(TASK_INTERRUPTIBLE);
  1534. /*
  1535. * Always short-circuit for fatal signals to allow
  1536. * threads to make a timely exit without the chance of
  1537. * finding more events available and fetching
  1538. * repeatedly.
  1539. */
  1540. if (fatal_signal_pending(current)) {
  1541. res = -EINTR;
  1542. break;
  1543. }
  1544. if (ep_events_available(ep) || timed_out)
  1545. break;
  1546. if (signal_pending(current)) {
  1547. res = -EINTR;
  1548. break;
  1549. }
  1550. spin_unlock_irqrestore(&ep->lock, flags);
  1551. if (!schedule_hrtimeout_range(to, slack, HRTIMER_MODE_ABS))
  1552. timed_out = 1;
  1553. spin_lock_irqsave(&ep->lock, flags);
  1554. }
  1555. __remove_wait_queue(&ep->wq, &wait);
  1556. __set_current_state(TASK_RUNNING);
  1557. }
  1558. check_events:
  1559. /* Is it worth to try to dig for events ? */
  1560. eavail = ep_events_available(ep);
  1561. spin_unlock_irqrestore(&ep->lock, flags);
  1562. /*
  1563. * Try to transfer events to user space. In case we get 0 events and
  1564. * there's still timeout left over, we go trying again in search of
  1565. * more luck.
  1566. */
  1567. if (!res && eavail &&
  1568. !(res = ep_send_events(ep, events, maxevents)) && !timed_out)
  1569. goto fetch_events;
  1570. return res;
  1571. }
  1572. /**
  1573. * ep_loop_check_proc - Callback function to be passed to the @ep_call_nested()
  1574. * API, to verify that adding an epoll file inside another
  1575. * epoll structure, does not violate the constraints, in
  1576. * terms of closed loops, or too deep chains (which can
  1577. * result in excessive stack usage).
  1578. *
  1579. * @priv: Pointer to the epoll file to be currently checked.
  1580. * @cookie: Original cookie for this call. This is the top-of-the-chain epoll
  1581. * data structure pointer.
  1582. * @call_nests: Current dept of the @ep_call_nested() call stack.
  1583. *
  1584. * Returns: Returns zero if adding the epoll @file inside current epoll
  1585. * structure @ep does not violate the constraints, or -1 otherwise.
  1586. */
  1587. static int ep_loop_check_proc(void *priv, void *cookie, int call_nests)
  1588. {
  1589. int error = 0;
  1590. struct file *file = priv;
  1591. struct eventpoll *ep = file->private_data;
  1592. struct eventpoll *ep_tovisit;
  1593. struct rb_node *rbp;
  1594. struct epitem *epi;
  1595. mutex_lock_nested(&ep->mtx, call_nests + 1);
  1596. ep->visited = 1;
  1597. list_add(&ep->visited_list_link, &visited_list);
  1598. for (rbp = rb_first_cached(&ep->rbr); rbp; rbp = rb_next(rbp)) {
  1599. epi = rb_entry(rbp, struct epitem, rbn);
  1600. if (unlikely(is_file_epoll(epi->ffd.file))) {
  1601. ep_tovisit = epi->ffd.file->private_data;
  1602. if (ep_tovisit->visited)
  1603. continue;
  1604. error = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
  1605. ep_loop_check_proc, epi->ffd.file,
  1606. ep_tovisit, current);
  1607. if (error != 0)
  1608. break;
  1609. } else {
  1610. /*
  1611. * If we've reached a file that is not associated with
  1612. * an ep, then we need to check if the newly added
  1613. * links are going to add too many wakeup paths. We do
  1614. * this by adding it to the tfile_check_list, if it's
  1615. * not already there, and calling reverse_path_check()
  1616. * during ep_insert().
  1617. */
  1618. if (list_empty(&epi->ffd.file->f_tfile_llink))
  1619. list_add(&epi->ffd.file->f_tfile_llink,
  1620. &tfile_check_list);
  1621. }
  1622. }
  1623. mutex_unlock(&ep->mtx);
  1624. return error;
  1625. }
  1626. /**
  1627. * ep_loop_check - Performs a check to verify that adding an epoll file (@file)
  1628. * another epoll file (represented by @ep) does not create
  1629. * closed loops or too deep chains.
  1630. *
  1631. * @ep: Pointer to the epoll private data structure.
  1632. * @file: Pointer to the epoll file to be checked.
  1633. *
  1634. * Returns: Returns zero if adding the epoll @file inside current epoll
  1635. * structure @ep does not violate the constraints, or -1 otherwise.
  1636. */
  1637. static int ep_loop_check(struct eventpoll *ep, struct file *file)
  1638. {
  1639. int ret;
  1640. struct eventpoll *ep_cur, *ep_next;
  1641. ret = ep_call_nested(&poll_loop_ncalls, EP_MAX_NESTS,
  1642. ep_loop_check_proc, file, ep, current);
  1643. /* clear visited list */
  1644. list_for_each_entry_safe(ep_cur, ep_next, &visited_list,
  1645. visited_list_link) {
  1646. ep_cur->visited = 0;
  1647. list_del(&ep_cur->visited_list_link);
  1648. }
  1649. return ret;
  1650. }
  1651. static void clear_tfile_check_list(void)
  1652. {
  1653. struct file *file;
  1654. /* first clear the tfile_check_list */
  1655. while (!list_empty(&tfile_check_list)) {
  1656. file = list_first_entry(&tfile_check_list, struct file,
  1657. f_tfile_llink);
  1658. list_del_init(&file->f_tfile_llink);
  1659. }
  1660. INIT_LIST_HEAD(&tfile_check_list);
  1661. }
  1662. /*
  1663. * Open an eventpoll file descriptor.
  1664. */
  1665. static int do_epoll_create(int flags)
  1666. {
  1667. int error, fd;
  1668. struct eventpoll *ep = NULL;
  1669. struct file *file;
  1670. /* Check the EPOLL_* constant for consistency. */
  1671. BUILD_BUG_ON(EPOLL_CLOEXEC != O_CLOEXEC);
  1672. if (flags & ~EPOLL_CLOEXEC)
  1673. return -EINVAL;
  1674. /*
  1675. * Create the internal data structure ("struct eventpoll").
  1676. */
  1677. error = ep_alloc(&ep);
  1678. if (error < 0)
  1679. return error;
  1680. /*
  1681. * Creates all the items needed to setup an eventpoll file. That is,
  1682. * a file structure and a free file descriptor.
  1683. */
  1684. fd = get_unused_fd_flags(O_RDWR | (flags & O_CLOEXEC));
  1685. if (fd < 0) {
  1686. error = fd;
  1687. goto out_free_ep;
  1688. }
  1689. file = anon_inode_getfile("[eventpoll]", &eventpoll_fops, ep,
  1690. O_RDWR | (flags & O_CLOEXEC));
  1691. if (IS_ERR(file)) {
  1692. error = PTR_ERR(file);
  1693. goto out_free_fd;
  1694. }
  1695. ep->file = file;
  1696. fd_install(fd, file);
  1697. return fd;
  1698. out_free_fd:
  1699. put_unused_fd(fd);
  1700. out_free_ep:
  1701. ep_free(ep);
  1702. return error;
  1703. }
  1704. SYSCALL_DEFINE1(epoll_create1, int, flags)
  1705. {
  1706. return do_epoll_create(flags);
  1707. }
  1708. SYSCALL_DEFINE1(epoll_create, int, size)
  1709. {
  1710. if (size <= 0)
  1711. return -EINVAL;
  1712. return do_epoll_create(0);
  1713. }
  1714. /*
  1715. * The following function implements the controller interface for
  1716. * the eventpoll file that enables the insertion/removal/change of
  1717. * file descriptors inside the interest set.
  1718. */
  1719. SYSCALL_DEFINE4(epoll_ctl, int, epfd, int, op, int, fd,
  1720. struct epoll_event __user *, event)
  1721. {
  1722. int error;
  1723. int full_check = 0;
  1724. struct fd f, tf;
  1725. struct eventpoll *ep;
  1726. struct epitem *epi;
  1727. struct epoll_event epds;
  1728. struct eventpoll *tep = NULL;
  1729. error = -EFAULT;
  1730. if (ep_op_has_event(op) &&
  1731. copy_from_user(&epds, event, sizeof(struct epoll_event)))
  1732. goto error_return;
  1733. error = -EBADF;
  1734. f = fdget(epfd);
  1735. if (!f.file)
  1736. goto error_return;
  1737. /* Get the "struct file *" for the target file */
  1738. tf = fdget(fd);
  1739. if (!tf.file)
  1740. goto error_fput;
  1741. /* The target file descriptor must support poll */
  1742. error = -EPERM;
  1743. if (!tf.file->f_op->poll)
  1744. goto error_tgt_fput;
  1745. /* Check if EPOLLWAKEUP is allowed */
  1746. if (ep_op_has_event(op))
  1747. ep_take_care_of_epollwakeup(&epds);
  1748. /*
  1749. * We have to check that the file structure underneath the file descriptor
  1750. * the user passed to us _is_ an eventpoll file. And also we do not permit
  1751. * adding an epoll file descriptor inside itself.
  1752. */
  1753. error = -EINVAL;
  1754. if (f.file == tf.file || !is_file_epoll(f.file))
  1755. goto error_tgt_fput;
  1756. /*
  1757. * epoll adds to the wakeup queue at EPOLL_CTL_ADD time only,
  1758. * so EPOLLEXCLUSIVE is not allowed for a EPOLL_CTL_MOD operation.
  1759. * Also, we do not currently supported nested exclusive wakeups.
  1760. */
  1761. if (ep_op_has_event(op) && (epds.events & EPOLLEXCLUSIVE)) {
  1762. if (op == EPOLL_CTL_MOD)
  1763. goto error_tgt_fput;
  1764. if (op == EPOLL_CTL_ADD && (is_file_epoll(tf.file) ||
  1765. (epds.events & ~EPOLLEXCLUSIVE_OK_BITS)))
  1766. goto error_tgt_fput;
  1767. }
  1768. /*
  1769. * At this point it is safe to assume that the "private_data" contains
  1770. * our own data structure.
  1771. */
  1772. ep = f.file->private_data;
  1773. /*
  1774. * When we insert an epoll file descriptor, inside another epoll file
  1775. * descriptor, there is the change of creating closed loops, which are
  1776. * better be handled here, than in more critical paths. While we are
  1777. * checking for loops we also determine the list of files reachable
  1778. * and hang them on the tfile_check_list, so we can check that we
  1779. * haven't created too many possible wakeup paths.
  1780. *
  1781. * We do not need to take the global 'epumutex' on EPOLL_CTL_ADD when
  1782. * the epoll file descriptor is attaching directly to a wakeup source,
  1783. * unless the epoll file descriptor is nested. The purpose of taking the
  1784. * 'epmutex' on add is to prevent complex toplogies such as loops and
  1785. * deep wakeup paths from forming in parallel through multiple
  1786. * EPOLL_CTL_ADD operations.
  1787. */
  1788. mutex_lock_nested(&ep->mtx, 0);
  1789. if (op == EPOLL_CTL_ADD) {
  1790. if (!list_empty(&f.file->f_ep_links) ||
  1791. is_file_epoll(tf.file)) {
  1792. full_check = 1;
  1793. mutex_unlock(&ep->mtx);
  1794. mutex_lock(&epmutex);
  1795. if (is_file_epoll(tf.file)) {
  1796. error = -ELOOP;
  1797. if (ep_loop_check(ep, tf.file) != 0) {
  1798. clear_tfile_check_list();
  1799. goto error_tgt_fput;
  1800. }
  1801. } else
  1802. list_add(&tf.file->f_tfile_llink,
  1803. &tfile_check_list);
  1804. mutex_lock_nested(&ep->mtx, 0);
  1805. if (is_file_epoll(tf.file)) {
  1806. tep = tf.file->private_data;
  1807. mutex_lock_nested(&tep->mtx, 1);
  1808. }
  1809. }
  1810. }
  1811. /*
  1812. * Try to lookup the file inside our RB tree, Since we grabbed "mtx"
  1813. * above, we can be sure to be able to use the item looked up by
  1814. * ep_find() till we release the mutex.
  1815. */
  1816. epi = ep_find(ep, tf.file, fd);
  1817. error = -EINVAL;
  1818. switch (op) {
  1819. case EPOLL_CTL_ADD:
  1820. if (!epi) {
  1821. epds.events |= EPOLLERR | EPOLLHUP;
  1822. error = ep_insert(ep, &epds, tf.file, fd, full_check);
  1823. } else
  1824. error = -EEXIST;
  1825. if (full_check)
  1826. clear_tfile_check_list();
  1827. break;
  1828. case EPOLL_CTL_DEL:
  1829. if (epi)
  1830. error = ep_remove(ep, epi);
  1831. else
  1832. error = -ENOENT;
  1833. break;
  1834. case EPOLL_CTL_MOD:
  1835. if (epi) {
  1836. if (!(epi->event.events & EPOLLEXCLUSIVE)) {
  1837. epds.events |= EPOLLERR | EPOLLHUP;
  1838. error = ep_modify(ep, epi, &epds);
  1839. }
  1840. } else
  1841. error = -ENOENT;
  1842. break;
  1843. }
  1844. if (tep != NULL)
  1845. mutex_unlock(&tep->mtx);
  1846. mutex_unlock(&ep->mtx);
  1847. error_tgt_fput:
  1848. if (full_check)
  1849. mutex_unlock(&epmutex);
  1850. fdput(tf);
  1851. error_fput:
  1852. fdput(f);
  1853. error_return:
  1854. return error;
  1855. }
  1856. /*
  1857. * Implement the event wait interface for the eventpoll file. It is the kernel
  1858. * part of the user space epoll_wait(2).
  1859. */
  1860. static int do_epoll_wait(int epfd, struct epoll_event __user *events,
  1861. int maxevents, int timeout)
  1862. {
  1863. int error;
  1864. struct fd f;
  1865. struct eventpoll *ep;
  1866. /* The maximum number of event must be greater than zero */
  1867. if (maxevents <= 0 || maxevents > EP_MAX_EVENTS)
  1868. return -EINVAL;
  1869. /* Verify that the area passed by the user is writeable */
  1870. if (!access_ok(VERIFY_WRITE, events, maxevents * sizeof(struct epoll_event)))
  1871. return -EFAULT;
  1872. /* Get the "struct file *" for the eventpoll file */
  1873. f = fdget(epfd);
  1874. if (!f.file)
  1875. return -EBADF;
  1876. /*
  1877. * We have to check that the file structure underneath the fd
  1878. * the user passed to us _is_ an eventpoll file.
  1879. */
  1880. error = -EINVAL;
  1881. if (!is_file_epoll(f.file))
  1882. goto error_fput;
  1883. /*
  1884. * At this point it is safe to assume that the "private_data" contains
  1885. * our own data structure.
  1886. */
  1887. ep = f.file->private_data;
  1888. /* Time to fish for events ... */
  1889. error = ep_poll(ep, events, maxevents, timeout);
  1890. error_fput:
  1891. fdput(f);
  1892. return error;
  1893. }
  1894. SYSCALL_DEFINE4(epoll_wait, int, epfd, struct epoll_event __user *, events,
  1895. int, maxevents, int, timeout)
  1896. {
  1897. return do_epoll_wait(epfd, events, maxevents, timeout);
  1898. }
  1899. /*
  1900. * Implement the event wait interface for the eventpoll file. It is the kernel
  1901. * part of the user space epoll_pwait(2).
  1902. */
  1903. SYSCALL_DEFINE6(epoll_pwait, int, epfd, struct epoll_event __user *, events,
  1904. int, maxevents, int, timeout, const sigset_t __user *, sigmask,
  1905. size_t, sigsetsize)
  1906. {
  1907. int error;
  1908. sigset_t ksigmask, sigsaved;
  1909. /*
  1910. * If the caller wants a certain signal mask to be set during the wait,
  1911. * we apply it here.
  1912. */
  1913. if (sigmask) {
  1914. if (sigsetsize != sizeof(sigset_t))
  1915. return -EINVAL;
  1916. if (copy_from_user(&ksigmask, sigmask, sizeof(ksigmask)))
  1917. return -EFAULT;
  1918. sigsaved = current->blocked;
  1919. set_current_blocked(&ksigmask);
  1920. }
  1921. error = do_epoll_wait(epfd, events, maxevents, timeout);
  1922. /*
  1923. * If we changed the signal mask, we need to restore the original one.
  1924. * In case we've got a signal while waiting, we do not restore the
  1925. * signal mask yet, and we allow do_signal() to deliver the signal on
  1926. * the way back to userspace, before the signal mask is restored.
  1927. */
  1928. if (sigmask) {
  1929. if (error == -EINTR) {
  1930. memcpy(&current->saved_sigmask, &sigsaved,
  1931. sizeof(sigsaved));
  1932. set_restore_sigmask();
  1933. } else
  1934. set_current_blocked(&sigsaved);
  1935. }
  1936. return error;
  1937. }
  1938. #ifdef CONFIG_COMPAT
  1939. COMPAT_SYSCALL_DEFINE6(epoll_pwait, int, epfd,
  1940. struct epoll_event __user *, events,
  1941. int, maxevents, int, timeout,
  1942. const compat_sigset_t __user *, sigmask,
  1943. compat_size_t, sigsetsize)
  1944. {
  1945. long err;
  1946. sigset_t ksigmask, sigsaved;
  1947. /*
  1948. * If the caller wants a certain signal mask to be set during the wait,
  1949. * we apply it here.
  1950. */
  1951. if (sigmask) {
  1952. if (sigsetsize != sizeof(compat_sigset_t))
  1953. return -EINVAL;
  1954. if (get_compat_sigset(&ksigmask, sigmask))
  1955. return -EFAULT;
  1956. sigsaved = current->blocked;
  1957. set_current_blocked(&ksigmask);
  1958. }
  1959. err = do_epoll_wait(epfd, events, maxevents, timeout);
  1960. /*
  1961. * If we changed the signal mask, we need to restore the original one.
  1962. * In case we've got a signal while waiting, we do not restore the
  1963. * signal mask yet, and we allow do_signal() to deliver the signal on
  1964. * the way back to userspace, before the signal mask is restored.
  1965. */
  1966. if (sigmask) {
  1967. if (err == -EINTR) {
  1968. memcpy(&current->saved_sigmask, &sigsaved,
  1969. sizeof(sigsaved));
  1970. set_restore_sigmask();
  1971. } else
  1972. set_current_blocked(&sigsaved);
  1973. }
  1974. return err;
  1975. }
  1976. #endif
  1977. static int __init eventpoll_init(void)
  1978. {
  1979. struct sysinfo si;
  1980. si_meminfo(&si);
  1981. /*
  1982. * Allows top 4% of lomem to be allocated for epoll watches (per user).
  1983. */
  1984. max_user_watches = (((si.totalram - si.totalhigh) / 25) << PAGE_SHIFT) /
  1985. EP_ITEM_COST;
  1986. BUG_ON(max_user_watches < 0);
  1987. /*
  1988. * Initialize the structure used to perform epoll file descriptor
  1989. * inclusion loops checks.
  1990. */
  1991. ep_nested_calls_init(&poll_loop_ncalls);
  1992. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  1993. /* Initialize the structure used to perform safe poll wait head wake ups */
  1994. ep_nested_calls_init(&poll_safewake_ncalls);
  1995. #endif
  1996. /*
  1997. * We can have many thousands of epitems, so prevent this from
  1998. * using an extra cache line on 64-bit (and smaller) CPUs
  1999. */
  2000. BUILD_BUG_ON(sizeof(void *) <= 8 && sizeof(struct epitem) > 128);
  2001. /* Allocates slab cache used to allocate "struct epitem" items */
  2002. epi_cache = kmem_cache_create("eventpoll_epi", sizeof(struct epitem),
  2003. 0, SLAB_HWCACHE_ALIGN|SLAB_PANIC|SLAB_ACCOUNT, NULL);
  2004. /* Allocates slab cache used to allocate "struct eppoll_entry" */
  2005. pwq_cache = kmem_cache_create("eventpoll_pwq",
  2006. sizeof(struct eppoll_entry), 0, SLAB_PANIC|SLAB_ACCOUNT, NULL);
  2007. return 0;
  2008. }
  2009. fs_initcall(eventpoll_init);