binutils/od-elf32_avr.c

   1 /* od-avrelf.c -- dump information about an AVR elf object file.
   2    Copyright (C) 2011-2024 Free Software Foundation, Inc.
   3    Written by Senthil Kumar Selvaraj, Atmel.
   4
   5    This file is part of GNU Binutils.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3, or (at your option)
  10    any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU 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, 51 Franklin Street - Fifth Floor, Boston,
  20    MA 02110-1301, USA.  */
  21
  22 #include "sysdep.h"
  23 #include <stddef.h>
  24 #include <time.h>
  25 #include <stdint.h>
  26 #include "safe-ctype.h"
  27 #include "bfd.h"
  28 #include "objdump.h"
  29 #include "bucomm.h"
  30 #include "bfdlink.h"
  31 #include "bfd.h"
  32 #include "elf/external.h"
  33 #include "elf/internal.h"
  34 #include "elf32-avr.h"
  35
  36 /* Index of the options in the options[] array.  */
  37 #define OPT_MEMUSAGE 0
  38 #define OPT_AVRPROP 1
  39 #define OPT_AVRDEVICEINFO 2
  40
  41 /* List of actions.  */
  42 static struct objdump_private_option options[] =
  43   {
  44     { "mem-usage", 0 },
  45     { "avr-prop",  0},
  46     { "avr-deviceinfo",  0},
  47     { NULL, 0 }
  48   };
  49
  50 /* Display help.  */
  51
  52 static void
  53 elf32_avr_help (FILE *stream)
  54 {
  55   fprintf (stream, _("\
  56 For AVR ELF files:\n\
  57   mem-usage       Display memory usage\n\
  58   avr-prop        Display contents of .avr.prop section\n\
  59   avr-deviceinfo  Display contents of .note.gnu.avr.deviceinfo section\n\
  60 "));
  61 }
  62
  63 typedef struct tagDeviceInfo
  64 {
  65     uint32_t flash_start;
  66     uint32_t flash_size;
  67     uint32_t ram_start;
  68     uint32_t ram_size;
  69     uint32_t eeprom_start;
  70     uint32_t eeprom_size;
  71     char * name;
  72 } deviceinfo;
  73
  74
  75 /* Return TRUE if ABFD is handled.  */
  76
  77 static int
  78 elf32_avr_filter (bfd *abfd)
  79 {
  80   return bfd_get_flavour (abfd) == bfd_target_elf_flavour;
  81 }
  82
  83 static char *
  84 elf32_avr_get_note_section_contents (bfd *abfd, bfd_size_type *size)
  85 {
  86   asection *section;
  87   bfd_byte *contents;
  88
  89   section = bfd_get_section_by_name (abfd, ".note.gnu.avr.deviceinfo");
  90   if (section == NULL)
  91     return NULL;
  92
  93   if (!bfd_malloc_and_get_section (abfd, section, &contents))
  94     {
  95       free (contents);
  96       contents = NULL;
  97     }
  98
  99   *size = bfd_section_size (section);
 100   return (char *) contents;
 101 }
 102
 103 static char *
 104 elf32_avr_get_note_desc (bfd *abfd, char *contents, bfd_size_type size,
 105                          bfd_size_type *descsz)
 106 {
 107   Elf_External_Note *xnp = (Elf_External_Note *) contents;
 108   Elf_Internal_Note in;
 109
 110   if (offsetof (Elf_External_Note, name) > size)
 111     return NULL;
 112
 113   in.type = bfd_get_32 (abfd, xnp->type);
 114   in.namesz = bfd_get_32 (abfd, xnp->namesz);
 115   in.namedata = xnp->name;
 116   if (in.namesz > contents - in.namedata + size)
 117     return NULL;
 118
 119   if (in.namesz != 4 || strcmp (in.namedata, "AVR") != 0)
 120     return NULL;
 121
 122   in.descsz = bfd_get_32 (abfd, xnp->descsz);
 123   in.descdata = in.namedata + align_power (in.namesz, 2);
 124   if (in.descsz < 6 * sizeof (uint32_t)
 125       || in.descdata >= contents + size
 126       || in.descsz > contents - in.descdata + size)
 127     return NULL;
 128
 129   /* If the note has a string table, ensure it is 0 terminated.  */
 130   if (in.descsz > 8 * sizeof (uint32_t))
 131     in.descdata[in.descsz - 1] = 0;
 132
 133   *descsz = in.descsz;
 134   return in.descdata;
 135 }
 136
 137 static void
 138 elf32_avr_get_device_info (bfd *abfd, char *description,
 139                            bfd_size_type desc_size, deviceinfo *device)
 140 {
 141   if (description == NULL)
 142     return;
 143
 144   const bfd_size_type memory_sizes = 6;
 145
 146   memcpy (device, description, memory_sizes * sizeof (uint32_t));
 147   desc_size -= memory_sizes * sizeof (uint32_t);
 148   if (desc_size < 8)
 149     return;
 150
 151   uint32_t *stroffset_table = (uint32_t *) description + memory_sizes;
 152   bfd_size_type stroffset_table_size = bfd_get_32 (abfd, stroffset_table);
 153
 154   /* If the only content is the size itself, there's nothing in the table */
 155   if (stroffset_table_size < 8)
 156     return;
 157   if (desc_size <= stroffset_table_size)
 158     return;
 159   desc_size -= stroffset_table_size;
 160
 161   /* First entry is the device name index. */
 162   uint32_t device_name_index = bfd_get_32 (abfd, stroffset_table + 1);
 163   if (device_name_index >= desc_size)
 164     return;
 165
 166   char *str_table = (char *) stroffset_table + stroffset_table_size;
 167   device->name = str_table + device_name_index;
 168 }
 169
 170 /* Get the size of section *SECNAME, truncated to a reasonable value in
 171    order to catch PR 27285 and dysfunctional binaries.  */
 172
 173 static bfd_size_type
 174 elf32_avr_get_truncated_size (bfd *abfd, const char *secname)
 175 {
 176   /* Max size of around 1 MiB is more than any reasonable AVR will
 177      ever be able to swallow.  And it's small enough so that we won't
 178      get overflows / UB as demonstrated in PR 27285.  */
 179   const bfd_size_type max_size = 1000000;
 180   bfd_size_type size = 0;
 181   asection *section;
 182
 183   section = bfd_get_section_by_name (abfd, secname);
 184
 185   if (section != NULL)
 186     {
 187       size = bfd_section_size (section);
 188       if (size > INT32_MAX)
 189         {
 190           fprintf (stderr, _("Warning: section %s has a negative size of"
 191                              " %ld bytes, saturating to 0 bytes\n"),
 192                    secname, (long) (int32_t) size);
 193           size = 0;
 194         }
 195       else if (size > max_size)
 196         {
 197           fprintf (stderr, _("Warning: section %s has an impossible size of"
 198                              " %lu bytes, truncating to %lu bytes\n"),
 199                    secname, (unsigned long) size, (unsigned long) max_size);
 200           size = max_size;
 201         }
 202     }
 203
 204   return size;
 205 }
 206
 207 static void
 208 elf32_avr_get_memory_usage (bfd *abfd,
 209                             bfd_size_type *text_usage,
 210                             bfd_size_type *data_usage,
 211                             bfd_size_type *eeprom_usage)
 212 {
 213   bfd_size_type avr_textsize = elf32_avr_get_truncated_size (abfd, ".text");
 214   bfd_size_type avr_datasize = elf32_avr_get_truncated_size (abfd, ".data");;
 215   bfd_size_type avr_bsssize  = elf32_avr_get_truncated_size (abfd, ".bss");
 216   bfd_size_type noinitsize = elf32_avr_get_truncated_size (abfd, ".noinit");
 217   bfd_size_type rodatasize = elf32_avr_get_truncated_size (abfd, ".rodata");
 218   bfd_size_type eepromsize = elf32_avr_get_truncated_size (abfd, ".eeprom");
 219   bfd_size_type bootloadersize = elf32_avr_get_truncated_size (abfd,
 220                                                                ".bootloader");
 221
 222   *text_usage = avr_textsize + avr_datasize + rodatasize + bootloadersize;
 223   *data_usage = avr_datasize + avr_bsssize + noinitsize;
 224   *eeprom_usage = eepromsize;
 225 }
 226
 227 static void
 228 elf32_avr_dump_mem_usage (bfd *abfd)
 229 {
 230   char *description = NULL;
 231   bfd_size_type sec_size, desc_size;
 232
 233   deviceinfo device = { 0, 0, 0, 0, 0, 0, NULL };
 234   device.name = "Unknown";
 235
 236   bfd_size_type data_usage = 0;
 237   bfd_size_type text_usage = 0;
 238   bfd_size_type eeprom_usage = 0;
 239
 240   char *contents = elf32_avr_get_note_section_contents (abfd, &sec_size);
 241
 242   if (contents != NULL)
 243     {
 244       description = elf32_avr_get_note_desc (abfd, contents, sec_size,
 245                                              &desc_size);
 246       elf32_avr_get_device_info (abfd, description, desc_size, &device);
 247     }
 248
 249   elf32_avr_get_memory_usage (abfd, &text_usage, &data_usage,
 250                               &eeprom_usage);
 251
 252   printf ("AVR Memory Usage\n"
 253           "----------------\n"
 254           "Device: %s\n\n", device.name);
 255
 256   /* Text size */
 257   printf ("Program:%8" PRIu64 " bytes", (uint64_t) text_usage);
 258   if (device.flash_size > 0)
 259     printf (" (%2.1f%% Full)", (double) text_usage / device.flash_size * 100);
 260
 261   printf ("\n(.text + .data + .rodata + .bootloader)\n\n");
 262
 263   /* Data size */
 264   printf ("Data:   %8" PRIu64 " bytes", (uint64_t) data_usage);
 265   if (device.ram_size > 0)
 266     printf (" (%2.1f%% Full)", (double) data_usage / device.ram_size * 100);
 267
 268   printf ("\n(.data + .bss + .noinit)\n\n");
 269
 270   /* EEPROM size */
 271   if (eeprom_usage > 0)
 272     {
 273       printf ("EEPROM: %8" PRIu64 " bytes", (uint64_t) eeprom_usage);
 274       if (device.eeprom_size > 0)
 275         printf (" (%2.1f%% Full)",
 276                 (double) eeprom_usage / device.eeprom_size * 100);
 277
 278       printf ("\n(.eeprom)\n\n");
 279     }
 280
 281   if (contents != NULL)
 282     free (contents);
 283
 284 }
 285
 286 static void
 287 elf32_avr_dump_avr_prop (bfd *abfd)
 288 {
 289   struct avr_property_record_list *r_list;
 290   unsigned int i;
 291
 292   r_list = avr_elf32_load_property_records (abfd);
 293   if (r_list == NULL)
 294     return;
 295
 296   printf ("\nContents of `%s' section:\n\n", r_list->section->name);
 297
 298   printf ("  Version: %d\n", r_list->version);
 299   printf ("  Flags:   %#x\n\n", r_list->flags);
 300
 301   for (i = 0; i < r_list->record_count; ++i)
 302     {
 303       printf ("   %d %s @ %s + %#08" PRIx64" (%#08" PRIx64 ")\n",
 304               i,
 305               avr_elf32_property_record_name (&r_list->records [i]),
 306               r_list->records [i].section->name,
 307               (uint64_t) r_list->records [i].offset,
 308               ((uint64_t) bfd_section_vma (r_list->records [i].section)
 309                + r_list->records [i].offset));
 310       switch (r_list->records [i].type)
 311         {
 312         case RECORD_ORG:
 313           /* Nothing else to print.  */
 314           break;
 315         case RECORD_ORG_AND_FILL:
 316           printf ("     Fill: %#08lx\n",
 317                   r_list->records [i].data.org.fill);
 318           break;
 319         case RECORD_ALIGN:
 320           printf ("     Align: %#08lx\n",
 321                   r_list->records [i].data.align.bytes);
 322           break;
 323         case RECORD_ALIGN_AND_FILL:
 324           printf ("     Align: %#08lx, Fill: %#08lx\n",
 325                   r_list->records [i].data.align.bytes,
 326                   r_list->records [i].data.align.fill);
 327           break;
 328         }
 329     }
 330
 331   free (r_list);
 332 }
 333
 334 static void
 335 elf32_avr_dump_avr_deviceinfo (bfd *abfd)
 336 {
 337   char *description = NULL;
 338   bfd_size_type sec_size, desc_size;
 339
 340   deviceinfo dinfo = { 0, 0, 0, 0, 0, 0, NULL };
 341   dinfo.name = "Unknown";
 342
 343   char *contents = elf32_avr_get_note_section_contents (abfd, &sec_size);
 344
 345   if (contents == NULL)
 346     return;
 347
 348   description = elf32_avr_get_note_desc (abfd, contents, sec_size, &desc_size);
 349   elf32_avr_get_device_info (abfd, description, desc_size, &dinfo);
 350
 351   printf ("AVR Device Info\n"
 352           "----------------\n"
 353           "Device: %s\n\n", dinfo.name);
 354
 355   printf ("Memory     Start      Size      Start      Size\n");
 356
 357   printf ("Flash  %9" PRIu32 " %9" PRIu32 "  %#9" PRIx32 " %#9" PRIx32 "\n",
 358           dinfo.flash_start, dinfo.flash_size,
 359           dinfo.flash_start, dinfo.flash_size);
 360
 361   /* FIXME: There are devices like ATtiny11 without RAM, and where the
 362      avr/io*.h header has defines like
 363          #define RAMSTART    0x60
 364          // Last memory addresses
 365          #define RAMEND      0x1F
 366      which results in a negative RAM size.  The correct display would be to
 367      show a size of 0, however we also want to show what's actually in the
 368      note section as precise as possible.  Hence, display the decimal size
 369      as %d, not as %u.  */
 370   printf ("RAM    %9" PRIu32 " %9" PRId32 "  %#9" PRIx32 " %#9" PRIx32 "\n",
 371           dinfo.ram_start, dinfo.ram_size,
 372           dinfo.ram_start, dinfo.ram_size);
 373
 374   printf ("EEPROM %9" PRIu32 " %9" PRIu32 "  %#9" PRIx32 " %#9" PRIx32 "\n",
 375           dinfo.eeprom_start, dinfo.eeprom_size,
 376           dinfo.eeprom_start, dinfo.eeprom_size);
 377
 378   free (contents);
 379 }
 380
 381 static void
 382 elf32_avr_dump (bfd *abfd)
 383 {
 384   if (options[OPT_MEMUSAGE].selected)
 385     elf32_avr_dump_mem_usage (abfd);
 386   if (options[OPT_AVRPROP].selected)
 387     elf32_avr_dump_avr_prop (abfd);
 388   if (options[OPT_AVRDEVICEINFO].selected)
 389     elf32_avr_dump_avr_deviceinfo (abfd);
 390 }
 391
 392 const struct objdump_private_desc objdump_private_desc_elf32_avr =
 393   {
 394     elf32_avr_help,
 395     elf32_avr_filter,
 396     elf32_avr_dump,
 397     options
 398   };