You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

worker_util.c 60KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313
  1. /*
  2. * Copyright 2024 Vsevolod Stakhov
  3. *
  4. * Licensed under the Apache License, Version 2.0 (the "License");
  5. * you may not use this file except in compliance with the License.
  6. * You may obtain a copy of the License at
  7. *
  8. * http://www.apache.org/licenses/LICENSE-2.0
  9. *
  10. * Unless required by applicable law or agreed to in writing, software
  11. * distributed under the License is distributed on an "AS IS" BASIS,
  12. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13. * See the License for the specific language governing permissions and
  14. * limitations under the License.
  15. */
  16. #include "config.h"
  17. #include "rspamd.h"
  18. #include "lua/lua_common.h"
  19. #include "worker_util.h"
  20. #include "unix-std.h"
  21. #include "utlist.h"
  22. #include "ottery.h"
  23. #include "rspamd_control.h"
  24. #include "libserver/maps/map.h"
  25. #include "libserver/maps/map_private.h"
  26. #include "libserver/http/http_private.h"
  27. #include "libserver/http/http_router.h"
  28. #include "libutil/rrd.h"
  29. /* sys/resource.h */
  30. #ifdef HAVE_SYS_RESOURCE_H
  31. #include <sys/resource.h>
  32. #endif
  33. /* pwd and grp */
  34. #ifdef HAVE_PWD_H
  35. #include <pwd.h>
  36. #endif
  37. #ifdef HAVE_GRP_H
  38. #include <grp.h>
  39. #endif
  40. #ifdef HAVE_LIBUTIL_H
  41. #include <libutil.h>
  42. #endif
  43. #include "zlib.h"
  44. #ifdef HAVE_UCONTEXT_H
  45. #include <ucontext.h>
  46. #elif defined(HAVE_SYS_UCONTEXT_H)
  47. #include <sys/ucontext.h>
  48. #endif
  49. #ifdef HAVE_SYS_WAIT_H
  50. #include <sys/wait.h>
  51. #include <math.h>
  52. #endif
  53. #include "contrib/libev/ev.h"
  54. #include "libstat/stat_api.h"
  55. struct rspamd_worker *rspamd_current_worker = NULL;
  56. /* Forward declaration */
  57. static void rspamd_worker_heartbeat_start(struct rspamd_worker *,
  58. struct ev_loop *);
  59. static void rspamd_worker_ignore_signal(struct rspamd_worker_signal_handler *);
  60. /**
  61. * Return worker's control structure by its type
  62. * @param type
  63. * @return worker's control structure or NULL
  64. */
  65. worker_t *
  66. rspamd_get_worker_by_type(struct rspamd_config *cfg, GQuark type)
  67. {
  68. worker_t **pwrk;
  69. pwrk = cfg->compiled_workers;
  70. while (pwrk && *pwrk) {
  71. if (rspamd_check_worker(cfg, *pwrk)) {
  72. if (g_quark_from_string((*pwrk)->name) == type) {
  73. return *pwrk;
  74. }
  75. }
  76. pwrk++;
  77. }
  78. return NULL;
  79. }
  80. static void
  81. rspamd_worker_check_finished(EV_P_ ev_timer *w, int revents)
  82. {
  83. int *pnchecks = (int *) w->data;
  84. if (*pnchecks > SOFT_SHUTDOWN_TIME * 10) {
  85. msg_warn("terminating worker before finishing of terminate handlers");
  86. ev_break(EV_A_ EVBREAK_ONE);
  87. }
  88. else {
  89. int refcount = ev_active_cnt(EV_A);
  90. if (refcount == 1) {
  91. ev_break(EV_A_ EVBREAK_ONE);
  92. }
  93. else {
  94. ev_timer_again(EV_A_ w);
  95. }
  96. }
  97. }
  98. static gboolean
  99. rspamd_worker_finalize(gpointer user_data)
  100. {
  101. struct rspamd_task *task = user_data;
  102. if (!(task->flags & RSPAMD_TASK_FLAG_PROCESSING)) {
  103. msg_info_task("finishing actions has been processed, terminating");
  104. /* ev_break (task->event_loop, EVBREAK_ALL); */
  105. task->worker->state = rspamd_worker_wanna_die;
  106. rspamd_session_destroy(task->s);
  107. return TRUE;
  108. }
  109. return FALSE;
  110. }
  111. gboolean
  112. rspamd_worker_call_finish_handlers(struct rspamd_worker *worker)
  113. {
  114. struct rspamd_task *task;
  115. struct rspamd_config *cfg = worker->srv->cfg;
  116. struct rspamd_abstract_worker_ctx *ctx;
  117. struct rspamd_config_cfg_lua_script *sc;
  118. if (cfg->on_term_scripts) {
  119. ctx = (struct rspamd_abstract_worker_ctx *) worker->ctx;
  120. /* Create a fake task object for async events */
  121. task = rspamd_task_new(worker, cfg, NULL, NULL, ctx->event_loop, FALSE);
  122. task->resolver = ctx->resolver;
  123. task->flags |= RSPAMD_TASK_FLAG_PROCESSING;
  124. task->s = rspamd_session_create(task->task_pool,
  125. rspamd_worker_finalize,
  126. NULL,
  127. (event_finalizer_t) rspamd_task_free,
  128. task);
  129. DL_FOREACH(cfg->on_term_scripts, sc)
  130. {
  131. lua_call_finish_script(sc, task);
  132. }
  133. task->flags &= ~RSPAMD_TASK_FLAG_PROCESSING;
  134. if (rspamd_session_pending(task->s)) {
  135. return TRUE;
  136. }
  137. }
  138. return FALSE;
  139. }
  140. static void
  141. rspamd_worker_terminate_handlers(struct rspamd_worker *w)
  142. {
  143. if (w->nconns == 0 &&
  144. (!(w->flags & RSPAMD_WORKER_SCANNER) || w->srv->cfg->on_term_scripts == NULL)) {
  145. /*
  146. * We are here either:
  147. * - No active connections are represented
  148. * - No term scripts are registered
  149. * - Worker is not a scanner, so it can die safely
  150. */
  151. w->state = rspamd_worker_wanna_die;
  152. }
  153. else {
  154. if (w->nconns > 0) {
  155. /*
  156. * Wait until all connections are terminated
  157. */
  158. w->state = rspamd_worker_wait_connections;
  159. }
  160. else {
  161. /*
  162. * Start finish scripts
  163. */
  164. if (w->state != rspamd_worker_wait_final_scripts) {
  165. w->state = rspamd_worker_wait_final_scripts;
  166. if ((w->flags & RSPAMD_WORKER_SCANNER) &&
  167. rspamd_worker_call_finish_handlers(w)) {
  168. msg_info("performing async finishing actions");
  169. w->state = rspamd_worker_wait_final_scripts;
  170. }
  171. else {
  172. /*
  173. * We are done now
  174. */
  175. msg_info("no async finishing actions, terminating");
  176. w->state = rspamd_worker_wanna_die;
  177. }
  178. }
  179. }
  180. }
  181. }
  182. static void
  183. rspamd_worker_on_delayed_shutdown(EV_P_ ev_timer *w, int revents)
  184. {
  185. struct rspamd_worker *worker = (struct rspamd_worker *) w->data;
  186. worker->state = rspamd_worker_wanna_die;
  187. ev_timer_stop(EV_A_ w);
  188. ev_break(loop, EVBREAK_ALL);
  189. }
  190. static void
  191. rspamd_worker_shutdown_check(EV_P_ ev_timer *w, int revents)
  192. {
  193. struct rspamd_worker *worker = (struct rspamd_worker *) w->data;
  194. if (worker->state != rspamd_worker_wanna_die) {
  195. rspamd_worker_terminate_handlers(worker);
  196. if (worker->state == rspamd_worker_wanna_die) {
  197. /* We are done, kill event loop */
  198. ev_timer_stop(EV_A_ w);
  199. ev_break(EV_A_ EVBREAK_ALL);
  200. }
  201. else {
  202. /* Try again later */
  203. ev_timer_again(EV_A_ w);
  204. }
  205. }
  206. else {
  207. ev_timer_stop(EV_A_ w);
  208. ev_break(EV_A_ EVBREAK_ALL);
  209. }
  210. }
  211. /*
  212. * Config reload is designed by sending sigusr2 to active workers and pending shutdown of them
  213. */
  214. static gboolean
  215. rspamd_worker_usr2_handler(struct rspamd_worker_signal_handler *sigh, void *arg)
  216. {
  217. /* Do not accept new connections, preparing to end worker's process */
  218. if (sigh->worker->state == rspamd_worker_state_running) {
  219. static ev_timer shutdown_ev, shutdown_check_ev;
  220. ev_tstamp shutdown_ts;
  221. if (sigh->worker->flags & RSPAMD_WORKER_NO_TERMINATE_DELAY) {
  222. shutdown_ts = 0.0;
  223. }
  224. else {
  225. shutdown_ts = MAX(SOFT_SHUTDOWN_TIME,
  226. sigh->worker->srv->cfg->task_timeout * 2.0);
  227. }
  228. rspamd_worker_ignore_signal(sigh);
  229. sigh->worker->state = rspamd_worker_state_terminating;
  230. rspamd_default_log_function(G_LOG_LEVEL_INFO,
  231. sigh->worker->srv->server_pool->tag.tagname,
  232. sigh->worker->srv->server_pool->tag.uid,
  233. G_STRFUNC,
  234. "worker's shutdown is pending in %.2f sec",
  235. shutdown_ts);
  236. /* Soft shutdown timer */
  237. shutdown_ev.data = sigh->worker;
  238. ev_timer_init(&shutdown_ev, rspamd_worker_on_delayed_shutdown,
  239. shutdown_ts, 0.0);
  240. ev_timer_start(sigh->event_loop, &shutdown_ev);
  241. if (!(sigh->worker->flags & RSPAMD_WORKER_NO_TERMINATE_DELAY)) {
  242. /* This timer checks if we are ready to die and is called frequently */
  243. shutdown_check_ev.data = sigh->worker;
  244. ev_timer_init(&shutdown_check_ev, rspamd_worker_shutdown_check,
  245. 0.5, 0.5);
  246. ev_timer_start(sigh->event_loop, &shutdown_check_ev);
  247. }
  248. rspamd_worker_stop_accept(sigh->worker);
  249. }
  250. /* No more signals */
  251. return FALSE;
  252. }
  253. /*
  254. * Reopen log is designed by sending sigusr1 to active workers and pending shutdown of them
  255. */
  256. static gboolean
  257. rspamd_worker_usr1_handler(struct rspamd_worker_signal_handler *sigh, void *arg)
  258. {
  259. struct rspamd_main *rspamd_main = sigh->worker->srv;
  260. rspamd_log_reopen(sigh->worker->srv->logger, rspamd_main->cfg, -1, -1);
  261. msg_info_main("logging reinitialised");
  262. /* Get more signals */
  263. return TRUE;
  264. }
  265. static gboolean
  266. rspamd_worker_term_handler(struct rspamd_worker_signal_handler *sigh, void *arg)
  267. {
  268. if (sigh->worker->state == rspamd_worker_state_running) {
  269. static ev_timer shutdown_ev, shutdown_check_ev;
  270. ev_tstamp shutdown_ts;
  271. if (sigh->worker->flags & RSPAMD_WORKER_NO_TERMINATE_DELAY) {
  272. shutdown_ts = 0.0;
  273. }
  274. else {
  275. shutdown_ts = MAX(SOFT_SHUTDOWN_TIME,
  276. sigh->worker->srv->cfg->task_timeout * 2.0);
  277. }
  278. rspamd_worker_ignore_signal(sigh);
  279. sigh->worker->state = rspamd_worker_state_terminating;
  280. rspamd_default_log_function(G_LOG_LEVEL_INFO,
  281. sigh->worker->srv->server_pool->tag.tagname,
  282. sigh->worker->srv->server_pool->tag.uid,
  283. G_STRFUNC,
  284. "terminating after receiving signal %s",
  285. g_strsignal(sigh->signo));
  286. rspamd_worker_stop_accept(sigh->worker);
  287. rspamd_worker_terminate_handlers(sigh->worker);
  288. /* Check if we are ready to die */
  289. if (sigh->worker->state != rspamd_worker_wanna_die) {
  290. /* This timer is called when we have no choices but to die */
  291. shutdown_ev.data = sigh->worker;
  292. ev_timer_init(&shutdown_ev, rspamd_worker_on_delayed_shutdown,
  293. shutdown_ts, 0.0);
  294. ev_timer_start(sigh->event_loop, &shutdown_ev);
  295. if (!(sigh->worker->flags & RSPAMD_WORKER_NO_TERMINATE_DELAY)) {
  296. /* This timer checks if we are ready to die and is called frequently */
  297. shutdown_check_ev.data = sigh->worker;
  298. ev_timer_init(&shutdown_check_ev, rspamd_worker_shutdown_check,
  299. 0.5, 0.5);
  300. ev_timer_start(sigh->event_loop, &shutdown_check_ev);
  301. }
  302. }
  303. else {
  304. /* Flag to die has been already set */
  305. ev_break(sigh->event_loop, EVBREAK_ALL);
  306. }
  307. }
  308. /* Stop reacting on signals */
  309. return FALSE;
  310. }
  311. static void
  312. rspamd_worker_signal_handle(EV_P_ ev_signal *w, int revents)
  313. {
  314. struct rspamd_worker_signal_handler *sigh =
  315. (struct rspamd_worker_signal_handler *) w->data;
  316. struct rspamd_worker_signal_handler_elt *cb, *cbtmp;
  317. /* Call all signal handlers registered */
  318. DL_FOREACH_SAFE(sigh->cb, cb, cbtmp)
  319. {
  320. if (!cb->handler(sigh, cb->handler_data)) {
  321. DL_DELETE(sigh->cb, cb);
  322. g_free(cb);
  323. }
  324. }
  325. }
  326. static void
  327. rspamd_worker_ignore_signal(struct rspamd_worker_signal_handler *sigh)
  328. {
  329. sigset_t set;
  330. ev_signal_stop(sigh->event_loop, &sigh->ev_sig);
  331. sigemptyset(&set);
  332. sigaddset(&set, sigh->signo);
  333. sigprocmask(SIG_BLOCK, &set, NULL);
  334. }
  335. static void
  336. rspamd_worker_default_signal(int signo)
  337. {
  338. struct sigaction sig;
  339. sigemptyset(&sig.sa_mask);
  340. sigaddset(&sig.sa_mask, signo);
  341. sig.sa_handler = SIG_DFL;
  342. sig.sa_flags = 0;
  343. sigaction(signo, &sig, NULL);
  344. }
  345. static void
  346. rspamd_sigh_free(void *p)
  347. {
  348. struct rspamd_worker_signal_handler *sigh = p;
  349. struct rspamd_worker_signal_handler_elt *cb, *tmp;
  350. DL_FOREACH_SAFE(sigh->cb, cb, tmp)
  351. {
  352. DL_DELETE(sigh->cb, cb);
  353. g_free(cb);
  354. }
  355. ev_signal_stop(sigh->event_loop, &sigh->ev_sig);
  356. rspamd_worker_default_signal(sigh->signo);
  357. g_free(sigh);
  358. }
  359. void rspamd_worker_set_signal_handler(int signo, struct rspamd_worker *worker,
  360. struct ev_loop *event_loop,
  361. rspamd_worker_signal_cb_t handler,
  362. void *handler_data)
  363. {
  364. struct rspamd_worker_signal_handler *sigh;
  365. struct rspamd_worker_signal_handler_elt *cb;
  366. sigh = g_hash_table_lookup(worker->signal_events, GINT_TO_POINTER(signo));
  367. if (sigh == NULL) {
  368. sigh = g_malloc0(sizeof(*sigh));
  369. sigh->signo = signo;
  370. sigh->worker = worker;
  371. sigh->event_loop = event_loop;
  372. sigh->enabled = TRUE;
  373. sigh->ev_sig.data = sigh;
  374. ev_signal_init(&sigh->ev_sig, rspamd_worker_signal_handle, signo);
  375. ev_signal_start(event_loop, &sigh->ev_sig);
  376. g_hash_table_insert(worker->signal_events,
  377. GINT_TO_POINTER(signo),
  378. sigh);
  379. }
  380. cb = g_malloc0(sizeof(*cb));
  381. cb->handler = handler;
  382. cb->handler_data = handler_data;
  383. DL_APPEND(sigh->cb, cb);
  384. }
  385. void rspamd_worker_init_signals(struct rspamd_worker *worker,
  386. struct ev_loop *event_loop)
  387. {
  388. /* A set of terminating signals */
  389. rspamd_worker_set_signal_handler(SIGTERM, worker, event_loop,
  390. rspamd_worker_term_handler, NULL);
  391. rspamd_worker_set_signal_handler(SIGINT, worker, event_loop,
  392. rspamd_worker_term_handler, NULL);
  393. rspamd_worker_set_signal_handler(SIGHUP, worker, event_loop,
  394. rspamd_worker_term_handler, NULL);
  395. /* Special purpose signals */
  396. rspamd_worker_set_signal_handler(SIGUSR1, worker, event_loop,
  397. rspamd_worker_usr1_handler, NULL);
  398. rspamd_worker_set_signal_handler(SIGUSR2, worker, event_loop,
  399. rspamd_worker_usr2_handler, NULL);
  400. }
  401. struct ev_loop *
  402. rspamd_prepare_worker(struct rspamd_worker *worker, const char *name,
  403. rspamd_accept_handler hdl)
  404. {
  405. struct ev_loop *event_loop;
  406. GList *cur;
  407. struct rspamd_worker_listen_socket *ls;
  408. struct rspamd_worker_accept_event *accept_ev;
  409. worker->signal_events = g_hash_table_new_full(g_direct_hash, g_direct_equal,
  410. NULL, rspamd_sigh_free);
  411. event_loop = ev_loop_new(rspamd_config_ev_backend_get(worker->srv->cfg));
  412. worker->srv->event_loop = event_loop;
  413. rspamd_worker_init_signals(worker, event_loop);
  414. rspamd_control_worker_add_default_cmd_handlers(worker, event_loop);
  415. rspamd_worker_heartbeat_start(worker, event_loop);
  416. rspamd_redis_pool_config(worker->srv->cfg->redis_pool,
  417. worker->srv->cfg, event_loop);
  418. /* Accept all sockets */
  419. if (hdl) {
  420. cur = worker->cf->listen_socks;
  421. while (cur) {
  422. ls = cur->data;
  423. if (ls->fd != -1) {
  424. accept_ev = g_malloc0(sizeof(*accept_ev));
  425. accept_ev->event_loop = event_loop;
  426. accept_ev->accept_ev.data = worker;
  427. ev_io_init(&accept_ev->accept_ev, hdl, ls->fd, EV_READ);
  428. ev_io_start(event_loop, &accept_ev->accept_ev);
  429. DL_APPEND(worker->accept_events, accept_ev);
  430. }
  431. cur = g_list_next(cur);
  432. }
  433. }
  434. return event_loop;
  435. }
  436. void rspamd_worker_stop_accept(struct rspamd_worker *worker)
  437. {
  438. struct rspamd_worker_accept_event *cur, *tmp;
  439. /* Remove all events */
  440. DL_FOREACH_SAFE(worker->accept_events, cur, tmp)
  441. {
  442. if (ev_can_stop(&cur->accept_ev)) {
  443. ev_io_stop(cur->event_loop, &cur->accept_ev);
  444. }
  445. if (ev_can_stop(&cur->throttling_ev)) {
  446. ev_timer_stop(cur->event_loop, &cur->throttling_ev);
  447. }
  448. g_free(cur);
  449. }
  450. /* XXX: we need to do it much later */
  451. #if 0
  452. g_hash_table_iter_init (&it, worker->signal_events);
  453. while (g_hash_table_iter_next (&it, &k, &v)) {
  454. sigh = (struct rspamd_worker_signal_handler *)v;
  455. g_hash_table_iter_steal (&it);
  456. if (sigh->enabled) {
  457. event_del (&sigh->ev);
  458. }
  459. g_free (sigh);
  460. }
  461. g_hash_table_unref (worker->signal_events);
  462. #endif
  463. }
  464. static rspamd_fstring_t *
  465. rspamd_controller_maybe_compress(struct rspamd_http_connection_entry *entry,
  466. rspamd_fstring_t *buf, struct rspamd_http_message *msg)
  467. {
  468. if (entry->support_gzip) {
  469. if (rspamd_fstring_gzip(&buf)) {
  470. rspamd_http_message_add_header(msg, "Content-Encoding", "gzip");
  471. }
  472. }
  473. return buf;
  474. }
  475. void rspamd_controller_send_error(struct rspamd_http_connection_entry *entry,
  476. gint code, const gchar *error_msg, ...)
  477. {
  478. struct rspamd_http_message *msg;
  479. va_list args;
  480. rspamd_fstring_t *reply;
  481. msg = rspamd_http_new_message(HTTP_RESPONSE);
  482. va_start(args, error_msg);
  483. msg->status = rspamd_fstring_new();
  484. rspamd_vprintf_fstring(&msg->status, error_msg, args);
  485. va_end(args);
  486. msg->date = time(NULL);
  487. msg->code = code;
  488. reply = rspamd_fstring_sized_new(msg->status->len + 16);
  489. rspamd_printf_fstring(&reply, "{\"error\":\"%V\"}", msg->status);
  490. rspamd_http_message_set_body_from_fstring_steal(msg,
  491. rspamd_controller_maybe_compress(entry, reply, msg));
  492. rspamd_http_connection_reset(entry->conn);
  493. rspamd_http_router_insert_headers(entry->rt, msg);
  494. rspamd_http_connection_write_message(entry->conn,
  495. msg,
  496. NULL,
  497. "application/json",
  498. entry,
  499. entry->rt->timeout);
  500. entry->is_reply = TRUE;
  501. }
  502. void rspamd_controller_send_openmetrics(struct rspamd_http_connection_entry *entry,
  503. rspamd_fstring_t *str)
  504. {
  505. struct rspamd_http_message *msg;
  506. msg = rspamd_http_new_message(HTTP_RESPONSE);
  507. msg->date = time(NULL);
  508. msg->code = 200;
  509. msg->status = rspamd_fstring_new_init("OK", 2);
  510. rspamd_http_message_set_body_from_fstring_steal(msg,
  511. rspamd_controller_maybe_compress(entry, str, msg));
  512. rspamd_http_connection_reset(entry->conn);
  513. rspamd_http_router_insert_headers(entry->rt, msg);
  514. rspamd_http_connection_write_message(entry->conn,
  515. msg,
  516. NULL,
  517. "application/openmetrics-text; version=1.0.0; charset=utf-8",
  518. entry,
  519. entry->rt->timeout);
  520. entry->is_reply = TRUE;
  521. }
  522. void rspamd_controller_send_string(struct rspamd_http_connection_entry *entry,
  523. const gchar *str)
  524. {
  525. struct rspamd_http_message *msg;
  526. rspamd_fstring_t *reply;
  527. msg = rspamd_http_new_message(HTTP_RESPONSE);
  528. msg->date = time(NULL);
  529. msg->code = 200;
  530. msg->status = rspamd_fstring_new_init("OK", 2);
  531. if (str) {
  532. reply = rspamd_fstring_new_init(str, strlen(str));
  533. }
  534. else {
  535. reply = rspamd_fstring_new_init("null", 4);
  536. }
  537. rspamd_http_message_set_body_from_fstring_steal(msg,
  538. rspamd_controller_maybe_compress(entry, reply, msg));
  539. rspamd_http_connection_reset(entry->conn);
  540. rspamd_http_router_insert_headers(entry->rt, msg);
  541. rspamd_http_connection_write_message(entry->conn,
  542. msg,
  543. NULL,
  544. "application/json",
  545. entry,
  546. entry->rt->timeout);
  547. entry->is_reply = TRUE;
  548. }
  549. void rspamd_controller_send_ucl(struct rspamd_http_connection_entry *entry,
  550. ucl_object_t *obj)
  551. {
  552. struct rspamd_http_message *msg;
  553. rspamd_fstring_t *reply;
  554. msg = rspamd_http_new_message(HTTP_RESPONSE);
  555. msg->date = time(NULL);
  556. msg->code = 200;
  557. msg->status = rspamd_fstring_new_init("OK", 2);
  558. reply = rspamd_fstring_sized_new(BUFSIZ);
  559. rspamd_ucl_emit_fstring(obj, UCL_EMIT_JSON_COMPACT, &reply);
  560. rspamd_http_message_set_body_from_fstring_steal(msg,
  561. rspamd_controller_maybe_compress(entry, reply, msg));
  562. rspamd_http_connection_reset(entry->conn);
  563. rspamd_http_router_insert_headers(entry->rt, msg);
  564. rspamd_http_connection_write_message(entry->conn,
  565. msg,
  566. NULL,
  567. "application/json",
  568. entry,
  569. entry->rt->timeout);
  570. entry->is_reply = TRUE;
  571. }
  572. static void
  573. rspamd_worker_drop_priv(struct rspamd_main *rspamd_main)
  574. {
  575. if (rspamd_main->is_privileged) {
  576. if (setgid(rspamd_main->workers_gid) == -1) {
  577. msg_err_main("cannot setgid to %d (%s), aborting",
  578. (gint) rspamd_main->workers_gid,
  579. strerror(errno));
  580. exit(-errno);
  581. }
  582. if (rspamd_main->cfg->rspamd_user &&
  583. initgroups(rspamd_main->cfg->rspamd_user,
  584. rspamd_main->workers_gid) == -1) {
  585. msg_err_main("initgroups failed (%s), aborting", strerror(errno));
  586. exit(-errno);
  587. }
  588. if (setuid(rspamd_main->workers_uid) == -1) {
  589. msg_err_main("cannot setuid to %d (%s), aborting",
  590. (gint) rspamd_main->workers_uid,
  591. strerror(errno));
  592. exit(-errno);
  593. }
  594. }
  595. }
  596. static void
  597. rspamd_worker_set_limits(struct rspamd_main *rspamd_main,
  598. struct rspamd_worker_conf *cf)
  599. {
  600. struct rlimit rlmt;
  601. if (cf->rlimit_nofile != 0) {
  602. rlmt.rlim_cur = (rlim_t) cf->rlimit_nofile;
  603. rlmt.rlim_max = (rlim_t) cf->rlimit_nofile;
  604. if (setrlimit(RLIMIT_NOFILE, &rlmt) == -1) {
  605. msg_warn_main("cannot set files rlimit: %L, %s",
  606. cf->rlimit_nofile,
  607. strerror(errno));
  608. }
  609. memset(&rlmt, 0, sizeof(rlmt));
  610. if (getrlimit(RLIMIT_NOFILE, &rlmt) == -1) {
  611. msg_warn_main("cannot get max files rlimit: %HL, %s",
  612. cf->rlimit_maxcore,
  613. strerror(errno));
  614. }
  615. else {
  616. msg_info_main("set max file descriptors limit: %HL cur and %HL max",
  617. (uint64_t) rlmt.rlim_cur,
  618. (uint64_t) rlmt.rlim_max);
  619. }
  620. }
  621. else {
  622. /* Just report */
  623. if (getrlimit(RLIMIT_NOFILE, &rlmt) == -1) {
  624. msg_warn_main("cannot get max files rlimit: %HL, %s",
  625. cf->rlimit_maxcore,
  626. strerror(errno));
  627. }
  628. else {
  629. msg_info_main("use system max file descriptors limit: %HL cur and %HL max",
  630. (uint64_t) rlmt.rlim_cur,
  631. (uint64_t) rlmt.rlim_max);
  632. }
  633. }
  634. if (rspamd_main->cores_throttling) {
  635. msg_info_main("disable core files for the new worker as limits are reached");
  636. rlmt.rlim_cur = 0;
  637. rlmt.rlim_max = 0;
  638. if (setrlimit(RLIMIT_CORE, &rlmt) == -1) {
  639. msg_warn_main("cannot disable core dumps: error when setting limits: %s",
  640. strerror(errno));
  641. }
  642. }
  643. else {
  644. if (cf->rlimit_maxcore != 0) {
  645. rlmt.rlim_cur = (rlim_t) cf->rlimit_maxcore;
  646. rlmt.rlim_max = (rlim_t) cf->rlimit_maxcore;
  647. if (setrlimit(RLIMIT_CORE, &rlmt) == -1) {
  648. msg_warn_main("cannot set max core size limit: %HL, %s",
  649. cf->rlimit_maxcore,
  650. strerror(errno));
  651. }
  652. /* Ensure that we did it */
  653. memset(&rlmt, 0, sizeof(rlmt));
  654. if (getrlimit(RLIMIT_CORE, &rlmt) == -1) {
  655. msg_warn_main("cannot get max core size rlimit: %HL, %s",
  656. cf->rlimit_maxcore,
  657. strerror(errno));
  658. }
  659. else {
  660. if (rlmt.rlim_cur != cf->rlimit_maxcore ||
  661. rlmt.rlim_max != cf->rlimit_maxcore) {
  662. msg_warn_main("setting of core file limits was unsuccessful: "
  663. "%HL was wanted, "
  664. "but we have %HL cur and %HL max",
  665. cf->rlimit_maxcore,
  666. (uint64_t) rlmt.rlim_cur,
  667. (uint64_t) rlmt.rlim_max);
  668. }
  669. else {
  670. msg_info_main("set max core size limit: %HL cur and %HL max",
  671. (uint64_t) rlmt.rlim_cur,
  672. (uint64_t) rlmt.rlim_max);
  673. }
  674. }
  675. }
  676. else {
  677. /* Just report */
  678. if (getrlimit(RLIMIT_CORE, &rlmt) == -1) {
  679. msg_warn_main("cannot get max core size limit: %HL, %s",
  680. cf->rlimit_maxcore,
  681. strerror(errno));
  682. }
  683. else {
  684. msg_info_main("use system max core size limit: %HL cur and %HL max",
  685. (uint64_t) rlmt.rlim_cur,
  686. (uint64_t) rlmt.rlim_max);
  687. }
  688. }
  689. }
  690. }
  691. static void
  692. rspamd_worker_on_term(EV_P_ ev_child *w, int revents)
  693. {
  694. struct rspamd_worker *wrk = (struct rspamd_worker *) w->data;
  695. if (wrk->ppid == getpid()) {
  696. if (wrk->term_handler) {
  697. wrk->term_handler(EV_A_ w, wrk->srv, wrk);
  698. }
  699. else {
  700. rspamd_check_termination_clause(wrk->srv, wrk, w->rstatus);
  701. }
  702. }
  703. else {
  704. /* Ignore SIGCHLD for not our children... */
  705. }
  706. }
  707. static void
  708. rspamd_worker_heartbeat_cb(EV_P_ ev_timer *w, int revents)
  709. {
  710. struct rspamd_worker *wrk = (struct rspamd_worker *) w->data;
  711. struct rspamd_srv_command cmd;
  712. memset(&cmd, 0, sizeof(cmd));
  713. cmd.type = RSPAMD_SRV_HEARTBEAT;
  714. rspamd_srv_send_command(wrk, EV_A, &cmd, -1, NULL, NULL);
  715. }
  716. static void
  717. rspamd_worker_heartbeat_start(struct rspamd_worker *wrk, struct ev_loop *event_loop)
  718. {
  719. wrk->hb.heartbeat_ev.data = (void *) wrk;
  720. ev_timer_init(&wrk->hb.heartbeat_ev, rspamd_worker_heartbeat_cb,
  721. 0.0, wrk->srv->cfg->heartbeat_interval);
  722. ev_timer_start(event_loop, &wrk->hb.heartbeat_ev);
  723. }
  724. static void
  725. rspamd_main_heartbeat_cb(EV_P_ ev_timer *w, int revents)
  726. {
  727. struct rspamd_worker *wrk = (struct rspamd_worker *) w->data;
  728. gdouble time_from_last = ev_time();
  729. struct rspamd_main *rspamd_main;
  730. static struct rspamd_control_command cmd;
  731. struct tm tm;
  732. gchar timebuf[64];
  733. gchar usec_buf[16];
  734. gint r;
  735. time_from_last -= wrk->hb.last_event;
  736. rspamd_main = wrk->srv;
  737. if (wrk->hb.last_event > 0 &&
  738. time_from_last > 0 &&
  739. time_from_last >= rspamd_main->cfg->heartbeat_interval * 2) {
  740. rspamd_localtime(wrk->hb.last_event, &tm);
  741. r = strftime(timebuf, sizeof(timebuf), "%F %H:%M:%S", &tm);
  742. rspamd_snprintf(usec_buf, sizeof(usec_buf), "%.5f",
  743. wrk->hb.last_event - (gdouble) (time_t) wrk->hb.last_event);
  744. rspamd_snprintf(timebuf + r, sizeof(timebuf) - r,
  745. "%s", usec_buf + 1);
  746. if (wrk->hb.nbeats > 0) {
  747. /* First time lost event */
  748. cmd.type = RSPAMD_CONTROL_CHILD_CHANGE;
  749. cmd.cmd.child_change.what = rspamd_child_offline;
  750. cmd.cmd.child_change.pid = wrk->pid;
  751. rspamd_control_broadcast_srv_cmd(rspamd_main, &cmd, wrk->pid);
  752. msg_warn_main("lost heartbeat from worker type %s with pid %P, "
  753. "last beat on: %s (%L beats received previously)",
  754. g_quark_to_string(wrk->type), wrk->pid,
  755. timebuf,
  756. wrk->hb.nbeats);
  757. wrk->hb.nbeats = -1;
  758. /* TODO: send notify about worker problem */
  759. }
  760. else {
  761. wrk->hb.nbeats--;
  762. msg_warn_main("lost %L heartbeat from worker type %s with pid %P, "
  763. "last beat on: %s",
  764. -(wrk->hb.nbeats),
  765. g_quark_to_string(wrk->type),
  766. wrk->pid,
  767. timebuf);
  768. if (rspamd_main->cfg->heartbeats_loss_max > 0 &&
  769. -(wrk->hb.nbeats) >= rspamd_main->cfg->heartbeats_loss_max) {
  770. if (-(wrk->hb.nbeats) > rspamd_main->cfg->heartbeats_loss_max + 1) {
  771. msg_err_main("force kill worker type %s with pid %P, "
  772. "last beat on: %s; %L heartbeat lost",
  773. g_quark_to_string(wrk->type),
  774. wrk->pid,
  775. timebuf,
  776. -(wrk->hb.nbeats));
  777. kill(wrk->pid, SIGKILL);
  778. }
  779. else {
  780. msg_err_main("terminate worker type %s with pid %P, "
  781. "last beat on: %s; %L heartbeat lost",
  782. g_quark_to_string(wrk->type),
  783. wrk->pid,
  784. timebuf,
  785. -(wrk->hb.nbeats));
  786. kill(wrk->pid, SIGTERM);
  787. }
  788. }
  789. }
  790. }
  791. else if (wrk->hb.nbeats < 0) {
  792. rspamd_localtime(wrk->hb.last_event, &tm);
  793. r = strftime(timebuf, sizeof(timebuf), "%F %H:%M:%S", &tm);
  794. rspamd_snprintf(usec_buf, sizeof(usec_buf), "%.5f",
  795. wrk->hb.last_event - (gdouble) (time_t) wrk->hb.last_event);
  796. rspamd_snprintf(timebuf + r, sizeof(timebuf) - r,
  797. "%s", usec_buf + 1);
  798. cmd.type = RSPAMD_CONTROL_CHILD_CHANGE;
  799. cmd.cmd.child_change.what = rspamd_child_online;
  800. cmd.cmd.child_change.pid = wrk->pid;
  801. rspamd_control_broadcast_srv_cmd(rspamd_main, &cmd, wrk->pid);
  802. msg_info_main("received heartbeat from worker type %s with pid %P, "
  803. "last beat on: %s (%L beats lost previously)",
  804. g_quark_to_string(wrk->type), wrk->pid,
  805. timebuf,
  806. -(wrk->hb.nbeats));
  807. wrk->hb.nbeats = 1;
  808. /* TODO: send notify about worker restoration */
  809. }
  810. }
  811. static void
  812. rspamd_main_heartbeat_start(struct rspamd_worker *wrk, struct ev_loop *event_loop)
  813. {
  814. wrk->hb.heartbeat_ev.data = (void *) wrk;
  815. ev_timer_init(&wrk->hb.heartbeat_ev, rspamd_main_heartbeat_cb,
  816. 0.0, wrk->srv->cfg->heartbeat_interval * 2);
  817. ev_timer_start(event_loop, &wrk->hb.heartbeat_ev);
  818. }
  819. static bool
  820. rspamd_maybe_reuseport_socket(struct rspamd_worker_listen_socket *ls)
  821. {
  822. if (ls->is_systemd) {
  823. /* No need to reuseport */
  824. return true;
  825. }
  826. if (ls->fd != -1 && rspamd_inet_address_get_af(ls->addr) == AF_UNIX) {
  827. /* Just try listen */
  828. if (listen(ls->fd, -1) == -1) {
  829. return false;
  830. }
  831. return true;
  832. }
  833. #if defined(SO_REUSEPORT) && defined(SO_REUSEADDR) && defined(LINUX)
  834. gint nfd = -1;
  835. if (ls->type == RSPAMD_WORKER_SOCKET_UDP) {
  836. nfd = rspamd_inet_address_listen(ls->addr,
  837. (ls->type == RSPAMD_WORKER_SOCKET_UDP ? SOCK_DGRAM : SOCK_STREAM),
  838. RSPAMD_INET_ADDRESS_LISTEN_ASYNC | RSPAMD_INET_ADDRESS_LISTEN_REUSEPORT,
  839. -1);
  840. if (nfd == -1) {
  841. msg_warn("cannot create reuseport listen socket for %d: %s",
  842. ls->fd, strerror(errno));
  843. nfd = ls->fd;
  844. }
  845. else {
  846. if (ls->fd != -1) {
  847. close(ls->fd);
  848. }
  849. ls->fd = nfd;
  850. nfd = -1;
  851. }
  852. }
  853. else {
  854. /*
  855. * Reuseport is broken with the current architecture, so it is easier not
  856. * to use it at all
  857. */
  858. nfd = ls->fd;
  859. }
  860. #endif
  861. #if 0
  862. /* This needed merely if we have reuseport for tcp, but for now it is disabled */
  863. /* This means that we have an fd with no listening enabled */
  864. if (nfd != -1) {
  865. if (ls->type == RSPAMD_WORKER_SOCKET_TCP) {
  866. if (listen (nfd, -1) == -1) {
  867. return false;
  868. }
  869. }
  870. }
  871. #endif
  872. return true;
  873. }
  874. /**
  875. * Handles worker after fork returned zero
  876. * @param wrk
  877. * @param rspamd_main
  878. * @param cf
  879. * @param listen_sockets
  880. */
  881. static void __attribute__((noreturn))
  882. rspamd_handle_child_fork(struct rspamd_worker *wrk,
  883. struct rspamd_main *rspamd_main,
  884. struct rspamd_worker_conf *cf,
  885. GHashTable *listen_sockets)
  886. {
  887. gint rc;
  888. struct rlimit rlim;
  889. /* Update pid for logging */
  890. rspamd_log_on_fork(cf->type, rspamd_main->cfg, rspamd_main->logger);
  891. wrk->pid = getpid();
  892. /* Init PRNG after fork */
  893. rc = ottery_init(rspamd_main->cfg->libs_ctx->ottery_cfg);
  894. if (rc != OTTERY_ERR_NONE) {
  895. msg_err_main("cannot initialize PRNG: %d", rc);
  896. abort();
  897. }
  898. rspamd_random_seed_fast();
  899. #ifdef HAVE_EVUTIL_RNG_INIT
  900. evutil_secure_rng_init();
  901. #endif
  902. /*
  903. * Libev stores all signals in a global table, so
  904. * previous handlers must be explicitly detached and forgotten
  905. * before starting a new loop
  906. */
  907. ev_signal_stop(rspamd_main->event_loop, &rspamd_main->int_ev);
  908. ev_signal_stop(rspamd_main->event_loop, &rspamd_main->term_ev);
  909. ev_signal_stop(rspamd_main->event_loop, &rspamd_main->hup_ev);
  910. ev_signal_stop(rspamd_main->event_loop, &rspamd_main->usr1_ev);
  911. /* Remove the inherited event base */
  912. ev_loop_destroy(rspamd_main->event_loop);
  913. rspamd_main->event_loop = NULL;
  914. /* Close unused sockets */
  915. GHashTableIter it;
  916. gpointer k, v;
  917. g_hash_table_iter_init(&it, listen_sockets);
  918. /*
  919. * Close listen sockets of not our process (inherited from other forks)
  920. */
  921. while (g_hash_table_iter_next(&it, &k, &v)) {
  922. GList *elt = (GList *) v;
  923. GList *our = cf->listen_socks;
  924. if (g_list_position(our, elt) == -1) {
  925. GList *cur = elt;
  926. while (cur) {
  927. struct rspamd_worker_listen_socket *ls =
  928. (struct rspamd_worker_listen_socket *) cur->data;
  929. if (ls->fd != -1 && close(ls->fd) == -1) {
  930. msg_err("cannot close fd %d (addr = %s): %s",
  931. ls->fd,
  932. rspamd_inet_address_to_string_pretty(ls->addr),
  933. strerror(errno));
  934. }
  935. ls->fd = -1;
  936. cur = g_list_next(cur);
  937. }
  938. }
  939. }
  940. /* Reuseport before dropping privs */
  941. GList *cur = cf->listen_socks;
  942. while (cur) {
  943. struct rspamd_worker_listen_socket *ls =
  944. (struct rspamd_worker_listen_socket *) cur->data;
  945. if (!rspamd_maybe_reuseport_socket(ls)) {
  946. msg_err("cannot listen on socket %s: %s",
  947. rspamd_inet_address_to_string_pretty(ls->addr),
  948. strerror(errno));
  949. }
  950. cur = g_list_next(cur);
  951. }
  952. /* Drop privileges */
  953. rspamd_worker_drop_priv(rspamd_main);
  954. /* Set limits */
  955. rspamd_worker_set_limits(rspamd_main, cf);
  956. /* Re-set stack limit */
  957. getrlimit(RLIMIT_STACK, &rlim);
  958. rlim.rlim_cur = 100 * 1024 * 1024;
  959. rlim.rlim_max = rlim.rlim_cur;
  960. setrlimit(RLIMIT_STACK, &rlim);
  961. if (cf->bind_conf) {
  962. rspamd_setproctitle("%s process (%s)", cf->worker->name,
  963. cf->bind_conf->bind_line);
  964. }
  965. else {
  966. rspamd_setproctitle("%s process", cf->worker->name);
  967. }
  968. if (rspamd_main->pfh) {
  969. rspamd_pidfile_close(rspamd_main->pfh);
  970. }
  971. if (rspamd_main->cfg->log_silent_workers) {
  972. rspamd_log_set_log_level(rspamd_main->logger, G_LOG_LEVEL_MESSAGE);
  973. }
  974. wrk->start_time = rspamd_get_calendar_ticks();
  975. if (cf->bind_conf) {
  976. GString *listen_conf_stringified = g_string_new(NULL);
  977. struct rspamd_worker_bind_conf *cur_conf;
  978. LL_FOREACH(cf->bind_conf, cur_conf)
  979. {
  980. if (cur_conf->next) {
  981. rspamd_printf_gstring(listen_conf_stringified, "%s, ",
  982. cur_conf->bind_line);
  983. }
  984. else {
  985. rspamd_printf_gstring(listen_conf_stringified, "%s",
  986. cur_conf->bind_line);
  987. }
  988. }
  989. msg_info_main("starting %s process %P (%d); listen on: %v",
  990. cf->worker->name,
  991. getpid(), wrk->index, listen_conf_stringified);
  992. g_string_free(listen_conf_stringified, TRUE);
  993. }
  994. else {
  995. msg_info_main("starting %s process %P (%d); no listen",
  996. cf->worker->name,
  997. getpid(), wrk->index);
  998. }
  999. /* Close parent part of socketpair */
  1000. close(wrk->control_pipe[0]);
  1001. close(wrk->srv_pipe[0]);
  1002. /*
  1003. * Read comments in `rspamd_handle_main_fork` for details why these channel
  1004. * is blocking.
  1005. */
  1006. rspamd_socket_nonblocking(wrk->control_pipe[1]);
  1007. #if 0
  1008. rspamd_socket_nonblocking (wrk->srv_pipe[1]);
  1009. #endif
  1010. rspamd_main->cfg->cur_worker = wrk;
  1011. /* Execute worker (this function should not return normally!) */
  1012. cf->worker->worker_start_func(wrk);
  1013. /* To distinguish from normal termination */
  1014. exit(EXIT_FAILURE);
  1015. }
  1016. static void
  1017. rspamd_handle_main_fork(struct rspamd_worker *wrk,
  1018. struct rspamd_main *rspamd_main,
  1019. struct rspamd_worker_conf *cf,
  1020. struct ev_loop *ev_base)
  1021. {
  1022. /* Close worker part of socketpair */
  1023. close(wrk->control_pipe[1]);
  1024. close(wrk->srv_pipe[1]);
  1025. /*
  1026. * There are no reasons why control pipes are blocking: the messages
  1027. * there are rare and are strictly bounded by command sizes, so if we block
  1028. * on some pipe, it is ok, as we still poll that for all operations.
  1029. * It is also impossible to block on writing in normal conditions.
  1030. * And if the conditions are not normal, e.g. a worker is unresponsive, then
  1031. * we can safely think that the non-blocking behaviour as it is implemented
  1032. * currently will not make things better, as it would lead to incomplete
  1033. * reads/writes that are not handled anyhow and are totally broken from the
  1034. * beginning.
  1035. */
  1036. #if 0
  1037. rspamd_socket_nonblocking (wrk->srv_pipe[0]);
  1038. #endif
  1039. rspamd_socket_nonblocking(wrk->control_pipe[0]);
  1040. rspamd_srv_start_watching(rspamd_main, wrk, ev_base);
  1041. /* Child event */
  1042. wrk->cld_ev.data = wrk;
  1043. ev_child_init(&wrk->cld_ev, rspamd_worker_on_term, wrk->pid, 0);
  1044. ev_child_start(rspamd_main->event_loop, &wrk->cld_ev);
  1045. /* Heartbeats */
  1046. rspamd_main_heartbeat_start(wrk, rspamd_main->event_loop);
  1047. /* Insert worker into worker's table, pid is index */
  1048. g_hash_table_insert(rspamd_main->workers,
  1049. GSIZE_TO_POINTER(wrk->pid), wrk);
  1050. #if defined(SO_REUSEPORT) && defined(SO_REUSEADDR) && defined(LINUX)
  1051. /*
  1052. * Close listen sockets in the main process once a child is handling them,
  1053. * if we have reuseport
  1054. */
  1055. GList *cur = cf->listen_socks;
  1056. while (cur) {
  1057. struct rspamd_worker_listen_socket *ls =
  1058. (struct rspamd_worker_listen_socket *) cur->data;
  1059. if (ls->fd != -1 && ls->type == RSPAMD_WORKER_SOCKET_UDP) {
  1060. close(ls->fd);
  1061. ls->fd = -1;
  1062. }
  1063. cur = g_list_next(cur);
  1064. }
  1065. #endif
  1066. }
  1067. #ifndef SOCK_SEQPACKET
  1068. #define SOCK_SEQPACKET SOCK_DGRAM
  1069. #endif
  1070. struct rspamd_worker *
  1071. rspamd_fork_worker(struct rspamd_main *rspamd_main,
  1072. struct rspamd_worker_conf *cf,
  1073. guint index,
  1074. struct ev_loop *ev_base,
  1075. rspamd_worker_term_cb term_handler,
  1076. GHashTable *listen_sockets)
  1077. {
  1078. struct rspamd_worker *wrk;
  1079. /* Starting worker process */
  1080. wrk = (struct rspamd_worker *) g_malloc0(sizeof(struct rspamd_worker));
  1081. if (!rspamd_socketpair(wrk->control_pipe, SOCK_SEQPACKET)) {
  1082. msg_err("socketpair failure: %s", strerror(errno));
  1083. rspamd_hard_terminate(rspamd_main);
  1084. }
  1085. if (!rspamd_socketpair(wrk->srv_pipe, SOCK_SEQPACKET)) {
  1086. msg_err("socketpair failure: %s", strerror(errno));
  1087. rspamd_hard_terminate(rspamd_main);
  1088. }
  1089. if (cf->bind_conf) {
  1090. msg_info_main("prepare to fork process %s (%d); listen on: %s",
  1091. cf->worker->name,
  1092. index, cf->bind_conf->name);
  1093. }
  1094. else {
  1095. msg_info_main("prepare to fork process %s (%d), no bind socket",
  1096. cf->worker->name,
  1097. index);
  1098. }
  1099. wrk->srv = rspamd_main;
  1100. wrk->type = cf->type;
  1101. wrk->cf = cf;
  1102. wrk->flags = cf->worker->flags;
  1103. REF_RETAIN(cf);
  1104. wrk->index = index;
  1105. wrk->ctx = cf->ctx;
  1106. wrk->ppid = getpid();
  1107. wrk->pid = fork();
  1108. wrk->cores_throttled = rspamd_main->cores_throttling;
  1109. wrk->term_handler = term_handler;
  1110. wrk->control_events_pending = g_hash_table_new_full(g_direct_hash, g_direct_equal,
  1111. NULL, rspamd_pending_control_free);
  1112. switch (wrk->pid) {
  1113. case 0:
  1114. rspamd_current_worker = wrk;
  1115. rspamd_handle_child_fork(wrk, rspamd_main, cf, listen_sockets);
  1116. break;
  1117. case -1:
  1118. msg_err_main("cannot fork main process: %s", strerror(errno));
  1119. if (rspamd_main->pfh) {
  1120. rspamd_pidfile_remove(rspamd_main->pfh);
  1121. }
  1122. rspamd_hard_terminate(rspamd_main);
  1123. break;
  1124. default:
  1125. rspamd_handle_main_fork(wrk, rspamd_main, cf, ev_base);
  1126. break;
  1127. }
  1128. return wrk;
  1129. }
  1130. void rspamd_worker_block_signals(void)
  1131. {
  1132. sigset_t set;
  1133. sigemptyset(&set);
  1134. sigaddset(&set, SIGTERM);
  1135. sigaddset(&set, SIGINT);
  1136. sigaddset(&set, SIGHUP);
  1137. sigaddset(&set, SIGUSR1);
  1138. sigaddset(&set, SIGUSR2);
  1139. sigprocmask(SIG_BLOCK, &set, NULL);
  1140. }
  1141. void rspamd_worker_unblock_signals(void)
  1142. {
  1143. sigset_t set;
  1144. sigemptyset(&set);
  1145. sigaddset(&set, SIGTERM);
  1146. sigaddset(&set, SIGINT);
  1147. sigaddset(&set, SIGHUP);
  1148. sigaddset(&set, SIGUSR1);
  1149. sigaddset(&set, SIGUSR2);
  1150. sigprocmask(SIG_UNBLOCK, &set, NULL);
  1151. }
  1152. void rspamd_hard_terminate(struct rspamd_main *rspamd_main)
  1153. {
  1154. GHashTableIter it;
  1155. gpointer k, v;
  1156. struct rspamd_worker *w;
  1157. sigset_t set;
  1158. /* Block all signals */
  1159. sigemptyset(&set);
  1160. sigaddset(&set, SIGTERM);
  1161. sigaddset(&set, SIGINT);
  1162. sigaddset(&set, SIGHUP);
  1163. sigaddset(&set, SIGUSR1);
  1164. sigaddset(&set, SIGUSR2);
  1165. sigaddset(&set, SIGCHLD);
  1166. sigprocmask(SIG_BLOCK, &set, NULL);
  1167. /* We need to terminate all workers that might be already spawned */
  1168. rspamd_worker_block_signals();
  1169. g_hash_table_iter_init(&it, rspamd_main->workers);
  1170. while (g_hash_table_iter_next(&it, &k, &v)) {
  1171. w = v;
  1172. msg_err_main("kill worker %P as Rspamd is terminating due to "
  1173. "an unrecoverable error",
  1174. w->pid);
  1175. kill(w->pid, SIGKILL);
  1176. }
  1177. msg_err_main("shutting down Rspamd due to fatal error");
  1178. rspamd_log_close(rspamd_main->logger);
  1179. exit(EXIT_FAILURE);
  1180. }
  1181. gboolean
  1182. rspamd_worker_is_scanner(struct rspamd_worker *w)
  1183. {
  1184. if (w) {
  1185. return !!(w->flags & RSPAMD_WORKER_SCANNER);
  1186. }
  1187. return FALSE;
  1188. }
  1189. gboolean
  1190. rspamd_worker_is_primary_controller(struct rspamd_worker *w)
  1191. {
  1192. if (w) {
  1193. return !!(w->flags & RSPAMD_WORKER_CONTROLLER) && w->index == 0;
  1194. }
  1195. return FALSE;
  1196. }
  1197. gboolean
  1198. rspamd_worker_check_controller_presence(struct rspamd_worker *w)
  1199. {
  1200. if (w->index == 0) {
  1201. GQuark our_type = w->type;
  1202. gboolean controller_seen = FALSE;
  1203. GList *cur;
  1204. enum {
  1205. low_priority_worker,
  1206. high_priority_worker
  1207. } our_priority;
  1208. if (our_type == g_quark_from_static_string("rspamd_proxy")) {
  1209. our_priority = low_priority_worker;
  1210. }
  1211. else if (our_type == g_quark_from_static_string("normal")) {
  1212. our_priority = high_priority_worker;
  1213. }
  1214. else {
  1215. msg_err("function is called for a wrong worker type: %s", g_quark_to_string(our_type));
  1216. return FALSE;
  1217. }
  1218. cur = w->srv->cfg->workers;
  1219. while (cur) {
  1220. struct rspamd_worker_conf *cf;
  1221. cf = (struct rspamd_worker_conf *) cur->data;
  1222. if (our_priority == low_priority_worker) {
  1223. if ((cf->type == g_quark_from_static_string("controller")) ||
  1224. (cf->type == g_quark_from_static_string("normal"))) {
  1225. if (cf->enabled && cf->count >= 0) {
  1226. controller_seen = TRUE;
  1227. break;
  1228. }
  1229. }
  1230. }
  1231. else {
  1232. if (cf->type == g_quark_from_static_string("controller")) {
  1233. if (cf->enabled && cf->count >= 0) {
  1234. controller_seen = TRUE;
  1235. break;
  1236. }
  1237. }
  1238. }
  1239. cur = g_list_next(cur);
  1240. }
  1241. if (!controller_seen) {
  1242. msg_info("no controller or normal workers defined, execute "
  1243. "controller periodics in this worker");
  1244. w->flags |= RSPAMD_WORKER_CONTROLLER;
  1245. return TRUE;
  1246. }
  1247. }
  1248. return FALSE;
  1249. }
  1250. struct rspamd_worker_session_elt {
  1251. void *ptr;
  1252. guint *pref;
  1253. const gchar *tag;
  1254. time_t when;
  1255. };
  1256. struct rspamd_worker_session_cache {
  1257. struct ev_loop *ev_base;
  1258. GHashTable *cache;
  1259. struct rspamd_config *cfg;
  1260. struct ev_timer periodic;
  1261. };
  1262. static gint
  1263. rspamd_session_cache_sort_cmp(gconstpointer pa, gconstpointer pb)
  1264. {
  1265. const struct rspamd_worker_session_elt
  1266. *e1 = *(const struct rspamd_worker_session_elt **) pa,
  1267. *e2 = *(const struct rspamd_worker_session_elt **) pb;
  1268. return e2->when < e1->when;
  1269. }
  1270. static void
  1271. rspamd_sessions_cache_periodic(EV_P_ ev_timer *w, int revents)
  1272. {
  1273. struct rspamd_worker_session_cache *c =
  1274. (struct rspamd_worker_session_cache *) w->data;
  1275. GHashTableIter it;
  1276. gchar timebuf[32];
  1277. gpointer k, v;
  1278. struct rspamd_worker_session_elt *elt;
  1279. struct tm tms;
  1280. GPtrArray *res;
  1281. guint i;
  1282. if (g_hash_table_size(c->cache) > c->cfg->max_sessions_cache) {
  1283. res = g_ptr_array_sized_new(g_hash_table_size(c->cache));
  1284. g_hash_table_iter_init(&it, c->cache);
  1285. while (g_hash_table_iter_next(&it, &k, &v)) {
  1286. g_ptr_array_add(res, v);
  1287. }
  1288. msg_err("sessions cache is overflowed %d elements where %d is limit",
  1289. (gint) res->len, (gint) c->cfg->max_sessions_cache);
  1290. g_ptr_array_sort(res, rspamd_session_cache_sort_cmp);
  1291. PTR_ARRAY_FOREACH(res, i, elt)
  1292. {
  1293. rspamd_localtime(elt->when, &tms);
  1294. strftime(timebuf, sizeof(timebuf), "%F %H:%M:%S", &tms);
  1295. msg_warn("redundant session; ptr: %p, "
  1296. "tag: %s, refcount: %d, time: %s",
  1297. elt->ptr, elt->tag ? elt->tag : "unknown",
  1298. elt->pref ? *elt->pref : 0,
  1299. timebuf);
  1300. }
  1301. }
  1302. ev_timer_again(EV_A_ w);
  1303. }
  1304. void *
  1305. rspamd_worker_session_cache_new(struct rspamd_worker *w,
  1306. struct ev_loop *ev_base)
  1307. {
  1308. struct rspamd_worker_session_cache *c;
  1309. static const gdouble periodic_interval = 60.0;
  1310. c = g_malloc0(sizeof(*c));
  1311. c->ev_base = ev_base;
  1312. c->cache = g_hash_table_new_full(g_direct_hash, g_direct_equal,
  1313. NULL, g_free);
  1314. c->cfg = w->srv->cfg;
  1315. c->periodic.data = c;
  1316. ev_timer_init(&c->periodic, rspamd_sessions_cache_periodic, periodic_interval,
  1317. periodic_interval);
  1318. ev_timer_start(ev_base, &c->periodic);
  1319. return c;
  1320. }
  1321. void rspamd_worker_session_cache_add(void *cache, const gchar *tag,
  1322. guint *pref, void *ptr)
  1323. {
  1324. struct rspamd_worker_session_cache *c = cache;
  1325. struct rspamd_worker_session_elt *elt;
  1326. elt = g_malloc0(sizeof(*elt));
  1327. elt->pref = pref;
  1328. elt->ptr = ptr;
  1329. elt->tag = tag;
  1330. elt->when = time(NULL);
  1331. g_hash_table_insert(c->cache, elt->ptr, elt);
  1332. }
  1333. void rspamd_worker_session_cache_remove(void *cache, void *ptr)
  1334. {
  1335. struct rspamd_worker_session_cache *c = cache;
  1336. g_hash_table_remove(c->cache, ptr);
  1337. }
  1338. static void
  1339. rspamd_worker_monitored_on_change(struct rspamd_monitored_ctx *ctx,
  1340. struct rspamd_monitored *m, gboolean alive,
  1341. void *ud)
  1342. {
  1343. struct rspamd_worker *worker = ud;
  1344. struct rspamd_config *cfg = worker->srv->cfg;
  1345. struct ev_loop *ev_base;
  1346. guchar tag[RSPAMD_MONITORED_TAG_LEN];
  1347. static struct rspamd_srv_command srv_cmd;
  1348. rspamd_monitored_get_tag(m, tag);
  1349. ev_base = rspamd_monitored_ctx_get_ev_base(ctx);
  1350. memset(&srv_cmd, 0, sizeof(srv_cmd));
  1351. srv_cmd.type = RSPAMD_SRV_MONITORED_CHANGE;
  1352. rspamd_strlcpy(srv_cmd.cmd.monitored_change.tag, tag,
  1353. sizeof(srv_cmd.cmd.monitored_change.tag));
  1354. srv_cmd.cmd.monitored_change.alive = alive;
  1355. srv_cmd.cmd.monitored_change.sender = getpid();
  1356. msg_info_config("broadcast monitored update for %s: %s",
  1357. srv_cmd.cmd.monitored_change.tag, alive ? "alive" : "dead");
  1358. rspamd_srv_send_command(worker, ev_base, &srv_cmd, -1, NULL, NULL);
  1359. }
  1360. void rspamd_worker_init_monitored(struct rspamd_worker *worker,
  1361. struct ev_loop *ev_base,
  1362. struct rspamd_dns_resolver *resolver)
  1363. {
  1364. rspamd_monitored_ctx_config(worker->srv->cfg->monitored_ctx,
  1365. worker->srv->cfg, ev_base, resolver->r,
  1366. rspamd_worker_monitored_on_change, worker);
  1367. }
  1368. #ifdef HAVE_SA_SIGINFO
  1369. static struct rspamd_main *saved_main = NULL;
  1370. static gboolean
  1371. rspamd_crash_propagate(gpointer key, gpointer value, gpointer unused)
  1372. {
  1373. struct rspamd_worker *w = value;
  1374. /* Kill children softly */
  1375. kill(w->pid, SIGTERM);
  1376. return TRUE;
  1377. }
  1378. #ifdef BACKWARD_ENABLE
  1379. /* See backtrace.cxx */
  1380. extern void rspamd_print_crash(void);
  1381. #endif
  1382. static void
  1383. rspamd_crash_sig_handler(int sig, siginfo_t *info, void *ctx)
  1384. {
  1385. struct sigaction sa;
  1386. ucontext_t *uap = ctx;
  1387. pid_t pid;
  1388. pid = getpid();
  1389. msg_err("caught fatal signal %d(%s), "
  1390. "pid: %P, trace: ",
  1391. sig, strsignal(sig), pid);
  1392. (void) uap;
  1393. #ifdef BACKWARD_ENABLE
  1394. rspamd_print_crash();
  1395. #endif
  1396. msg_err("please see Rspamd FAQ to learn how to dump core files and how to "
  1397. "fill a bug report");
  1398. if (saved_main) {
  1399. if (pid == saved_main->pid) {
  1400. /*
  1401. * Main process has crashed, propagate crash further to trigger
  1402. * monitoring alerts and mass panic
  1403. */
  1404. g_hash_table_foreach_remove(saved_main->workers,
  1405. rspamd_crash_propagate, NULL);
  1406. }
  1407. }
  1408. /*
  1409. * Invoke signal with the default handler
  1410. */
  1411. sigemptyset(&sa.sa_mask);
  1412. sa.sa_handler = SIG_DFL;
  1413. sa.sa_flags = 0;
  1414. sigaction(sig, &sa, NULL);
  1415. kill(pid, sig);
  1416. }
  1417. #endif
  1418. RSPAMD_NO_SANITIZE void
  1419. rspamd_set_crash_handler(struct rspamd_main *rspamd_main)
  1420. {
  1421. #ifdef HAVE_SA_SIGINFO
  1422. struct sigaction sa;
  1423. #ifdef HAVE_SIGALTSTACK
  1424. void *stack_mem;
  1425. stack_t ss;
  1426. memset(&ss, 0, sizeof ss);
  1427. ss.ss_size = MAX(SIGSTKSZ, 8192 * 4);
  1428. stack_mem = g_malloc0(ss.ss_size);
  1429. ss.ss_sp = stack_mem;
  1430. sigaltstack(&ss, NULL);
  1431. #endif
  1432. saved_main = rspamd_main;
  1433. sigemptyset(&sa.sa_mask);
  1434. sa.sa_sigaction = &rspamd_crash_sig_handler;
  1435. sa.sa_flags = SA_RESTART | SA_SIGINFO | SA_ONSTACK;
  1436. sigaction(SIGSEGV, &sa, NULL);
  1437. sigaction(SIGBUS, &sa, NULL);
  1438. sigaction(SIGABRT, &sa, NULL);
  1439. sigaction(SIGFPE, &sa, NULL);
  1440. sigaction(SIGSYS, &sa, NULL);
  1441. #endif
  1442. }
  1443. RSPAMD_NO_SANITIZE void rspamd_unset_crash_handler(struct rspamd_main *unused_)
  1444. {
  1445. #ifdef HAVE_SIGALTSTACK
  1446. int ret;
  1447. stack_t ss;
  1448. ret = sigaltstack(NULL, &ss);
  1449. if (ret != -1) {
  1450. if (ss.ss_size > 0 && ss.ss_sp) {
  1451. g_free(ss.ss_sp);
  1452. }
  1453. ss.ss_size = 0;
  1454. ss.ss_sp = NULL;
  1455. #ifdef SS_DISABLE
  1456. ss.ss_flags |= SS_DISABLE;
  1457. #endif
  1458. sigaltstack(&ss, NULL);
  1459. }
  1460. #endif
  1461. }
  1462. static void
  1463. rspamd_enable_accept_event(EV_P_ ev_timer *w, int revents)
  1464. {
  1465. struct rspamd_worker_accept_event *ac_ev =
  1466. (struct rspamd_worker_accept_event *) w->data;
  1467. ev_timer_stop(EV_A_ w);
  1468. ev_io_start(EV_A_ & ac_ev->accept_ev);
  1469. }
  1470. void rspamd_worker_throttle_accept_events(gint sock, void *data)
  1471. {
  1472. struct rspamd_worker_accept_event *head, *cur;
  1473. const gdouble throttling = 0.5;
  1474. head = (struct rspamd_worker_accept_event *) data;
  1475. DL_FOREACH(head, cur)
  1476. {
  1477. ev_io_stop(cur->event_loop, &cur->accept_ev);
  1478. cur->throttling_ev.data = cur;
  1479. ev_timer_init(&cur->throttling_ev, rspamd_enable_accept_event,
  1480. throttling, 0.0);
  1481. ev_timer_start(cur->event_loop, &cur->throttling_ev);
  1482. }
  1483. }
  1484. gboolean
  1485. rspamd_check_termination_clause(struct rspamd_main *rspamd_main,
  1486. struct rspamd_worker *wrk,
  1487. int res)
  1488. {
  1489. gboolean need_refork = TRUE;
  1490. if (wrk->state != rspamd_worker_state_running || rspamd_main->wanna_die ||
  1491. (wrk->flags & RSPAMD_WORKER_OLD_CONFIG)) {
  1492. /* Do not refork workers that are intended to be terminated */
  1493. need_refork = FALSE;
  1494. }
  1495. if (WIFEXITED(res) && WEXITSTATUS(res) == 0) {
  1496. /* Normal worker termination, do not fork one more */
  1497. if (wrk->flags & RSPAMD_WORKER_OLD_CONFIG) {
  1498. /* Never re-fork old workers */
  1499. msg_info_main("%s process %P terminated normally",
  1500. g_quark_to_string(wrk->type),
  1501. wrk->pid);
  1502. need_refork = FALSE;
  1503. }
  1504. else {
  1505. if (wrk->hb.nbeats < 0 && rspamd_main->cfg->heartbeats_loss_max > 0 &&
  1506. -(wrk->hb.nbeats) >= rspamd_main->cfg->heartbeats_loss_max) {
  1507. msg_info_main("%s process %P terminated normally, but lost %L "
  1508. "heartbeats, refork it",
  1509. g_quark_to_string(wrk->type),
  1510. wrk->pid,
  1511. -(wrk->hb.nbeats));
  1512. need_refork = TRUE;
  1513. }
  1514. else {
  1515. msg_info_main("%s process %P terminated normally",
  1516. g_quark_to_string(wrk->type),
  1517. wrk->pid);
  1518. need_refork = FALSE;
  1519. }
  1520. }
  1521. }
  1522. else {
  1523. if (WIFSIGNALED(res)) {
  1524. #ifdef WCOREDUMP
  1525. if (WCOREDUMP(res)) {
  1526. msg_warn_main(
  1527. "%s process %P terminated abnormally by signal: %s"
  1528. " and created core file; please see Rspamd FAQ "
  1529. "to learn how to extract data from core file and "
  1530. "fill a bug report",
  1531. g_quark_to_string(wrk->type),
  1532. wrk->pid,
  1533. g_strsignal(WTERMSIG(res)));
  1534. }
  1535. else {
  1536. #ifdef HAVE_SYS_RESOURCE_H
  1537. struct rlimit rlmt;
  1538. (void) getrlimit(RLIMIT_CORE, &rlmt);
  1539. msg_warn_main(
  1540. "%s process %P terminated abnormally with exit code %d by "
  1541. "signal: %s"
  1542. " but NOT created core file (throttled=%s); "
  1543. "core file limits: %L current, %L max",
  1544. g_quark_to_string(wrk->type),
  1545. wrk->pid,
  1546. WEXITSTATUS(res),
  1547. g_strsignal(WTERMSIG(res)),
  1548. wrk->cores_throttled ? "yes" : "no",
  1549. (int64_t) rlmt.rlim_cur,
  1550. (int64_t) rlmt.rlim_max);
  1551. #else
  1552. msg_warn_main(
  1553. "%s process %P terminated abnormally with exit code %d by signal: %s"
  1554. " but NOT created core file (throttled=%s); ",
  1555. g_quark_to_string(wrk->type),
  1556. wrk->pid, WEXITSTATUS(res),
  1557. g_strsignal(WTERMSIG(res)),
  1558. wrk->cores_throttled ? "yes" : "no");
  1559. #endif
  1560. }
  1561. #else
  1562. msg_warn_main(
  1563. "%s process %P terminated abnormally with exit code %d by signal: %s",
  1564. g_quark_to_string(wrk->type),
  1565. wrk->pid, WEXITSTATUS(res),
  1566. g_strsignal(WTERMSIG(res)));
  1567. #endif
  1568. if (WTERMSIG(res) == SIGUSR2) {
  1569. /*
  1570. * It is actually race condition when not started process
  1571. * has been requested to be reloaded.
  1572. *
  1573. * We shouldn't refork on this
  1574. */
  1575. need_refork = FALSE;
  1576. }
  1577. }
  1578. else {
  1579. msg_warn_main("%s process %P terminated abnormally "
  1580. "(but it was not killed by a signal) "
  1581. "with exit code %d",
  1582. g_quark_to_string(wrk->type),
  1583. wrk->pid,
  1584. WEXITSTATUS(res));
  1585. }
  1586. }
  1587. return need_refork;
  1588. }
  1589. #ifdef WITH_HYPERSCAN
  1590. gboolean
  1591. rspamd_worker_hyperscan_ready(struct rspamd_main *rspamd_main,
  1592. struct rspamd_worker *worker, gint fd,
  1593. gint attached_fd,
  1594. struct rspamd_control_command *cmd,
  1595. gpointer ud)
  1596. {
  1597. struct rspamd_control_reply rep;
  1598. struct rspamd_re_cache *cache = worker->srv->cfg->re_cache;
  1599. memset(&rep, 0, sizeof(rep));
  1600. rep.type = RSPAMD_CONTROL_HYPERSCAN_LOADED;
  1601. if (rspamd_re_cache_is_hs_loaded(cache) != RSPAMD_HYPERSCAN_LOADED_FULL ||
  1602. cmd->cmd.hs_loaded.forced) {
  1603. msg_info("loading hyperscan expressions after receiving compilation "
  1604. "notice: %s",
  1605. (rspamd_re_cache_is_hs_loaded(cache) != RSPAMD_HYPERSCAN_LOADED_FULL) ? "new db" : "forced update");
  1606. rep.reply.hs_loaded.status = rspamd_re_cache_load_hyperscan(
  1607. worker->srv->cfg->re_cache, cmd->cmd.hs_loaded.cache_dir, false);
  1608. }
  1609. if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
  1610. msg_err("cannot write reply to the control socket: %s",
  1611. strerror(errno));
  1612. }
  1613. return TRUE;
  1614. }
  1615. #endif /* With Hyperscan */
  1616. gboolean
  1617. rspamd_worker_check_context(gpointer ctx, uint64_t magic)
  1618. {
  1619. struct rspamd_abstract_worker_ctx *actx = (struct rspamd_abstract_worker_ctx *) ctx;
  1620. return actx->magic == magic;
  1621. }
  1622. static gboolean
  1623. rspamd_worker_log_pipe_handler(struct rspamd_main *rspamd_main,
  1624. struct rspamd_worker *worker, gint fd,
  1625. gint attached_fd,
  1626. struct rspamd_control_command *cmd,
  1627. gpointer ud)
  1628. {
  1629. struct rspamd_config *cfg = ud;
  1630. struct rspamd_worker_log_pipe *lp;
  1631. struct rspamd_control_reply rep;
  1632. memset(&rep, 0, sizeof(rep));
  1633. rep.type = RSPAMD_CONTROL_LOG_PIPE;
  1634. if (attached_fd != -1) {
  1635. lp = g_malloc0(sizeof(*lp));
  1636. lp->fd = attached_fd;
  1637. lp->type = cmd->cmd.log_pipe.type;
  1638. DL_APPEND(cfg->log_pipes, lp);
  1639. msg_info("added new log pipe");
  1640. }
  1641. else {
  1642. rep.reply.log_pipe.status = ENOENT;
  1643. msg_err("cannot attach log pipe: invalid fd");
  1644. }
  1645. if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
  1646. msg_err("cannot write reply to the control socket: %s",
  1647. strerror(errno));
  1648. }
  1649. return TRUE;
  1650. }
  1651. static gboolean
  1652. rspamd_worker_monitored_handler(struct rspamd_main *rspamd_main,
  1653. struct rspamd_worker *worker, gint fd,
  1654. gint attached_fd,
  1655. struct rspamd_control_command *cmd,
  1656. gpointer ud)
  1657. {
  1658. struct rspamd_control_reply rep;
  1659. struct rspamd_monitored *m;
  1660. struct rspamd_monitored_ctx *mctx = worker->srv->cfg->monitored_ctx;
  1661. struct rspamd_config *cfg = ud;
  1662. memset(&rep, 0, sizeof(rep));
  1663. rep.type = RSPAMD_CONTROL_MONITORED_CHANGE;
  1664. if (cmd->cmd.monitored_change.sender != getpid()) {
  1665. m = rspamd_monitored_by_tag(mctx, cmd->cmd.monitored_change.tag);
  1666. if (m != NULL) {
  1667. rspamd_monitored_set_alive(m, cmd->cmd.monitored_change.alive);
  1668. rep.reply.monitored_change.status = 1;
  1669. msg_info_config("updated monitored status for %s: %s",
  1670. cmd->cmd.monitored_change.tag,
  1671. cmd->cmd.monitored_change.alive ? "alive" : "dead");
  1672. }
  1673. else {
  1674. msg_err("cannot find monitored by tag: %*s", 32,
  1675. cmd->cmd.monitored_change.tag);
  1676. rep.reply.monitored_change.status = 0;
  1677. }
  1678. }
  1679. if (write(fd, &rep, sizeof(rep)) != sizeof(rep)) {
  1680. msg_err("cannot write reply to the control socket: %s",
  1681. strerror(errno));
  1682. }
  1683. return TRUE;
  1684. }
  1685. void rspamd_worker_init_scanner(struct rspamd_worker *worker,
  1686. struct ev_loop *ev_base,
  1687. struct rspamd_dns_resolver *resolver,
  1688. struct rspamd_lang_detector **plang_det)
  1689. {
  1690. rspamd_stat_init(worker->srv->cfg, ev_base);
  1691. #ifdef WITH_HYPERSCAN
  1692. rspamd_control_worker_add_cmd_handler(worker,
  1693. RSPAMD_CONTROL_HYPERSCAN_LOADED,
  1694. rspamd_worker_hyperscan_ready,
  1695. NULL);
  1696. #endif
  1697. rspamd_control_worker_add_cmd_handler(worker,
  1698. RSPAMD_CONTROL_LOG_PIPE,
  1699. rspamd_worker_log_pipe_handler,
  1700. worker->srv->cfg);
  1701. rspamd_control_worker_add_cmd_handler(worker,
  1702. RSPAMD_CONTROL_MONITORED_CHANGE,
  1703. rspamd_worker_monitored_handler,
  1704. worker->srv->cfg);
  1705. *plang_det = worker->srv->cfg->lang_det;
  1706. }
  1707. void rspamd_controller_store_saved_stats(struct rspamd_main *rspamd_main,
  1708. struct rspamd_config *cfg)
  1709. {
  1710. struct rspamd_stat *stat;
  1711. ucl_object_t *top, *sub;
  1712. struct ucl_emitter_functions *efuncs;
  1713. gint i, fd;
  1714. FILE *fp;
  1715. gchar fpath[PATH_MAX];
  1716. if (cfg->stats_file == NULL) {
  1717. return;
  1718. }
  1719. rspamd_snprintf(fpath, sizeof(fpath), "%s.XXXXXXXX", cfg->stats_file);
  1720. fd = g_mkstemp_full(fpath, O_WRONLY | O_TRUNC, 00644);
  1721. if (fd == -1) {
  1722. msg_err_config("cannot open for writing controller stats from %s: %s",
  1723. fpath, strerror(errno));
  1724. return;
  1725. }
  1726. fp = fdopen(fd, "w");
  1727. stat = rspamd_main->stat;
  1728. top = ucl_object_typed_new(UCL_OBJECT);
  1729. ucl_object_insert_key(top, ucl_object_fromint(stat->messages_scanned), "scanned", 0, false);
  1730. ucl_object_insert_key(top, ucl_object_fromint(stat->messages_learned), "learned", 0, false);
  1731. if (stat->messages_scanned > 0) {
  1732. sub = ucl_object_typed_new(UCL_OBJECT);
  1733. for (i = METRIC_ACTION_REJECT; i <= METRIC_ACTION_NOACTION; i++) {
  1734. ucl_object_insert_key(sub,
  1735. ucl_object_fromint(stat->actions_stat[i]),
  1736. rspamd_action_to_str(i), 0, false);
  1737. }
  1738. ucl_object_insert_key(top, sub, "actions", 0, false);
  1739. }
  1740. ucl_object_insert_key(top,
  1741. ucl_object_fromint(stat->connections_count),
  1742. "connections", 0, false);
  1743. ucl_object_insert_key(top,
  1744. ucl_object_fromint(stat->control_connections_count),
  1745. "control_connections", 0, false);
  1746. efuncs = ucl_object_emit_file_funcs(fp);
  1747. if (!ucl_object_emit_full(top, UCL_EMIT_JSON_COMPACT,
  1748. efuncs, NULL)) {
  1749. msg_err_config("cannot write stats to %s: %s",
  1750. fpath, strerror(errno));
  1751. unlink(fpath);
  1752. }
  1753. else {
  1754. if (rename(fpath, cfg->stats_file) == -1) {
  1755. msg_err_config("cannot rename stats from %s to %s: %s",
  1756. fpath, cfg->stats_file, strerror(errno));
  1757. }
  1758. }
  1759. ucl_object_unref(top);
  1760. fclose(fp);
  1761. ucl_object_emit_funcs_free(efuncs);
  1762. }
  1763. static ev_timer rrd_timer;
  1764. void rspamd_controller_on_terminate(struct rspamd_worker *worker,
  1765. struct rspamd_rrd_file *rrd)
  1766. {
  1767. struct rspamd_abstract_worker_ctx *ctx;
  1768. ctx = (struct rspamd_abstract_worker_ctx *) worker->ctx;
  1769. rspamd_controller_store_saved_stats(worker->srv, worker->srv->cfg);
  1770. if (rrd) {
  1771. ev_timer_stop(ctx->event_loop, &rrd_timer);
  1772. msg_info("closing rrd file: %s", rrd->filename);
  1773. rspamd_rrd_close(rrd);
  1774. }
  1775. }
  1776. static void
  1777. rspamd_controller_load_saved_stats(struct rspamd_main *rspamd_main,
  1778. struct rspamd_config *cfg)
  1779. {
  1780. struct ucl_parser *parser;
  1781. ucl_object_t *obj;
  1782. const ucl_object_t *elt, *subelt;
  1783. struct rspamd_stat *stat, stat_copy;
  1784. gint i;
  1785. if (cfg->stats_file == NULL) {
  1786. return;
  1787. }
  1788. if (access(cfg->stats_file, R_OK) == -1) {
  1789. msg_err_config("cannot load controller stats from %s: %s",
  1790. cfg->stats_file, strerror(errno));
  1791. return;
  1792. }
  1793. parser = ucl_parser_new(0);
  1794. if (!ucl_parser_add_file(parser, cfg->stats_file)) {
  1795. msg_err_config("cannot parse controller stats from %s: %s",
  1796. cfg->stats_file, ucl_parser_get_error(parser));
  1797. ucl_parser_free(parser);
  1798. return;
  1799. }
  1800. obj = ucl_parser_get_object(parser);
  1801. ucl_parser_free(parser);
  1802. stat = rspamd_main->stat;
  1803. memcpy(&stat_copy, stat, sizeof(stat_copy));
  1804. elt = ucl_object_lookup(obj, "scanned");
  1805. if (elt != NULL && ucl_object_type(elt) == UCL_INT) {
  1806. stat_copy.messages_scanned = ucl_object_toint(elt);
  1807. }
  1808. elt = ucl_object_lookup(obj, "learned");
  1809. if (elt != NULL && ucl_object_type(elt) == UCL_INT) {
  1810. stat_copy.messages_learned = ucl_object_toint(elt);
  1811. }
  1812. elt = ucl_object_lookup(obj, "actions");
  1813. if (elt != NULL) {
  1814. for (i = METRIC_ACTION_REJECT; i <= METRIC_ACTION_NOACTION; i++) {
  1815. subelt = ucl_object_lookup(elt, rspamd_action_to_str(i));
  1816. if (subelt && ucl_object_type(subelt) == UCL_INT) {
  1817. stat_copy.actions_stat[i] = ucl_object_toint(subelt);
  1818. }
  1819. }
  1820. }
  1821. elt = ucl_object_lookup(obj, "connections_count");
  1822. if (elt != NULL && ucl_object_type(elt) == UCL_INT) {
  1823. stat_copy.connections_count = ucl_object_toint(elt);
  1824. }
  1825. elt = ucl_object_lookup(obj, "control_connections_count");
  1826. if (elt != NULL && ucl_object_type(elt) == UCL_INT) {
  1827. stat_copy.control_connections_count = ucl_object_toint(elt);
  1828. }
  1829. ucl_object_unref(obj);
  1830. memcpy(stat, &stat_copy, sizeof(stat_copy));
  1831. }
  1832. struct rspamd_controller_periodics_cbdata {
  1833. struct rspamd_worker *worker;
  1834. struct rspamd_rrd_file *rrd;
  1835. struct rspamd_stat *stat;
  1836. ev_timer save_stats_event;
  1837. };
  1838. static void
  1839. rspamd_controller_rrd_update(EV_P_ ev_timer *w, int revents)
  1840. {
  1841. struct rspamd_controller_periodics_cbdata *cbd =
  1842. (struct rspamd_controller_periodics_cbdata *) w->data;
  1843. struct rspamd_stat *stat;
  1844. GArray ar;
  1845. gdouble points[METRIC_ACTION_MAX];
  1846. GError *err = NULL;
  1847. guint i;
  1848. g_assert(cbd->rrd != NULL);
  1849. stat = cbd->stat;
  1850. for (i = METRIC_ACTION_REJECT; i < METRIC_ACTION_MAX; i++) {
  1851. points[i] = stat->actions_stat[i];
  1852. }
  1853. ar.data = (gchar *) points;
  1854. ar.len = sizeof(points);
  1855. if (!rspamd_rrd_add_record(cbd->rrd, &ar, rspamd_get_calendar_ticks(),
  1856. &err)) {
  1857. msg_err("cannot update rrd file: %e", err);
  1858. g_error_free(err);
  1859. }
  1860. /* Plan new event */
  1861. ev_timer_again(EV_A_ w);
  1862. }
  1863. static void
  1864. rspamd_controller_stats_save_periodic(EV_P_ ev_timer *w, int revents)
  1865. {
  1866. struct rspamd_controller_periodics_cbdata *cbd =
  1867. (struct rspamd_controller_periodics_cbdata *) w->data;
  1868. rspamd_controller_store_saved_stats(cbd->worker->srv, cbd->worker->srv->cfg);
  1869. ev_timer_again(EV_A_ w);
  1870. }
  1871. void rspamd_worker_init_controller(struct rspamd_worker *worker,
  1872. struct rspamd_rrd_file **prrd)
  1873. {
  1874. struct rspamd_abstract_worker_ctx *ctx;
  1875. static const ev_tstamp rrd_update_time = 1.0;
  1876. ctx = (struct rspamd_abstract_worker_ctx *) worker->ctx;
  1877. rspamd_controller_load_saved_stats(worker->srv, worker->srv->cfg);
  1878. if (worker->index == 0) {
  1879. /* Enable periodics and other stuff */
  1880. static struct rspamd_controller_periodics_cbdata cbd;
  1881. const ev_tstamp save_stats_interval = 60; /* 1 minute */
  1882. memset(&cbd, 0, sizeof(cbd));
  1883. cbd.save_stats_event.data = &cbd;
  1884. cbd.worker = worker;
  1885. cbd.stat = worker->srv->stat;
  1886. ev_timer_init(&cbd.save_stats_event,
  1887. rspamd_controller_stats_save_periodic,
  1888. save_stats_interval, save_stats_interval);
  1889. ev_timer_start(ctx->event_loop, &cbd.save_stats_event);
  1890. rspamd_map_watch(worker->srv->cfg, ctx->event_loop,
  1891. ctx->resolver, worker,
  1892. RSPAMD_MAP_WATCH_PRIMARY_CONTROLLER);
  1893. if (prrd != NULL) {
  1894. if (ctx->cfg->rrd_file && worker->index == 0) {
  1895. GError *rrd_err = NULL;
  1896. *prrd = rspamd_rrd_file_default(ctx->cfg->rrd_file, &rrd_err);
  1897. if (*prrd) {
  1898. cbd.rrd = *prrd;
  1899. rrd_timer.data = &cbd;
  1900. ev_timer_init(&rrd_timer, rspamd_controller_rrd_update,
  1901. rrd_update_time, rrd_update_time);
  1902. ev_timer_start(ctx->event_loop, &rrd_timer);
  1903. }
  1904. else if (rrd_err) {
  1905. msg_err("cannot load rrd from %s: %e", ctx->cfg->rrd_file,
  1906. rrd_err);
  1907. g_error_free(rrd_err);
  1908. }
  1909. else {
  1910. msg_err("cannot load rrd from %s: unknown error",
  1911. ctx->cfg->rrd_file);
  1912. }
  1913. }
  1914. else {
  1915. *prrd = NULL;
  1916. }
  1917. }
  1918. if (!ctx->cfg->disable_monitored) {
  1919. rspamd_worker_init_monitored(worker,
  1920. ctx->event_loop, ctx->resolver);
  1921. }
  1922. }
  1923. else {
  1924. rspamd_map_watch(worker->srv->cfg, ctx->event_loop,
  1925. ctx->resolver, worker, RSPAMD_MAP_WATCH_SCANNER);
  1926. }
  1927. }
  1928. gdouble
  1929. rspamd_worker_check_and_adjust_timeout(struct rspamd_config *cfg, gdouble timeout)
  1930. {
  1931. if (isnan(timeout)) {
  1932. /* Use implicit timeout from cfg->task_timeout */
  1933. timeout = cfg->task_timeout;
  1934. }
  1935. if (isnan(timeout)) {
  1936. return timeout;
  1937. }
  1938. struct rspamd_symcache_timeout_result *tres = rspamd_symcache_get_max_timeout(cfg->cache);
  1939. g_assert(tres != 0);
  1940. if (tres->max_timeout > timeout) {
  1941. msg_info_config("configured task_timeout %.2f is less than maximum symbols cache timeout %.2f; "
  1942. "some symbols can be terminated before checks",
  1943. timeout, tres->max_timeout);
  1944. GString *buf = g_string_sized_new(512);
  1945. static const int max_displayed_items = 12;
  1946. for (int i = 0; i < MIN(tres->nitems, max_displayed_items); i++) {
  1947. if (i == 0) {
  1948. rspamd_printf_gstring(buf, "%s(%.2f)",
  1949. rspamd_symcache_item_name((struct rspamd_symcache_item *) tres->items[i].item),
  1950. tres->items[i].timeout);
  1951. }
  1952. else {
  1953. rspamd_printf_gstring(buf, "; %s(%.2f)",
  1954. rspamd_symcache_item_name((struct rspamd_symcache_item *) tres->items[i].item),
  1955. tres->items[i].timeout);
  1956. }
  1957. }
  1958. msg_info_config("list of top %d symbols by execution time: %v",
  1959. (int) MIN(tres->nitems, max_displayed_items),
  1960. buf);
  1961. g_string_free(buf, TRUE);
  1962. }
  1963. rspamd_symcache_timeout_result_free(tres);
  1964. /* TODO: maybe adjust timeout */
  1965. return timeout;
  1966. }