1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
|
/*
* Copyright 2023 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
#define G_LOG_DOMAIN "FuInputStream"
#include "config.h"
#include "fu-chunk-array.h"
#include "fu-crc-private.h"
#include "fu-input-stream.h"
#include "fu-mem-private.h"
#include "fu-sum.h"
/**
* fu_input_stream_from_path:
* @path: a filename
* @error: (nullable): optional return location for an error
*
* Opens the file as n input stream.
*
* Returns: (transfer full): a #GInputStream, or %NULL on error
*
* Since: 2.0.0
**/
GInputStream *
fu_input_stream_from_path(const gchar *path, GError **error)
{
g_autoptr(GFile) file = NULL;
g_autoptr(GFileInputStream) stream = NULL;
g_return_val_if_fail(path != NULL, NULL);
g_return_val_if_fail(error == NULL || *error == NULL, NULL);
file = g_file_new_for_path(path);
stream = g_file_read(file, NULL, error);
if (stream == NULL) {
fwupd_error_convert(error);
return NULL;
}
return G_INPUT_STREAM(g_steal_pointer(&stream));
}
/**
* fu_input_stream_read_safe:
* @stream: a #GInputStream
* @buf (not nullable): a buffer to read data into
* @bufsz: size of @buf
* @offset: offset in bytes into @buf to copy from
* @seek_set: given offset to seek to
* @count: the number of bytes that will be read from the stream
* @error: (nullable): optional return location for an error
*
* Tries to read count bytes from the stream into the buffer starting at @buf.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_safe(GInputStream *stream,
guint8 *buf,
gsize bufsz,
gsize offset,
gsize seek_set,
gsize count,
GError **error)
{
gssize rc;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(buf != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_memchk_write(bufsz, offset, count, error))
return FALSE;
if (!g_seekable_seek(G_SEEKABLE(stream), seek_set, G_SEEK_SET, NULL, error)) {
g_prefix_error(error, "seek to 0x%x: ", (guint)seek_set);
return FALSE;
}
rc = g_input_stream_read(stream, buf + offset, count, NULL, error);
if (rc == -1) {
g_prefix_error(error, "failed read of 0x%x: ", (guint)count);
return FALSE;
}
if ((gsize)rc != count) {
g_set_error(error,
FWUPD_ERROR,
FWUPD_ERROR_READ,
"requested 0x%x and got 0x%x",
(guint)count,
(guint)rc);
return FALSE;
}
return TRUE;
}
/**
* fu_input_stream_read_u8:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @value: (out) (not nullable): the parsed value
* @error: (nullable): optional return location for an error
*
* Read a value from a stream using a specified endian in a safe way.
*
* Returns: %TRUE if @value was set, %FALSE otherwise
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_u8(GInputStream *stream, gsize offset, guint8 *value, GError **error)
{
guint8 buf = 0;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_read_safe(stream, &buf, sizeof(buf), 0x0, offset, sizeof(buf), error))
return FALSE;
*value = buf;
return TRUE;
}
/**
* fu_input_stream_read_u16:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @value: (out) (not nullable): the parsed value
* @endian: an endian type, e.g. %G_LITTLE_ENDIAN
* @error: (nullable): optional return location for an error
*
* Read a value from a stream using a specified endian in a safe way.
*
* Returns: %TRUE if @value was set, %FALSE otherwise
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_u16(GInputStream *stream,
gsize offset,
guint16 *value,
FuEndianType endian,
GError **error)
{
guint8 buf[2] = {0};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_read_safe(stream, buf, sizeof(buf), 0x0, offset, sizeof(buf), error))
return FALSE;
*value = fu_memread_uint16(buf, endian);
return TRUE;
}
/**
* fu_input_stream_read_u24:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @value: (out) (not nullable): the parsed value
* @endian: an endian type, e.g. %G_LITTLE_ENDIAN
* @error: (nullable): optional return location for an error
*
* Read a value from a stream using a specified endian in a safe way.
*
* Returns: %TRUE if @value was set, %FALSE otherwise
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_u24(GInputStream *stream,
gsize offset,
guint32 *value,
FuEndianType endian,
GError **error)
{
guint8 buf[3] = {0};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_read_safe(stream, buf, sizeof(buf), 0x0, offset, sizeof(buf), error))
return FALSE;
*value = fu_memread_uint24(buf, endian);
return TRUE;
}
/**
* fu_input_stream_read_u32:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @value: (out) (not nullable): the parsed value
* @endian: an endian type, e.g. %G_LITTLE_ENDIAN
* @error: (nullable): optional return location for an error
*
* Read a value from a stream using a specified endian in a safe way.
*
* Returns: %TRUE if @value was set, %FALSE otherwise
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_u32(GInputStream *stream,
gsize offset,
guint32 *value,
FuEndianType endian,
GError **error)
{
guint8 buf[4] = {0};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_read_safe(stream, buf, sizeof(buf), 0x0, offset, sizeof(buf), error))
return FALSE;
*value = fu_memread_uint32(buf, endian);
return TRUE;
}
/**
* fu_input_stream_read_u64:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @value: (out) (not nullable): the parsed value
* @endian: an endian type, e.g. %G_LITTLE_ENDIAN
* @error: (nullable): optional return location for an error
*
* Read a value from a stream using a specified endian in a safe way.
*
* Returns: %TRUE if @value was set, %FALSE otherwise
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_read_u64(GInputStream *stream,
gsize offset,
guint64 *value,
FuEndianType endian,
GError **error)
{
guint8 buf[8] = {0};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_read_safe(stream, buf, sizeof(buf), 0x0, offset, sizeof(buf), error))
return FALSE;
*value = fu_memread_uint64(buf, endian);
return TRUE;
}
/**
* fu_input_stream_read_byte_array:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @count: maximum number of bytes to read
* @progress: (nullable): an optional #FuProgress
* @error: (nullable): optional return location for an error
*
* Read a byte array from a stream in a safe way.
*
* NOTE: The returned buffer may be smaller than @count!
*
* Returns: (transfer full): buffer
*
* Since: 2.0.0
**/
GByteArray *
fu_input_stream_read_byte_array(GInputStream *stream,
gsize offset,
gsize count,
FuProgress *progress,
GError **error)
{
guint8 tmp[0x8000]; /* nocheck:zero-init */
g_autoptr(GByteArray) buf = g_byte_array_new();
g_autoptr(GError) error_local = NULL;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), NULL);
g_return_val_if_fail(progress == NULL || FU_IS_PROGRESS(progress), NULL);
g_return_val_if_fail(error == NULL || *error == NULL, NULL);
/* this is invalid */
if (count == 0) {
g_set_error_literal(error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_SUPPORTED,
"read size must be non-zero");
return NULL;
}
/* seek back to start */
if (G_IS_SEEKABLE(stream) && g_seekable_can_seek(G_SEEKABLE(stream))) {
if (!g_seekable_seek(G_SEEKABLE(stream), offset, G_SEEK_SET, NULL, error))
return NULL;
}
/* read from stream in 32kB chunks */
while (TRUE) {
gssize sz;
sz = g_input_stream_read(stream,
tmp,
MIN(count - buf->len, sizeof(tmp)),
NULL,
&error_local);
if (sz == 0)
break;
if (sz < 0) {
g_set_error_literal(error,
FWUPD_ERROR,
FWUPD_ERROR_INVALID_FILE,
error_local->message);
return NULL;
}
/* update progress */
if (progress != NULL)
fu_progress_set_percentage_full(progress, buf->len, count);
g_byte_array_append(buf, tmp, sz);
if (buf->len >= count)
break;
}
/* no data was read */
if (buf->len == 0) {
g_set_error_literal(error,
FWUPD_ERROR,
FWUPD_ERROR_INVALID_FILE,
"no data could be read");
return NULL;
}
/* success */
return g_steal_pointer(&buf);
}
/**
* fu_input_stream_read_bytes:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @count: maximum number of bytes to read
* @progress: (nullable): an optional #FuProgress
* @error: (nullable): optional return location for an error
*
* Read a #GBytes from a stream in a safe way.
*
* NOTE: The returned buffer may be smaller than @count!
*
* Returns: (transfer full): buffer
*
* Since: 2.0.0
**/
GBytes *
fu_input_stream_read_bytes(GInputStream *stream,
gsize offset,
gsize count,
FuProgress *progress,
GError **error)
{
g_autoptr(GByteArray) buf = NULL;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), NULL);
g_return_val_if_fail(progress == NULL || FU_IS_PROGRESS(progress), NULL);
g_return_val_if_fail(error == NULL || *error == NULL, NULL);
buf = fu_input_stream_read_byte_array(stream, offset, count, progress, error);
if (buf == NULL)
return NULL;
return g_byte_array_free_to_bytes(g_steal_pointer(&buf)); /* nocheck:blocked */
}
/**
* fu_input_stream_read_string:
* @stream: a #GInputStream
* @offset: offset in bytes into @stream to copy from
* @count: maximum number of bytes to read
* @error: (nullable): optional return location for an error
*
* Read a UTF-8 string from a stream in a safe way.
*
* Returns: (transfer full): string
*
* Since: 2.0.0
**/
gchar *
fu_input_stream_read_string(GInputStream *stream, gsize offset, gsize count, GError **error)
{
g_autoptr(GByteArray) buf = NULL;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), NULL);
g_return_val_if_fail(error == NULL || *error == NULL, NULL);
buf = fu_input_stream_read_byte_array(stream, offset, count, NULL, error);
if (buf == NULL)
return NULL;
if (!g_utf8_validate_len((const gchar *)buf->data, buf->len, NULL)) {
g_set_error_literal(error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_SUPPORTED,
"non UTF-8 string");
return NULL;
}
return g_strndup((const gchar *)buf->data, buf->len);
}
/**
* fu_input_stream_size:
* @stream: a #GInputStream
* @val: (out): size in bytes
* @error: (nullable): optional return location for an error
*
* Reads the total possible of the stream.
*
* If @stream is not seekable, %G_MAXSIZE is used as the size.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_size(GInputStream *stream, gsize *val, GError **error)
{
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
/* streaming from unseekable stream */
if (!G_IS_SEEKABLE(stream) || !g_seekable_can_seek(G_SEEKABLE(stream))) {
if (val != NULL)
*val = G_MAXSIZE;
return TRUE;
}
if (!g_seekable_seek(G_SEEKABLE(stream), 0, G_SEEK_END, NULL, error)) {
g_prefix_error_literal(error, "seek to end: ");
return FALSE;
}
if (val != NULL)
*val = g_seekable_tell(G_SEEKABLE(stream));
/* success */
return TRUE;
}
static gboolean
fu_input_stream_compute_checksum_cb(const guint8 *buf,
gsize bufsz,
gpointer user_data,
GError **error)
{
GChecksum *csum = (GChecksum *)user_data;
g_checksum_update(csum, buf, bufsz);
return TRUE;
}
/**
* fu_input_stream_compute_checksum:
* @stream: a #GInputStream
* @checksum_type: a #GChecksumType
* @error: (nullable): optional return location for an error
*
* Generates the checksum of the entire stream.
*
* Returns: the hexadecimal representation of the checksum, or %NULL on error
*
* Since: 2.0.0
**/
gchar *
fu_input_stream_compute_checksum(GInputStream *stream, GChecksumType checksum_type, GError **error)
{
g_autoptr(GChecksum) csum = g_checksum_new(checksum_type);
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), NULL);
g_return_val_if_fail(error == NULL || *error == NULL, NULL);
if (!fu_input_stream_chunkify(stream, fu_input_stream_compute_checksum_cb, csum, error))
return NULL;
return g_strdup(g_checksum_get_string(csum));
}
static gboolean
fu_input_stream_compute_sum8_cb(const guint8 *buf, gsize bufsz, gpointer user_data, GError **error)
{
guint8 *value = (guint8 *)user_data;
*value += fu_sum8(buf, bufsz);
return TRUE;
}
/**
* fu_input_stream_compute_sum8:
* @stream: a #GInputStream
* @value: (out): value
* @error: (nullable): optional return location for an error
*
* Returns the arithmetic sum of all bytes in the stream.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_compute_sum8(GInputStream *stream, guint8 *value, GError **error)
{
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
return fu_input_stream_chunkify(stream, fu_input_stream_compute_sum8_cb, value, error);
}
static gboolean
fu_input_stream_compute_sum16_cb(const guint8 *buf, gsize bufsz, gpointer user_data, GError **error)
{
guint16 *value = (guint16 *)user_data;
if (bufsz % sizeof(*value) != 0) {
g_set_error(error,
FWUPD_ERROR,
FWUPD_ERROR_READ,
"not aligned to %u bytes, got 0x%x",
(guint)sizeof(*value),
(guint)bufsz);
return FALSE;
}
*value += fu_sum16(buf, bufsz);
return TRUE;
}
/**
* fu_input_stream_compute_sum16:
* @stream: a #GInputStream
* @value: (out): value
* @error: (nullable): optional return location for an error
*
* Returns the arithmetic sum of all bytes in the stream.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_compute_sum16(GInputStream *stream, guint16 *value, GError **error)
{
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
return fu_input_stream_chunkify(stream, fu_input_stream_compute_sum16_cb, value, error);
}
static gboolean
fu_input_stream_compute_sum32_cb(const guint8 *buf, gsize bufsz, gpointer user_data, GError **error)
{
guint32 *value = (guint32 *)user_data;
if (bufsz % sizeof(*value) != 0) {
g_set_error(error,
FWUPD_ERROR,
FWUPD_ERROR_READ,
"not aligned to %u bytes, got 0x%x",
(guint)sizeof(*value),
(guint)bufsz);
return FALSE;
}
*value += fu_sum32(buf, bufsz);
return TRUE;
}
/**
* fu_input_stream_compute_sum32:
* @stream: a #GInputStream
* @value: (out): value
* @error: (nullable): optional return location for an error
*
* Returns the arithmetic sum of all bytes in the stream.
*
* Returns: %TRUE for success
*
* Since: 2.0.1
**/
gboolean
fu_input_stream_compute_sum32(GInputStream *stream, guint32 *value, GError **error)
{
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(value != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
return fu_input_stream_chunkify(stream, fu_input_stream_compute_sum32_cb, value, error);
}
typedef struct {
FuCrcKind kind;
guint32 crc;
} FuInputStreamComputeCrc32Helper;
static gboolean
fu_input_stream_compute_crc32_cb(const guint8 *buf, gsize bufsz, gpointer user_data, GError **error)
{
FuInputStreamComputeCrc32Helper *helper = (FuInputStreamComputeCrc32Helper *)user_data;
helper->crc = fu_crc32_step(helper->kind, buf, bufsz, helper->crc);
return TRUE;
}
/**
* fu_input_stream_compute_crc32:
* @stream: a #GInputStream
* @kind: a #FuCrcKind, typically %FU_CRC_KIND_B32_STANDARD
* @crc: (inout): initial and final CRC value
* @error: (nullable): optional return location for an error
*
* Returns the cyclic redundancy check value for the given memory buffer.
*
* NOTE: The initial @crc differs from fu_crc32_step() in that it is inverted (to make it
* symmetrical, and chainable), so for most uses you want to use the value of 0x0, not 0xFFFFFFFF.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_compute_crc32(GInputStream *stream, FuCrcKind kind, guint32 *crc, GError **error)
{
FuInputStreamComputeCrc32Helper helper = {.crc = *crc, .kind = kind};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(crc != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_chunkify(stream, fu_input_stream_compute_crc32_cb, &helper, error))
return FALSE;
*crc = fu_crc32_done(kind, helper.crc);
return TRUE;
}
typedef struct {
FuCrcKind kind;
guint16 crc;
} FuInputStreamComputeCrc16Helper;
static gboolean
fu_input_stream_compute_crc16_cb(const guint8 *buf, gsize bufsz, gpointer user_data, GError **error)
{
FuInputStreamComputeCrc16Helper *helper = (FuInputStreamComputeCrc16Helper *)user_data;
helper->crc = fu_crc16_step(helper->kind, buf, bufsz, helper->crc);
return TRUE;
}
/**
* fu_input_stream_compute_crc16:
* @stream: a #GInputStream
* @kind: a #FuCrcKind, typically %FU_CRC_KIND_B16_XMODEM
* @crc: (inout): initial and final CRC value
* @error: (nullable): optional return location for an error
*
* Returns the cyclic redundancy check value for the given memory buffer.
*
* NOTE: The initial @crc differs from fu_crc16() in that it is inverted (to make it
* symmetrical, and chainable), so for most uses you want to use the value of 0x0, not 0xFFFF.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_compute_crc16(GInputStream *stream, FuCrcKind kind, guint16 *crc, GError **error)
{
FuInputStreamComputeCrc16Helper helper = {.crc = *crc, .kind = kind};
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(crc != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
if (!fu_input_stream_chunkify(stream, fu_input_stream_compute_crc16_cb, &helper, error))
return FALSE;
*crc = fu_crc16_done(kind, helper.crc);
return TRUE;
}
/**
* fu_input_stream_chunkify:
* @stream: a #GInputStream
* @func_cb: (scope async): function to call with chunks
* @user_data: user data to pass to @func_cb
* @error: (nullable): optional return location for an error
*
* Split the stream into blocks and calls a function on each chunk.
*
* Returns: %TRUE for success
*
* Since: 2.0.0
**/
gboolean
fu_input_stream_chunkify(GInputStream *stream,
FuInputStreamChunkifyFunc func_cb,
gpointer user_data,
GError **error)
{
g_autoptr(FuChunkArray) chunks = NULL;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(func_cb != NULL, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
chunks = fu_chunk_array_new_from_stream(stream,
FU_CHUNK_ADDR_OFFSET_NONE,
FU_CHUNK_PAGESZ_NONE,
0x8000,
error);
if (chunks == NULL)
return FALSE;
for (gsize i = 0; i < fu_chunk_array_length(chunks); i++) {
g_autoptr(FuChunk) chk = NULL;
chk = fu_chunk_array_index(chunks, i, error);
if (chk == NULL)
return FALSE;
if (!func_cb(fu_chunk_get_data(chk), fu_chunk_get_data_sz(chk), user_data, error))
return FALSE;
}
return TRUE;
}
/**
* fu_input_stream_find:
* @stream: a #GInputStream
* @buf: input buffer to look for
* @bufsz: size of @buf
* @offset: starting offset, typically 0x0
* @offset_found: (nullable) (out): found offset
* @error: (nullable): optional return location for an error
*
* Find a memory buffer within an input stream, without loading the entire stream into a buffer.
*
* Returns: %TRUE if @buf was found
*
* Since: 2.0.18
**/
gboolean
fu_input_stream_find(GInputStream *stream,
const guint8 *buf,
gsize bufsz,
gsize offset,
gsize *offset_found,
GError **error)
{
g_autoptr(GByteArray) buf_acc = g_byte_array_new();
const gsize blocksz = 0x10000;
gsize offset_add = 0;
gsize offset_cur = offset;
g_return_val_if_fail(G_IS_INPUT_STREAM(stream), FALSE);
g_return_val_if_fail(buf != NULL, FALSE);
g_return_val_if_fail(bufsz != 0, FALSE);
g_return_val_if_fail(bufsz < blocksz, FALSE);
g_return_val_if_fail(error == NULL || *error == NULL, FALSE);
while (TRUE) {
g_autoptr(GByteArray) buf_tmp = NULL;
g_autoptr(GError) error_local = NULL;
/* read more data */
buf_tmp = fu_input_stream_read_byte_array(stream,
offset_cur,
blocksz,
NULL,
&error_local);
if (buf_tmp == NULL) {
if (g_error_matches(error_local, FWUPD_ERROR, FWUPD_ERROR_INVALID_FILE))
break;
g_propagate_error(error, g_steal_pointer(&error_local));
return FALSE;
}
g_byte_array_append(buf_acc, buf_tmp->data, buf_tmp->len);
/* we found something */
if (fu_memmem_safe(buf_acc->data, buf_acc->len, buf, bufsz, offset_found, NULL)) {
if (offset_found != NULL)
*offset_found += offset + offset_add;
return TRUE;
}
/* truncate the buffer */
if (buf_acc->len > bufsz) {
offset_add += buf_acc->len - bufsz;
g_byte_array_remove_range(buf_acc, 0, buf_acc->len - bufsz);
}
/* move the offset */
offset_cur += buf_tmp->len;
}
g_set_error(error,
FWUPD_ERROR,
FWUPD_ERROR_NOT_FOUND,
"failed to find buffer of size 0x%x",
(guint)bufsz);
return FALSE;
}
|