Received: from list by lists.gnu.org with archive (Exim 4.90_1) id 1nyxhm-0004nt-PW for mharc-grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:45740) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nyxhk-0004kK-Qc for grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:44 -0400 Received: from mail-vs1-xe35.google.com ([2607:f8b0:4864:20::e35]:39722) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nyxhi-0004fv-05 for grub-devel@gnu.org; Wed, 08 Jun 2022 11:34:44 -0400 Received: by mail-vs1-xe35.google.com with SMTP id n4so11111602vsm.6 for ; Wed, 08 Jun 2022 08:34:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=efficientek-com.20210112.gappssmtp.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Gdchg9G5XcIZf9gGSiDYiwPQvhItjNmZSULWUdjhwpM=; b=M8hoM1GUqeVRjPX1y2QeU+L7yJoiLoOThNvTlUaAR3/DQObPwNvPm5vvNKnS+ev8Jb U1gwteyvFYBlv/iVuAUKDSoJV3GeDobkKKcpMAydgHuOuW0e9ARStbscbuhFete6v4XJ 5sMSlWjKEXQvVmXVBKGtjoK5ZbvE6SlYro9oTdy+iWgJZ4ThVITBB04kP01AGPn8CsAF DbUP5MlMt2yjR8F39QVlaAyzF4KgogR90iQx17Y7mWiJi+Fq0eb/FbZleOKvGnNoDkeR 2x7GNTxRTCLcAOONGi/Xzs/S8GD3NoOQf/DTXYbSvAYsKhiDbjWyWc7/pbPqN49/Puif sMyA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Gdchg9G5XcIZf9gGSiDYiwPQvhItjNmZSULWUdjhwpM=; b=pVGYAU8IBLWYbCUw2P9Ew/4kXVqg83s3+m3GpRFo9/jsNRu9+GGKQ7xsmbHForKI5B aK37L6U1Ak2/Rd0ZFNHSaV7cYKQImZSpleYq8QXK9RMWSFnz/Yu9C0gjlAtCpn0xGanO QlPcf/DDkwJdiBatkoES0STcAOamab1qGmPskRmY+CfBx1zl9V39xbk139Gr6FhYV5Ug PGjSLTgxv10nWrlMWzVVZ+zSKBK1kai/qIEVMyaQ4BvRqncl5bHSaGPNrs9Wg6kPhjJk NtL8XG0FVJ3XAOg/5jifzDKlF0Agu/n2/MjHe5be2Pjo3cZdcCjxyfD1F9XkiCdTkvOu 3Jxg== X-Gm-Message-State: AOAM533UK6ASmvbQnQ1r1Kmg8X04ZbHNIQXu0FNWF45oqQfCz/wDcq6Z ZNnMT8fYnd1Ook7jZ+0IXCAellX2Hw6m5A== X-Google-Smtp-Source: ABdhPJxENhU9opgvawEUjRcy+LEuEkY2hG2oISxrv6oy+fHDm5/IhuC9baIJCsYHzQZTIZYhp0zCPw== X-Received: by 2002:a05:6102:c4e:b0:337:d17b:414 with SMTP id y14-20020a0561020c4e00b00337d17b0414mr15555228vss.51.1654702478942; Wed, 08 Jun 2022 08:34:38 -0700 (PDT) Received: from localhost.localdomain ([37.218.244.249]) by smtp.gmail.com with ESMTPSA id s13-20020ac5cb4d000000b00357c1bab9b0sm3373342vkl.36.2022.06.08.08.34.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 08 Jun 2022 08:34:38 -0700 (PDT) From: Glenn Washburn To: grub-devel@gnu.org, Daniel Kiper Cc: Denis 'GNUtoo' Carikli , Patrick Steinhardt , John Lane , Glenn Washburn Subject: [PATCH v3 1/3] disk: Allow read hook callback to take read buffer to potentially modify it Date: Wed, 8 Jun 2022 10:34:02 -0500 Message-Id: X-Mailer: git-send-email 2.34.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::e35; envelope-from=development@efficientek.com; helo=mail-vs1-xe35.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 Jun 2022 15:34:45 -0000 It will be desirable in the future to allow having the read hook modify the data passed back from a read function call on a disk or file. This adds that infrustructure and has no impact on code flow for existing uses of the read hook. Also changed is that now when the read hook callback is called it can also indicate what error code should be sent back to the read caller. Signed-off-by: Glenn Washburn Reviewed-by: Patrick Steinhardt --- grub-core/commands/blocklist.c | 10 ++++++---- grub-core/commands/loadenv.c | 8 +++++--- grub-core/commands/testload.c | 4 +++- grub-core/fs/hfspluscomp.c | 4 ++-- grub-core/fs/ntfscomp.c | 14 +++++++------- grub-core/kern/disk.c | 12 ++++++------ grub-core/lib/progress.c | 11 +++++++---- grub-core/net/net.c | 2 +- include/grub/disk.h | 6 +++--- 9 files changed, 40 insertions(+), 31 deletions(-) diff --git a/grub-core/commands/blocklist.c b/grub-core/commands/blocklist.c index 944449b77..48fd85a33 100644 --- a/grub-core/commands/blocklist.c +++ b/grub-core/commands/blocklist.c @@ -53,9 +53,9 @@ print_blocklist (grub_disk_addr_t sector, unsigned num, } /* Helper for grub_cmd_blocklist. */ -static void +static grub_err_t read_blocklist (grub_disk_addr_t sector, unsigned offset, unsigned length, - void *data) + char *buf __attribute__ ((unused)), void *data) { struct blocklist_ctx *ctx = data; @@ -70,7 +70,7 @@ read_blocklist (grub_disk_addr_t sector, unsigned offset, unsigned length, } if (!length) - return; + return GRUB_ERR_NONE; print_blocklist (ctx->start_sector, ctx->num_sectors, 0, 0, ctx); ctx->num_sectors = 0; } @@ -87,7 +87,7 @@ read_blocklist (grub_disk_addr_t sector, unsigned offset, unsigned length, } if (!length) - return; + return GRUB_ERR_NONE; if (length & (GRUB_DISK_SECTOR_SIZE - 1)) { @@ -103,6 +103,8 @@ read_blocklist (grub_disk_addr_t sector, unsigned offset, unsigned length, ctx->start_sector = sector; ctx->num_sectors = length >> GRUB_DISK_SECTOR_BITS; } + + return GRUB_ERR_NONE; } static grub_err_t diff --git a/grub-core/commands/loadenv.c b/grub-core/commands/loadenv.c index 3fd664aac..166445849 100644 --- a/grub-core/commands/loadenv.c +++ b/grub-core/commands/loadenv.c @@ -352,16 +352,16 @@ struct grub_cmd_save_env_ctx }; /* Store blocklists in a linked list. */ -static void +static grub_err_t save_env_read_hook (grub_disk_addr_t sector, unsigned offset, unsigned length, - void *data) + char *buf __attribute__ ((unused)), void *data) { struct grub_cmd_save_env_ctx *ctx = data; struct blocklist *block; block = grub_malloc (sizeof (*block)); if (! block) - return; + return GRUB_ERR_NONE; block->sector = sector; block->offset = offset; @@ -374,6 +374,8 @@ save_env_read_hook (grub_disk_addr_t sector, unsigned offset, unsigned length, ctx->tail = block; if (! ctx->head) ctx->head = block; + + return GRUB_ERR_NONE; } static grub_err_t diff --git a/grub-core/commands/testload.c b/grub-core/commands/testload.c index ff01a0516..76a8af94c 100644 --- a/grub-core/commands/testload.c +++ b/grub-core/commands/testload.c @@ -32,10 +32,11 @@ GRUB_MOD_LICENSE ("GPLv3+"); /* Helper for grub_cmd_testload. */ -static void +static grub_err_t read_progress (grub_disk_addr_t sector __attribute__ ((unused)), unsigned offset __attribute__ ((unused)), unsigned len, + char *buf __attribute__ ((unused)), void *data __attribute__ ((unused))) { for (; len >= GRUB_DISK_SECTOR_SIZE; len -= GRUB_DISK_SECTOR_SIZE) @@ -43,6 +44,7 @@ read_progress (grub_disk_addr_t sector __attribute__ ((unused)), if (len) grub_xputs ("."); grub_refresh (); + return GRUB_ERR_NONE; } static grub_err_t diff --git a/grub-core/fs/hfspluscomp.c b/grub-core/fs/hfspluscomp.c index 095ea48c9..48ae438d8 100644 --- a/grub-core/fs/hfspluscomp.c +++ b/grub-core/fs/hfspluscomp.c @@ -123,7 +123,7 @@ hfsplus_read_compressed_real (struct grub_hfsplus_file *node, { grub_memcpy (buf, node->cbuf + pos, len); if (grub_file_progress_hook && node->file) - grub_file_progress_hook (0, 0, len, node->file); + grub_file_progress_hook (0, 0, len, NULL, node->file); return len; } @@ -170,7 +170,7 @@ hfsplus_read_compressed_real (struct grub_hfsplus_file *node, grub_memcpy (buf, node->cbuf + (pos % HFSPLUS_COMPRESS_BLOCK_SIZE), curlen); if (grub_file_progress_hook && node->file) - grub_file_progress_hook (0, 0, curlen, node->file); + grub_file_progress_hook (0, 0, curlen, NULL, node->file); buf += curlen; pos += curlen; len -= curlen; diff --git a/grub-core/fs/ntfscomp.c b/grub-core/fs/ntfscomp.c index 3cd97d337..a009f2c2d 100644 --- a/grub-core/fs/ntfscomp.c +++ b/grub-core/fs/ntfscomp.c @@ -227,7 +227,7 @@ read_block (struct grub_ntfs_rlst *ctx, grub_uint8_t *buf, grub_size_t num) grub_memset (buf, 0, nn * GRUB_NTFS_COM_LEN); buf += nn * GRUB_NTFS_COM_LEN; if (grub_file_progress_hook && ctx->file) - grub_file_progress_hook (0, 0, nn * GRUB_NTFS_COM_LEN, + grub_file_progress_hook (0, 0, nn * GRUB_NTFS_COM_LEN, NULL, ctx->file); } } @@ -240,7 +240,7 @@ read_block (struct grub_ntfs_rlst *ctx, grub_uint8_t *buf, grub_size_t num) if (buf) buf += GRUB_NTFS_COM_LEN; if (grub_file_progress_hook && ctx->file) - grub_file_progress_hook (0, 0, GRUB_NTFS_COM_LEN, + grub_file_progress_hook (0, 0, GRUB_NTFS_COM_LEN, NULL, ctx->file); nn--; } @@ -271,7 +271,7 @@ read_block (struct grub_ntfs_rlst *ctx, grub_uint8_t *buf, grub_size_t num) if (grub_file_progress_hook && ctx->file) grub_file_progress_hook (0, 0, tt << (ctx->comp.log_spc - + GRUB_NTFS_BLK_SHR), + + GRUB_NTFS_BLK_SHR), NULL, ctx->file); buf += tt << (ctx->comp.log_spc + GRUB_NTFS_BLK_SHR); } @@ -294,7 +294,7 @@ read_block (struct grub_ntfs_rlst *ctx, grub_uint8_t *buf, grub_size_t num) if (grub_file_progress_hook && ctx->file) grub_file_progress_hook (0, 0, nn << (ctx->comp.log_spc - + GRUB_NTFS_BLK_SHR), + + GRUB_NTFS_BLK_SHR), NULL, ctx->file); } ctx->target_vcn += nn; @@ -323,7 +323,7 @@ ntfscomp (grub_uint8_t *dest, grub_disk_addr_t ofs, grub_memcpy (dest, ctx->attr->sbuf + ofs - ctx->attr->save_pos, n); if (grub_file_progress_hook && ctx->file) - grub_file_progress_hook (0, 0, n, ctx->file); + grub_file_progress_hook (0, 0, n, NULL, ctx->file); if (n == len) return 0; @@ -390,7 +390,7 @@ ntfscomp (grub_uint8_t *dest, grub_disk_addr_t ofs, n = len; grub_memcpy (dest, &ctx->attr->sbuf[o], n); if (grub_file_progress_hook && ctx->file) - grub_file_progress_hook (0, 0, n, ctx->file); + grub_file_progress_hook (0, 0, n, NULL, ctx->file); if (n == len) goto quit; dest += n; @@ -422,7 +422,7 @@ ntfscomp (grub_uint8_t *dest, grub_disk_addr_t ofs, grub_memcpy (dest, ctx->attr->sbuf, len); if (grub_file_progress_hook && file) - grub_file_progress_hook (0, 0, len, file); + grub_file_progress_hook (0, 0, len, NULL, file); } quit: diff --git a/grub-core/kern/disk.c b/grub-core/kern/disk.c index 3a42c007b..01190085e 100644 --- a/grub-core/kern/disk.c +++ b/grub-core/kern/disk.c @@ -402,10 +402,10 @@ grub_disk_read_small (grub_disk_t disk, grub_disk_addr_t sector, if (err) return err; if (disk->read_hook) - (disk->read_hook) (sector + (offset >> GRUB_DISK_SECTOR_BITS), - offset & (GRUB_DISK_SECTOR_SIZE - 1), - size, disk->read_hook_data); - return GRUB_ERR_NONE; + err = (disk->read_hook) (sector + (offset >> GRUB_DISK_SECTOR_BITS), + offset & (GRUB_DISK_SECTOR_SIZE - 1), + size, buf, disk->read_hook_data); + return err; } /* Read data from the disk. */ @@ -501,7 +501,7 @@ grub_disk_read (grub_disk_t disk, grub_disk_addr_t sector, if (disk->read_hook) (disk->read_hook) (sector, 0, agglomerate << (GRUB_DISK_CACHE_BITS + GRUB_DISK_SECTOR_BITS), - disk->read_hook_data); + buf, disk->read_hook_data); sector += agglomerate << GRUB_DISK_CACHE_BITS; size -= agglomerate << (GRUB_DISK_CACHE_BITS + GRUB_DISK_SECTOR_BITS); @@ -513,7 +513,7 @@ grub_disk_read (grub_disk_t disk, grub_disk_addr_t sector, { if (disk->read_hook) (disk->read_hook) (sector, 0, (GRUB_DISK_CACHE_SIZE << GRUB_DISK_SECTOR_BITS), - disk->read_hook_data); + buf, disk->read_hook_data); sector += GRUB_DISK_CACHE_SIZE; buf = (char *) buf + (GRUB_DISK_CACHE_SIZE << GRUB_DISK_SECTOR_BITS); size -= (GRUB_DISK_CACHE_SIZE << GRUB_DISK_SECTOR_BITS); diff --git a/grub-core/lib/progress.c b/grub-core/lib/progress.c index 4b7cbbca6..4f4389dd5 100644 --- a/grub-core/lib/progress.c +++ b/grub-core/lib/progress.c @@ -29,10 +29,11 @@ GRUB_MOD_LICENSE ("GPLv3+"); #define UPDATE_INTERVAL 800 -static void +static grub_err_t grub_file_progress_hook_real (grub_disk_addr_t sector __attribute__ ((unused)), unsigned offset __attribute__ ((unused)), - unsigned length, void *data) + unsigned length, + char *buf __attribute__ ((unused)), void *data) { static int call_depth = 0; grub_uint64_t now; @@ -42,11 +43,11 @@ grub_file_progress_hook_real (grub_disk_addr_t sector __attribute__ ((unused)), file->progress_offset += length; if (call_depth) - return; + return GRUB_ERR_NONE; e = grub_env_get ("enable_progress_indicator"); if (e && e[0] == '0') { - return; + return GRUB_ERR_NONE; } call_depth = 1; @@ -132,6 +133,8 @@ grub_file_progress_hook_real (grub_disk_addr_t sector __attribute__ ((unused)), last_progress_update_time = now; } call_depth = 0; + + return GRUB_ERR_NONE; } GRUB_MOD_INIT(progress) diff --git a/grub-core/net/net.c b/grub-core/net/net.c index 9f09f8e48..064e7114e 100644 --- a/grub-core/net/net.c +++ b/grub-core/net/net.c @@ -1662,7 +1662,7 @@ grub_net_fs_read_real (grub_file_t file, char *buf, grub_size_t len) total += amount; file->device->net->offset += amount; if (grub_file_progress_hook) - grub_file_progress_hook (0, 0, amount, file); + grub_file_progress_hook (0, 0, amount, NULL, file); if (buf) { grub_memcpy (ptr, nb->data, amount); diff --git a/include/grub/disk.h b/include/grub/disk.h index a17d257c3..25c141ea2 100644 --- a/include/grub/disk.h +++ b/include/grub/disk.h @@ -110,9 +110,9 @@ extern grub_disk_dev_t EXPORT_VAR (grub_disk_dev_list); struct grub_partition; -typedef void (*grub_disk_read_hook_t) (grub_disk_addr_t sector, - unsigned offset, unsigned length, - void *data); +typedef grub_err_t (*grub_disk_read_hook_t) (grub_disk_addr_t sector, + unsigned offset, unsigned length, + char *buf, void *data); /* Disk. */ struct grub_disk -- 2.34.1