1/* -*- mode: C; c-basic-offset: 3; indent-tabs-mode: nil; -*- */
2/*
3  This file is part of drd, a thread error detector.
4
5  Copyright (C) 2006-2011 Bart Van Assche <bvanassche@acm.org>.
6
7  This program is free software; you can redistribute it and/or
8  modify it under the terms of the GNU General Public License as
9  published by the Free Software Foundation; either version 2 of the
10  License, or (at your option) any later version.
11
12  This program is distributed in the hope that it will be useful, but
13  WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  General Public License for more details.
16
17  You should have received a copy of the GNU General Public License
18  along with this program; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
20  02111-1307, USA.
21
22  The GNU General Public License is contained in the file COPYING.
23*/
24
25
26#ifndef __SEGMENT_H
27#define __SEGMENT_H
28
29
30/*
31 * Segments and segment lists. A segment represents information about
32 * a contiguous group of statements of a specific thread. There is a vector
33 * clock associated with each segment.
34 */
35
36
37#include "drd_vc.h"
38#include "pub_drd_bitmap.h"
39#include "pub_tool_execontext.h" // ExeContext
40#include "pub_tool_stacktrace.h" // StackTrace
41
42
43typedef struct segment
44{
45   /** Pointers to next and previous segments executed by the same thread. */
46   struct segment*    next;
47   struct segment*    prev;
48   DrdThreadId        tid;
49   /** Reference count: number of pointers that point to this segment. */
50   int                refcnt;
51   /** Stack trace of the first instruction of the segment. */
52   ExeContext*        stacktrace;
53   /** Vector clock associated with the segment. */
54   VectorClock        vc;
55   /**
56    * Bitmap representing the memory accesses by the instructions associated
57    * with the segment.
58    */
59   struct bitmap      bm;
60} Segment;
61
62
63Segment* DRD_(sg_new)(const DrdThreadId creator, const DrdThreadId created);
64static int DRD_(sg_get_refcnt)(const Segment* const sg);
65Segment* DRD_(sg_get)(Segment* const sg);
66void DRD_(sg_put)(Segment* const sg);
67static struct bitmap* DRD_(sg_bm)(Segment* const sg);
68void DRD_(sg_merge)(Segment* const sg1, Segment* const sg2);
69void DRD_(sg_print)(Segment* const sg);
70Bool DRD_(sg_get_trace)(void);
71void DRD_(sg_set_trace)(const Bool trace_segment);
72ULong DRD_(sg_get_segments_created_count)(void);
73ULong DRD_(sg_get_segments_alive_count)(void);
74ULong DRD_(sg_get_max_segments_alive_count)(void);
75ULong DRD_(sg_get_segment_merge_count)(void);
76
77
78/** Query the reference count of the specified segment. */
79static __inline__ int DRD_(sg_get_refcnt)(const Segment* const sg)
80{
81#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
82   tl_assert(sg);
83#endif
84
85   return sg->refcnt;
86}
87
88/** Return the pointer to the bitmap of the segment. */
89static __inline__ struct bitmap* DRD_(sg_bm)(Segment* const sg)
90{
91#ifdef ENABLE_DRD_CONSISTENCY_CHECKS
92   tl_assert(sg);
93#endif
94
95   return &sg->bm;
96}
97
98
99
100#endif // __SEGMENT_H
101