1 /* Parts of target interface that deal with accessing memory and memory-like
4 Copyright (C) 2006-2016 Free 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 3 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, see <http://www.gnu.org/licenses/>. */
24 #include "memory-map.h"
26 #include "gdb_sys_time.h"
29 compare_block_starting_address (const void *a, const void *b)
31 const struct memory_write_request *a_req
32 = (const struct memory_write_request *) a;
33 const struct memory_write_request *b_req
34 = (const struct memory_write_request *) b;
36 if (a_req->begin < b_req->begin)
38 else if (a_req->begin == b_req->begin)
44 /* Adds to RESULT all memory write requests from BLOCK that are
45 in [BEGIN, END) range.
47 If any memory request is only partially in the specified range,
48 that part of the memory request will be added. */
51 claim_memory (VEC(memory_write_request_s) *blocks,
52 VEC(memory_write_request_s) **result,
57 ULONGEST claimed_begin;
59 struct memory_write_request *r;
61 for (i = 0; VEC_iterate (memory_write_request_s, blocks, i, r); ++i)
63 /* If the request doesn't overlap [BEGIN, END), skip it. We
64 must handle END == 0 meaning the top of memory; we don't yet
65 check for R->end == 0, which would also mean the top of
66 memory, but there's an assertion in
67 target_write_memory_blocks which checks for that. */
71 if (end != 0 && end <= r->begin)
74 claimed_begin = max (begin, r->begin);
78 claimed_end = min (end, r->end);
80 if (claimed_begin == r->begin && claimed_end == r->end)
81 VEC_safe_push (memory_write_request_s, *result, r);
84 struct memory_write_request *n =
85 VEC_safe_push (memory_write_request_s, *result, NULL);
88 n->begin = claimed_begin;
90 n->data += claimed_begin - r->begin;
95 /* Given a vector of struct memory_write_request objects in BLOCKS,
96 add memory requests for flash memory into FLASH_BLOCKS, and for
97 regular memory to REGULAR_BLOCKS. */
100 split_regular_and_flash_blocks (VEC(memory_write_request_s) *blocks,
101 VEC(memory_write_request_s) **regular_blocks,
102 VEC(memory_write_request_s) **flash_blocks)
104 struct mem_region *region;
105 CORE_ADDR cur_address;
107 /* This implementation runs in O(length(regions)*length(blocks)) time.
108 However, in most cases the number of blocks will be small, so this does
111 Note also that it's extremely unlikely that a memory write request
112 will span more than one memory region, however for safety we handle
118 VEC(memory_write_request_s) **r;
120 region = lookup_mem_region (cur_address);
121 r = region->attrib.mode == MEM_FLASH ? flash_blocks : regular_blocks;
122 cur_address = region->hi;
123 claim_memory (blocks, r, region->lo, region->hi);
125 if (cur_address == 0)
130 /* Given an ADDRESS, if BEGIN is non-NULL this function sets *BEGIN
131 to the start of the flash block containing the address. Similarly,
132 if END is non-NULL *END will be set to the address one past the end
133 of the block containing the address. */
136 block_boundaries (CORE_ADDR address, CORE_ADDR *begin, CORE_ADDR *end)
138 struct mem_region *region;
141 region = lookup_mem_region (address);
142 gdb_assert (region->attrib.mode == MEM_FLASH);
143 blocksize = region->attrib.blocksize;
145 *begin = address / blocksize * blocksize;
147 *end = (address + blocksize - 1) / blocksize * blocksize;
150 /* Given the list of memory requests to be WRITTEN, this function
151 returns write requests covering each group of flash blocks which must
154 static VEC(memory_write_request_s) *
155 blocks_to_erase (VEC(memory_write_request_s) *written)
158 struct memory_write_request *ptr;
160 VEC(memory_write_request_s) *result = NULL;
162 for (i = 0; VEC_iterate (memory_write_request_s, written, i, ptr); ++i)
164 CORE_ADDR begin, end;
166 block_boundaries (ptr->begin, &begin, 0);
167 block_boundaries (ptr->end - 1, 0, &end);
169 if (!VEC_empty (memory_write_request_s, result)
170 && VEC_last (memory_write_request_s, result)->end >= begin)
172 VEC_last (memory_write_request_s, result)->end = end;
176 struct memory_write_request *n =
177 VEC_safe_push (memory_write_request_s, result, NULL);
179 memset (n, 0, sizeof (struct memory_write_request));
188 /* Given ERASED_BLOCKS, a list of blocks that will be erased with
189 flash erase commands, and WRITTEN_BLOCKS, the list of memory
190 addresses that will be written, compute the set of memory addresses
191 that will be erased but not rewritten (e.g. padding within a block
192 which is only partially filled by "load"). */
194 static VEC(memory_write_request_s) *
195 compute_garbled_blocks (VEC(memory_write_request_s) *erased_blocks,
196 VEC(memory_write_request_s) *written_blocks)
198 VEC(memory_write_request_s) *result = NULL;
201 unsigned je = VEC_length (memory_write_request_s, written_blocks);
202 struct memory_write_request *erased_p;
204 /* Look at each erased memory_write_request in turn, and
205 see what part of it is subsequently written to.
207 This implementation is O(length(erased) * length(written)). If
208 the lists are sorted at this point it could be rewritten more
209 efficiently, but the complexity is not generally worthwhile. */
212 VEC_iterate (memory_write_request_s, erased_blocks, i, erased_p);
215 /* Make a deep copy -- it will be modified inside the loop, but
216 we don't want to modify original vector. */
217 struct memory_write_request erased = *erased_p;
219 for (j = 0; j != je;)
221 struct memory_write_request *written
222 = VEC_index (memory_write_request_s,
225 /* Now try various cases. */
227 /* If WRITTEN is fully to the left of ERASED, check the next
228 written memory_write_request. */
229 if (written->end <= erased.begin)
235 /* If WRITTEN is fully to the right of ERASED, then ERASED
236 is not written at all. WRITTEN might affect other
238 if (written->begin >= erased.end)
240 VEC_safe_push (memory_write_request_s, result, &erased);
244 /* If all of ERASED is completely written, we can move on to
245 the next erased region. */
246 if (written->begin <= erased.begin
247 && written->end >= erased.end)
252 /* If there is an unwritten part at the beginning of ERASED,
253 then we should record that part and try this inner loop
254 again for the remainder. */
255 if (written->begin > erased.begin)
257 struct memory_write_request *n =
258 VEC_safe_push (memory_write_request_s, result, NULL);
260 memset (n, 0, sizeof (struct memory_write_request));
261 n->begin = erased.begin;
262 n->end = written->begin;
263 erased.begin = written->begin;
267 /* If there is an unwritten part at the end of ERASED, we
268 forget about the part that was written to and wait to see
269 if the next write request writes more of ERASED. We can't
271 if (written->end < erased.end)
273 erased.begin = written->end;
279 /* If we ran out of write requests without doing anything about
280 ERASED, then that means it's really erased. */
281 VEC_safe_push (memory_write_request_s, result, &erased);
291 cleanup_request_data (void *p)
293 VEC(memory_write_request_s) **v = (VEC(memory_write_request_s) **) p;
294 struct memory_write_request *r;
297 for (i = 0; VEC_iterate (memory_write_request_s, *v, i, r); ++i)
302 cleanup_write_requests_vector (void *p)
304 VEC(memory_write_request_s) **v = (VEC(memory_write_request_s) **) p;
306 VEC_free (memory_write_request_s, *v);
310 target_write_memory_blocks (VEC(memory_write_request_s) *requests,
311 enum flash_preserve_mode preserve_flash_p,
312 void (*progress_cb) (ULONGEST, void *))
314 struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
315 VEC(memory_write_request_s) *blocks = VEC_copy (memory_write_request_s,
319 struct memory_write_request *r;
320 VEC(memory_write_request_s) *regular = NULL;
321 VEC(memory_write_request_s) *flash = NULL;
322 VEC(memory_write_request_s) *erased, *garbled;
324 /* END == 0 would represent wraparound: a write to the very last
325 byte of the address space. This file was not written with that
326 possibility in mind. This is fixable, but a lot of work for a
327 rare problem; so for now, fail noisily here instead of obscurely
329 for (i = 0; VEC_iterate (memory_write_request_s, requests, i, r); ++i)
330 gdb_assert (r->end != 0);
332 make_cleanup (cleanup_write_requests_vector, &blocks);
334 /* Sort the blocks by their start address. */
335 qsort (VEC_address (memory_write_request_s, blocks),
336 VEC_length (memory_write_request_s, blocks),
337 sizeof (struct memory_write_request), compare_block_starting_address);
339 /* Split blocks into list of regular memory blocks,
340 and list of flash memory blocks. */
341 make_cleanup (cleanup_write_requests_vector, ®ular);
342 make_cleanup (cleanup_write_requests_vector, &flash);
343 split_regular_and_flash_blocks (blocks, ®ular, &flash);
345 /* If a variable is added to forbid flash write, even during "load",
346 it should be checked here. Similarly, if this function is used
347 for other situations besides "load" in which writing to flash
348 is undesirable, that should be checked here. */
350 /* Find flash blocks to erase. */
351 erased = blocks_to_erase (flash);
352 make_cleanup (cleanup_write_requests_vector, &erased);
354 /* Find what flash regions will be erased, and not overwritten; then
355 either preserve or discard the old contents. */
356 garbled = compute_garbled_blocks (erased, flash);
357 make_cleanup (cleanup_request_data, &garbled);
358 make_cleanup (cleanup_write_requests_vector, &garbled);
360 if (!VEC_empty (memory_write_request_s, garbled))
362 if (preserve_flash_p == flash_preserve)
364 struct memory_write_request *r;
366 /* Read in regions that must be preserved and add them to
367 the list of blocks we read. */
368 for (i = 0; VEC_iterate (memory_write_request_s, garbled, i, r); ++i)
370 gdb_assert (r->data == NULL);
371 r->data = (gdb_byte *) xmalloc (r->end - r->begin);
372 err = target_read_memory (r->begin, r->data, r->end - r->begin);
376 VEC_safe_push (memory_write_request_s, flash, r);
379 qsort (VEC_address (memory_write_request_s, flash),
380 VEC_length (memory_write_request_s, flash),
381 sizeof (struct memory_write_request),
382 compare_block_starting_address);
386 /* We could coalesce adjacent memory blocks here, to reduce the
387 number of write requests for small sections. However, we would
388 have to reallocate and copy the data pointers, which could be
389 large; large sections are more common in loadable objects than
390 large numbers of small sections (although the reverse can be true
391 in object files). So, we issue at least one write request per
392 passed struct memory_write_request. The remote stub will still
393 have the opportunity to batch flash requests. */
395 /* Write regular blocks. */
396 for (i = 0; VEC_iterate (memory_write_request_s, regular, i, r); ++i)
400 len = target_write_with_progress (current_target.beneath,
401 TARGET_OBJECT_MEMORY, NULL,
402 r->data, r->begin, r->end - r->begin,
403 progress_cb, r->baton);
404 if (len < (LONGEST) (r->end - r->begin))
412 if (!VEC_empty (memory_write_request_s, erased))
414 /* Erase all pages. */
415 for (i = 0; VEC_iterate (memory_write_request_s, erased, i, r); ++i)
416 target_flash_erase (r->begin, r->end - r->begin);
418 /* Write flash data. */
419 for (i = 0; VEC_iterate (memory_write_request_s, flash, i, r); ++i)
423 len = target_write_with_progress (¤t_target,
424 TARGET_OBJECT_FLASH, NULL,
427 progress_cb, r->baton);
428 if (len < (LONGEST) (r->end - r->begin))
429 error (_("Error writing data to flash"));
432 target_flash_done ();
436 do_cleanups (back_to);