1 /* Caching code for GDB, the GNU debugger.
3 Copyright 1992, 1993, 1995, 1996, 1998, 1999, 2000, 2001, 2003 Free
4 Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
26 #include "gdb_string.h"
30 /* The data cache could lead to incorrect results because it doesn't
31 know about volatile variables, thus making it impossible to debug
32 functions which use memory mapped I/O devices. Set the nocache
33 memory region attribute in those cases.
35 In general the dcache speeds up performance, some speed improvement
36 comes from the actual caching mechanism, but the major gain is in
37 the reduction of the remote protocol overhead; instead of reading
38 or writing a large area of memory in 4 byte requests, the cache
39 bundles up the requests into 32 byte (actually LINE_SIZE) chunks.
40 Reducing the overhead to an eighth of what it was. This is very
41 obvious when displaying a large amount of data,
46 ----------------------------
47 first time | 4 sec 2 sec improvement due to chunking
48 second time | 4 sec 0 sec improvement due to caching
50 The cache structure is unusual, we keep a number of cache blocks
51 (DCACHE_SIZE) and each one caches a LINE_SIZEed area of memory.
52 Within each line we remember the address of the line (always a
53 multiple of the LINE_SIZE) and a vector of bytes over the range.
54 There's another vector which contains the state of the bytes.
56 ENTRY_BAD means that the byte is just plain wrong, and has no
57 correspondence with anything else (as it would when the cache is
58 turned on, but nothing has been done to it.
60 ENTRY_DIRTY means that the byte has some data in it which should be
61 written out to the remote target one day, but contains correct
64 ENTRY_OK means that the data is the same in the cache as it is in
68 The ENTRY_DIRTY state is necessary because GDB likes to write large
69 lumps of memory in small bits. If the caching mechanism didn't
70 maintain the DIRTY information, then something like a two byte
71 write would mean that the entire cache line would have to be read,
72 the two bytes modified and then written out again. The alternative
73 would be to not read in the cache line in the first place, and just
74 write the two bytes directly into target memory. The trouble with
75 that is that it really nails performance, because of the remote
76 protocol overhead. This way, all those little writes are bundled
77 up into an entire cache line write in one go, without having to
78 read the cache line in the first place.
81 /* NOTE: Interaction of dcache and memory region attributes
83 As there is no requirement that memory region attributes be aligned
84 to or be a multiple of the dcache page size, dcache_read_line() and
85 dcache_write_line() must break up the page by memory region. If a
86 chunk does not have the cache attribute set, an invalid memory type
87 is set, etc., then the chunk is skipped. Those chunks are handled
88 in target_xfer_memory() (or target_xfer_memory_partial()).
90 This doesn't occur very often. The most common occurance is when
91 the last bit of the .text segment and the first bit of the .data
92 segment fall within the same dcache page with a ro/cacheable memory
93 region defined for the .text segment and a rw/non-cacheable memory
94 region defined for the .data segment. */
96 /* This value regulates the number of cache blocks stored.
97 Smaller values reduce the time spent searching for a cache
98 line, and reduce memory requirements, but increase the risk
99 of a line not being in memory */
101 #define DCACHE_SIZE 64
103 /* This value regulates the size of a cache line. Smaller values
104 reduce the time taken to read a single byte, but reduce overall
107 #define LINE_SIZE_POWER (5)
108 #define LINE_SIZE (1 << LINE_SIZE_POWER)
110 /* Each cache block holds LINE_SIZE bytes of data
111 starting at a multiple-of-LINE_SIZE address. */
113 #define LINE_SIZE_MASK ((LINE_SIZE - 1))
114 #define XFORM(x) ((x) & LINE_SIZE_MASK)
115 #define MASK(x) ((x) & ~LINE_SIZE_MASK)
118 #define ENTRY_BAD 0 /* data at this byte is wrong */
119 #define ENTRY_DIRTY 1 /* data at this byte needs to be written back */
120 #define ENTRY_OK 2 /* data at this byte is same as in memory */
125 struct dcache_block
*p
; /* next in list */
126 CORE_ADDR addr
; /* Address for which data is recorded. */
127 char data
[LINE_SIZE
]; /* bytes at given address */
128 unsigned char state
[LINE_SIZE
]; /* what state the data is in */
130 /* whether anything in state is dirty - used to speed up the
138 /* FIXME: dcache_struct used to have a cache_has_stuff field that was
139 used to record whether the cache had been accessed. This was used
140 to invalidate the cache whenever caching was (re-)enabled (if the
141 cache was disabled and later re-enabled, it could contain stale
142 data). This was not needed because the cache is write through and
143 the code that enables, disables, and deletes memory region all
144 invalidate the cache.
146 This is overkill, since it also invalidates cache lines from
147 unrelated regions. One way this could be addressed by adding a
148 new function that takes an address and a length and invalidates
149 only those cache lines that match. */
154 struct dcache_block
*free_head
;
155 struct dcache_block
*free_tail
;
158 struct dcache_block
*valid_head
;
159 struct dcache_block
*valid_tail
;
161 /* The cache itself. */
162 struct dcache_block
*the_cache
;
165 static int dcache_poke_byte (DCACHE
*dcache
, CORE_ADDR addr
, char *ptr
);
167 static int dcache_peek_byte (DCACHE
*dcache
, CORE_ADDR addr
, char *ptr
);
169 static struct dcache_block
*dcache_hit (DCACHE
*dcache
, CORE_ADDR addr
);
171 static int dcache_write_line (DCACHE
*dcache
, struct dcache_block
*db
);
173 static int dcache_read_line (DCACHE
*dcache
, struct dcache_block
*db
);
175 static struct dcache_block
*dcache_alloc (DCACHE
*dcache
, CORE_ADDR addr
);
177 static int dcache_writeback (DCACHE
*dcache
);
179 static void dcache_info (char *exp
, int tty
);
181 void _initialize_dcache (void);
183 static int dcache_enabled_p
= 0;
185 show_dcache_enabled_p (struct ui_file
*file
, int from_tty
,
186 struct cmd_list_element
*c
, const char *value
)
188 fprintf_filtered (file
, _("Cache use for remote targets is %s.\n"), value
);
192 DCACHE
*last_cache
; /* Used by info dcache */
195 /* Free all the data cache blocks, thus discarding all cached data. */
198 dcache_invalidate (DCACHE
*dcache
)
201 dcache
->valid_head
= 0;
202 dcache
->valid_tail
= 0;
204 dcache
->free_head
= 0;
205 dcache
->free_tail
= 0;
207 for (i
= 0; i
< DCACHE_SIZE
; i
++)
209 struct dcache_block
*db
= dcache
->the_cache
+ i
;
211 if (!dcache
->free_head
)
212 dcache
->free_head
= db
;
214 dcache
->free_tail
->p
= db
;
215 dcache
->free_tail
= db
;
222 /* If addr is present in the dcache, return the address of the block
225 static struct dcache_block
*
226 dcache_hit (DCACHE
*dcache
, CORE_ADDR addr
)
228 struct dcache_block
*db
;
230 /* Search all cache blocks for one that is at this address. */
231 db
= dcache
->valid_head
;
235 if (MASK (addr
) == db
->addr
)
246 /* Make sure that anything in this line which needs to
250 dcache_write_line (DCACHE
*dcache
, struct dcache_block
*db
)
257 struct mem_region
*region
;
272 region
= lookup_mem_region(memaddr
);
273 if (memaddr
+ len
< region
->hi
)
276 reg_len
= region
->hi
- memaddr
;
278 if (!region
->attrib
.cache
|| region
->attrib
.mode
== MEM_RO
)
289 while (reg_len
> 0) {
290 if (db
->state
[s
] == ENTRY_DIRTY
)
301 while (reg_len
> 0) {
302 if (db
->state
[e
] != ENTRY_DIRTY
)
309 while (dirty_len
> 0)
311 res
= do_xfer_memory(memaddr
, myaddr
, dirty_len
, 1,
316 memset (&db
->state
[XFORM(memaddr
)], ENTRY_OK
, res
);
329 /* Read cache line */
331 dcache_read_line (DCACHE
*dcache
, struct dcache_block
*db
)
338 struct mem_region
*region
;
340 /* If there are any dirty bytes in the line, it must be written
341 before a new line can be read */
344 if (!dcache_write_line (dcache
, db
))
354 region
= lookup_mem_region(memaddr
);
355 if (memaddr
+ len
< region
->hi
)
358 reg_len
= region
->hi
- memaddr
;
360 if (!region
->attrib
.cache
|| region
->attrib
.mode
== MEM_WO
)
370 res
= do_xfer_memory (memaddr
, myaddr
, reg_len
, 0,
382 memset (db
->state
, ENTRY_OK
, sizeof (db
->data
));
388 /* Get a free cache block, put or keep it on the valid list,
389 and return its address. */
391 static struct dcache_block
*
392 dcache_alloc (DCACHE
*dcache
, CORE_ADDR addr
)
394 struct dcache_block
*db
;
396 /* Take something from the free list */
397 db
= dcache
->free_head
;
400 dcache
->free_head
= db
->p
;
404 /* Nothing left on free list, so grab one from the valid list */
405 db
= dcache
->valid_head
;
407 if (!dcache_write_line (dcache
, db
))
410 dcache
->valid_head
= db
->p
;
413 db
->addr
= MASK(addr
);
416 memset (db
->state
, ENTRY_BAD
, sizeof (db
->data
));
418 /* append this line to end of valid list */
419 if (!dcache
->valid_head
)
420 dcache
->valid_head
= db
;
422 dcache
->valid_tail
->p
= db
;
423 dcache
->valid_tail
= db
;
429 /* Writeback any dirty lines. */
431 dcache_writeback (DCACHE
*dcache
)
433 struct dcache_block
*db
;
435 db
= dcache
->valid_head
;
439 if (!dcache_write_line (dcache
, db
))
447 /* Using the data cache DCACHE return the contents of the byte at
448 address ADDR in the remote machine.
450 Returns 0 on error. */
453 dcache_peek_byte (DCACHE
*dcache
, CORE_ADDR addr
, char *ptr
)
455 struct dcache_block
*db
= dcache_hit (dcache
, addr
);
459 db
= dcache_alloc (dcache
, addr
);
464 if (db
->state
[XFORM (addr
)] == ENTRY_BAD
)
466 if (!dcache_read_line(dcache
, db
))
470 *ptr
= db
->data
[XFORM (addr
)];
475 /* Write the byte at PTR into ADDR in the data cache.
476 Return zero on write error.
480 dcache_poke_byte (DCACHE
*dcache
, CORE_ADDR addr
, char *ptr
)
482 struct dcache_block
*db
= dcache_hit (dcache
, addr
);
486 db
= dcache_alloc (dcache
, addr
);
491 db
->data
[XFORM (addr
)] = *ptr
;
492 db
->state
[XFORM (addr
)] = ENTRY_DIRTY
;
497 /* Initialize the data cache. */
501 int csize
= sizeof (struct dcache_block
) * DCACHE_SIZE
;
504 dcache
= (DCACHE
*) xmalloc (sizeof (*dcache
));
506 dcache
->the_cache
= (struct dcache_block
*) xmalloc (csize
);
507 memset (dcache
->the_cache
, 0, csize
);
509 dcache_invalidate (dcache
);
515 /* Free a data cache */
517 dcache_free (DCACHE
*dcache
)
519 if (last_cache
== dcache
)
522 xfree (dcache
->the_cache
);
526 /* Read or write LEN bytes from inferior memory at MEMADDR, transferring
527 to or from debugger address MYADDR. Write to inferior if SHOULD_WRITE is
530 Returns length of data written or read; 0 for error.
532 This routine is indended to be called by remote_xfer_ functions. */
535 dcache_xfer_memory (DCACHE
*dcache
, CORE_ADDR memaddr
, gdb_byte
*myaddr
,
536 int len
, int should_write
)
539 int (*xfunc
) (DCACHE
*dcache
, CORE_ADDR addr
, char *ptr
);
540 xfunc
= should_write
? dcache_poke_byte
: dcache_peek_byte
;
542 for (i
= 0; i
< len
; i
++)
544 if (!xfunc (dcache
, memaddr
+ i
, myaddr
+ i
))
548 /* FIXME: There may be some benefit from moving the cache writeback
549 to a higher layer, as it could occur after a sequence of smaller
550 writes have been completed (as when a stack frame is constructed
551 for an inferior function call). Note that only moving it up one
552 level to target_xfer_memory() (also target_xfer_memory_partial())
553 is not sufficent, since we want to coalesce memory transfers that
554 are "logically" connected but not actually a single call to one
555 of the memory transfer functions. */
558 dcache_writeback (dcache
);
564 dcache_info (char *exp
, int tty
)
566 struct dcache_block
*p
;
568 printf_filtered (_("Dcache line width %d, depth %d\n"),
569 LINE_SIZE
, DCACHE_SIZE
);
573 printf_filtered (_("Cache state:\n"));
575 for (p
= last_cache
->valid_head
; p
; p
= p
->p
)
578 printf_filtered (_("Line at %s, referenced %d times\n"),
579 paddr (p
->addr
), p
->refs
);
581 for (j
= 0; j
< LINE_SIZE
; j
++)
582 printf_filtered ("%02x", p
->data
[j
] & 0xFF);
583 printf_filtered (("\n"));
585 for (j
= 0; j
< LINE_SIZE
; j
++)
586 printf_filtered ("%2x", p
->state
[j
]);
587 printf_filtered ("\n");
593 _initialize_dcache (void)
595 add_setshow_boolean_cmd ("remotecache", class_support
,
596 &dcache_enabled_p
, _("\
597 Set cache use for remote targets."), _("\
598 Show cache use for remote targets."), _("\
599 When on, use data caching for remote targets. For many remote targets\n\
600 this option can offer better throughput for reading target memory.\n\
601 Unfortunately, gdb does not currently know anything about volatile\n\
602 registers and thus data caching will produce incorrect results with\n\
603 volatile registers are in use. By default, this option is off."),
605 show_dcache_enabled_p
,
606 &setlist
, &showlist
);
608 add_info ("dcache", dcache_info
,
609 _("Print information on the dcache performance."));
This page took 0.041467 seconds and 4 git commands to generate.