-
Notifications
You must be signed in to change notification settings - Fork 47
/
pmc_main.c
2553 lines (2197 loc) · 80.1 KB
/
pmc_main.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Persistent memory checker.
* Copyright (c) 2014-2020, Intel Corporation.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU General Public License,
* version 2, or (at your option) any later version, as published
* by the Free Software Foundation.
*
* This program is distributed in the hope it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*/
/*
* This program is based on lackey, cachegrind and memcheck.
*/
#include <sys/param.h>
#include "pub_tool_libcfile.h"
#include <fcntl.h>
#include "pub_tool_oset.h"
#include "pub_tool_mallocfree.h"
#include "pub_tool_options.h"
#include "pub_tool_libcbase.h"
#include "pub_tool_gdbserver.h"
#include "pub_tool_tooliface.h"
#include "pub_tool_threadstate.h"
#include "pub_tool_libcassert.h"
#include "pub_tool_libcprint.h"
#include "pub_tool_machine.h"
#include "pub_tool_stacktrace.h"
#include "pub_tool_debuginfo.h"
#include "pmemcheck.h"
#include "pmc_include.h"
/* track at max this many multiple overwrites */
#define MAX_MULT_OVERWRITES 10000UL
/* track at max this many flush error events */
#define MAX_FLUSH_ERROR_EVENTS 10000UL
/* build various kinds of expressions */
#define triop(_op, _arg1, _arg2, _arg3) \
IRExpr_Triop((_op),(_arg1),(_arg2),(_arg3))
#define binop(_op, _arg1, _arg2) IRExpr_Binop((_op),(_arg1),(_arg2))
#define unop(_op, _arg) IRExpr_Unop((_op),(_arg))
#define mkU1(_n) IRExpr_Const(IRConst_U1(_n))
#define mkU8(_n) IRExpr_Const(IRConst_U8(_n))
#define mkU16(_n) IRExpr_Const(IRConst_U16(_n))
#define mkU32(_n) IRExpr_Const(IRConst_U32(_n))
#define mkU64(_n) IRExpr_Const(IRConst_U64(_n))
#define mkexpr(_tmp) IRExpr_RdTmp((_tmp))
/** Max store size */
#define MAX_DSIZE 256
/** Max allowable path length */
#define MAX_PATH_SIZE 4096
/** Max allowable length of memory location information array */
#define INIT_STORE_ARRAY_MAX_NUM 1000UL
/** Defining memory location information array structure */
struct pmem_stores_array {
/** Index of current metadata */
UWord m_index;
struct pmem_st *pmem_stores;
struct arr_md *m_data;
ULong max_array_num;
ULong max_m_data_num;
};
/** Hybrid structure to store information of persistent memory **/
static struct pmem_hybrid_struct {
/** Array of stores to persistent memory */
struct pmem_stores_array info_array;
/** Set of stores to persistent memory. */
OSet *pmem_stores;
} pInfo;
/** Holds parameters and runtime data */
static struct pmem_ops {
/** Set of registered persistent memory regions. */
OSet *pmem_mappings;
/** Inversion of pmem_mappings. */
OSet *nonpmem_mappings;
/** Holds possible multiple overwrite error events. */
struct pmem_st **multiple_stores;
/** Holds the number of registered multiple overwrites. */
UWord multiple_stores_reg;
/** Holds possible redundant flush events. */
struct pmem_st **redundant_flushes;
/** Holds the number of registered redundant flush events. */
UWord redundant_flushes_reg;
/** Holds superfluous flush error events. */
struct pmem_st **superfluous_flushes;
/** Holds the number of superfluous flush events. */
UWord superfluous_flushes_reg;
/** Within this many SBlocks a consecutive write is not considered
* a poss_leak. */
UWord store_sb_indiff;
/** Turns on multiple overwrite error tracking. */
Bool track_multiple_stores;
/** Turns on logging persistent memory events. */
Bool log_stores;
/** Toggles summary printing. */
Bool print_summary;
/** Toggles checking multiple and superfluous flushes */
Bool check_flush;
/** The size of the cache line */
Long flush_align_size;
/** Force flush alignment to native cache line size */
Bool force_flush_align;
/** Toggles transaction tracking. */
Bool transactions_only;
/** Toggles store stacktrace logging. */
Bool store_traces;
/** Depth of the printed store stacktrace. */
UInt store_traces_depth;
/** Toggles automatic ISA recognition. */
Bool automatic_isa_rec;
/** Toggles error summary message */
Bool error_summary;
/** Simulate 2-phase flushing. */
Bool weak_clflush;
} pmem;
/*
* Memory tracing pattern as in cachegrind/lackey - in case of future
* improvements.
*/
/** A specific kind of expression. */
typedef IRExpr IRAtom;
/** Types of discernable events. */
typedef enum {
Event_Ir,
Event_Dr,
Event_Dw,
Event_Dm
} EventKind;
/** The event structure. */
typedef struct {
EventKind ekind;
IRAtom *addr;
SizeT size;
IRAtom *guard; /* :: Ity_I1, or NULL=="always True" */
IRAtom *value;
} Event;
/** Number of sblock run. */
static ULong sblocks = 0;
/** Cached last pmem region. */
static struct pmem_st *lastPMEM = NULL;
/** Cached last non-pmem region. */
static struct pmem_st *lastNONPMEM = NULL;
/**
* \brief Allocate a node in the store information array.
* \return The pointer of the allocated node
*/
static struct pmem_st *
pInfo_AllocNodeInArray(void)
{
struct pmem_st *store;
UWord old_index = pInfo.info_array.m_data[pInfo.info_array.m_index].end_index;
/* grow store information array if the array is not enough */
if (UNLIKELY(old_index >= pInfo.info_array.max_array_num)) {
pInfo.info_array.max_array_num *= 2;
pInfo.info_array.pmem_stores = VG_(realloc)("grow info_array structure", pInfo.info_array.pmem_stores,
pInfo.info_array.max_array_num);
}
store = pInfo.info_array.pmem_stores + old_index;
return store;
}
/**
* \brief Check if a given store overlaps with registered persistent memory
* regions.
* \param[in] addr The base address of the store.
* \param[in] size The size of the store.
* \return True if store overlaps with any registered region, false otherwise.
*/
static inline __attribute__((always_inline)) Bool
is_pmem_access(Addr addr, SizeT size)
{
struct pmem_st tmp = {0};
tmp.size = size;
tmp.addr = addr;
if (LIKELY(lastNONPMEM && cmp_pmem_st(lastNONPMEM, &tmp) == 0))
return False;
if (LIKELY(lastPMEM && cmp_pmem_st(lastPMEM, &tmp) == 0))
return True;
struct pmem_st *nonpmem_st =
VG_(OSetGen_Lookup)(pmem.nonpmem_mappings, &tmp);
if (nonpmem_st) {
lastNONPMEM = nonpmem_st;
} else {
struct pmem_st *pmem_st = VG_(OSetGen_Lookup)(pmem.pmem_mappings, &tmp);
tl_assert(pmem_st != NULL);
lastPMEM = pmem_st;
}
return nonpmem_st == NULL;
}
/**
* \brief State to string change for information purposes.
*/
static const char *
store_state_to_string(enum store_state state)
{
switch (state) {
case STST_CLEAN:
return "CLEAN";
case STST_DIRTY:
return "DIRTY";
case STST_FLUSHED:
return "FLUSHED";
default:
return NULL;
}
}
/**
* \brief Prints registered redundant flushes.
*
* \details Flushing regions of memory which have already been flushed, but not
* committed to memory, is a possible performance issue. This is not a data
* consistency related problem.
*/
static void
print_redundant_flushes(void)
{
VG_(umsg)("\nNumber of redundantly flushed stores: %lu\n",
pmem.redundant_flushes_reg);
VG_(umsg)("Stores flushed multiple times:\n");
struct pmem_st *tmp;
Int i;
for (i = 0; i < pmem.redundant_flushes_reg; ++i) {
tmp = pmem.redundant_flushes[i];
VG_(umsg)("[%d] ", i);
VG_(pp_ExeContext)(tmp->context);
VG_(umsg)("\tAddress: 0x%lx\tsize: %llu\tstate: %s\n",
tmp->addr, tmp->size, store_state_to_string(tmp->state));
}
}
/**
* \brief Prints registered superfluous flushes.
*
* \details Flushing clean (with no pending stores to flush) regions of memory
* is most certainly an error in the algorithm. This is not a data consistency
* related problem, but a performance issue.
*/
static void
print_superfluous_flushes(void)
{
VG_(umsg)("\nNumber of unnecessary flushes: %lu\n",
pmem.superfluous_flushes_reg);
struct pmem_st *tmp;
Int i;
for (i = 0; i < pmem.superfluous_flushes_reg; ++i) {
tmp = pmem.superfluous_flushes[i];
VG_(umsg)("[%d] ", i);
VG_(pp_ExeContext)(tmp->context);
VG_(umsg)("\tAddress: 0x%lx\tsize: %llu\n", tmp->addr, tmp->size);
}
}
/**
* \brief Prints registered multiple stores.
*
* \details Overwriting stores before they are made persistent suggests
* an error in the algorithm. This could be both a data consistency and
* performance issue.
*/
static void
print_multiple_stores(void)
{
VG_(umsg)("\nNumber of overwritten stores: %lu\n",
pmem.multiple_stores_reg);
VG_(umsg)("Overwritten stores before they were made persistent:\n");
struct pmem_st *tmp;
Int i;
for (i = 0; i < pmem.multiple_stores_reg; ++i) {
tmp = pmem.multiple_stores[i];
VG_(umsg)("[%d] ", i);
VG_(pp_ExeContext)(tmp->context);
VG_(umsg)("\tAddress: 0x%lx\tsize: %llu\tstate: %s\n",
tmp->addr, tmp->size, store_state_to_string(tmp->state));
}
}
static void add_and_merge_store(struct pmem_st *region);
/**
* \brief Prints registered store statistics.
*
* \details Print outstanding stores which were not made persistent during the
* whole run of the application.
*/
static void
print_store_stats(void)
{
/* print store states of the array */
struct pmem_st *tmp;
struct pmem_stores_array *info_arr = &pInfo.info_array;
for (int s_index=0; s_index <= info_arr->m_index; s_index++) {
for (int i= info_arr->m_data[s_index].start_index; i< info_arr->m_data[s_index].end_index; i++) {
tmp = info_arr->pmem_stores + i;
if (tmp->size == 0)
continue;
if (info_arr->m_data[s_index].state == ALL_FLUSHED)
tmp->state = STST_FLUSHED;
struct pmem_st *new = VG_(OSetGen_AllocNode)(pInfo.pmem_stores, sizeof(struct pmem_st));
*new = *tmp;
add_and_merge_store(new);
}
}
VG_(umsg)("Number of stores not made persistent: %u\n", VG_(OSetGen_Size)
(pInfo.pmem_stores));
if (VG_(OSetGen_Size)(pInfo.pmem_stores) != 0) {
VG_(OSetGen_ResetIter)(pInfo.pmem_stores);
UWord total = 0;
Int i = 0;
VG_(umsg)("Stores not made persistent properly:\n");
while ((tmp = VG_(OSetGen_Next)(pInfo.pmem_stores)) != NULL) {
VG_(umsg)("[%d] ", i);
VG_(pp_ExeContext)(tmp->context);
VG_(umsg)("\tAddress: 0x%lx\tsize: %llu\tstate: %s\n",
tmp->addr, tmp->size, store_state_to_string(tmp->state));
total += tmp->size;
++i;
}
VG_(umsg)("Total memory not made persistent: %lu\n", total);
}
}
/**
* \brief Prints the error message for exceeding the maximum allowable
* overwrites.
* \param[in] limit The limit to print.
*/
static void
print_max_poss_overwrites_error(UWord limit)
{
VG_(umsg)("The number of overwritten stores exceeded %lu\n\n",
limit);
VG_(umsg)("This either means there is something fundamentally wrong with"
" your program, or you are using your persistent memory as "
"volatile memory.\n");
VG_(message_flush)();
print_multiple_stores();
}
/**
* \brief Prints the error message for exceeding the maximum allowable
* number of superfluous flushes.
* \param[in] limit The limit to print.
*/
static void
print_superfluous_flush_error(UWord limit)
{
VG_(umsg)("The number of superfluous flushes exceeded %lu\n\n",
limit);
VG_(umsg)("This means your program is constantly flushing regions of"
" memory, where no stores were made. This is a performance"
" issue.\n");
VG_(message_flush)();
print_superfluous_flushes();
}
/**
* \brief Prints the error message for exceeding the maximum allowable
* number of redundant flushes.
* \param[in] limit The limit to print.
*/
static void
print_redundant_flush_error(UWord limit)
{
VG_(umsg)("The number of redundant flushes exceeded %lu\n\n",
limit);
VG_(umsg)("This means your program is constantly flushing regions of"
" memory, which have already been flushed. This is a performance"
" issue.\n");
VG_(message_flush)();
print_redundant_flushes();
}
/**
* \brief Prints registered store context.
*
* \details Print store context.
*/
static void
print_store_ip_desc(UInt n, DiEpoch ep, Addr ip, void *uu_opaque)
{
InlIPCursor *iipc = VG_(new_IIPC)(ep, ip);
VG_(emit)(";");
do {
const HChar *buf = VG_(describe_IP)(ep, ip, iipc);
if (VG_(clo_xml))
VG_(printf_xml)("%s\n", buf);
else
VG_(emit)("%s", buf);
// Increase n to show "at" for only one level.
n++;
} while (VG_(next_IIPC)(iipc));
VG_(delete_IIPC)(iipc);
}
/**
* \brief Prints stack trace.
*
* \details Print stack trace.
*/
static void
pp_store_trace(const struct pmem_st *store, UInt n_ips)
{
n_ips = n_ips == 0 ? VG_(get_ExeContext_n_ips)(store->context) : n_ips;
tl_assert( n_ips > 0 );
if (VG_(clo_xml))
VG_(printf_xml)(" <stack>\n");
DiEpoch ep = VG_(current_DiEpoch)();
VG_(apply_StackTrace)(print_store_ip_desc, NULL, ep,
VG_(get_ExeContext_StackTrace(store->context)), n_ips);
if (VG_(clo_xml))
VG_(printf_xml)(" </stack>\n");
}
/**
* \brief Check if both addresses belong to functions that do have
* memcpy or memset in their names.
* \param[in] ep current context
* \param[in] a1 instruction pointer
* \param[in] a2 instruction pointer
* \return True if both instruction pointers belong to memcpy/memset,
* False otherwise.
*/
static Bool
addresses_belong_to_memcpy_memset(DiEpoch ep, Addr a1, Addr a2)
{
const HChar *fn;
if (!VG_(get_fnname)(ep, a1, &fn))
return False;
UInt fn1_is_memcpy = VG_(strstr)(fn, "memcpy") != NULL;
UInt fn1_is_memset = VG_(strstr)(fn, "memset") != NULL;
if (!fn1_is_memcpy && !fn1_is_memset)
return False;
if (!VG_(get_fnname)(ep, a2, &fn))
return False;
UInt fn2_is_memcpy = VG_(strstr)(fn, "memcpy") != NULL;
UInt fn2_is_memset = VG_(strstr)(fn, "memset") != NULL;
/*
* If both IPs belong to function with memcpy in the name, then
* consider them as the same.
*/
if (fn1_is_memcpy && fn2_is_memcpy)
return True;
/* Same story with memset. */
if (fn1_is_memset && fn2_is_memset)
return True;
return False;
}
/**
* \brief Check if Instruction Pointers should be considered the same.
*
* \param[in] a1 instruction pointer
* \param[in] a2 instruction pointer
* \return True if instruction pointers are the same, False otherwise.
*/
static Bool
addresses_are_mergeable(Addr a1, Addr a2)
{
DiEpoch ep = VG_(current_DiEpoch)();
if (a1 == a2)
return True;
/* if the addresses are far from each other, then return early */
#define SAME_FUNC_LIMIT 4096
if (a1 > a2 + SAME_FUNC_LIMIT)
return False;
if (a2 > a1 + SAME_FUNC_LIMIT)
return False;
#undef SAME_FUNC_LIMIT
const HChar *filename;
if (!VG_(get_filename)(ep, a1, &filename))
goto fallback;
HChar tmp[4096];
/*
* Copy file name, because original pointer will be overwritten
* the next time get_filename will be called.
*/
HChar *filename1;
/* Try to keep it on the stack. */
if (VG_(strlen)(filename) + 1 < sizeof(tmp)) {
filename1 = tmp;
VG_(strcpy)(filename1, filename);
} else {
filename1 = VG_(strdup)("addresses_are_mergable", filename);
}
const HChar *filename2;
if (!VG_(get_filename)(ep, a2, &filename2)) {
if (filename1 != tmp)
VG_(free)(filename1);
goto fallback;
}
/*
* If instruction pointers belong to different files, then they are
* not mergeable.
*/
Bool files_eq = VG_(strcmp)(filename1, filename2) == 0;
if (filename1 != tmp)
VG_(free)(filename1);
if (!files_eq)
return False;
UInt line1, line2;
if (!VG_(get_linenum)(ep, a1, &line1))
goto fallback;
if (!VG_(get_linenum)(ep, a2, &line2))
goto fallback;
/* Exact line match -> mergeable. */
if (line1 == line2)
return True;
fallback:
return addresses_belong_to_memcpy_memset(ep, a1, a2);
}
/**
* \brief Compare two ExeContexts.
* Checks if two ExeContext are equal not counting the possible first
* memset/memcpy function in the callstack.
*
* \param[in] lhs The first ExeContext to compare.
* \param[in] rhs The second ExeContext to compare.
*
* Return True if the ExeContexts are equal, not counting the first
* memcpy/memset function, False otherwise.
*/
static Bool
cmp_exe_context(const ExeContext* lhs, const ExeContext* rhs)
{
if (lhs == NULL || rhs == NULL)
return False;
if (lhs == rhs)
return True;
/* retrieve stacktraces */
UInt n_ips1;
UInt n_ips2;
const Addr *ips1 = VG_(make_StackTrace_from_ExeContext)(lhs, &n_ips1);
const Addr *ips2 = VG_(make_StackTrace_from_ExeContext)(rhs, &n_ips2);
/* Must be at least one address in each trace. */
tl_assert(n_ips1 >= 1 && n_ips2 >= 1);
/* different stacktrace depth */
if (n_ips1 != n_ips2)
return False;
/* compare instruction pointers, starting from the _second_ */
for (Int i = 1; i < n_ips1; i++)
if (ips1[i] != ips2[i])
return False;
return addresses_are_mergeable(ips1[0], ips2[0]);
}
/**
* \brief Checks if two stores are merge'able.
* Does not check the adjacency of the stores. Checks only the context and state
* of the store.
*
* \param[in] lhs The first store to check.
* \param[in] rhs The second store to check.
*
* \return True if stores are merge'able, False otherwise.
*/
static Bool
is_store_mergeable(const struct pmem_st *lhs,
const struct pmem_st *rhs)
{
Bool state_eq = lhs->state == rhs->state;
return state_eq && cmp_exe_context(lhs->context, rhs->context);
}
/**
* \brief Merge two stores together.
* Does not check whether the two stores can in fact be merged. The two stores
* should be adjacent or overlapping for the merging to make sense.
*
* \param[in,out] to_merge the store with which the merge will happen.
* \param[in] to_be_merged the store that will be merged.
*/
static inline void
merge_stores(struct pmem_st *to_merge,
const struct pmem_st *to_be_merged)
{
ULong max_addr = MAX(to_merge->addr + to_merge->size,
to_be_merged->addr + to_be_merged->size);
to_merge->addr = MIN(to_merge->addr, to_be_merged->addr);
to_merge->size = max_addr - to_merge->addr;
}
typedef void (*split_clb)(struct pmem_st *store, OSet *set, Bool preallocated);
typedef void (*array_split_clb)(struct pmem_st *store, OSet *set);
/**
* \brief Free store if it was preallocated.
*
* \param[in,out] store The store to be freed.
* \param[in,out] set The set the store belongs to.
* \param[in] preallocated True if the store is in the heap and not the stack.
*/
static void
free_clb(struct pmem_st *store, OSet *set, Bool preallocated)
{
if (preallocated)
VG_(OSetGen_FreeNode)(set, store);
}
/**
* \brief Issues a warning event with the given store as the offender.
*
* \param[in,out] store The store to be registered as a warning.
* \param[in,out] set The set the store belongs to.
* \param[in] preallocated True if the store is in the heap and not the stack.
*/
static void
add_mult_overwrite_warn(struct pmem_st *store, OSet *set, Bool preallocated)
{
if (!preallocated) {
struct pmem_st *new = VG_(OSetGen_AllocNode)(set,
(SizeT) sizeof(struct pmem_st));
*new = *store;
store = new;
}
add_warning_event(pmem.multiple_stores, &pmem.multiple_stores_reg,
store, MAX_MULT_OVERWRITES, print_max_poss_overwrites_error);
}
/**
* \brief Splits-adjusts the two given stores so that they do not overlap.
*
* The stores need to be from the same set and have to overlap.
*
* \param[in,out] old The old store that will be modified.
* \param[in] new The new store that will not be modified.
* \param[in,out] set The set both of the stores belong to.
* \param[in,out] clb The callback to be called for the overlapping part of the
* old store.
*/
static void
split_stores(struct pmem_st *old, const struct pmem_st *new, OSet *set,
split_clb clb, Bool is_array)
{
Addr new_max = new->addr + new->size;
Addr old_max = old->addr + old->size;
/* new store encapsulates old, it needs to be removed */
if (old->addr >= new->addr && old_max <= new_max) {
if (is_array == True) {
clb(old, set, False);
/* using size =0 to mark this information as deleted */
old->size = 0;
} else {
VG_(OSetGen_Remove)(set, old);
clb(old, set, True);
}
return;
}
struct pmem_st tmp;
if (old->addr < new->addr) {
/* the new store is within the old store */
if (old_max > new_max) {
struct pmem_st *after = VG_(OSetGen_AllocNode)(set,
(SizeT) sizeof(struct pmem_st));
*after = *old;
after->addr = new_max;
after->size = old_max - new_max;
after->value &= (1 << (after->size * 8 + 1)) - 1;
/* adjust the size and value of the old entry */
old->value >>= old_max - new->addr;
old->size = new->addr - old->addr;
/* insert the new store fragment */
VG_(OSetGen_Insert)(set, after);
/* clb the cut out fragment with the old ExeContext */
tmp = *new;
tmp.context = old->context;
clb(&tmp, set, False);
} else {
/* old starts before new */
/* callback for removed part */
tmp = *old;
tmp.addr = new->addr;
tmp.size = old_max - new->addr;
/* adjust leftover */
clb(&tmp, set, False);
old->value >>= old_max - new->addr;
old->size = new->addr - old->addr;
}
return;
}
/* now old->addr >= new->addr */
/* end of old is behind end of new */
if (old_max > new_max) {
/* callback for removed part */
tmp = *old;
tmp.size -= old_max - new_max;
clb(&tmp, set, False);
/* adjust leftover */
old->addr = new_max;
old->size = old_max - new_max;
old->value &= (1 << (old->size * 8 + 1)) - 1;
return;
}
/* you should never end up here */
tl_assert(False);
}
/**
* \brief Add and merges adjacent stores if possible.
* Should not be used if track_multiple_stores is enabled.
*
* param[in,out] region the store to be added and merged with adjacent stores.
*/
static void
add_and_merge_store(struct pmem_st *region)
{
struct pmem_st *old_entry;
/* remove old overlapping entries */
while ((old_entry = VG_(OSetGen_Lookup)(pInfo.pmem_stores, region)) != NULL)
split_stores(old_entry, region, pInfo.pmem_stores, free_clb, False);
/* check adjacent entries */
struct pmem_st search_entry = *region;
search_entry.addr -= 1;
int i = 0;
for (i = 0; i < 2; ++i, search_entry.addr += 2) {
old_entry = VG_(OSetGen_Lookup)(pInfo.pmem_stores, &search_entry);
/* no adjacent entry */
if (old_entry == NULL)
continue;
/* adjacent entry not merge'able */
if (!is_store_mergeable(region, old_entry))
continue;
/* registering overlapping stores, glue them together */
merge_stores(region, old_entry);
old_entry = VG_(OSetGen_Remove)(pInfo.pmem_stores, &search_entry);
VG_(OSetGen_FreeNode)(pInfo.pmem_stores, old_entry);
}
VG_(OSetGen_Insert)(pInfo.pmem_stores, region);
}
/**
* \brief Update minimum and maximum address of current metadata in arr_md structure.
*
* param[in] store the store used to update minimum and maximum address of current metadata.
*/
static void
update_array_metadata_minandmax(struct pmem_st *store)
{
Addr store_max = store->addr + store->size;
struct arr_md* m_data = pInfo.info_array.m_data + pInfo.info_array.m_index;
if (m_data->max_addr == -1 && m_data->min_addr == -1) {
m_data->min_addr = store->addr;
m_data->max_addr = store_max;
}
if (m_data->min_addr > store->addr)
m_data->min_addr = store->addr;
if (m_data->max_addr < store_max)
m_data->max_addr = store_max;
return;
}
/**
* \brief Compare regions with the interval of one metadata (decided by minimum and maximum address) in arr_md structure.
* \param[in] p_st the store to compare.
* \param[in] index the index to indicate with which metadata the store compares.
* \return -1 if the region doesn't overlap with the interval of the metadata, 1 if the interval of one metadata includes the region and 0 if the interval of the metadata overlaps with the region.
*/
static int
cmp_with_arr_minandmax(struct pmem_st *p_st, int index)
{
Addr p_st_max = p_st->addr + p_st->size;
struct arr_md* m_data = pInfo.info_array.m_data + index;
if ((p_st->addr > m_data->max_addr) || (p_st_max < m_data->min_addr)) {
return -1;
} else if (m_data->min_addr <= p_st->addr && p_st_max <= m_data->max_addr) {
return 1;
} else {
return 0;
}
}
/**
* Handle multiple overwrites in memory location information array.
* \param[in,out] store the store to be handled.
*/
static void
array_handle_with_mult_stores(struct pmem_st *store)
{
struct pmem_st *existing;
/* remove any overlapping stores from the collection */
for(int s_index=0; s_index <= pInfo.info_array.m_index; s_index++) {
if (cmp_with_arr_minandmax(store, s_index) != -1) {
for (int i = pInfo.info_array.m_data[s_index].start_index; i < pInfo.info_array.m_data[s_index].end_index; i++) {
if (LIKELY(pInfo.info_array.pmem_stores[i].size != 0)) {
existing = pInfo.info_array.pmem_stores + i;
} else {
continue;
}
if (cmp_pmem_st(existing, store) == 0) {
if ((store->block_num - existing->block_num) < pmem.store_sb_indiff
&& existing->addr == store->addr
&& existing->size == store->size
&& existing->value == store->value) {
/* using size = 0 to mark this information as deleted */
existing->size = 0;
continue;
}
split_stores(existing, store, pInfo.pmem_stores,
add_mult_overwrite_warn, True);
}
}
}
}
}
/**
* \brief Handle a new store checking for multiple overwrites.
* This should be called when track_multiple_stores is enabled.
*
* \param[in,out] store the store to be handled.
*/
static void
handle_with_mult_stores(struct pmem_st *store)
{
/* handle multiple overwrite in the array structure */
array_handle_with_mult_stores(store);
struct pmem_st *existing;
/* remove any overlapping stores from the collection */
while ((existing = VG_(OSetGen_Lookup)(pInfo.pmem_stores, store)) !=
NULL) {
/* check store indifference */
if ((store->block_num - existing->block_num) < pmem.store_sb_indiff
&& existing->addr == store->addr
&& existing->size == store->size
&& existing->value == store->value) {
VG_(OSetGen_Remove)(pInfo.pmem_stores, store);
VG_(OSetGen_FreeNode)(pInfo.pmem_stores, existing);
continue;
}
split_stores(existing, store, pInfo.pmem_stores,
add_mult_overwrite_warn, False);
}
/* Inserting the new store happens after return*/
}
/**
* \brief Trace the given store if it was to any of the registered persistent
* memory regions.
* \param[in] addr The base address of the store.
* \param[in] size The size of the store.
* \param[in] value The value of the store.
*/
static VG_REGPARM(3) void
trace_pmem_store(Addr addr, SizeT size, UWord value)
{
if (LIKELY(!is_pmem_access(addr, size)))
return;
struct pmem_st *store = pInfo_AllocNodeInArray();
store->addr = addr;
store->size = size;
store->state = STST_DIRTY;
store->block_num = sblocks;
store->value = value;
store->context = VG_(record_ExeContext)(VG_(get_running_tid)(), 0);
/* log the store, regardless if it is a double store */
if (pmem.log_stores) {
VG_(emit)("|STORE;0x%lx;0x%lx;0x%lx", addr, value, size);
if (pmem.store_traces)
pp_store_trace(store, pmem.store_traces_depth);
}
if (pmem.track_multiple_stores) {
handle_with_mult_stores(store);
}
/* Insert information */
pInfo.info_array.m_data[pInfo.info_array.m_index].end_index++;
update_array_metadata_minandmax(store);
/* do transaction check */
handle_tx_store(store);
}
/**
* \brief Register the entry of a new SB.
*
* Useful when handling implementation independent multiple writes under