cryptodisk: Rename "offset" in grub_cryptodisk_t to "offset_sectors"

This makes it clear that the offset represents sectors, not bytes, in
order to improve readability.

Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Patrick Steinhardt <ps@pks.im>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>

diff --git a/grub-core/disk/cryptodisk.c b/grub-core/disk/cryptodisk.c
index 3703da221b939b1af1abb2c1448e7c1149f36218..473c93976243dd8eb3b780ca4642ed1a95aa9e26 100644 (file)
--- a/grub-core/disk/cryptodisk.c
+++ b/grub-core/disk/cryptodisk.c
@@ -754,10 +754,10 @@ grub_cryptodisk_read (grub_disk_t disk, grub_disk_addr_t sector,
   grub_dprintf ("cryptodisk",
                "Reading %" PRIuGRUB_SIZE " sectors from sector 0x%"
                PRIxGRUB_UINT64_T " with offset of %" PRIuGRUB_UINT64_T "\n",
-               size, sector, dev->offset);
+               size, sector, dev->offset_sectors);
 
   err = grub_disk_read (dev->source_disk,
-                       grub_disk_from_native_sector (disk, sector + dev->offset),
+                       grub_disk_from_native_sector (disk, sector + dev->offset_sectors),
                        0, size << disk->log_sector_size, buf);
   if (err)
     {
@@ -803,7 +803,7 @@ grub_cryptodisk_write (grub_disk_t disk, grub_disk_addr_t sector,
   grub_dprintf ("cryptodisk",
                "Writing %" PRIuGRUB_SIZE " sectors to sector 0x%"
                PRIxGRUB_UINT64_T " with offset of %" PRIuGRUB_UINT64_T "\n",
-               size, sector, dev->offset);
+               size, sector, dev->offset_sectors);
 
   gcry_err = grub_cryptodisk_endecrypt (dev, (grub_uint8_t *) tmp,
                                        size << disk->log_sector_size,
@@ -815,7 +815,7 @@ grub_cryptodisk_write (grub_disk_t disk, grub_disk_addr_t sector,
     }
 
   /* Since ->write was called so disk.mod is loaded but be paranoid  */
-  sector = sector + dev->offset;
+  sector = sector + dev->offset_sectors;
   if (grub_disk_write_weak)
     err = grub_disk_write_weak (dev->source_disk,
                                grub_disk_from_native_sector (disk, sector),
@@ -1228,7 +1228,7 @@ luks_script_get (grub_size_t *sz)
        ptr = grub_stpcpy (ptr, "luks_mount ");
        ptr = grub_stpcpy (ptr, i->uuid);
        *ptr++ = ' ';
-       grub_snprintf (ptr, 21, "%" PRIuGRUB_UINT64_T " ", i->offset);
+       grub_snprintf (ptr, 21, "%" PRIuGRUB_UINT64_T " ", i->offset_sectors);
        while (*ptr)
          ptr++;
        for (iptr = i->cipher->cipher->name; *iptr; iptr++)

diff --git a/grub-core/disk/geli.c b/grub-core/disk/geli.c
index 4ec875821d683405e57acb6858b863ac1f2a423d..0175ce4c468d9c6a891984ce49ce578ecf803638 100644 (file)
--- a/grub-core/disk/geli.c
+++ b/grub-core/disk/geli.c
@@ -361,7 +361,7 @@ configure_ciphers (grub_disk_t disk, const char *check_uuid,
     }
   newdev->cipher = cipher;
   newdev->secondary_cipher = secondary_cipher;
-  newdev->offset = 0;
+  newdev->offset_sectors = 0;
   newdev->source_disk = NULL;
   newdev->benbi_log = 0;
   if (grub_le_to_cpu16 (header.alg) == 0x16)

diff --git a/grub-core/disk/luks.c b/grub-core/disk/luks.c
index 429db4ad8841da70317d08ca3033f794d51f3f07..aa9877b6850afd365bd13761b2bf2554124d54b1 100644 (file)
--- a/grub-core/disk/luks.c
+++ b/grub-core/disk/luks.c
@@ -122,10 +122,10 @@ configure_ciphers (grub_disk_t disk, const char *check_uuid,
   newdev = grub_zalloc (sizeof (struct grub_cryptodisk));
   if (!newdev)
       return NULL;
-  newdev->offset = grub_be_to_cpu32 (header.payloadOffset);
+  newdev->offset_sectors = grub_be_to_cpu32 (header.payloadOffset);
   newdev->source_disk = NULL;
   newdev->log_sector_size = 9;
-  newdev->total_sectors = grub_disk_get_size (disk) - newdev->offset;
+  newdev->total_sectors = grub_disk_get_size (disk) - newdev->offset_sectors;
   grub_memcpy (newdev->uuid, uuid, sizeof (uuid));
   newdev->modname = "luks";
 

diff --git a/grub-core/disk/luks2.c b/grub-core/disk/luks2.c
index 3173a098d45e970102a3e1b283ee5a6d3a7bd7cf..26fb14a12e079fef4c0485d2d6867fd30d6df277 100644 (file)
--- a/grub-core/disk/luks2.c
+++ b/grub-core/disk/luks2.c
@@ -605,11 +605,11 @@ luks2_recover_key (grub_disk_t disk,
       grub_dprintf ("luks2", "Trying keyslot %"PRIuGRUB_SIZE"\n", i);
 
       /* Set up disk according to keyslot's segment. */
-      crypt->offset = grub_divmod64 (segment.offset, segment.sector_size, NULL);
+      crypt->offset_sectors = grub_divmod64 (segment.offset, segment.sector_size, NULL);
       crypt->log_sector_size = sizeof (unsigned int) * 8
                - __builtin_clz ((unsigned int) segment.sector_size) - 1;
       if (grub_strcmp (segment.size, "dynamic") == 0)
-       crypt->total_sectors = grub_disk_get_size (disk) - crypt->offset;
+       crypt->total_sectors = grub_disk_get_size (disk) - crypt->offset_sectors;
       else
        crypt->total_sectors = grub_strtoull (segment.size, NULL, 10);
 

diff --git a/include/grub/cryptodisk.h b/include/grub/cryptodisk.h
index 6ed850bb5ec1d56f096023e701c2744e5b3f3c75..c9bf7597a93163b997326f2d92536e501f9802cc 100644 (file)
--- a/include/grub/cryptodisk.h
+++ b/include/grub/cryptodisk.h
@@ -66,7 +66,11 @@ struct grub_cryptodisk
   struct grub_cryptodisk **prev;
 
   char *source;
-  grub_disk_addr_t offset;
+  /*
+   * The number of sectors the start of the encrypted data is offset into the
+   * underlying disk, where sectors are the size noted by log_sector_size.
+   */
+  grub_disk_addr_t offset_sectors;
   /* Total number of encrypted sectors of size (1 << log_sector_size). */
   grub_disk_addr_t total_sectors;
   grub_disk_t source_disk;