randomize_layout_plugin.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026
  1. /*
  2. * Copyright 2014-2016 by Open Source Security, Inc., Brad Spengler <spender@grsecurity.net>
  3. * and PaX Team <pageexec@freemail.hu>
  4. * Licensed under the GPL v2
  5. *
  6. * Note: the choice of the license means that the compilation process is
  7. * NOT 'eligible' as defined by gcc's library exception to the GPL v3,
  8. * but for the kernel it doesn't matter since it doesn't link against
  9. * any of the gcc libraries
  10. *
  11. * Usage:
  12. * $ # for 4.5/4.6/C based 4.7
  13. * $ gcc -I`gcc -print-file-name=plugin`/include -I`gcc -print-file-name=plugin`/include/c-family -fPIC -shared -O2 -o randomize_layout_plugin.so randomize_layout_plugin.c
  14. * $ # for C++ based 4.7/4.8+
  15. * $ g++ -I`g++ -print-file-name=plugin`/include -I`g++ -print-file-name=plugin`/include/c-family -fPIC -shared -O2 -o randomize_layout_plugin.so randomize_layout_plugin.c
  16. * $ gcc -fplugin=./randomize_layout_plugin.so test.c -O2
  17. */
  18. #include "gcc-common.h"
  19. #include "randomize_layout_seed.h"
  20. #if BUILDING_GCC_MAJOR < 4 || (BUILDING_GCC_MAJOR == 4 && BUILDING_GCC_MINOR < 7)
  21. #error "The RANDSTRUCT plugin requires GCC 4.7 or newer."
  22. #endif
  23. #define ORIG_TYPE_NAME(node) \
  24. (TYPE_NAME(TYPE_MAIN_VARIANT(node)) != NULL_TREE ? ((const unsigned char *)IDENTIFIER_POINTER(TYPE_NAME(TYPE_MAIN_VARIANT(node)))) : (const unsigned char *)"anonymous")
  25. #define INFORM(loc, msg, ...) inform(loc, "randstruct: " msg, ##__VA_ARGS__)
  26. #define MISMATCH(loc, how, ...) INFORM(loc, "casting between randomized structure pointer types (" how "): %qT and %qT\n", __VA_ARGS__)
  27. __visible int plugin_is_GPL_compatible;
  28. static int performance_mode;
  29. static struct plugin_info randomize_layout_plugin_info = {
  30. .version = "201402201816vanilla",
  31. .help = "disable\t\t\tdo not activate plugin\n"
  32. "performance-mode\tenable cacheline-aware layout randomization\n"
  33. };
  34. struct whitelist_entry {
  35. const char *pathname;
  36. const char *lhs;
  37. const char *rhs;
  38. };
  39. static const struct whitelist_entry whitelist[] = {
  40. /* unix_skb_parms via UNIXCB() buffer */
  41. { "net/unix/af_unix.c", "unix_skb_parms", "char" },
  42. /* big_key payload.data struct splashing */
  43. { "security/keys/big_key.c", "path", "void *" },
  44. /* walk struct security_hook_heads as an array of struct list_head */
  45. { "security/security.c", "list_head", "security_hook_heads" },
  46. { }
  47. };
  48. /* from old Linux dcache.h */
  49. static inline unsigned long
  50. partial_name_hash(unsigned long c, unsigned long prevhash)
  51. {
  52. return (prevhash + (c << 4) + (c >> 4)) * 11;
  53. }
  54. static inline unsigned int
  55. name_hash(const unsigned char *name)
  56. {
  57. unsigned long hash = 0;
  58. unsigned int len = strlen((const char *)name);
  59. while (len--)
  60. hash = partial_name_hash(*name++, hash);
  61. return (unsigned int)hash;
  62. }
  63. static tree handle_randomize_layout_attr(tree *node, tree name, tree args, int flags, bool *no_add_attrs)
  64. {
  65. tree type;
  66. *no_add_attrs = true;
  67. if (TREE_CODE(*node) == FUNCTION_DECL) {
  68. error("%qE attribute does not apply to functions (%qF)", name, *node);
  69. return NULL_TREE;
  70. }
  71. if (TREE_CODE(*node) == PARM_DECL) {
  72. error("%qE attribute does not apply to function parameters (%qD)", name, *node);
  73. return NULL_TREE;
  74. }
  75. if (TREE_CODE(*node) == VAR_DECL) {
  76. error("%qE attribute does not apply to variables (%qD)", name, *node);
  77. return NULL_TREE;
  78. }
  79. if (TYPE_P(*node)) {
  80. type = *node;
  81. } else {
  82. gcc_assert(TREE_CODE(*node) == TYPE_DECL);
  83. type = TREE_TYPE(*node);
  84. }
  85. if (TREE_CODE(type) != RECORD_TYPE) {
  86. error("%qE attribute used on %qT applies to struct types only", name, type);
  87. return NULL_TREE;
  88. }
  89. if (lookup_attribute(IDENTIFIER_POINTER(name), TYPE_ATTRIBUTES(type))) {
  90. error("%qE attribute is already applied to the type %qT", name, type);
  91. return NULL_TREE;
  92. }
  93. *no_add_attrs = false;
  94. return NULL_TREE;
  95. }
  96. /* set on complete types that we don't need to inspect further at all */
  97. static tree handle_randomize_considered_attr(tree *node, tree name, tree args, int flags, bool *no_add_attrs)
  98. {
  99. *no_add_attrs = false;
  100. return NULL_TREE;
  101. }
  102. /*
  103. * set on types that we've performed a shuffle on, to prevent re-shuffling
  104. * this does not preclude us from inspecting its fields for potential shuffles
  105. */
  106. static tree handle_randomize_performed_attr(tree *node, tree name, tree args, int flags, bool *no_add_attrs)
  107. {
  108. *no_add_attrs = false;
  109. return NULL_TREE;
  110. }
  111. /*
  112. * 64bit variant of Bob Jenkins' public domain PRNG
  113. * 256 bits of internal state
  114. */
  115. typedef unsigned long long u64;
  116. typedef struct ranctx { u64 a; u64 b; u64 c; u64 d; } ranctx;
  117. #define rot(x,k) (((x)<<(k))|((x)>>(64-(k))))
  118. static u64 ranval(ranctx *x) {
  119. u64 e = x->a - rot(x->b, 7);
  120. x->a = x->b ^ rot(x->c, 13);
  121. x->b = x->c + rot(x->d, 37);
  122. x->c = x->d + e;
  123. x->d = e + x->a;
  124. return x->d;
  125. }
  126. static void raninit(ranctx *x, u64 *seed) {
  127. int i;
  128. x->a = seed[0];
  129. x->b = seed[1];
  130. x->c = seed[2];
  131. x->d = seed[3];
  132. for (i=0; i < 30; ++i)
  133. (void)ranval(x);
  134. }
  135. static u64 shuffle_seed[4];
  136. struct partition_group {
  137. tree tree_start;
  138. unsigned long start;
  139. unsigned long length;
  140. };
  141. static void partition_struct(tree *fields, unsigned long length, struct partition_group *size_groups, unsigned long *num_groups)
  142. {
  143. unsigned long i;
  144. unsigned long accum_size = 0;
  145. unsigned long accum_length = 0;
  146. unsigned long group_idx = 0;
  147. gcc_assert(length < INT_MAX);
  148. memset(size_groups, 0, sizeof(struct partition_group) * length);
  149. for (i = 0; i < length; i++) {
  150. if (size_groups[group_idx].tree_start == NULL_TREE) {
  151. size_groups[group_idx].tree_start = fields[i];
  152. size_groups[group_idx].start = i;
  153. accum_length = 0;
  154. accum_size = 0;
  155. }
  156. accum_size += (unsigned long)int_size_in_bytes(TREE_TYPE(fields[i]));
  157. accum_length++;
  158. if (accum_size >= 64) {
  159. size_groups[group_idx].length = accum_length;
  160. accum_length = 0;
  161. group_idx++;
  162. }
  163. }
  164. if (size_groups[group_idx].tree_start != NULL_TREE &&
  165. !size_groups[group_idx].length) {
  166. size_groups[group_idx].length = accum_length;
  167. group_idx++;
  168. }
  169. *num_groups = group_idx;
  170. }
  171. static void performance_shuffle(tree *newtree, unsigned long length, ranctx *prng_state)
  172. {
  173. unsigned long i, x;
  174. struct partition_group size_group[length];
  175. unsigned long num_groups = 0;
  176. unsigned long randnum;
  177. partition_struct(newtree, length, (struct partition_group *)&size_group, &num_groups);
  178. for (i = num_groups - 1; i > 0; i--) {
  179. struct partition_group tmp;
  180. randnum = ranval(prng_state) % (i + 1);
  181. tmp = size_group[i];
  182. size_group[i] = size_group[randnum];
  183. size_group[randnum] = tmp;
  184. }
  185. for (x = 0; x < num_groups; x++) {
  186. for (i = size_group[x].start + size_group[x].length - 1; i > size_group[x].start; i--) {
  187. tree tmp;
  188. if (DECL_BIT_FIELD_TYPE(newtree[i]))
  189. continue;
  190. randnum = ranval(prng_state) % (i + 1);
  191. // we could handle this case differently if desired
  192. if (DECL_BIT_FIELD_TYPE(newtree[randnum]))
  193. continue;
  194. tmp = newtree[i];
  195. newtree[i] = newtree[randnum];
  196. newtree[randnum] = tmp;
  197. }
  198. }
  199. }
  200. static void full_shuffle(tree *newtree, unsigned long length, ranctx *prng_state)
  201. {
  202. unsigned long i, randnum;
  203. for (i = length - 1; i > 0; i--) {
  204. tree tmp;
  205. randnum = ranval(prng_state) % (i + 1);
  206. tmp = newtree[i];
  207. newtree[i] = newtree[randnum];
  208. newtree[randnum] = tmp;
  209. }
  210. }
  211. /* modern in-place Fisher-Yates shuffle */
  212. static void shuffle(const_tree type, tree *newtree, unsigned long length)
  213. {
  214. unsigned long i;
  215. u64 seed[4];
  216. ranctx prng_state;
  217. const unsigned char *structname;
  218. if (length == 0)
  219. return;
  220. gcc_assert(TREE_CODE(type) == RECORD_TYPE);
  221. structname = ORIG_TYPE_NAME(type);
  222. #ifdef __DEBUG_PLUGIN
  223. fprintf(stderr, "Shuffling struct %s %p\n", (const char *)structname, type);
  224. #ifdef __DEBUG_VERBOSE
  225. debug_tree((tree)type);
  226. #endif
  227. #endif
  228. for (i = 0; i < 4; i++) {
  229. seed[i] = shuffle_seed[i];
  230. seed[i] ^= name_hash(structname);
  231. }
  232. raninit(&prng_state, (u64 *)&seed);
  233. if (performance_mode)
  234. performance_shuffle(newtree, length, &prng_state);
  235. else
  236. full_shuffle(newtree, length, &prng_state);
  237. }
  238. static bool is_flexible_array(const_tree field)
  239. {
  240. const_tree fieldtype;
  241. const_tree typesize;
  242. const_tree elemtype;
  243. const_tree elemsize;
  244. fieldtype = TREE_TYPE(field);
  245. typesize = TYPE_SIZE(fieldtype);
  246. if (TREE_CODE(fieldtype) != ARRAY_TYPE)
  247. return false;
  248. elemtype = TREE_TYPE(fieldtype);
  249. elemsize = TYPE_SIZE(elemtype);
  250. /* size of type is represented in bits */
  251. if (typesize == NULL_TREE && TYPE_DOMAIN(fieldtype) != NULL_TREE &&
  252. TYPE_MAX_VALUE(TYPE_DOMAIN(fieldtype)) == NULL_TREE)
  253. return true;
  254. if (typesize != NULL_TREE &&
  255. (TREE_CONSTANT(typesize) && (!tree_to_uhwi(typesize) ||
  256. tree_to_uhwi(typesize) == tree_to_uhwi(elemsize))))
  257. return true;
  258. return false;
  259. }
  260. static int relayout_struct(tree type)
  261. {
  262. unsigned long num_fields = (unsigned long)list_length(TYPE_FIELDS(type));
  263. unsigned long shuffle_length = num_fields;
  264. tree field;
  265. tree newtree[num_fields];
  266. unsigned long i;
  267. tree list;
  268. tree variant;
  269. tree main_variant;
  270. expanded_location xloc;
  271. bool has_flexarray = false;
  272. if (TYPE_FIELDS(type) == NULL_TREE)
  273. return 0;
  274. if (num_fields < 2)
  275. return 0;
  276. gcc_assert(TREE_CODE(type) == RECORD_TYPE);
  277. gcc_assert(num_fields < INT_MAX);
  278. if (lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(type)) ||
  279. lookup_attribute("no_randomize_layout", TYPE_ATTRIBUTES(TYPE_MAIN_VARIANT(type))))
  280. return 0;
  281. /* Workaround for 3rd-party VirtualBox source that we can't modify ourselves */
  282. if (!strcmp((const char *)ORIG_TYPE_NAME(type), "INTNETTRUNKFACTORY") ||
  283. !strcmp((const char *)ORIG_TYPE_NAME(type), "RAWPCIFACTORY"))
  284. return 0;
  285. /* throw out any structs in uapi */
  286. xloc = expand_location(DECL_SOURCE_LOCATION(TYPE_FIELDS(type)));
  287. if (strstr(xloc.file, "/uapi/"))
  288. error(G_("attempted to randomize userland API struct %s"), ORIG_TYPE_NAME(type));
  289. for (field = TYPE_FIELDS(type), i = 0; field; field = TREE_CHAIN(field), i++) {
  290. gcc_assert(TREE_CODE(field) == FIELD_DECL);
  291. newtree[i] = field;
  292. }
  293. /*
  294. * enforce that we don't randomize the layout of the last
  295. * element of a struct if it's a 0 or 1-length array
  296. * or a proper flexible array
  297. */
  298. if (is_flexible_array(newtree[num_fields - 1])) {
  299. has_flexarray = true;
  300. shuffle_length--;
  301. }
  302. shuffle(type, (tree *)newtree, shuffle_length);
  303. /*
  304. * set up a bogus anonymous struct field designed to error out on unnamed struct initializers
  305. * as gcc provides no other way to detect such code
  306. */
  307. list = make_node(FIELD_DECL);
  308. TREE_CHAIN(list) = newtree[0];
  309. TREE_TYPE(list) = void_type_node;
  310. DECL_SIZE(list) = bitsize_zero_node;
  311. DECL_NONADDRESSABLE_P(list) = 1;
  312. DECL_FIELD_BIT_OFFSET(list) = bitsize_zero_node;
  313. DECL_SIZE_UNIT(list) = size_zero_node;
  314. DECL_FIELD_OFFSET(list) = size_zero_node;
  315. DECL_CONTEXT(list) = type;
  316. // to satisfy the constify plugin
  317. TREE_READONLY(list) = 1;
  318. for (i = 0; i < num_fields - 1; i++)
  319. TREE_CHAIN(newtree[i]) = newtree[i+1];
  320. TREE_CHAIN(newtree[num_fields - 1]) = NULL_TREE;
  321. main_variant = TYPE_MAIN_VARIANT(type);
  322. for (variant = main_variant; variant; variant = TYPE_NEXT_VARIANT(variant)) {
  323. TYPE_FIELDS(variant) = list;
  324. TYPE_ATTRIBUTES(variant) = copy_list(TYPE_ATTRIBUTES(variant));
  325. TYPE_ATTRIBUTES(variant) = tree_cons(get_identifier("randomize_performed"), NULL_TREE, TYPE_ATTRIBUTES(variant));
  326. TYPE_ATTRIBUTES(variant) = tree_cons(get_identifier("designated_init"), NULL_TREE, TYPE_ATTRIBUTES(variant));
  327. if (has_flexarray)
  328. TYPE_ATTRIBUTES(type) = tree_cons(get_identifier("has_flexarray"), NULL_TREE, TYPE_ATTRIBUTES(type));
  329. }
  330. /*
  331. * force a re-layout of the main variant
  332. * the TYPE_SIZE for all variants will be recomputed
  333. * by finalize_type_size()
  334. */
  335. TYPE_SIZE(main_variant) = NULL_TREE;
  336. layout_type(main_variant);
  337. gcc_assert(TYPE_SIZE(main_variant) != NULL_TREE);
  338. return 1;
  339. }
  340. /* from constify plugin */
  341. static const_tree get_field_type(const_tree field)
  342. {
  343. return strip_array_types(TREE_TYPE(field));
  344. }
  345. /* from constify plugin */
  346. static bool is_fptr(const_tree fieldtype)
  347. {
  348. if (TREE_CODE(fieldtype) != POINTER_TYPE)
  349. return false;
  350. return TREE_CODE(TREE_TYPE(fieldtype)) == FUNCTION_TYPE;
  351. }
  352. /* derived from constify plugin */
  353. static int is_pure_ops_struct(const_tree node)
  354. {
  355. const_tree field;
  356. gcc_assert(TREE_CODE(node) == RECORD_TYPE || TREE_CODE(node) == UNION_TYPE);
  357. /* XXX: Do not apply randomization to all-ftpr structs yet. */
  358. return 0;
  359. for (field = TYPE_FIELDS(node); field; field = TREE_CHAIN(field)) {
  360. const_tree fieldtype = get_field_type(field);
  361. enum tree_code code = TREE_CODE(fieldtype);
  362. if (node == fieldtype)
  363. continue;
  364. if (!is_fptr(fieldtype))
  365. return 0;
  366. if (code != RECORD_TYPE && code != UNION_TYPE)
  367. continue;
  368. if (!is_pure_ops_struct(fieldtype))
  369. return 0;
  370. }
  371. return 1;
  372. }
  373. static void randomize_type(tree type)
  374. {
  375. tree variant;
  376. gcc_assert(TREE_CODE(type) == RECORD_TYPE);
  377. if (lookup_attribute("randomize_considered", TYPE_ATTRIBUTES(type)))
  378. return;
  379. if (lookup_attribute("randomize_layout", TYPE_ATTRIBUTES(TYPE_MAIN_VARIANT(type))) || is_pure_ops_struct(type))
  380. relayout_struct(type);
  381. for (variant = TYPE_MAIN_VARIANT(type); variant; variant = TYPE_NEXT_VARIANT(variant)) {
  382. TYPE_ATTRIBUTES(type) = copy_list(TYPE_ATTRIBUTES(type));
  383. TYPE_ATTRIBUTES(type) = tree_cons(get_identifier("randomize_considered"), NULL_TREE, TYPE_ATTRIBUTES(type));
  384. }
  385. #ifdef __DEBUG_PLUGIN
  386. fprintf(stderr, "Marking randomize_considered on struct %s\n", ORIG_TYPE_NAME(type));
  387. #ifdef __DEBUG_VERBOSE
  388. debug_tree(type);
  389. #endif
  390. #endif
  391. }
  392. static void update_decl_size(tree decl)
  393. {
  394. tree lastval, lastidx, field, init, type, flexsize;
  395. unsigned HOST_WIDE_INT len;
  396. type = TREE_TYPE(decl);
  397. if (!lookup_attribute("has_flexarray", TYPE_ATTRIBUTES(type)))
  398. return;
  399. init = DECL_INITIAL(decl);
  400. if (init == NULL_TREE || init == error_mark_node)
  401. return;
  402. if (TREE_CODE(init) != CONSTRUCTOR)
  403. return;
  404. len = CONSTRUCTOR_NELTS(init);
  405. if (!len)
  406. return;
  407. lastval = CONSTRUCTOR_ELT(init, CONSTRUCTOR_NELTS(init) - 1)->value;
  408. lastidx = CONSTRUCTOR_ELT(init, CONSTRUCTOR_NELTS(init) - 1)->index;
  409. for (field = TYPE_FIELDS(TREE_TYPE(decl)); TREE_CHAIN(field); field = TREE_CHAIN(field))
  410. ;
  411. if (lastidx != field)
  412. return;
  413. if (TREE_CODE(lastval) != STRING_CST) {
  414. error("Only string constants are supported as initializers "
  415. "for randomized structures with flexible arrays");
  416. return;
  417. }
  418. flexsize = bitsize_int(TREE_STRING_LENGTH(lastval) *
  419. tree_to_uhwi(TYPE_SIZE(TREE_TYPE(TREE_TYPE(lastval)))));
  420. DECL_SIZE(decl) = size_binop(PLUS_EXPR, TYPE_SIZE(type), flexsize);
  421. return;
  422. }
  423. static void randomize_layout_finish_decl(void *event_data, void *data)
  424. {
  425. tree decl = (tree)event_data;
  426. tree type;
  427. if (decl == NULL_TREE || decl == error_mark_node)
  428. return;
  429. type = TREE_TYPE(decl);
  430. if (TREE_CODE(decl) != VAR_DECL)
  431. return;
  432. if (TREE_CODE(type) != RECORD_TYPE && TREE_CODE(type) != UNION_TYPE)
  433. return;
  434. if (!lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(type)))
  435. return;
  436. DECL_SIZE(decl) = 0;
  437. DECL_SIZE_UNIT(decl) = 0;
  438. SET_DECL_ALIGN(decl, 0);
  439. SET_DECL_MODE (decl, VOIDmode);
  440. SET_DECL_RTL(decl, 0);
  441. update_decl_size(decl);
  442. layout_decl(decl, 0);
  443. }
  444. static void finish_type(void *event_data, void *data)
  445. {
  446. tree type = (tree)event_data;
  447. if (type == NULL_TREE || type == error_mark_node)
  448. return;
  449. if (TREE_CODE(type) != RECORD_TYPE)
  450. return;
  451. if (TYPE_FIELDS(type) == NULL_TREE)
  452. return;
  453. if (lookup_attribute("randomize_considered", TYPE_ATTRIBUTES(type)))
  454. return;
  455. #ifdef __DEBUG_PLUGIN
  456. fprintf(stderr, "Calling randomize_type on %s\n", ORIG_TYPE_NAME(type));
  457. #endif
  458. #ifdef __DEBUG_VERBOSE
  459. debug_tree(type);
  460. #endif
  461. randomize_type(type);
  462. return;
  463. }
  464. static struct attribute_spec randomize_layout_attr = {
  465. .name = "randomize_layout",
  466. // related to args
  467. .min_length = 0,
  468. .max_length = 0,
  469. .decl_required = false,
  470. // need type declaration
  471. .type_required = true,
  472. .function_type_required = false,
  473. .handler = handle_randomize_layout_attr,
  474. #if BUILDING_GCC_VERSION >= 4007
  475. .affects_type_identity = true
  476. #endif
  477. };
  478. static struct attribute_spec no_randomize_layout_attr = {
  479. .name = "no_randomize_layout",
  480. // related to args
  481. .min_length = 0,
  482. .max_length = 0,
  483. .decl_required = false,
  484. // need type declaration
  485. .type_required = true,
  486. .function_type_required = false,
  487. .handler = handle_randomize_layout_attr,
  488. #if BUILDING_GCC_VERSION >= 4007
  489. .affects_type_identity = true
  490. #endif
  491. };
  492. static struct attribute_spec randomize_considered_attr = {
  493. .name = "randomize_considered",
  494. // related to args
  495. .min_length = 0,
  496. .max_length = 0,
  497. .decl_required = false,
  498. // need type declaration
  499. .type_required = true,
  500. .function_type_required = false,
  501. .handler = handle_randomize_considered_attr,
  502. #if BUILDING_GCC_VERSION >= 4007
  503. .affects_type_identity = false
  504. #endif
  505. };
  506. static struct attribute_spec randomize_performed_attr = {
  507. .name = "randomize_performed",
  508. // related to args
  509. .min_length = 0,
  510. .max_length = 0,
  511. .decl_required = false,
  512. // need type declaration
  513. .type_required = true,
  514. .function_type_required = false,
  515. .handler = handle_randomize_performed_attr,
  516. #if BUILDING_GCC_VERSION >= 4007
  517. .affects_type_identity = false
  518. #endif
  519. };
  520. static void register_attributes(void *event_data, void *data)
  521. {
  522. register_attribute(&randomize_layout_attr);
  523. register_attribute(&no_randomize_layout_attr);
  524. register_attribute(&randomize_considered_attr);
  525. register_attribute(&randomize_performed_attr);
  526. }
  527. static void check_bad_casts_in_constructor(tree var, tree init)
  528. {
  529. unsigned HOST_WIDE_INT idx;
  530. tree field, val;
  531. tree field_type, val_type;
  532. FOR_EACH_CONSTRUCTOR_ELT(CONSTRUCTOR_ELTS(init), idx, field, val) {
  533. if (TREE_CODE(val) == CONSTRUCTOR) {
  534. check_bad_casts_in_constructor(var, val);
  535. continue;
  536. }
  537. /* pipacs' plugin creates franken-arrays that differ from those produced by
  538. normal code which all have valid 'field' trees. work around this */
  539. if (field == NULL_TREE)
  540. continue;
  541. field_type = TREE_TYPE(field);
  542. val_type = TREE_TYPE(val);
  543. if (TREE_CODE(field_type) != POINTER_TYPE || TREE_CODE(val_type) != POINTER_TYPE)
  544. continue;
  545. if (field_type == val_type)
  546. continue;
  547. field_type = TYPE_MAIN_VARIANT(strip_array_types(TYPE_MAIN_VARIANT(TREE_TYPE(field_type))));
  548. val_type = TYPE_MAIN_VARIANT(strip_array_types(TYPE_MAIN_VARIANT(TREE_TYPE(val_type))));
  549. if (field_type == void_type_node)
  550. continue;
  551. if (field_type == val_type)
  552. continue;
  553. if (TREE_CODE(val_type) != RECORD_TYPE)
  554. continue;
  555. if (!lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(val_type)))
  556. continue;
  557. MISMATCH(DECL_SOURCE_LOCATION(var), "constructor\n", TYPE_MAIN_VARIANT(field_type), TYPE_MAIN_VARIANT(val_type));
  558. }
  559. }
  560. /* derived from the constify plugin */
  561. static void check_global_variables(void *event_data, void *data)
  562. {
  563. struct varpool_node *node;
  564. tree init;
  565. FOR_EACH_VARIABLE(node) {
  566. tree var = NODE_DECL(node);
  567. init = DECL_INITIAL(var);
  568. if (init == NULL_TREE)
  569. continue;
  570. if (TREE_CODE(init) != CONSTRUCTOR)
  571. continue;
  572. check_bad_casts_in_constructor(var, init);
  573. }
  574. }
  575. static bool dominated_by_is_err(const_tree rhs, basic_block bb)
  576. {
  577. basic_block dom;
  578. gimple dom_stmt;
  579. gimple call_stmt;
  580. const_tree dom_lhs;
  581. const_tree poss_is_err_cond;
  582. const_tree poss_is_err_func;
  583. const_tree is_err_arg;
  584. dom = get_immediate_dominator(CDI_DOMINATORS, bb);
  585. if (!dom)
  586. return false;
  587. dom_stmt = last_stmt(dom);
  588. if (!dom_stmt)
  589. return false;
  590. if (gimple_code(dom_stmt) != GIMPLE_COND)
  591. return false;
  592. if (gimple_cond_code(dom_stmt) != NE_EXPR)
  593. return false;
  594. if (!integer_zerop(gimple_cond_rhs(dom_stmt)))
  595. return false;
  596. poss_is_err_cond = gimple_cond_lhs(dom_stmt);
  597. if (TREE_CODE(poss_is_err_cond) != SSA_NAME)
  598. return false;
  599. call_stmt = SSA_NAME_DEF_STMT(poss_is_err_cond);
  600. if (gimple_code(call_stmt) != GIMPLE_CALL)
  601. return false;
  602. dom_lhs = gimple_get_lhs(call_stmt);
  603. poss_is_err_func = gimple_call_fndecl(call_stmt);
  604. if (!poss_is_err_func)
  605. return false;
  606. if (dom_lhs != poss_is_err_cond)
  607. return false;
  608. if (strcmp(DECL_NAME_POINTER(poss_is_err_func), "IS_ERR"))
  609. return false;
  610. is_err_arg = gimple_call_arg(call_stmt, 0);
  611. if (!is_err_arg)
  612. return false;
  613. if (is_err_arg != rhs)
  614. return false;
  615. return true;
  616. }
  617. static void handle_local_var_initializers(void)
  618. {
  619. tree var;
  620. unsigned int i;
  621. FOR_EACH_LOCAL_DECL(cfun, i, var) {
  622. tree init = DECL_INITIAL(var);
  623. if (!init)
  624. continue;
  625. if (TREE_CODE(init) != CONSTRUCTOR)
  626. continue;
  627. check_bad_casts_in_constructor(var, init);
  628. }
  629. }
  630. static bool type_name_eq(gimple stmt, const_tree type_tree, const char *wanted_name)
  631. {
  632. const char *type_name;
  633. if (type_tree == NULL_TREE)
  634. return false;
  635. switch (TREE_CODE(type_tree)) {
  636. case RECORD_TYPE:
  637. type_name = TYPE_NAME_POINTER(type_tree);
  638. break;
  639. case INTEGER_TYPE:
  640. if (TYPE_PRECISION(type_tree) == CHAR_TYPE_SIZE)
  641. type_name = "char";
  642. else {
  643. INFORM(gimple_location(stmt), "found non-char INTEGER_TYPE cast comparison: %qT\n", type_tree);
  644. debug_tree(type_tree);
  645. return false;
  646. }
  647. break;
  648. case POINTER_TYPE:
  649. if (TREE_CODE(TREE_TYPE(type_tree)) == VOID_TYPE) {
  650. type_name = "void *";
  651. break;
  652. } else {
  653. INFORM(gimple_location(stmt), "found non-void POINTER_TYPE cast comparison %qT\n", type_tree);
  654. debug_tree(type_tree);
  655. return false;
  656. }
  657. default:
  658. INFORM(gimple_location(stmt), "unhandled cast comparison: %qT\n", type_tree);
  659. debug_tree(type_tree);
  660. return false;
  661. }
  662. return strcmp(type_name, wanted_name) == 0;
  663. }
  664. static bool whitelisted_cast(gimple stmt, const_tree lhs_tree, const_tree rhs_tree)
  665. {
  666. const struct whitelist_entry *entry;
  667. expanded_location xloc = expand_location(gimple_location(stmt));
  668. for (entry = whitelist; entry->pathname; entry++) {
  669. if (!strstr(xloc.file, entry->pathname))
  670. continue;
  671. if (type_name_eq(stmt, lhs_tree, entry->lhs) && type_name_eq(stmt, rhs_tree, entry->rhs))
  672. return true;
  673. }
  674. return false;
  675. }
  676. /*
  677. * iterate over all statements to find "bad" casts:
  678. * those where the address of the start of a structure is cast
  679. * to a pointer of a structure of a different type, or a
  680. * structure pointer type is cast to a different structure pointer type
  681. */
  682. static unsigned int find_bad_casts_execute(void)
  683. {
  684. basic_block bb;
  685. handle_local_var_initializers();
  686. FOR_EACH_BB_FN(bb, cfun) {
  687. gimple_stmt_iterator gsi;
  688. for (gsi = gsi_start_bb(bb); !gsi_end_p(gsi); gsi_next(&gsi)) {
  689. gimple stmt;
  690. const_tree lhs;
  691. const_tree lhs_type;
  692. const_tree rhs1;
  693. const_tree rhs_type;
  694. const_tree ptr_lhs_type;
  695. const_tree ptr_rhs_type;
  696. const_tree op0;
  697. const_tree op0_type;
  698. enum tree_code rhs_code;
  699. stmt = gsi_stmt(gsi);
  700. #ifdef __DEBUG_PLUGIN
  701. #ifdef __DEBUG_VERBOSE
  702. debug_gimple_stmt(stmt);
  703. debug_tree(gimple_get_lhs(stmt));
  704. #endif
  705. #endif
  706. if (gimple_code(stmt) != GIMPLE_ASSIGN)
  707. continue;
  708. #ifdef __DEBUG_PLUGIN
  709. #ifdef __DEBUG_VERBOSE
  710. debug_tree(gimple_assign_rhs1(stmt));
  711. #endif
  712. #endif
  713. rhs_code = gimple_assign_rhs_code(stmt);
  714. if (rhs_code != ADDR_EXPR && rhs_code != SSA_NAME)
  715. continue;
  716. lhs = gimple_get_lhs(stmt);
  717. lhs_type = TREE_TYPE(lhs);
  718. rhs1 = gimple_assign_rhs1(stmt);
  719. rhs_type = TREE_TYPE(rhs1);
  720. if (TREE_CODE(rhs_type) != POINTER_TYPE ||
  721. TREE_CODE(lhs_type) != POINTER_TYPE)
  722. continue;
  723. ptr_lhs_type = TYPE_MAIN_VARIANT(strip_array_types(TYPE_MAIN_VARIANT(TREE_TYPE(lhs_type))));
  724. ptr_rhs_type = TYPE_MAIN_VARIANT(strip_array_types(TYPE_MAIN_VARIANT(TREE_TYPE(rhs_type))));
  725. if (ptr_rhs_type == void_type_node)
  726. continue;
  727. if (ptr_lhs_type == void_type_node)
  728. continue;
  729. if (dominated_by_is_err(rhs1, bb))
  730. continue;
  731. if (TREE_CODE(ptr_rhs_type) != RECORD_TYPE) {
  732. #ifndef __DEBUG_PLUGIN
  733. if (lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(ptr_lhs_type)))
  734. #endif
  735. {
  736. if (!whitelisted_cast(stmt, ptr_lhs_type, ptr_rhs_type))
  737. MISMATCH(gimple_location(stmt), "rhs", ptr_lhs_type, ptr_rhs_type);
  738. }
  739. continue;
  740. }
  741. if (rhs_code == SSA_NAME && ptr_lhs_type == ptr_rhs_type)
  742. continue;
  743. if (rhs_code == ADDR_EXPR) {
  744. op0 = TREE_OPERAND(rhs1, 0);
  745. if (op0 == NULL_TREE)
  746. continue;
  747. if (TREE_CODE(op0) != VAR_DECL)
  748. continue;
  749. op0_type = TYPE_MAIN_VARIANT(strip_array_types(TYPE_MAIN_VARIANT(TREE_TYPE(op0))));
  750. if (op0_type == ptr_lhs_type)
  751. continue;
  752. #ifndef __DEBUG_PLUGIN
  753. if (lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(op0_type)))
  754. #endif
  755. {
  756. if (!whitelisted_cast(stmt, ptr_lhs_type, op0_type))
  757. MISMATCH(gimple_location(stmt), "op0", ptr_lhs_type, op0_type);
  758. }
  759. } else {
  760. const_tree ssa_name_var = SSA_NAME_VAR(rhs1);
  761. /* skip bogus type casts introduced by container_of */
  762. if (ssa_name_var != NULL_TREE && DECL_NAME(ssa_name_var) &&
  763. !strcmp((const char *)DECL_NAME_POINTER(ssa_name_var), "__mptr"))
  764. continue;
  765. #ifndef __DEBUG_PLUGIN
  766. if (lookup_attribute("randomize_performed", TYPE_ATTRIBUTES(ptr_rhs_type)))
  767. #endif
  768. {
  769. if (!whitelisted_cast(stmt, ptr_lhs_type, ptr_rhs_type))
  770. MISMATCH(gimple_location(stmt), "ssa", ptr_lhs_type, ptr_rhs_type);
  771. }
  772. }
  773. }
  774. }
  775. return 0;
  776. }
  777. #define PASS_NAME find_bad_casts
  778. #define NO_GATE
  779. #define TODO_FLAGS_FINISH TODO_dump_func
  780. #include "gcc-generate-gimple-pass.h"
  781. __visible int plugin_init(struct plugin_name_args *plugin_info, struct plugin_gcc_version *version)
  782. {
  783. int i;
  784. const char * const plugin_name = plugin_info->base_name;
  785. const int argc = plugin_info->argc;
  786. const struct plugin_argument * const argv = plugin_info->argv;
  787. bool enable = true;
  788. int obtained_seed = 0;
  789. struct register_pass_info find_bad_casts_pass_info;
  790. find_bad_casts_pass_info.pass = make_find_bad_casts_pass();
  791. find_bad_casts_pass_info.reference_pass_name = "ssa";
  792. find_bad_casts_pass_info.ref_pass_instance_number = 1;
  793. find_bad_casts_pass_info.pos_op = PASS_POS_INSERT_AFTER;
  794. if (!plugin_default_version_check(version, &gcc_version)) {
  795. error(G_("incompatible gcc/plugin versions"));
  796. return 1;
  797. }
  798. if (strncmp(lang_hooks.name, "GNU C", 5) && !strncmp(lang_hooks.name, "GNU C+", 6)) {
  799. inform(UNKNOWN_LOCATION, G_("%s supports C only, not %s"), plugin_name, lang_hooks.name);
  800. enable = false;
  801. }
  802. for (i = 0; i < argc; ++i) {
  803. if (!strcmp(argv[i].key, "disable")) {
  804. enable = false;
  805. continue;
  806. }
  807. if (!strcmp(argv[i].key, "performance-mode")) {
  808. performance_mode = 1;
  809. continue;
  810. }
  811. error(G_("unknown option '-fplugin-arg-%s-%s'"), plugin_name, argv[i].key);
  812. }
  813. if (strlen(randstruct_seed) != 64) {
  814. error(G_("invalid seed value supplied for %s plugin"), plugin_name);
  815. return 1;
  816. }
  817. obtained_seed = sscanf(randstruct_seed, "%016llx%016llx%016llx%016llx",
  818. &shuffle_seed[0], &shuffle_seed[1], &shuffle_seed[2], &shuffle_seed[3]);
  819. if (obtained_seed != 4) {
  820. error(G_("Invalid seed supplied for %s plugin"), plugin_name);
  821. return 1;
  822. }
  823. register_callback(plugin_name, PLUGIN_INFO, NULL, &randomize_layout_plugin_info);
  824. if (enable) {
  825. register_callback(plugin_name, PLUGIN_ALL_IPA_PASSES_START, check_global_variables, NULL);
  826. register_callback(plugin_name, PLUGIN_PASS_MANAGER_SETUP, NULL, &find_bad_casts_pass_info);
  827. register_callback(plugin_name, PLUGIN_FINISH_TYPE, finish_type, NULL);
  828. register_callback(plugin_name, PLUGIN_FINISH_DECL, randomize_layout_finish_decl, NULL);
  829. }
  830. register_callback(plugin_name, PLUGIN_ATTRIBUTES, register_attributes, NULL);
  831. return 0;
  832. }