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.

re_cache.c 64KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677
  1. /*-
  2. * Copyright 2016 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 "libmime/message.h"
  17. #include "re_cache.h"
  18. #include "cryptobox.h"
  19. #include "ref.h"
  20. #include "libserver/url.h"
  21. #include "libserver/task.h"
  22. #include "libserver/cfg_file.h"
  23. #include "libutil/util.h"
  24. #include "libutil/regexp.h"
  25. #include "lua/lua_common.h"
  26. #include "libstat/stat_api.h"
  27. #include "contrib/uthash/utlist.h"
  28. #include "khash.h"
  29. #ifdef WITH_HYPERSCAN
  30. #include "hs.h"
  31. #endif
  32. #include "unix-std.h"
  33. #include <signal.h>
  34. #include <stdalign.h>
  35. #include <math.h>
  36. #include "contrib/libev/ev.h"
  37. #ifndef WITH_PCRE2
  38. #include <pcre.h>
  39. #else
  40. #include <pcre2.h>
  41. #endif
  42. #include "contrib/fastutf8/fastutf8.h"
  43. #ifdef HAVE_SYS_WAIT_H
  44. #include <sys/wait.h>
  45. #endif
  46. #define msg_err_re_cache(...) rspamd_default_log_function (G_LOG_LEVEL_CRITICAL, \
  47. "re_cache", cache->hash, \
  48. G_STRFUNC, \
  49. __VA_ARGS__)
  50. #define msg_warn_re_cache(...) rspamd_default_log_function (G_LOG_LEVEL_WARNING, \
  51. "re_cache", cache->hash, \
  52. G_STRFUNC, \
  53. __VA_ARGS__)
  54. #define msg_info_re_cache(...) rspamd_default_log_function (G_LOG_LEVEL_INFO, \
  55. "re_cache", cache->hash, \
  56. G_STRFUNC, \
  57. __VA_ARGS__)
  58. #define msg_debug_re_task(...) rspamd_conditional_debug_fast (NULL, NULL, \
  59. rspamd_re_cache_log_id, "re_cache", task->task_pool->tag.uid, \
  60. G_STRFUNC, \
  61. __VA_ARGS__)
  62. #define msg_debug_re_cache(...) rspamd_conditional_debug_fast (NULL, NULL, \
  63. rspamd_re_cache_log_id, "re_cache", cache->hash, \
  64. G_STRFUNC, \
  65. __VA_ARGS__)
  66. INIT_LOG_MODULE(re_cache)
  67. #ifdef WITH_HYPERSCAN
  68. #define RSPAMD_HS_MAGIC_LEN (sizeof (rspamd_hs_magic))
  69. static const guchar rspamd_hs_magic[] = {'r', 's', 'h', 's', 'r', 'e', '1', '1'},
  70. rspamd_hs_magic_vector[] = {'r', 's', 'h', 's', 'r', 'v', '1', '1'};
  71. #endif
  72. struct rspamd_re_class {
  73. guint64 id;
  74. enum rspamd_re_type type;
  75. gboolean has_utf8; /* if there are any utf8 regexps */
  76. gpointer type_data;
  77. gsize type_len;
  78. GHashTable *re;
  79. rspamd_cryptobox_hash_state_t *st;
  80. gchar hash[rspamd_cryptobox_HASHBYTES + 1];
  81. #ifdef WITH_HYPERSCAN
  82. hs_database_t *hs_db;
  83. hs_scratch_t *hs_scratch;
  84. gint *hs_ids;
  85. guint nhs;
  86. #endif
  87. };
  88. enum rspamd_re_cache_elt_match_type {
  89. RSPAMD_RE_CACHE_PCRE = 0,
  90. RSPAMD_RE_CACHE_HYPERSCAN,
  91. RSPAMD_RE_CACHE_HYPERSCAN_PRE
  92. };
  93. struct rspamd_re_cache_elt {
  94. rspamd_regexp_t *re;
  95. gint lua_cbref;
  96. enum rspamd_re_cache_elt_match_type match_type;
  97. };
  98. KHASH_INIT (lua_selectors_hash, gchar *, int, 1, kh_str_hash_func, kh_str_hash_equal);
  99. struct rspamd_re_cache {
  100. GHashTable *re_classes;
  101. GPtrArray *re;
  102. khash_t (lua_selectors_hash) *selectors;
  103. ref_entry_t ref;
  104. guint nre;
  105. guint max_re_data;
  106. gchar hash[rspamd_cryptobox_HASHBYTES + 1];
  107. lua_State *L;
  108. #ifdef WITH_HYPERSCAN
  109. enum rspamd_hyperscan_status hyperscan_loaded;
  110. gboolean disable_hyperscan;
  111. gboolean vectorized_hyperscan;
  112. hs_platform_info_t plt;
  113. #endif
  114. };
  115. struct rspamd_re_selector_result {
  116. guchar **scvec;
  117. guint *lenvec;
  118. guint cnt;
  119. };
  120. KHASH_INIT (selectors_results_hash, int, struct rspamd_re_selector_result, 1,
  121. kh_int_hash_func, kh_int_hash_equal);
  122. struct rspamd_re_runtime {
  123. guchar *checked;
  124. guchar *results;
  125. khash_t (selectors_results_hash) *sel_cache;
  126. struct rspamd_re_cache *cache;
  127. struct rspamd_re_cache_stat stat;
  128. gboolean has_hs;
  129. };
  130. static GQuark
  131. rspamd_re_cache_quark (void)
  132. {
  133. return g_quark_from_static_string ("re_cache");
  134. }
  135. static guint64
  136. rspamd_re_cache_class_id (enum rspamd_re_type type,
  137. gconstpointer type_data,
  138. gsize datalen)
  139. {
  140. rspamd_cryptobox_fast_hash_state_t st;
  141. rspamd_cryptobox_fast_hash_init (&st, 0xdeadbabe);
  142. rspamd_cryptobox_fast_hash_update (&st, &type, sizeof (type));
  143. if (datalen > 0) {
  144. rspamd_cryptobox_fast_hash_update (&st, type_data, datalen);
  145. }
  146. return rspamd_cryptobox_fast_hash_final (&st);
  147. }
  148. static void
  149. rspamd_re_cache_destroy (struct rspamd_re_cache *cache)
  150. {
  151. GHashTableIter it;
  152. gpointer k, v;
  153. struct rspamd_re_class *re_class;
  154. gchar *skey;
  155. gint sref;
  156. g_assert (cache != NULL);
  157. g_hash_table_iter_init (&it, cache->re_classes);
  158. while (g_hash_table_iter_next (&it, &k, &v)) {
  159. re_class = v;
  160. g_hash_table_iter_steal (&it);
  161. g_hash_table_unref (re_class->re);
  162. if (re_class->type_data) {
  163. g_free (re_class->type_data);
  164. }
  165. #ifdef WITH_HYPERSCAN
  166. if (re_class->hs_db) {
  167. hs_free_database (re_class->hs_db);
  168. }
  169. if (re_class->hs_scratch) {
  170. hs_free_scratch (re_class->hs_scratch);
  171. }
  172. if (re_class->hs_ids) {
  173. g_free (re_class->hs_ids);
  174. }
  175. #endif
  176. g_free (re_class);
  177. }
  178. if (cache->L) {
  179. kh_foreach (cache->selectors, skey, sref, {
  180. luaL_unref (cache->L, LUA_REGISTRYINDEX, sref);
  181. g_free (skey);
  182. });
  183. struct rspamd_re_cache_elt *elt;
  184. guint i;
  185. PTR_ARRAY_FOREACH (cache->re, i, elt) {
  186. if (elt->lua_cbref != -1) {
  187. luaL_unref (cache->L, LUA_REGISTRYINDEX, elt->lua_cbref);
  188. }
  189. }
  190. }
  191. kh_destroy (lua_selectors_hash, cache->selectors);
  192. g_hash_table_unref (cache->re_classes);
  193. g_ptr_array_free (cache->re, TRUE);
  194. g_free (cache);
  195. }
  196. static void
  197. rspamd_re_cache_elt_dtor (gpointer e)
  198. {
  199. struct rspamd_re_cache_elt *elt = e;
  200. rspamd_regexp_unref (elt->re);
  201. g_free (elt);
  202. }
  203. struct rspamd_re_cache *
  204. rspamd_re_cache_new (void)
  205. {
  206. struct rspamd_re_cache *cache;
  207. cache = g_malloc0 (sizeof (*cache));
  208. cache->re_classes = g_hash_table_new (g_int64_hash, g_int64_equal);
  209. cache->nre = 0;
  210. cache->re = g_ptr_array_new_full (256, rspamd_re_cache_elt_dtor);
  211. cache->selectors = kh_init (lua_selectors_hash);
  212. #ifdef WITH_HYPERSCAN
  213. cache->hyperscan_loaded = RSPAMD_HYPERSCAN_UNKNOWN;
  214. #endif
  215. REF_INIT_RETAIN (cache, rspamd_re_cache_destroy);
  216. return cache;
  217. }
  218. enum rspamd_hyperscan_status
  219. rspamd_re_cache_is_hs_loaded (struct rspamd_re_cache *cache)
  220. {
  221. g_assert (cache != NULL);
  222. #ifdef WITH_HYPERSCAN
  223. return cache->hyperscan_loaded;
  224. #else
  225. return RSPAMD_HYPERSCAN_UNSUPPORTED;
  226. #endif
  227. }
  228. rspamd_regexp_t *
  229. rspamd_re_cache_add (struct rspamd_re_cache *cache,
  230. rspamd_regexp_t *re,
  231. enum rspamd_re_type type,
  232. gconstpointer type_data, gsize datalen,
  233. gint lua_cbref)
  234. {
  235. guint64 class_id;
  236. struct rspamd_re_class *re_class;
  237. rspamd_regexp_t *nre;
  238. struct rspamd_re_cache_elt *elt;
  239. g_assert (cache != NULL);
  240. g_assert (re != NULL);
  241. class_id = rspamd_re_cache_class_id (type, type_data, datalen);
  242. re_class = g_hash_table_lookup (cache->re_classes, &class_id);
  243. if (re_class == NULL) {
  244. re_class = g_malloc0 (sizeof (*re_class));
  245. re_class->id = class_id;
  246. re_class->type_len = datalen;
  247. re_class->type = type;
  248. re_class->re = g_hash_table_new_full (rspamd_regexp_hash,
  249. rspamd_regexp_equal, NULL, (GDestroyNotify)rspamd_regexp_unref);
  250. if (datalen > 0) {
  251. re_class->type_data = g_malloc0 (datalen);
  252. memcpy (re_class->type_data, type_data, datalen);
  253. }
  254. g_hash_table_insert (cache->re_classes, &re_class->id, re_class);
  255. }
  256. if ((nre = g_hash_table_lookup (re_class->re, rspamd_regexp_get_id (re)))
  257. == NULL) {
  258. /*
  259. * We set re id based on the global position in the cache
  260. */
  261. elt = g_malloc0 (sizeof (*elt));
  262. /* One ref for re_class */
  263. nre = rspamd_regexp_ref (re);
  264. rspamd_regexp_set_cache_id (re, cache->nre++);
  265. /* One ref for cache */
  266. elt->re = rspamd_regexp_ref (re);
  267. g_ptr_array_add (cache->re, elt);
  268. rspamd_regexp_set_class (re, re_class);
  269. elt->lua_cbref = lua_cbref;
  270. g_hash_table_insert (re_class->re, rspamd_regexp_get_id (nre), nre);
  271. }
  272. if (rspamd_regexp_get_flags (re) & RSPAMD_REGEXP_FLAG_UTF) {
  273. re_class->has_utf8 = TRUE;
  274. }
  275. return nre;
  276. }
  277. void
  278. rspamd_re_cache_replace (struct rspamd_re_cache *cache,
  279. rspamd_regexp_t *what,
  280. rspamd_regexp_t *with)
  281. {
  282. guint64 re_id;
  283. struct rspamd_re_class *re_class;
  284. rspamd_regexp_t *src;
  285. struct rspamd_re_cache_elt *elt;
  286. g_assert (cache != NULL);
  287. g_assert (what != NULL);
  288. g_assert (with != NULL);
  289. re_class = rspamd_regexp_get_class (what);
  290. if (re_class != NULL) {
  291. re_id = rspamd_regexp_get_cache_id (what);
  292. g_assert (re_id != RSPAMD_INVALID_ID);
  293. src = g_hash_table_lookup (re_class->re, rspamd_regexp_get_id (what));
  294. elt = g_ptr_array_index (cache->re, re_id);
  295. g_assert (elt != NULL);
  296. g_assert (src != NULL);
  297. rspamd_regexp_set_cache_id (what, RSPAMD_INVALID_ID);
  298. rspamd_regexp_set_class (what, NULL);
  299. rspamd_regexp_set_cache_id (with, re_id);
  300. rspamd_regexp_set_class (with, re_class);
  301. /*
  302. * On calling of this function, we actually unref old re (what)
  303. */
  304. g_hash_table_insert (re_class->re,
  305. rspamd_regexp_get_id (what),
  306. rspamd_regexp_ref (with));
  307. rspamd_regexp_unref (elt->re);
  308. elt->re = rspamd_regexp_ref (with);
  309. /* XXX: do not touch match type here */
  310. }
  311. }
  312. static gint
  313. rspamd_re_cache_sort_func (gconstpointer a, gconstpointer b)
  314. {
  315. struct rspamd_re_cache_elt * const *re1 = a, * const *re2 = b;
  316. return rspamd_regexp_cmp (rspamd_regexp_get_id ((*re1)->re),
  317. rspamd_regexp_get_id ((*re2)->re));
  318. }
  319. void
  320. rspamd_re_cache_init (struct rspamd_re_cache *cache, struct rspamd_config *cfg)
  321. {
  322. guint i, fl;
  323. GHashTableIter it;
  324. gpointer k, v;
  325. struct rspamd_re_class *re_class;
  326. rspamd_cryptobox_hash_state_t st_global;
  327. rspamd_regexp_t *re;
  328. struct rspamd_re_cache_elt *elt;
  329. guchar hash_out[rspamd_cryptobox_HASHBYTES];
  330. g_assert (cache != NULL);
  331. rspamd_cryptobox_hash_init (&st_global, NULL, 0);
  332. /* Resort all regexps */
  333. g_ptr_array_sort (cache->re, rspamd_re_cache_sort_func);
  334. for (i = 0; i < cache->re->len; i ++) {
  335. elt = g_ptr_array_index (cache->re, i);
  336. re = elt->re;
  337. re_class = rspamd_regexp_get_class (re);
  338. g_assert (re_class != NULL);
  339. rspamd_regexp_set_cache_id (re, i);
  340. if (re_class->st == NULL) {
  341. (void) !posix_memalign ((void **)&re_class->st, RSPAMD_ALIGNOF(rspamd_cryptobox_hash_state_t),
  342. sizeof (*re_class->st));
  343. g_assert (re_class->st != NULL);
  344. rspamd_cryptobox_hash_init (re_class->st, NULL, 0);
  345. }
  346. /* Update hashes */
  347. /* Id of re class */
  348. rspamd_cryptobox_hash_update (re_class->st, (gpointer) &re_class->id,
  349. sizeof (re_class->id));
  350. rspamd_cryptobox_hash_update (&st_global, (gpointer) &re_class->id,
  351. sizeof (re_class->id));
  352. /* Id of re expression */
  353. rspamd_cryptobox_hash_update (re_class->st, rspamd_regexp_get_id (re),
  354. rspamd_cryptobox_HASHBYTES);
  355. rspamd_cryptobox_hash_update (&st_global, rspamd_regexp_get_id (re),
  356. rspamd_cryptobox_HASHBYTES);
  357. /* PCRE flags */
  358. fl = rspamd_regexp_get_pcre_flags (re);
  359. rspamd_cryptobox_hash_update (re_class->st, (const guchar *)&fl,
  360. sizeof (fl));
  361. rspamd_cryptobox_hash_update (&st_global, (const guchar *) &fl,
  362. sizeof (fl));
  363. /* Rspamd flags */
  364. fl = rspamd_regexp_get_flags (re);
  365. rspamd_cryptobox_hash_update (re_class->st, (const guchar *) &fl,
  366. sizeof (fl));
  367. rspamd_cryptobox_hash_update (&st_global, (const guchar *) &fl,
  368. sizeof (fl));
  369. /* Limit of hits */
  370. fl = rspamd_regexp_get_maxhits (re);
  371. rspamd_cryptobox_hash_update (re_class->st, (const guchar *) &fl,
  372. sizeof (fl));
  373. rspamd_cryptobox_hash_update (&st_global, (const guchar *) &fl,
  374. sizeof (fl));
  375. /* Numberic order */
  376. rspamd_cryptobox_hash_update (re_class->st, (const guchar *)&i,
  377. sizeof (i));
  378. rspamd_cryptobox_hash_update (&st_global, (const guchar *)&i,
  379. sizeof (i));
  380. }
  381. rspamd_cryptobox_hash_final (&st_global, hash_out);
  382. rspamd_snprintf (cache->hash, sizeof (cache->hash), "%*xs",
  383. (gint) rspamd_cryptobox_HASHBYTES, hash_out);
  384. /* Now finalize all classes */
  385. g_hash_table_iter_init (&it, cache->re_classes);
  386. while (g_hash_table_iter_next (&it, &k, &v)) {
  387. re_class = v;
  388. if (re_class->st) {
  389. /*
  390. * We finally update all classes with the number of expressions
  391. * in the cache to ensure that if even a single re has been changed
  392. * we won't be broken due to id mismatch
  393. */
  394. rspamd_cryptobox_hash_update (re_class->st,
  395. (gpointer)&cache->re->len,
  396. sizeof (cache->re->len));
  397. rspamd_cryptobox_hash_final (re_class->st, hash_out);
  398. rspamd_snprintf (re_class->hash, sizeof (re_class->hash), "%*xs",
  399. (gint) rspamd_cryptobox_HASHBYTES, hash_out);
  400. free (re_class->st); /* Due to posix_memalign */
  401. re_class->st = NULL;
  402. }
  403. }
  404. cache->L = cfg->lua_state;
  405. #ifdef WITH_HYPERSCAN
  406. const gchar *platform = "generic";
  407. rspamd_fstring_t *features = rspamd_fstring_new ();
  408. cache->disable_hyperscan = cfg->disable_hyperscan;
  409. cache->vectorized_hyperscan = cfg->vectorized_hyperscan;
  410. g_assert (hs_populate_platform (&cache->plt) == HS_SUCCESS);
  411. /* Now decode what we do have */
  412. switch (cache->plt.tune) {
  413. case HS_TUNE_FAMILY_HSW:
  414. platform = "haswell";
  415. break;
  416. case HS_TUNE_FAMILY_SNB:
  417. platform = "sandy";
  418. break;
  419. case HS_TUNE_FAMILY_BDW:
  420. platform = "broadwell";
  421. break;
  422. case HS_TUNE_FAMILY_IVB:
  423. platform = "ivy";
  424. break;
  425. default:
  426. break;
  427. }
  428. if (cache->plt.cpu_features & HS_CPU_FEATURES_AVX2) {
  429. features = rspamd_fstring_append (features, "AVX2", 4);
  430. }
  431. hs_set_allocator (g_malloc, g_free);
  432. msg_info_re_cache ("loaded hyperscan engine with cpu tune '%s' and features '%V'",
  433. platform, features);
  434. rspamd_fstring_free (features);
  435. #endif
  436. }
  437. struct rspamd_re_runtime *
  438. rspamd_re_cache_runtime_new (struct rspamd_re_cache *cache)
  439. {
  440. struct rspamd_re_runtime *rt;
  441. g_assert (cache != NULL);
  442. rt = g_malloc0 (sizeof (*rt) + NBYTES (cache->nre) + cache->nre);
  443. rt->cache = cache;
  444. REF_RETAIN (cache);
  445. rt->checked = ((guchar *)rt) + sizeof (*rt);
  446. rt->results = rt->checked + NBYTES (cache->nre);
  447. rt->stat.regexp_total = cache->nre;
  448. #ifdef WITH_HYPERSCAN
  449. rt->has_hs = cache->hyperscan_loaded;
  450. #endif
  451. return rt;
  452. }
  453. const struct rspamd_re_cache_stat *
  454. rspamd_re_cache_get_stat (struct rspamd_re_runtime *rt)
  455. {
  456. g_assert (rt != NULL);
  457. return &rt->stat;
  458. }
  459. static gboolean
  460. rspamd_re_cache_check_lua_condition (struct rspamd_task *task,
  461. rspamd_regexp_t *re,
  462. const guchar *in, gsize len,
  463. goffset start, goffset end,
  464. gint lua_cbref)
  465. {
  466. lua_State *L = (lua_State *)task->cfg->lua_state;
  467. GError *err = NULL;
  468. struct rspamd_lua_text __attribute__ ((unused)) *t;
  469. gint text_pos;
  470. if (G_LIKELY (lua_cbref == -1)) {
  471. return TRUE;
  472. }
  473. t = lua_new_text (L, in, len, FALSE);
  474. text_pos = lua_gettop (L);
  475. if (!rspamd_lua_universal_pcall (L, lua_cbref,
  476. G_STRLOC, 1, "utii", &err,
  477. "rspamd{task}", task,
  478. text_pos, start, end)) {
  479. msg_warn_task ("cannot call for re_cache_check_lua_condition for re %s: %e",
  480. rspamd_regexp_get_pattern (re), err);
  481. g_error_free (err);
  482. return TRUE;
  483. }
  484. gboolean res = lua_toboolean (L, -1);
  485. lua_settop (L, text_pos - 1);
  486. return res;
  487. }
  488. static guint
  489. rspamd_re_cache_process_pcre (struct rspamd_re_runtime *rt,
  490. rspamd_regexp_t *re, struct rspamd_task *task,
  491. const guchar *in, gsize len,
  492. gboolean is_raw,
  493. gint lua_cbref)
  494. {
  495. guint r = 0;
  496. const gchar *start = NULL, *end = NULL;
  497. guint max_hits = rspamd_regexp_get_maxhits (re);
  498. guint64 id = rspamd_regexp_get_cache_id (re);
  499. gdouble t1 = NAN, t2, pr;
  500. const gdouble slow_time = 1e8;
  501. if (in == NULL) {
  502. return rt->results[id];
  503. }
  504. if (len == 0) {
  505. return rt->results[id];
  506. }
  507. if (rt->cache->max_re_data > 0 && len > rt->cache->max_re_data) {
  508. len = rt->cache->max_re_data;
  509. }
  510. r = rt->results[id];
  511. if (max_hits == 0 || r < max_hits) {
  512. pr = rspamd_random_double_fast ();
  513. if (pr > 0.9) {
  514. t1 = rspamd_get_ticks (TRUE);
  515. }
  516. while (rspamd_regexp_search (re,
  517. in,
  518. len,
  519. &start,
  520. &end,
  521. is_raw,
  522. NULL)) {
  523. if (rspamd_re_cache_check_lua_condition (task, re, in, len,
  524. start - (const gchar *)in, end - (const gchar *)in, lua_cbref)) {
  525. r++;
  526. msg_debug_re_task ("found regexp /%s/, total hits: %d",
  527. rspamd_regexp_get_pattern (re), r);
  528. }
  529. if (max_hits > 0 && r >= max_hits) {
  530. break;
  531. }
  532. }
  533. rt->results[id] += r;
  534. rt->stat.regexp_checked++;
  535. rt->stat.bytes_scanned_pcre += len;
  536. rt->stat.bytes_scanned += len;
  537. if (r > 0) {
  538. rt->stat.regexp_matched += r;
  539. }
  540. if (!isnan (t1)) {
  541. t2 = rspamd_get_ticks (TRUE);
  542. if (t2 - t1 > slow_time) {
  543. rspamd_symcache_enable_profile (task);
  544. msg_info_task ("regexp '%16s' took %.0f ticks to execute",
  545. rspamd_regexp_get_pattern (re), t2 - t1);
  546. }
  547. }
  548. }
  549. return r;
  550. }
  551. #ifdef WITH_HYPERSCAN
  552. struct rspamd_re_hyperscan_cbdata {
  553. struct rspamd_re_runtime *rt;
  554. const guchar **ins;
  555. const guint *lens;
  556. guint count;
  557. rspamd_regexp_t *re;
  558. struct rspamd_task *task;
  559. };
  560. static gint
  561. rspamd_re_cache_hyperscan_cb (unsigned int id,
  562. unsigned long long from,
  563. unsigned long long to,
  564. unsigned int flags,
  565. void *ud)
  566. {
  567. struct rspamd_re_hyperscan_cbdata *cbdata = ud;
  568. struct rspamd_re_runtime *rt;
  569. struct rspamd_re_cache_elt *cache_elt;
  570. guint ret, maxhits, i, processed;
  571. struct rspamd_task *task;
  572. rt = cbdata->rt;
  573. task = cbdata->task;
  574. cache_elt = g_ptr_array_index (rt->cache->re, id);
  575. maxhits = rspamd_regexp_get_maxhits (cache_elt->re);
  576. if (cache_elt->match_type == RSPAMD_RE_CACHE_HYPERSCAN) {
  577. if (rspamd_re_cache_check_lua_condition (task, cache_elt->re,
  578. cbdata->ins[0], cbdata->lens[0], from, to, cache_elt->lua_cbref)) {
  579. ret = 1;
  580. setbit (rt->checked, id);
  581. if (maxhits == 0 || rt->results[id] < maxhits) {
  582. rt->results[id] += ret;
  583. rt->stat.regexp_matched++;
  584. }
  585. msg_debug_re_task ("found regexp /%s/ using hyperscan only, total hits: %d",
  586. rspamd_regexp_get_pattern (cache_elt->re), rt->results[id]);
  587. }
  588. }
  589. else {
  590. if (!isset (rt->checked, id)) {
  591. processed = 0;
  592. for (i = 0; i < cbdata->count; i ++) {
  593. rspamd_re_cache_process_pcre (rt,
  594. cache_elt->re,
  595. cbdata->task,
  596. cbdata->ins[i],
  597. cbdata->lens[i],
  598. FALSE,
  599. cache_elt->lua_cbref);
  600. setbit (rt->checked, id);
  601. processed += cbdata->lens[i];
  602. if (processed >= to) {
  603. break;
  604. }
  605. }
  606. }
  607. }
  608. return 0;
  609. }
  610. #endif
  611. static guint
  612. rspamd_re_cache_process_regexp_data (struct rspamd_re_runtime *rt,
  613. rspamd_regexp_t *re, struct rspamd_task *task,
  614. const guchar **in, guint *lens,
  615. guint count,
  616. gboolean is_raw,
  617. gboolean *processed_hyperscan)
  618. {
  619. guint64 re_id;
  620. guint ret = 0;
  621. guint i;
  622. struct rspamd_re_cache_elt *cache_elt;
  623. re_id = rspamd_regexp_get_cache_id (re);
  624. if (count == 0 || in == NULL) {
  625. /* We assume this as absence of the specified data */
  626. setbit (rt->checked, re_id);
  627. rt->results[re_id] = ret;
  628. return ret;
  629. }
  630. cache_elt = (struct rspamd_re_cache_elt *)g_ptr_array_index (rt->cache->re, re_id);
  631. #ifndef WITH_HYPERSCAN
  632. for (i = 0; i < count; i++) {
  633. ret = rspamd_re_cache_process_pcre (rt,
  634. re,
  635. task,
  636. in[i],
  637. lens[i],
  638. is_raw,
  639. cache_elt->lua_cbref);
  640. rt->results[re_id] = ret;
  641. }
  642. setbit (rt->checked, re_id);
  643. #else
  644. struct rspamd_re_class *re_class;
  645. struct rspamd_re_hyperscan_cbdata cbdata;
  646. cache_elt = g_ptr_array_index (rt->cache->re, re_id);
  647. re_class = rspamd_regexp_get_class (re);
  648. if (rt->cache->disable_hyperscan || cache_elt->match_type == RSPAMD_RE_CACHE_PCRE ||
  649. !rt->has_hs || (is_raw && re_class->has_utf8)) {
  650. for (i = 0; i < count; i++) {
  651. ret = rspamd_re_cache_process_pcre (rt,
  652. re,
  653. task,
  654. in[i],
  655. lens[i],
  656. is_raw,
  657. cache_elt->lua_cbref);
  658. }
  659. setbit (rt->checked, re_id);
  660. }
  661. else {
  662. for (i = 0; i < count; i ++) {
  663. /* For Hyperscan we can probably safely disable all those limits */
  664. #if 0
  665. if (rt->cache->max_re_data > 0 && lens[i] > rt->cache->max_re_data) {
  666. lens[i] = rt->cache->max_re_data;
  667. }
  668. #endif
  669. rt->stat.bytes_scanned += lens[i];
  670. }
  671. g_assert (re_class->hs_scratch != NULL);
  672. g_assert (re_class->hs_db != NULL);
  673. /* Go through hyperscan API */
  674. if (!rt->cache->vectorized_hyperscan) {
  675. for (i = 0; i < count; i++) {
  676. cbdata.ins = &in[i];
  677. cbdata.re = re;
  678. cbdata.rt = rt;
  679. cbdata.lens = &lens[i];
  680. cbdata.count = 1;
  681. cbdata.task = task;
  682. if ((hs_scan (re_class->hs_db, in[i], lens[i], 0,
  683. re_class->hs_scratch,
  684. rspamd_re_cache_hyperscan_cb, &cbdata)) != HS_SUCCESS) {
  685. ret = 0;
  686. }
  687. else {
  688. ret = rt->results[re_id];
  689. *processed_hyperscan = TRUE;
  690. }
  691. }
  692. }
  693. else {
  694. cbdata.ins = in;
  695. cbdata.re = re;
  696. cbdata.rt = rt;
  697. cbdata.lens = lens;
  698. cbdata.count = 1;
  699. cbdata.task = task;
  700. if ((hs_scan_vector (re_class->hs_db, (const char **)in, lens, count, 0,
  701. re_class->hs_scratch,
  702. rspamd_re_cache_hyperscan_cb, &cbdata)) != HS_SUCCESS) {
  703. ret = 0;
  704. }
  705. else {
  706. ret = rt->results[re_id];
  707. *processed_hyperscan = TRUE;
  708. }
  709. }
  710. }
  711. #endif
  712. return ret;
  713. }
  714. static void
  715. rspamd_re_cache_finish_class (struct rspamd_task *task,
  716. struct rspamd_re_runtime *rt,
  717. struct rspamd_re_class *re_class,
  718. const gchar *class_name)
  719. {
  720. #ifdef WITH_HYPERSCAN
  721. guint i;
  722. guint64 re_id;
  723. guint found = 0;
  724. /* Set all bits that are not checked and included in hyperscan to 1 */
  725. for (i = 0; i < re_class->nhs; i++) {
  726. re_id = re_class->hs_ids[i];
  727. if (!isset (rt->checked, re_id)) {
  728. g_assert (rt->results[re_id] == 0);
  729. rt->results[re_id] = 0;
  730. setbit (rt->checked, re_id);
  731. }
  732. else {
  733. found ++;
  734. }
  735. }
  736. msg_debug_re_task ("finished hyperscan for class %s; %d "
  737. "matches found; %d hyperscan supported regexps; %d total regexps",
  738. class_name, found, re_class->nhs, (gint)g_hash_table_size (re_class->re));
  739. #endif
  740. }
  741. static gboolean
  742. rspamd_re_cache_process_selector (struct rspamd_task *task,
  743. struct rspamd_re_runtime *rt,
  744. const gchar *name,
  745. guchar ***svec,
  746. guint **lenvec,
  747. guint *n)
  748. {
  749. gint ref;
  750. khiter_t k;
  751. lua_State *L;
  752. gint err_idx, ret;
  753. struct rspamd_task **ptask;
  754. gboolean result = FALSE;
  755. struct rspamd_re_cache *cache = rt->cache;
  756. struct rspamd_re_selector_result *sr;
  757. L = cache->L;
  758. k = kh_get (lua_selectors_hash, cache->selectors, (gchar *)name);
  759. if (k == kh_end (cache->selectors)) {
  760. msg_err_task ("cannot find selector %s, not registered", name);
  761. return FALSE;
  762. }
  763. ref = kh_value (cache->selectors, k);
  764. /* First, search for the cached result */
  765. if (rt->sel_cache) {
  766. k = kh_get (selectors_results_hash, rt->sel_cache, ref);
  767. if (k != kh_end (rt->sel_cache)) {
  768. sr = &kh_value (rt->sel_cache, k);
  769. *svec = sr->scvec;
  770. *lenvec = sr->lenvec;
  771. *n = sr->cnt;
  772. return TRUE;
  773. }
  774. }
  775. else {
  776. rt->sel_cache = kh_init (selectors_results_hash);
  777. }
  778. lua_pushcfunction (L, &rspamd_lua_traceback);
  779. err_idx = lua_gettop (L);
  780. lua_rawgeti (L, LUA_REGISTRYINDEX, ref);
  781. ptask = lua_newuserdata (L, sizeof (*ptask));
  782. *ptask = task;
  783. rspamd_lua_setclass (L, "rspamd{task}", -1);
  784. if ((ret = lua_pcall (L, 1, 1, err_idx)) != 0) {
  785. msg_err_task ("call to selector %s "
  786. "failed (%d): %s", name, ret,
  787. lua_tostring (L, -1));
  788. }
  789. else {
  790. struct rspamd_lua_text *txt;
  791. gsize slen;
  792. const gchar *sel_data;
  793. if (lua_type (L, -1) != LUA_TTABLE) {
  794. txt = lua_check_text_or_string (L, -1);
  795. if (txt) {
  796. sel_data = txt->start;
  797. slen = txt->len;
  798. *n = 1;
  799. *svec = g_malloc (sizeof (guchar *));
  800. *lenvec = g_malloc (sizeof (guint));
  801. (*svec)[0] = g_malloc (slen);
  802. memcpy ((*svec)[0], sel_data, slen);
  803. (*lenvec)[0] = slen;
  804. result = TRUE;
  805. }
  806. }
  807. else {
  808. *n = rspamd_lua_table_size (L, -1);
  809. if (*n > 0) {
  810. *svec = g_malloc (sizeof (guchar *) * (*n));
  811. *lenvec = g_malloc (sizeof (guint) * (*n));
  812. for (guint i = 0; i < *n; i ++) {
  813. lua_rawgeti (L, -1, i + 1);
  814. txt = lua_check_text_or_string (L, -1);
  815. if (txt) {
  816. sel_data = txt->start;
  817. slen = txt->len;
  818. }
  819. else {
  820. sel_data = "";
  821. slen = 0;
  822. }
  823. (*svec)[i] = g_malloc (slen);
  824. memcpy ((*svec)[i], sel_data, slen);
  825. (*lenvec)[i] = slen;
  826. lua_pop (L, 1);
  827. }
  828. result = TRUE;
  829. }
  830. }
  831. }
  832. lua_settop (L, err_idx - 1);
  833. if (result) {
  834. k = kh_put (selectors_results_hash, rt->sel_cache, ref, &ret);
  835. sr = &kh_value (rt->sel_cache, k);
  836. sr->cnt = *n;
  837. sr->scvec = *svec;
  838. sr->lenvec = *lenvec;
  839. }
  840. return result;
  841. }
  842. static inline guint
  843. rspamd_process_words_vector (GArray *words,
  844. const guchar **scvec,
  845. guint *lenvec,
  846. struct rspamd_re_class *re_class,
  847. guint cnt,
  848. gboolean *raw)
  849. {
  850. guint j;
  851. rspamd_stat_token_t *tok;
  852. if (words) {
  853. for (j = 0; j < words->len; j ++) {
  854. tok = &g_array_index (words, rspamd_stat_token_t, j);
  855. if (tok->flags & RSPAMD_STAT_TOKEN_FLAG_TEXT) {
  856. if (!(tok->flags & RSPAMD_STAT_TOKEN_FLAG_UTF)) {
  857. if (!re_class->has_utf8) {
  858. *raw = TRUE;
  859. }
  860. else {
  861. continue; /* Skip */
  862. }
  863. }
  864. }
  865. else {
  866. continue; /* Skip non text */
  867. }
  868. if (re_class->type == RSPAMD_RE_RAWWORDS) {
  869. if (tok->original.len > 0) {
  870. scvec[cnt] = tok->original.begin;
  871. lenvec[cnt++] = tok->original.len;
  872. }
  873. }
  874. else if (re_class->type == RSPAMD_RE_WORDS) {
  875. if (tok->normalized.len > 0) {
  876. scvec[cnt] = tok->normalized.begin;
  877. lenvec[cnt++] = tok->normalized.len;
  878. }
  879. }
  880. else {
  881. /* Stemmed words */
  882. if (tok->stemmed.len > 0) {
  883. scvec[cnt] = tok->stemmed.begin;
  884. lenvec[cnt++] = tok->stemmed.len;
  885. }
  886. }
  887. }
  888. }
  889. return cnt;
  890. }
  891. static guint
  892. rspamd_re_cache_process_headers_list (struct rspamd_task *task,
  893. struct rspamd_re_runtime *rt,
  894. rspamd_regexp_t *re,
  895. struct rspamd_re_class *re_class,
  896. struct rspamd_mime_header *rh,
  897. gboolean is_strong,
  898. gboolean *processed_hyperscan)
  899. {
  900. const guchar **scvec, *in;
  901. gboolean raw = FALSE;
  902. guint *lenvec;
  903. struct rspamd_mime_header *cur;
  904. guint cnt = 0, i = 0, ret = 0;
  905. DL_COUNT (rh, cur, cnt);
  906. scvec = g_malloc (sizeof (*scvec) * cnt);
  907. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  908. DL_FOREACH (rh, cur) {
  909. if (is_strong && strcmp (cur->name, re_class->type_data) != 0) {
  910. /* Skip a different case */
  911. continue;
  912. }
  913. if (re_class->type == RSPAMD_RE_RAWHEADER) {
  914. in = (const guchar *)cur->value;
  915. lenvec[i] = strlen (cur->value);
  916. if (rspamd_fast_utf8_validate (in, lenvec[i]) != 0) {
  917. raw = TRUE;
  918. }
  919. }
  920. else {
  921. in = (const guchar *)cur->decoded;
  922. /* Validate input^W^WNo need to validate as it is already valid */
  923. if (!in) {
  924. lenvec[i] = 0;
  925. scvec[i] = (guchar *)"";
  926. continue;
  927. }
  928. lenvec[i] = strlen (in);
  929. }
  930. scvec[i] = in;
  931. i ++;
  932. }
  933. if (i > 0) {
  934. ret = rspamd_re_cache_process_regexp_data (rt, re,
  935. task, scvec, lenvec, i, raw, processed_hyperscan);
  936. msg_debug_re_task ("checking header %s regexp: %s=%*s -> %d",
  937. re_class->type_data,
  938. rspamd_regexp_get_pattern (re),
  939. (int) lenvec[0], scvec[0], ret);
  940. }
  941. g_free (scvec);
  942. g_free (lenvec);
  943. return ret;
  944. }
  945. /*
  946. * Calculates the specified regexp for the specified class if it's not calculated
  947. */
  948. static guint
  949. rspamd_re_cache_exec_re (struct rspamd_task *task,
  950. struct rspamd_re_runtime *rt,
  951. rspamd_regexp_t *re,
  952. struct rspamd_re_class *re_class,
  953. gboolean is_strong)
  954. {
  955. guint ret = 0, i, re_id;
  956. struct rspamd_mime_header *rh;
  957. const gchar *in;
  958. const guchar **scvec;
  959. guint *lenvec;
  960. gboolean raw = FALSE, processed_hyperscan = FALSE;
  961. struct rspamd_mime_text_part *text_part;
  962. struct rspamd_mime_part *mime_part;
  963. struct rspamd_url *url;
  964. guint len, cnt;
  965. const gchar *class_name;
  966. class_name = rspamd_re_cache_type_to_string (re_class->type);
  967. msg_debug_re_task ("start check re type: %s: /%s/",
  968. class_name,
  969. rspamd_regexp_get_pattern (re));
  970. re_id = rspamd_regexp_get_cache_id (re);
  971. switch (re_class->type) {
  972. case RSPAMD_RE_HEADER:
  973. case RSPAMD_RE_RAWHEADER:
  974. /* Get list of specified headers */
  975. rh = rspamd_message_get_header_array(task,
  976. re_class->type_data, FALSE);
  977. if (rh) {
  978. ret = rspamd_re_cache_process_headers_list (task, rt, re,
  979. re_class, rh, is_strong, &processed_hyperscan);
  980. msg_debug_re_task ("checked header(%s) regexp: %s -> %d",
  981. (const char *)re_class->type_data,
  982. rspamd_regexp_get_pattern (re),
  983. ret);
  984. }
  985. break;
  986. case RSPAMD_RE_ALLHEADER:
  987. raw = TRUE;
  988. in = MESSAGE_FIELD (task, raw_headers_content).begin;
  989. len = MESSAGE_FIELD (task, raw_headers_content).len;
  990. ret = rspamd_re_cache_process_regexp_data (rt, re,
  991. task, (const guchar **)&in, &len, 1, raw, &processed_hyperscan);
  992. msg_debug_re_task ("checked allheader regexp: %s -> %d",
  993. rspamd_regexp_get_pattern (re), ret);
  994. break;
  995. case RSPAMD_RE_MIMEHEADER:
  996. PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, parts), i, mime_part) {
  997. rh = rspamd_message_get_header_from_hash(mime_part->raw_headers,
  998. re_class->type_data, FALSE);
  999. if (rh) {
  1000. ret += rspamd_re_cache_process_headers_list (task, rt, re,
  1001. re_class, rh, is_strong, &processed_hyperscan);
  1002. }
  1003. msg_debug_re_task ("checked mime header(%s) regexp: %s -> %d",
  1004. (const char *)re_class->type_data,
  1005. rspamd_regexp_get_pattern (re),
  1006. ret);
  1007. }
  1008. break;
  1009. case RSPAMD_RE_MIME:
  1010. case RSPAMD_RE_RAWMIME:
  1011. /* Iterate through text parts */
  1012. if (MESSAGE_FIELD (task, text_parts)->len > 0) {
  1013. cnt = MESSAGE_FIELD (task, text_parts)->len;
  1014. scvec = g_malloc (sizeof (*scvec) * cnt);
  1015. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1016. PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, text_part) {
  1017. /* Select data for regexp */
  1018. if (re_class->type == RSPAMD_RE_RAWMIME) {
  1019. if (text_part->raw.len == 0) {
  1020. len = 0;
  1021. in = "";
  1022. }
  1023. else {
  1024. in = text_part->raw.begin;
  1025. len = text_part->raw.len;
  1026. }
  1027. raw = TRUE;
  1028. }
  1029. else {
  1030. /* Skip empty parts */
  1031. if (IS_TEXT_PART_EMPTY (text_part)) {
  1032. len = 0;
  1033. in = "";
  1034. }
  1035. else {
  1036. /* Check raw flags */
  1037. if (!IS_TEXT_PART_UTF (text_part)) {
  1038. raw = TRUE;
  1039. }
  1040. in = text_part->utf_content.begin;
  1041. len = text_part->utf_content.len;
  1042. }
  1043. }
  1044. scvec[i] = (guchar *) in;
  1045. lenvec[i] = len;
  1046. }
  1047. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1048. task, scvec, lenvec, cnt, raw, &processed_hyperscan);
  1049. msg_debug_re_task ("checked mime regexp: %s -> %d",
  1050. rspamd_regexp_get_pattern (re), ret);
  1051. g_free (scvec);
  1052. g_free (lenvec);
  1053. }
  1054. break;
  1055. case RSPAMD_RE_URL:
  1056. cnt = kh_size (MESSAGE_FIELD (task, urls));
  1057. if (cnt > 0) {
  1058. scvec = g_malloc (sizeof (*scvec) * cnt);
  1059. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1060. i = 0;
  1061. raw = FALSE;
  1062. kh_foreach_key (MESSAGE_FIELD (task, urls), url, {
  1063. if ((url->protocol & PROTOCOL_MAILTO)) {
  1064. continue;
  1065. }
  1066. in = url->string;
  1067. len = url->urllen;
  1068. if (len > 0 && !(url->flags & RSPAMD_URL_FLAG_IMAGE)) {
  1069. scvec[i] = (guchar *) in;
  1070. lenvec[i++] = len;
  1071. }
  1072. });
  1073. #if 0
  1074. g_hash_table_iter_init (&it, MESSAGE_FIELD (task, emails));
  1075. while (g_hash_table_iter_next (&it, &k, &v)) {
  1076. url = v;
  1077. in = url->string;
  1078. len = url->urllen;
  1079. if (len > 0 && !(url->flags & RSPAMD_URL_FLAG_IMAGE)) {
  1080. scvec[i] = (guchar *) in;
  1081. lenvec[i++] = len;
  1082. }
  1083. }
  1084. #endif
  1085. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1086. task, scvec, lenvec, i, raw, &processed_hyperscan);
  1087. msg_debug_re_task ("checked url regexp: %s -> %d",
  1088. rspamd_regexp_get_pattern (re), ret);
  1089. g_free (scvec);
  1090. g_free (lenvec);
  1091. }
  1092. break;
  1093. case RSPAMD_RE_EMAIL:
  1094. cnt = kh_size (MESSAGE_FIELD (task, urls));
  1095. if (cnt > 0) {
  1096. scvec = g_malloc (sizeof (*scvec) * cnt);
  1097. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1098. i = 0;
  1099. raw = FALSE;
  1100. kh_foreach_key (MESSAGE_FIELD (task, urls), url, {
  1101. if (!(url->protocol & PROTOCOL_MAILTO)) {
  1102. continue;
  1103. }
  1104. if (url->userlen == 0 || url->hostlen == 0) {
  1105. continue;
  1106. }
  1107. in = rspamd_url_user_unsafe (url);
  1108. len = url->userlen + 1 + url->hostlen;
  1109. scvec[i] = (guchar *) in;
  1110. lenvec[i++] = len;
  1111. });
  1112. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1113. task, scvec, lenvec, i, raw, &processed_hyperscan);
  1114. msg_debug_re_task ("checked email regexp: %s -> %d",
  1115. rspamd_regexp_get_pattern (re), ret);
  1116. g_free (scvec);
  1117. g_free (lenvec);
  1118. }
  1119. break;
  1120. case RSPAMD_RE_BODY:
  1121. raw = TRUE;
  1122. in = task->msg.begin;
  1123. len = task->msg.len;
  1124. ret = rspamd_re_cache_process_regexp_data (rt, re, task,
  1125. (const guchar **)&in, &len, 1, raw, &processed_hyperscan);
  1126. msg_debug_re_task ("checked rawbody regexp: %s -> %d",
  1127. rspamd_regexp_get_pattern (re), ret);
  1128. break;
  1129. case RSPAMD_RE_SABODY:
  1130. /* According to SA docs:
  1131. * The 'body' in this case is the textual parts of the message body;
  1132. * any non-text MIME parts are stripped, and the message decoded from
  1133. * Quoted-Printable or Base-64-encoded format if necessary. The message
  1134. * Subject header is considered part of the body and becomes the first
  1135. * paragraph when running the rules. All HTML tags and line breaks will
  1136. * be removed before matching.
  1137. */
  1138. cnt = MESSAGE_FIELD (task, text_parts)->len + 1;
  1139. scvec = g_malloc (sizeof (*scvec) * cnt);
  1140. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1141. /*
  1142. * Body rules also include the Subject as the first line
  1143. * of the body content.
  1144. */
  1145. rh = rspamd_message_get_header_array(task, "Subject", FALSE);
  1146. if (rh) {
  1147. scvec[0] = (guchar *)rh->decoded;
  1148. lenvec[0] = strlen (rh->decoded);
  1149. }
  1150. else {
  1151. scvec[0] = (guchar *)"";
  1152. lenvec[0] = 0;
  1153. }
  1154. PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, text_part) {
  1155. if (text_part->utf_stripped_content) {
  1156. scvec[i + 1] = (guchar *)text_part->utf_stripped_content->data;
  1157. lenvec[i + 1] = text_part->utf_stripped_content->len;
  1158. if (!IS_TEXT_PART_UTF (text_part)) {
  1159. raw = TRUE;
  1160. }
  1161. }
  1162. else {
  1163. scvec[i + 1] = (guchar *)"";
  1164. lenvec[i + 1] = 0;
  1165. }
  1166. }
  1167. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1168. task, scvec, lenvec, cnt, raw, &processed_hyperscan);
  1169. msg_debug_re_task ("checked sa body regexp: %s -> %d",
  1170. rspamd_regexp_get_pattern (re), ret);
  1171. g_free (scvec);
  1172. g_free (lenvec);
  1173. break;
  1174. case RSPAMD_RE_SARAWBODY:
  1175. /* According to SA docs:
  1176. * The 'raw body' of a message is the raw data inside all textual
  1177. * parts. The text will be decoded from base64 or quoted-printable
  1178. * encoding, but HTML tags and line breaks will still be present.
  1179. * Multiline expressions will need to be used to match strings that are
  1180. * broken by line breaks.
  1181. */
  1182. if (MESSAGE_FIELD (task, text_parts)->len > 0) {
  1183. cnt = MESSAGE_FIELD (task, text_parts)->len;
  1184. scvec = g_malloc (sizeof (*scvec) * cnt);
  1185. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1186. for (i = 0; i < cnt; i++) {
  1187. text_part = g_ptr_array_index (MESSAGE_FIELD (task, text_parts), i);
  1188. if (text_part->parsed.len > 0) {
  1189. scvec[i] = (guchar *)text_part->parsed.begin;
  1190. lenvec[i] = text_part->parsed.len;
  1191. if (!IS_TEXT_PART_UTF (text_part)) {
  1192. raw = TRUE;
  1193. }
  1194. }
  1195. else {
  1196. scvec[i] = (guchar *)"";
  1197. lenvec[i] = 0;
  1198. }
  1199. }
  1200. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1201. task, scvec, lenvec, cnt, raw, &processed_hyperscan);
  1202. msg_debug_re_task ("checked sa rawbody regexp: %s -> %d",
  1203. rspamd_regexp_get_pattern (re), ret);
  1204. g_free (scvec);
  1205. g_free (lenvec);
  1206. }
  1207. break;
  1208. case RSPAMD_RE_WORDS:
  1209. case RSPAMD_RE_STEMWORDS:
  1210. case RSPAMD_RE_RAWWORDS:
  1211. if (MESSAGE_FIELD (task, text_parts)->len > 0) {
  1212. cnt = 0;
  1213. raw = FALSE;
  1214. PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, text_part) {
  1215. if (text_part->utf_words) {
  1216. cnt += text_part->utf_words->len;
  1217. }
  1218. }
  1219. if (task->meta_words && task->meta_words->len > 0) {
  1220. cnt += task->meta_words->len;
  1221. }
  1222. if (cnt > 0) {
  1223. scvec = g_malloc (sizeof (*scvec) * cnt);
  1224. lenvec = g_malloc (sizeof (*lenvec) * cnt);
  1225. cnt = 0;
  1226. PTR_ARRAY_FOREACH (MESSAGE_FIELD (task, text_parts), i, text_part) {
  1227. if (text_part->utf_words) {
  1228. cnt = rspamd_process_words_vector (text_part->utf_words,
  1229. scvec, lenvec, re_class, cnt, &raw);
  1230. }
  1231. }
  1232. if (task->meta_words) {
  1233. cnt = rspamd_process_words_vector (task->meta_words,
  1234. scvec, lenvec, re_class, cnt, &raw);
  1235. }
  1236. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1237. task, scvec, lenvec, cnt, raw, &processed_hyperscan);
  1238. msg_debug_re_task ("checked sa words regexp: %s -> %d",
  1239. rspamd_regexp_get_pattern (re), ret);
  1240. g_free (scvec);
  1241. g_free (lenvec);
  1242. }
  1243. }
  1244. break;
  1245. case RSPAMD_RE_SELECTOR:
  1246. if (rspamd_re_cache_process_selector (task, rt,
  1247. re_class->type_data,
  1248. (guchar ***)&scvec,
  1249. &lenvec, &cnt)) {
  1250. ret = rspamd_re_cache_process_regexp_data (rt, re,
  1251. task, scvec, lenvec, cnt, raw, &processed_hyperscan);
  1252. msg_debug_re_task ("checked selector(%s) regexp: %s -> %d",
  1253. re_class->type_data,
  1254. rspamd_regexp_get_pattern (re), ret);
  1255. /* Do not free vectors as they are managed by rt->sel_cache */
  1256. }
  1257. break;
  1258. case RSPAMD_RE_MAX:
  1259. msg_err_task ("regexp of class invalid has been called: %s",
  1260. rspamd_regexp_get_pattern (re));
  1261. break;
  1262. }
  1263. #if WITH_HYPERSCAN
  1264. if (processed_hyperscan) {
  1265. rspamd_re_cache_finish_class (task, rt, re_class, class_name);
  1266. }
  1267. #endif
  1268. setbit (rt->checked, re_id);
  1269. return rt->results[re_id];
  1270. }
  1271. gint
  1272. rspamd_re_cache_process (struct rspamd_task *task,
  1273. rspamd_regexp_t *re,
  1274. enum rspamd_re_type type,
  1275. gconstpointer type_data,
  1276. gsize datalen,
  1277. gboolean is_strong)
  1278. {
  1279. guint64 re_id;
  1280. struct rspamd_re_class *re_class;
  1281. struct rspamd_re_cache *cache;
  1282. struct rspamd_re_runtime *rt;
  1283. g_assert (task != NULL);
  1284. rt = task->re_rt;
  1285. g_assert (rt != NULL);
  1286. g_assert (re != NULL);
  1287. cache = rt->cache;
  1288. re_id = rspamd_regexp_get_cache_id (re);
  1289. if (re_id == RSPAMD_INVALID_ID || re_id > cache->nre) {
  1290. msg_err_task ("re '%s' has no valid id for the cache",
  1291. rspamd_regexp_get_pattern (re));
  1292. return 0;
  1293. }
  1294. if (isset (rt->checked, re_id)) {
  1295. /* Fast path */
  1296. rt->stat.regexp_fast_cached ++;
  1297. return rt->results[re_id];
  1298. }
  1299. else {
  1300. /* Slow path */
  1301. re_class = rspamd_regexp_get_class (re);
  1302. if (re_class == NULL) {
  1303. msg_err_task ("cannot find re class for regexp '%s'",
  1304. rspamd_regexp_get_pattern (re));
  1305. return 0;
  1306. }
  1307. return rspamd_re_cache_exec_re (task, rt, re, re_class,
  1308. is_strong);
  1309. }
  1310. return 0;
  1311. }
  1312. int
  1313. rspamd_re_cache_process_ffi (void *ptask,
  1314. void *pre,
  1315. int type,
  1316. void *type_data,
  1317. int is_strong)
  1318. {
  1319. struct rspamd_lua_regexp **lua_re = pre;
  1320. struct rspamd_task **real_task = ptask;
  1321. gsize typelen = 0;
  1322. if (type_data) {
  1323. typelen = strlen (type_data);
  1324. }
  1325. return rspamd_re_cache_process (*real_task, (*lua_re)->re,
  1326. type, type_data, typelen, is_strong);
  1327. }
  1328. void
  1329. rspamd_re_cache_runtime_destroy (struct rspamd_re_runtime *rt)
  1330. {
  1331. g_assert (rt != NULL);
  1332. if (rt->sel_cache) {
  1333. struct rspamd_re_selector_result sr;
  1334. kh_foreach_value (rt->sel_cache, sr, {
  1335. for (guint i = 0; i < sr.cnt; i ++) {
  1336. g_free ((gpointer)sr.scvec[i]);
  1337. }
  1338. g_free (sr.scvec);
  1339. g_free (sr.lenvec);
  1340. });
  1341. kh_destroy (selectors_results_hash, rt->sel_cache);
  1342. }
  1343. REF_RELEASE (rt->cache);
  1344. g_free (rt);
  1345. }
  1346. void
  1347. rspamd_re_cache_unref (struct rspamd_re_cache *cache)
  1348. {
  1349. if (cache) {
  1350. REF_RELEASE (cache);
  1351. }
  1352. }
  1353. struct rspamd_re_cache *
  1354. rspamd_re_cache_ref (struct rspamd_re_cache *cache)
  1355. {
  1356. if (cache) {
  1357. REF_RETAIN (cache);
  1358. }
  1359. return cache;
  1360. }
  1361. guint
  1362. rspamd_re_cache_set_limit (struct rspamd_re_cache *cache, guint limit)
  1363. {
  1364. guint old;
  1365. g_assert (cache != NULL);
  1366. old = cache->max_re_data;
  1367. cache->max_re_data = limit;
  1368. return old;
  1369. }
  1370. const gchar *
  1371. rspamd_re_cache_type_to_string (enum rspamd_re_type type)
  1372. {
  1373. const gchar *ret = "unknown";
  1374. switch (type) {
  1375. case RSPAMD_RE_HEADER:
  1376. ret = "header";
  1377. break;
  1378. case RSPAMD_RE_RAWHEADER:
  1379. ret = "raw header";
  1380. break;
  1381. case RSPAMD_RE_MIMEHEADER:
  1382. ret = "mime header";
  1383. break;
  1384. case RSPAMD_RE_ALLHEADER:
  1385. ret = "all headers";
  1386. break;
  1387. case RSPAMD_RE_MIME:
  1388. ret = "part";
  1389. break;
  1390. case RSPAMD_RE_RAWMIME:
  1391. ret = "raw part";
  1392. break;
  1393. case RSPAMD_RE_BODY:
  1394. ret = "rawbody";
  1395. break;
  1396. case RSPAMD_RE_URL:
  1397. ret = "url";
  1398. break;
  1399. case RSPAMD_RE_EMAIL:
  1400. ret = "email";
  1401. break;
  1402. case RSPAMD_RE_SABODY:
  1403. ret = "sa body";
  1404. break;
  1405. case RSPAMD_RE_SARAWBODY:
  1406. ret = "sa raw body";
  1407. break;
  1408. case RSPAMD_RE_SELECTOR:
  1409. ret = "selector";
  1410. break;
  1411. case RSPAMD_RE_WORDS:
  1412. ret = "words";
  1413. break;
  1414. case RSPAMD_RE_RAWWORDS:
  1415. ret = "raw_words";
  1416. break;
  1417. case RSPAMD_RE_STEMWORDS:
  1418. ret = "stem_words";
  1419. break;
  1420. case RSPAMD_RE_MAX:
  1421. default:
  1422. ret = "invalid class";
  1423. break;
  1424. }
  1425. return ret;
  1426. }
  1427. enum rspamd_re_type
  1428. rspamd_re_cache_type_from_string (const char *str)
  1429. {
  1430. enum rspamd_re_type ret;
  1431. guint64 h;
  1432. /*
  1433. * To optimize this function, we apply hash to input string and
  1434. * pre-select it from the values
  1435. */
  1436. if (str != NULL) {
  1437. h = rspamd_cryptobox_fast_hash_specific (RSPAMD_CRYPTOBOX_XXHASH64,
  1438. str, strlen (str), 0xdeadbabe);
  1439. switch (h) {
  1440. case G_GUINT64_CONSTANT(0x298b9c8a58887d44): /* header */
  1441. ret = RSPAMD_RE_HEADER;
  1442. break;
  1443. case G_GUINT64_CONSTANT(0x467bfb5cd7ddf890): /* rawheader */
  1444. ret = RSPAMD_RE_RAWHEADER;
  1445. break;
  1446. case G_GUINT64_CONSTANT(0xda081341fb600389): /* mime */
  1447. ret = RSPAMD_RE_MIME;
  1448. break;
  1449. case G_GUINT64_CONSTANT(0xc35831e067a8221d): /* rawmime */
  1450. ret = RSPAMD_RE_RAWMIME;
  1451. break;
  1452. case G_GUINT64_CONSTANT(0xc625e13dbe636de2): /* body */
  1453. case G_GUINT64_CONSTANT(0xCCDEBA43518F721C): /* message */
  1454. ret = RSPAMD_RE_BODY;
  1455. break;
  1456. case G_GUINT64_CONSTANT(0x286edbe164c791d2): /* url */
  1457. case G_GUINT64_CONSTANT(0x7D9ACDF6685661A1): /* uri */
  1458. ret = RSPAMD_RE_URL;
  1459. break;
  1460. case G_GUINT64_CONSTANT (0x7e232b0f60b571be): /* email */
  1461. ret = RSPAMD_RE_EMAIL;
  1462. break;
  1463. case G_GUINT64_CONSTANT(0x796d62205a8778c7): /* allheader */
  1464. ret = RSPAMD_RE_ALLHEADER;
  1465. break;
  1466. case G_GUINT64_CONSTANT(0xa3c6c153b3b00a5e): /* mimeheader */
  1467. ret = RSPAMD_RE_MIMEHEADER;
  1468. break;
  1469. case G_GUINT64_CONSTANT(0x7794501506e604e9): /* sabody */
  1470. ret = RSPAMD_RE_SABODY;
  1471. break;
  1472. case G_GUINT64_CONSTANT(0x28828962E7D2A05F): /* sarawbody */
  1473. ret = RSPAMD_RE_SARAWBODY;
  1474. break;
  1475. default:
  1476. ret = RSPAMD_RE_MAX;
  1477. break;
  1478. }
  1479. }
  1480. else {
  1481. ret = RSPAMD_RE_MAX;
  1482. }
  1483. return ret;
  1484. }
  1485. #ifdef WITH_HYPERSCAN
  1486. static gchar *
  1487. rspamd_re_cache_hs_pattern_from_pcre (rspamd_regexp_t *re)
  1488. {
  1489. /*
  1490. * Workaroung for bug in ragel 7.0.0.11
  1491. * https://github.com/intel/hyperscan/issues/133
  1492. */
  1493. const gchar *pat = rspamd_regexp_get_pattern (re);
  1494. guint flags = rspamd_regexp_get_flags (re), esc_flags = RSPAMD_REGEXP_ESCAPE_RE;
  1495. gchar *escaped;
  1496. gsize esc_len;
  1497. if (flags & RSPAMD_REGEXP_FLAG_UTF) {
  1498. esc_flags |= RSPAMD_REGEXP_ESCAPE_UTF;
  1499. }
  1500. escaped = rspamd_str_regexp_escape (pat, strlen (pat), &esc_len,esc_flags);
  1501. return escaped;
  1502. }
  1503. static gboolean
  1504. rspamd_re_cache_is_finite (struct rspamd_re_cache *cache,
  1505. rspamd_regexp_t *re, gint flags, gdouble max_time)
  1506. {
  1507. pid_t cld;
  1508. gint status;
  1509. struct timespec ts;
  1510. hs_compile_error_t *hs_errors;
  1511. hs_database_t *test_db;
  1512. gdouble wait_time;
  1513. const gint max_tries = 10;
  1514. gint tries = 0, rc;
  1515. void (*old_hdl)(int);
  1516. wait_time = max_time / max_tries;
  1517. /* We need to restore SIGCHLD processing */
  1518. old_hdl = signal (SIGCHLD, SIG_DFL);
  1519. cld = fork ();
  1520. if (cld == 0) {
  1521. /* Try to compile pattern */
  1522. gchar *pat = rspamd_re_cache_hs_pattern_from_pcre (re);
  1523. if (hs_compile (pat,
  1524. flags | HS_FLAG_PREFILTER,
  1525. cache->vectorized_hyperscan ? HS_MODE_VECTORED : HS_MODE_BLOCK,
  1526. &cache->plt,
  1527. &test_db,
  1528. &hs_errors) != HS_SUCCESS) {
  1529. msg_info_re_cache ("cannot compile (prefilter mode) '%s' to hyperscan: '%s'",
  1530. pat,
  1531. hs_errors != NULL ? hs_errors->message : "unknown error");
  1532. hs_free_compile_error (hs_errors);
  1533. g_free (pat);
  1534. exit (EXIT_FAILURE);
  1535. }
  1536. g_free (pat);
  1537. exit (EXIT_SUCCESS);
  1538. }
  1539. else if (cld > 0) {
  1540. double_to_ts (wait_time, &ts);
  1541. while ((rc = waitpid (cld, &status, WNOHANG)) == 0 && tries ++ < max_tries) {
  1542. (void)nanosleep (&ts, NULL);
  1543. }
  1544. /* Child has been terminated */
  1545. if (rc > 0) {
  1546. /* Forget about SIGCHLD after this point */
  1547. signal (SIGCHLD, old_hdl);
  1548. if (WIFEXITED (status) && WEXITSTATUS (status) == EXIT_SUCCESS) {
  1549. return TRUE;
  1550. }
  1551. else {
  1552. msg_err_re_cache (
  1553. "cannot approximate %s to hyperscan",
  1554. rspamd_regexp_get_pattern (re));
  1555. return FALSE;
  1556. }
  1557. }
  1558. else {
  1559. /* We consider that as timeout */
  1560. kill (cld, SIGKILL);
  1561. g_assert (waitpid (cld, &status, 0) != -1);
  1562. msg_err_re_cache (
  1563. "cannot approximate %s to hyperscan: timeout waiting",
  1564. rspamd_regexp_get_pattern (re));
  1565. signal (SIGCHLD, old_hdl);
  1566. }
  1567. }
  1568. else {
  1569. msg_err_re_cache (
  1570. "cannot approximate %s to hyperscan: fork failed: %s",
  1571. rspamd_regexp_get_pattern (re), strerror (errno));
  1572. signal (SIGCHLD, old_hdl);
  1573. }
  1574. return FALSE;
  1575. }
  1576. #endif
  1577. #ifdef WITH_HYPERSCAN
  1578. struct rspamd_re_cache_hs_compile_cbdata {
  1579. GHashTableIter it;
  1580. struct rspamd_re_cache *cache;
  1581. const char *cache_dir;
  1582. gdouble max_time;
  1583. gboolean silent;
  1584. guint total;
  1585. void (*cb)(guint ncompiled, GError *err, void *cbd);
  1586. void *cbd;
  1587. };
  1588. static void
  1589. rspamd_re_cache_compile_err (EV_P_ ev_timer *w, GError *err,
  1590. struct rspamd_re_cache_hs_compile_cbdata *cbdata, bool is_fatal)
  1591. {
  1592. cbdata->cb (cbdata->total, err, cbdata->cbd);
  1593. if (is_fatal) {
  1594. ev_timer_stop(EV_A_ w);
  1595. g_free(w);
  1596. g_free(cbdata);
  1597. }
  1598. else {
  1599. /* Continue compilation */
  1600. ev_timer_again(EV_A_ w);
  1601. }
  1602. g_error_free (err);
  1603. }
  1604. static void
  1605. rspamd_re_cache_compile_timer_cb (EV_P_ ev_timer *w, int revents )
  1606. {
  1607. struct rspamd_re_cache_hs_compile_cbdata *cbdata =
  1608. (struct rspamd_re_cache_hs_compile_cbdata *)w->data;
  1609. GHashTableIter cit;
  1610. gpointer k, v;
  1611. struct rspamd_re_class *re_class;
  1612. gchar path[PATH_MAX], npath[PATH_MAX];
  1613. hs_database_t *test_db;
  1614. gint fd, i, n, *hs_ids = NULL, pcre_flags, re_flags;
  1615. rspamd_cryptobox_fast_hash_state_t crc_st;
  1616. guint64 crc;
  1617. rspamd_regexp_t *re;
  1618. hs_compile_error_t *hs_errors = NULL;
  1619. guint *hs_flags = NULL;
  1620. const hs_expr_ext_t **hs_exts = NULL;
  1621. gchar **hs_pats = NULL;
  1622. gchar *hs_serialized = NULL;
  1623. gsize serialized_len;
  1624. struct iovec iov[7];
  1625. struct rspamd_re_cache *cache;
  1626. GError *err;
  1627. pid_t our_pid = getpid ();
  1628. cache = cbdata->cache;
  1629. if (!g_hash_table_iter_next (&cbdata->it, &k, &v)) {
  1630. /* All done */
  1631. ev_timer_stop (EV_A_ w);
  1632. cbdata->cb (cbdata->total, NULL, cbdata->cbd);
  1633. g_free (w);
  1634. g_free (cbdata);
  1635. return;
  1636. }
  1637. re_class = v;
  1638. rspamd_snprintf (path, sizeof (path), "%s%c%s.hs", cbdata->cache_dir,
  1639. G_DIR_SEPARATOR, re_class->hash);
  1640. if (rspamd_re_cache_is_valid_hyperscan_file (cache, path, TRUE, TRUE)) {
  1641. fd = open (path, O_RDONLY, 00600);
  1642. /* Read number of regexps */
  1643. g_assert (fd != -1);
  1644. g_assert (lseek (fd, RSPAMD_HS_MAGIC_LEN + sizeof (cache->plt), SEEK_SET) != -1);
  1645. g_assert (read (fd, &n, sizeof (n)) == sizeof (n));
  1646. close (fd);
  1647. if (re_class->type_len > 0) {
  1648. if (!cbdata->silent) {
  1649. msg_info_re_cache (
  1650. "skip already valid class %s(%*s) to cache %6s, %d regexps",
  1651. rspamd_re_cache_type_to_string (re_class->type),
  1652. (gint) re_class->type_len - 1,
  1653. re_class->type_data,
  1654. re_class->hash,
  1655. n);
  1656. }
  1657. }
  1658. else {
  1659. if (!cbdata->silent) {
  1660. msg_info_re_cache (
  1661. "skip already valid class %s to cache %6s, %d regexps",
  1662. rspamd_re_cache_type_to_string (re_class->type),
  1663. re_class->hash,
  1664. n);
  1665. }
  1666. }
  1667. ev_timer_again (EV_A_ w);
  1668. return;
  1669. }
  1670. rspamd_snprintf (path, sizeof (path), "%s%c%s.%P.hs.new", cbdata->cache_dir,
  1671. G_DIR_SEPARATOR, re_class->hash, our_pid);
  1672. fd = open (path, O_CREAT|O_TRUNC|O_EXCL|O_WRONLY, 00600);
  1673. if (fd == -1) {
  1674. err = g_error_new (rspamd_re_cache_quark (), errno,
  1675. "cannot open file %s: %s", path, strerror (errno));
  1676. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1677. return;
  1678. }
  1679. g_hash_table_iter_init (&cit, re_class->re);
  1680. n = g_hash_table_size (re_class->re);
  1681. hs_flags = g_malloc0 (sizeof (*hs_flags) * n);
  1682. hs_ids = g_malloc (sizeof (*hs_ids) * n);
  1683. hs_pats = g_malloc (sizeof (*hs_pats) * n);
  1684. hs_exts = g_malloc0 (sizeof (*hs_exts) * n);
  1685. i = 0;
  1686. while (g_hash_table_iter_next (&cit, &k, &v)) {
  1687. re = v;
  1688. pcre_flags = rspamd_regexp_get_pcre_flags (re);
  1689. re_flags = rspamd_regexp_get_flags (re);
  1690. if (re_flags & RSPAMD_REGEXP_FLAG_PCRE_ONLY) {
  1691. /* Do not try to compile bad regexp */
  1692. msg_info_re_cache (
  1693. "do not try compile %s to hyperscan as it is PCRE only",
  1694. rspamd_regexp_get_pattern (re));
  1695. continue;
  1696. }
  1697. hs_flags[i] = 0;
  1698. hs_exts[i] = NULL;
  1699. #ifndef WITH_PCRE2
  1700. if (pcre_flags & PCRE_FLAG(UTF8)) {
  1701. hs_flags[i] |= HS_FLAG_UTF8;
  1702. }
  1703. #else
  1704. if (pcre_flags & PCRE_FLAG(UTF)) {
  1705. hs_flags[i] |= HS_FLAG_UTF8;
  1706. }
  1707. #endif
  1708. if (pcre_flags & PCRE_FLAG(CASELESS)) {
  1709. hs_flags[i] |= HS_FLAG_CASELESS;
  1710. }
  1711. if (pcre_flags & PCRE_FLAG(MULTILINE)) {
  1712. hs_flags[i] |= HS_FLAG_MULTILINE;
  1713. }
  1714. if (pcre_flags & PCRE_FLAG(DOTALL)) {
  1715. hs_flags[i] |= HS_FLAG_DOTALL;
  1716. }
  1717. if (re_flags & RSPAMD_REGEXP_FLAG_LEFTMOST) {
  1718. hs_flags[i] |= HS_FLAG_SOM_LEFTMOST;
  1719. }
  1720. else if (rspamd_regexp_get_maxhits (re) == 1) {
  1721. hs_flags[i] |= HS_FLAG_SINGLEMATCH;
  1722. }
  1723. gchar *pat = rspamd_re_cache_hs_pattern_from_pcre (re);
  1724. if (hs_compile (pat,
  1725. hs_flags[i],
  1726. cache->vectorized_hyperscan ? HS_MODE_VECTORED : HS_MODE_BLOCK,
  1727. &cache->plt,
  1728. &test_db,
  1729. &hs_errors) != HS_SUCCESS) {
  1730. msg_info_re_cache ("cannot compile '%s' to hyperscan: '%s', try prefilter match",
  1731. pat,
  1732. hs_errors != NULL ? hs_errors->message : "unknown error");
  1733. hs_free_compile_error (hs_errors);
  1734. /* The approximation operation might take a significant
  1735. * amount of time, so we need to check if it's finite
  1736. */
  1737. if (rspamd_re_cache_is_finite (cache, re, hs_flags[i], cbdata->max_time)) {
  1738. hs_flags[i] |= HS_FLAG_PREFILTER;
  1739. hs_ids[i] = rspamd_regexp_get_cache_id (re);
  1740. hs_pats[i] = pat;
  1741. i++;
  1742. }
  1743. else {
  1744. g_free (pat); /* Avoid leak */
  1745. }
  1746. }
  1747. else {
  1748. hs_ids[i] = rspamd_regexp_get_cache_id (re);
  1749. hs_pats[i] = pat;
  1750. i ++;
  1751. hs_free_database (test_db);
  1752. }
  1753. }
  1754. /* Adjust real re number */
  1755. n = i;
  1756. #define CLEANUP_ALLOCATED(is_err) do { \
  1757. g_free (hs_flags); \
  1758. g_free (hs_ids); \
  1759. for (guint j = 0; j < i; j ++) { \
  1760. g_free (hs_pats[j]); \
  1761. } \
  1762. g_free (hs_pats); \
  1763. g_free (hs_exts); \
  1764. if (is_err) { \
  1765. close (fd); \
  1766. unlink (path); \
  1767. if (hs_errors) hs_free_compile_error (hs_errors); \
  1768. } \
  1769. } while(0)
  1770. if (n > 0) {
  1771. /* Create the hs tree */
  1772. hs_errors = NULL;
  1773. if (hs_compile_ext_multi ((const char **)hs_pats,
  1774. hs_flags,
  1775. hs_ids,
  1776. hs_exts,
  1777. n,
  1778. cache->vectorized_hyperscan ? HS_MODE_VECTORED : HS_MODE_BLOCK,
  1779. &cache->plt,
  1780. &test_db,
  1781. &hs_errors) != HS_SUCCESS) {
  1782. err = g_error_new (rspamd_re_cache_quark (), EINVAL,
  1783. "cannot create tree of regexp when processing '%s': %s",
  1784. hs_pats[hs_errors->expression], hs_errors->message);
  1785. CLEANUP_ALLOCATED(true);
  1786. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1787. return;
  1788. }
  1789. if (hs_serialize_database (test_db, &hs_serialized,
  1790. &serialized_len) != HS_SUCCESS) {
  1791. err = g_error_new (rspamd_re_cache_quark (),
  1792. errno,
  1793. "cannot serialize tree of regexp for %s",
  1794. re_class->hash);
  1795. CLEANUP_ALLOCATED(true);
  1796. hs_free_database (test_db);
  1797. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1798. return;
  1799. }
  1800. hs_free_database (test_db);
  1801. /*
  1802. * Magic - 8 bytes
  1803. * Platform - sizeof (platform)
  1804. * n - number of regexps
  1805. * n * <regexp ids>
  1806. * n * <regexp flags>
  1807. * crc - 8 bytes checksum
  1808. * <hyperscan blob>
  1809. */
  1810. rspamd_cryptobox_fast_hash_init (&crc_st, 0xdeadbabe);
  1811. /* IDs -> Flags -> Hs blob */
  1812. rspamd_cryptobox_fast_hash_update (&crc_st,
  1813. hs_ids, sizeof (*hs_ids) * n);
  1814. rspamd_cryptobox_fast_hash_update (&crc_st,
  1815. hs_flags, sizeof (*hs_flags) * n);
  1816. rspamd_cryptobox_fast_hash_update (&crc_st,
  1817. hs_serialized, serialized_len);
  1818. crc = rspamd_cryptobox_fast_hash_final (&crc_st);
  1819. if (cache->vectorized_hyperscan) {
  1820. iov[0].iov_base = (void *) rspamd_hs_magic_vector;
  1821. }
  1822. else {
  1823. iov[0].iov_base = (void *) rspamd_hs_magic;
  1824. }
  1825. iov[0].iov_len = RSPAMD_HS_MAGIC_LEN;
  1826. iov[1].iov_base = &cache->plt;
  1827. iov[1].iov_len = sizeof (cache->plt);
  1828. iov[2].iov_base = &n;
  1829. iov[2].iov_len = sizeof (n);
  1830. iov[3].iov_base = hs_ids;
  1831. iov[3].iov_len = sizeof (*hs_ids) * n;
  1832. iov[4].iov_base = hs_flags;
  1833. iov[4].iov_len = sizeof (*hs_flags) * n;
  1834. iov[5].iov_base = &crc;
  1835. iov[5].iov_len = sizeof (crc);
  1836. iov[6].iov_base = hs_serialized;
  1837. iov[6].iov_len = serialized_len;
  1838. if (writev (fd, iov, G_N_ELEMENTS (iov)) == -1) {
  1839. err = g_error_new (rspamd_re_cache_quark (),
  1840. errno,
  1841. "cannot serialize tree of regexp to %s: %s",
  1842. path, strerror (errno));
  1843. CLEANUP_ALLOCATED(true);
  1844. g_free (hs_serialized);
  1845. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1846. return;
  1847. }
  1848. if (re_class->type_len > 0) {
  1849. msg_info_re_cache (
  1850. "compiled class %s(%*s) to cache %6s, %d/%d regexps",
  1851. rspamd_re_cache_type_to_string (re_class->type),
  1852. (gint) re_class->type_len - 1,
  1853. re_class->type_data,
  1854. re_class->hash,
  1855. n,
  1856. (gint)g_hash_table_size (re_class->re));
  1857. }
  1858. else {
  1859. msg_info_re_cache (
  1860. "compiled class %s to cache %6s, %d/%d regexps",
  1861. rspamd_re_cache_type_to_string (re_class->type),
  1862. re_class->hash,
  1863. n,
  1864. (gint)g_hash_table_size (re_class->re));
  1865. }
  1866. cbdata->total += n;
  1867. CLEANUP_ALLOCATED(false);
  1868. /* Now rename temporary file to the new .hs file */
  1869. rspamd_snprintf (npath, sizeof (npath), "%s%c%s.hs", cbdata->cache_dir,
  1870. G_DIR_SEPARATOR, re_class->hash);
  1871. if (rename (path, npath) == -1) {
  1872. err = g_error_new (rspamd_re_cache_quark (),
  1873. errno,
  1874. "cannot rename %s to %s: %s",
  1875. path, npath, strerror (errno));
  1876. unlink (path);
  1877. close (fd);
  1878. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1879. return;
  1880. }
  1881. close (fd);
  1882. }
  1883. else {
  1884. err = g_error_new (rspamd_re_cache_quark (),
  1885. errno,
  1886. "no suitable regular expressions %s (%d original): "
  1887. "remove temporary file %s",
  1888. rspamd_re_cache_type_to_string (re_class->type),
  1889. (gint)g_hash_table_size (re_class->re),
  1890. path);
  1891. CLEANUP_ALLOCATED(true);
  1892. rspamd_re_cache_compile_err (EV_A_ w, err, cbdata, false);
  1893. return;
  1894. }
  1895. /* Continue process */
  1896. ev_timer_again (EV_A_ w);
  1897. }
  1898. #endif
  1899. gint
  1900. rspamd_re_cache_compile_hyperscan (struct rspamd_re_cache *cache,
  1901. const char *cache_dir,
  1902. gdouble max_time,
  1903. gboolean silent,
  1904. struct ev_loop *event_loop,
  1905. void (*cb)(guint ncompiled, GError *err, void *cbd),
  1906. void *cbd)
  1907. {
  1908. g_assert (cache != NULL);
  1909. g_assert (cache_dir != NULL);
  1910. #ifndef WITH_HYPERSCAN
  1911. return -1;
  1912. #else
  1913. static ev_timer *timer;
  1914. static const ev_tstamp timer_interval = 0.1;
  1915. struct rspamd_re_cache_hs_compile_cbdata *cbdata;
  1916. cbdata = g_malloc0 (sizeof (*cbdata));
  1917. g_hash_table_iter_init (&cbdata->it, cache->re_classes);
  1918. cbdata->cache = cache;
  1919. cbdata->cache_dir = cache_dir;
  1920. cbdata->cb = cb;
  1921. cbdata->cbd = cbd;
  1922. cbdata->max_time = max_time;
  1923. cbdata->silent = silent;
  1924. cbdata->total = 0;
  1925. timer = g_malloc0 (sizeof (*timer));
  1926. timer->data = (void *)cbdata; /* static */
  1927. ev_timer_init (timer, rspamd_re_cache_compile_timer_cb,
  1928. timer_interval, timer_interval);
  1929. ev_timer_start (event_loop, timer);
  1930. return 0;
  1931. #endif
  1932. }
  1933. gboolean
  1934. rspamd_re_cache_is_valid_hyperscan_file (struct rspamd_re_cache *cache,
  1935. const char *path, gboolean silent, gboolean try_load)
  1936. {
  1937. g_assert (cache != NULL);
  1938. g_assert (path != NULL);
  1939. #ifndef WITH_HYPERSCAN
  1940. return FALSE;
  1941. #else
  1942. gint fd, n, ret;
  1943. guchar magicbuf[RSPAMD_HS_MAGIC_LEN];
  1944. const guchar *mb;
  1945. GHashTableIter it;
  1946. gpointer k, v;
  1947. struct rspamd_re_class *re_class;
  1948. gsize len;
  1949. const gchar *hash_pos;
  1950. hs_platform_info_t test_plt;
  1951. hs_database_t *test_db = NULL;
  1952. guchar *map, *p, *end;
  1953. rspamd_cryptobox_fast_hash_state_t crc_st;
  1954. guint64 crc, valid_crc;
  1955. len = strlen (path);
  1956. if (len < sizeof (rspamd_cryptobox_HASHBYTES + 3)) {
  1957. if (!silent) {
  1958. msg_err_re_cache ("cannot open hyperscan cache file %s: too short filename",
  1959. path);
  1960. }
  1961. return FALSE;
  1962. }
  1963. if (memcmp (path + len - 3, ".hs", 3) != 0) {
  1964. if (!silent) {
  1965. msg_err_re_cache ("cannot open hyperscan cache file %s: not ending with .hs",
  1966. path);
  1967. }
  1968. return FALSE;
  1969. }
  1970. hash_pos = path + len - 3 - (sizeof (re_class->hash) - 1);
  1971. g_hash_table_iter_init (&it, cache->re_classes);
  1972. while (g_hash_table_iter_next (&it, &k, &v)) {
  1973. re_class = v;
  1974. if (memcmp (hash_pos, re_class->hash, sizeof (re_class->hash) - 1) == 0) {
  1975. /* Open file and check magic */
  1976. gssize r;
  1977. fd = open (path, O_RDONLY);
  1978. if (fd == -1) {
  1979. if (errno != ENOENT || !silent) {
  1980. msg_err_re_cache ("cannot open hyperscan cache file %s: %s",
  1981. path, strerror (errno));
  1982. }
  1983. return FALSE;
  1984. }
  1985. if ((r = read (fd, magicbuf, sizeof (magicbuf))) != sizeof (magicbuf)) {
  1986. if (r == -1) {
  1987. msg_err_re_cache ("cannot read magic from hyperscan "
  1988. "cache file %s: %s",
  1989. path, strerror (errno));
  1990. }
  1991. else {
  1992. msg_err_re_cache ("truncated read magic from hyperscan "
  1993. "cache file %s: %z, %z wanted",
  1994. path, r, (gsize)sizeof (magicbuf));
  1995. }
  1996. close (fd);
  1997. return FALSE;
  1998. }
  1999. if (cache->vectorized_hyperscan) {
  2000. mb = rspamd_hs_magic_vector;
  2001. }
  2002. else {
  2003. mb = rspamd_hs_magic;
  2004. }
  2005. if (memcmp (magicbuf, mb, sizeof (magicbuf)) != 0) {
  2006. msg_err_re_cache ("cannot open hyperscan cache file %s: "
  2007. "bad magic ('%*xs', '%*xs' expected)",
  2008. path, (int) RSPAMD_HS_MAGIC_LEN, magicbuf,
  2009. (int) RSPAMD_HS_MAGIC_LEN, mb);
  2010. close (fd);
  2011. return FALSE;
  2012. }
  2013. if ((r = read (fd, &test_plt, sizeof (test_plt))) != sizeof (test_plt)) {
  2014. if (r == -1) {
  2015. msg_err_re_cache ("cannot read platform data from hyperscan "
  2016. "cache file %s: %s",
  2017. path, strerror (errno));
  2018. }
  2019. else {
  2020. msg_err_re_cache ("truncated read platform data from hyperscan "
  2021. "cache file %s: %z, %z wanted",
  2022. path, r, (gsize)sizeof (magicbuf));
  2023. }
  2024. close (fd);
  2025. return FALSE;
  2026. }
  2027. if (memcmp (&test_plt, &cache->plt, sizeof (test_plt)) != 0) {
  2028. msg_err_re_cache ("cannot open hyperscan cache file %s: "
  2029. "compiled for a different platform",
  2030. path);
  2031. close (fd);
  2032. return FALSE;
  2033. }
  2034. close (fd);
  2035. if (try_load) {
  2036. map = rspamd_file_xmap (path, PROT_READ, &len, TRUE);
  2037. if (map == NULL) {
  2038. msg_err_re_cache ("cannot mmap hyperscan cache file %s: "
  2039. "%s",
  2040. path, strerror (errno));
  2041. return FALSE;
  2042. }
  2043. p = map + RSPAMD_HS_MAGIC_LEN + sizeof (test_plt);
  2044. end = map + len;
  2045. n = *(gint *)p;
  2046. p += sizeof (gint);
  2047. if (n <= 0 || 2 * n * sizeof (gint) + /* IDs + flags */
  2048. sizeof (guint64) + /* crc */
  2049. RSPAMD_HS_MAGIC_LEN + /* header */
  2050. sizeof (cache->plt) > len) {
  2051. /* Some wrong amount of regexps */
  2052. msg_err_re_cache ("bad number of expressions in %s: %d",
  2053. path, n);
  2054. munmap (map, len);
  2055. return FALSE;
  2056. }
  2057. /*
  2058. * Magic - 8 bytes
  2059. * Platform - sizeof (platform)
  2060. * n - number of regexps
  2061. * n * <regexp ids>
  2062. * n * <regexp flags>
  2063. * crc - 8 bytes checksum
  2064. * <hyperscan blob>
  2065. */
  2066. memcpy (&crc, p + n * 2 * sizeof (gint), sizeof (crc));
  2067. rspamd_cryptobox_fast_hash_init (&crc_st, 0xdeadbabe);
  2068. /* IDs */
  2069. rspamd_cryptobox_fast_hash_update (&crc_st, p, n * sizeof (gint));
  2070. /* Flags */
  2071. rspamd_cryptobox_fast_hash_update (&crc_st, p + n * sizeof (gint),
  2072. n * sizeof (gint));
  2073. /* HS database */
  2074. p += n * sizeof (gint) * 2 + sizeof (guint64);
  2075. rspamd_cryptobox_fast_hash_update (&crc_st, p, end - p);
  2076. valid_crc = rspamd_cryptobox_fast_hash_final (&crc_st);
  2077. if (crc != valid_crc) {
  2078. msg_warn_re_cache ("outdated or invalid hs database in %s: "
  2079. "crc read %xL, crc expected %xL", path, crc, valid_crc);
  2080. munmap (map, len);
  2081. return FALSE;
  2082. }
  2083. if ((ret = hs_deserialize_database (p, end - p, &test_db))
  2084. != HS_SUCCESS) {
  2085. msg_err_re_cache ("bad hs database in %s: %d", path, ret);
  2086. munmap (map, len);
  2087. return FALSE;
  2088. }
  2089. hs_free_database (test_db);
  2090. munmap (map, len);
  2091. }
  2092. /* XXX: add crc check */
  2093. return TRUE;
  2094. }
  2095. }
  2096. if (!silent) {
  2097. msg_warn_re_cache ("unknown hyperscan cache file %s", path);
  2098. }
  2099. return FALSE;
  2100. #endif
  2101. }
  2102. enum rspamd_hyperscan_status
  2103. rspamd_re_cache_load_hyperscan (struct rspamd_re_cache *cache,
  2104. const char *cache_dir, bool try_load)
  2105. {
  2106. g_assert (cache != NULL);
  2107. g_assert (cache_dir != NULL);
  2108. #ifndef WITH_HYPERSCAN
  2109. return RSPAMD_HYPERSCAN_UNSUPPORTED;
  2110. #else
  2111. gchar path[PATH_MAX];
  2112. gint fd, i, n, *hs_ids = NULL, *hs_flags = NULL, total = 0, ret;
  2113. GHashTableIter it;
  2114. gpointer k, v;
  2115. guint8 *map, *p, *end;
  2116. struct rspamd_re_class *re_class;
  2117. struct rspamd_re_cache_elt *elt;
  2118. struct stat st;
  2119. gboolean has_valid = FALSE, all_valid = FALSE;
  2120. g_hash_table_iter_init (&it, cache->re_classes);
  2121. while (g_hash_table_iter_next (&it, &k, &v)) {
  2122. re_class = v;
  2123. rspamd_snprintf (path, sizeof (path), "%s%c%s.hs", cache_dir,
  2124. G_DIR_SEPARATOR, re_class->hash);
  2125. if (rspamd_re_cache_is_valid_hyperscan_file (cache, path, try_load, FALSE)) {
  2126. msg_debug_re_cache ("load hyperscan database from '%s'",
  2127. re_class->hash);
  2128. fd = open (path, O_RDONLY);
  2129. /* Read number of regexps */
  2130. g_assert (fd != -1);
  2131. fstat (fd, &st);
  2132. map = mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, fd, 0);
  2133. if (map == MAP_FAILED) {
  2134. if (!try_load) {
  2135. msg_err_re_cache ("cannot mmap %s: %s", path, strerror (errno));
  2136. }
  2137. else {
  2138. msg_debug_re_cache ("cannot mmap %s: %s", path, strerror (errno));
  2139. }
  2140. close (fd);
  2141. all_valid = FALSE;
  2142. continue;
  2143. }
  2144. close (fd);
  2145. end = map + st.st_size;
  2146. p = map + RSPAMD_HS_MAGIC_LEN + sizeof (cache->plt);
  2147. n = *(gint *)p;
  2148. if (n <= 0 || 2 * n * sizeof (gint) + /* IDs + flags */
  2149. sizeof (guint64) + /* crc */
  2150. RSPAMD_HS_MAGIC_LEN + /* header */
  2151. sizeof (cache->plt) > (gsize)st.st_size) {
  2152. /* Some wrong amount of regexps */
  2153. if (!try_load) {
  2154. msg_err_re_cache ("bad number of expressions in %s: %d",
  2155. path, n);
  2156. }
  2157. else {
  2158. msg_debug_re_cache ("bad number of expressions in %s: %d",
  2159. path, n);
  2160. }
  2161. munmap (map, st.st_size);
  2162. all_valid = FALSE;
  2163. continue;
  2164. }
  2165. total += n;
  2166. p += sizeof (n);
  2167. hs_ids = g_malloc (n * sizeof (*hs_ids));
  2168. memcpy (hs_ids, p, n * sizeof (*hs_ids));
  2169. p += n * sizeof (*hs_ids);
  2170. hs_flags = g_malloc (n * sizeof (*hs_flags));
  2171. memcpy (hs_flags, p, n * sizeof (*hs_flags));
  2172. /* Skip crc */
  2173. p += n * sizeof (*hs_ids) + sizeof (guint64);
  2174. /* Cleanup */
  2175. if (re_class->hs_scratch != NULL) {
  2176. hs_free_scratch (re_class->hs_scratch);
  2177. }
  2178. if (re_class->hs_db != NULL) {
  2179. hs_free_database (re_class->hs_db);
  2180. }
  2181. if (re_class->hs_ids) {
  2182. g_free (re_class->hs_ids);
  2183. }
  2184. re_class->hs_ids = NULL;
  2185. re_class->hs_scratch = NULL;
  2186. re_class->hs_db = NULL;
  2187. if ((ret = hs_deserialize_database (p, end - p, &re_class->hs_db))
  2188. != HS_SUCCESS) {
  2189. if (!try_load) {
  2190. msg_err_re_cache ("bad hs database in %s: %d", path, ret);
  2191. }
  2192. else {
  2193. msg_debug_re_cache ("bad hs database in %s: %d", path, ret);
  2194. }
  2195. munmap (map, st.st_size);
  2196. g_free (hs_ids);
  2197. g_free (hs_flags);
  2198. re_class->hs_ids = NULL;
  2199. re_class->hs_scratch = NULL;
  2200. re_class->hs_db = NULL;
  2201. all_valid = FALSE;
  2202. continue;
  2203. }
  2204. munmap (map, st.st_size);
  2205. g_assert (hs_alloc_scratch (re_class->hs_db,
  2206. &re_class->hs_scratch) == HS_SUCCESS);
  2207. /*
  2208. * Now find hyperscan elts that are successfully compiled and
  2209. * specify that they should be matched using hyperscan
  2210. */
  2211. for (i = 0; i < n; i ++) {
  2212. g_assert ((gint)cache->re->len > hs_ids[i] && hs_ids[i] >= 0);
  2213. elt = g_ptr_array_index (cache->re, hs_ids[i]);
  2214. if (hs_flags[i] & HS_FLAG_PREFILTER) {
  2215. elt->match_type = RSPAMD_RE_CACHE_HYPERSCAN_PRE;
  2216. }
  2217. else {
  2218. elt->match_type = RSPAMD_RE_CACHE_HYPERSCAN;
  2219. }
  2220. }
  2221. re_class->hs_ids = hs_ids;
  2222. g_free (hs_flags);
  2223. re_class->nhs = n;
  2224. if (!has_valid) {
  2225. has_valid = TRUE;
  2226. all_valid = TRUE;
  2227. }
  2228. }
  2229. else {
  2230. if (!try_load) {
  2231. msg_err_re_cache ("invalid hyperscan hash file '%s'",
  2232. path);
  2233. }
  2234. else {
  2235. msg_debug_re_cache ("invalid hyperscan hash file '%s'",
  2236. path);
  2237. }
  2238. all_valid = FALSE;
  2239. continue;
  2240. }
  2241. }
  2242. if (has_valid) {
  2243. if (all_valid) {
  2244. msg_info_re_cache ("full hyperscan database of %d regexps has been loaded", total);
  2245. cache->hyperscan_loaded = RSPAMD_HYPERSCAN_LOADED_FULL;
  2246. }
  2247. else {
  2248. msg_info_re_cache ("partial hyperscan database of %d regexps has been loaded", total);
  2249. cache->hyperscan_loaded = RSPAMD_HYPERSCAN_LOADED_PARTIAL;
  2250. }
  2251. }
  2252. else {
  2253. msg_info_re_cache ("hyperscan database has NOT been loaded; no valid expressions");
  2254. cache->hyperscan_loaded = RSPAMD_HYPERSCAN_LOAD_ERROR;
  2255. }
  2256. return cache->hyperscan_loaded;
  2257. #endif
  2258. }
  2259. void rspamd_re_cache_add_selector (struct rspamd_re_cache *cache,
  2260. const gchar *sname,
  2261. gint ref)
  2262. {
  2263. khiter_t k;
  2264. k = kh_get (lua_selectors_hash, cache->selectors, (gchar *)sname);
  2265. if (k == kh_end (cache->selectors)) {
  2266. gchar *cpy = g_strdup (sname);
  2267. gint res;
  2268. k = kh_put (lua_selectors_hash, cache->selectors, cpy, &res);
  2269. kh_value (cache->selectors, k) = ref;
  2270. }
  2271. else {
  2272. msg_warn_re_cache ("replacing selector with name %s", sname);
  2273. if (cache->L) {
  2274. luaL_unref (cache->L, LUA_REGISTRYINDEX, kh_value (cache->selectors, k));
  2275. }
  2276. kh_value (cache->selectors, k) = ref;
  2277. }
  2278. }