Branch data     Line data    Source code

       1                 :            : /* SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  * Copyright(c) 2021 Red Hat, Inc.
       3                 :            :  */
       4                 :            : 
       5                 :            : #ifdef RTE_HAS_LIBARCHIVE
       6                 :            : #include <archive.h>
       7                 :            : #endif
       8                 :            : #include <fcntl.h>
       9                 :            : #include <stdio.h>
      10                 :            : #include <stdlib.h>
      11                 :            : #include <unistd.h>
      12                 :            : 
      13                 :            : #include <rte_common.h>
      14                 :            : #include <rte_log.h>
      15                 :            : 
      16                 :            : #include <eal_export.h>
      17                 :            : #include "eal_firmware.h"
      18                 :            : #include "eal_private.h"
      19                 :            : 
      20                 :            : static const char * const compression_suffixes[] = { "xz", "zst" };
      21                 :            : 
      22                 :            : #ifdef RTE_HAS_LIBARCHIVE
      23                 :            : 
      24                 :            : struct firmware_read_ctx {
      25                 :            :         struct archive *a;
      26                 :            : };
      27                 :            : 
      28                 :            : static int
      29                 :            : firmware_open(struct firmware_read_ctx *ctx, const char *name, size_t blocksize)
      30                 :            : {
      31                 :            :         struct archive_entry *e;
      32                 :            :         int err;
      33                 :            : 
      34                 :            :         ctx->a = archive_read_new();
      35                 :            :         if (ctx->a == NULL)
      36                 :            :                 return -1;
      37                 :            : 
      38                 :            :         if (archive_read_support_format_raw(ctx->a) != ARCHIVE_OK)
      39                 :            :                 goto error;
      40                 :            : 
      41                 :            :         err = archive_read_support_filter_xz(ctx->a);
      42                 :            :         if (err != ARCHIVE_OK && err != ARCHIVE_WARN)
      43                 :            :                 EAL_LOG(DEBUG, "could not initialise libarchive for xz compression");
      44                 :            : 
      45                 :            :         err = archive_read_support_filter_zstd(ctx->a);
      46                 :            :         if (err != ARCHIVE_OK && err != ARCHIVE_WARN)
      47                 :            :                 EAL_LOG(DEBUG, "could not initialise libarchive for zstd compression");
      48                 :            : 
      49                 :            :         if (archive_read_open_filename(ctx->a, name, blocksize) != ARCHIVE_OK)
      50                 :            :                 goto error;
      51                 :            : 
      52                 :            :         if (archive_read_next_header(ctx->a, &e) != ARCHIVE_OK)
      53                 :            :                 goto error;
      54                 :            : 
      55                 :            :         return 0;
      56                 :            : 
      57                 :            : error:
      58                 :            :         archive_read_free(ctx->a);
      59                 :            :         ctx->a = NULL;
      60                 :            :         return -1;
      61                 :            : }
      62                 :            : 
      63                 :            : static ssize_t
      64                 :            : firmware_read_block(struct firmware_read_ctx *ctx, void *buf, size_t count)
      65                 :            : {
      66                 :            :         return archive_read_data(ctx->a, buf, count);
      67                 :            : }
      68                 :            : 
      69                 :            : static void
      70                 :            : firmware_close(struct firmware_read_ctx *ctx)
      71                 :            : {
      72                 :            :         archive_read_free(ctx->a);
      73                 :            :         ctx->a = NULL;
      74                 :            : }
      75                 :            : 
      76                 :            : #else /* !RTE_HAS_LIBARCHIVE */
      77                 :            : 
      78                 :            : struct firmware_read_ctx {
      79                 :            :         int fd;
      80                 :            : };
      81                 :            : 
      82                 :            : static int
      83                 :            : firmware_open(struct firmware_read_ctx *ctx, const char *name,
      84                 :            :         __rte_unused size_t blocksize)
      85                 :            : {
      86                 :          0 :         ctx->fd = open(name, O_RDONLY);
      87         [ #  # ]:          0 :         if (ctx->fd < 0)
      88                 :            :                 return -1;
      89                 :            :         return 0;
      90                 :            : }
      91                 :            : 
      92                 :            : static ssize_t
      93                 :          0 : firmware_read_block(struct firmware_read_ctx *ctx, void *buf, size_t count)
      94                 :            : {
      95         [ #  # ]:          0 :         return read(ctx->fd, buf, count);
      96                 :            : }
      97                 :            : 
      98                 :            : static void
      99                 :            : firmware_close(struct firmware_read_ctx *ctx)
     100                 :            : {
     101                 :          0 :         close(ctx->fd);
     102                 :            :         ctx->fd = -1;
     103                 :            : }
     104                 :            : 
     105                 :            : #endif /* !RTE_HAS_LIBARCHIVE */
     106                 :            : 
     107                 :            : static int
     108                 :          0 : firmware_read(const char *name, void **buf, size_t *bufsz)
     109                 :            : {
     110                 :            :         const size_t blocksize = 4096;
     111                 :            :         struct firmware_read_ctx ctx;
     112                 :            :         int ret = -1;
     113                 :            :         int err;
     114                 :            : 
     115                 :          0 :         *buf = NULL;
     116                 :          0 :         *bufsz = 0;
     117                 :            : 
     118                 :            :         if (firmware_open(&ctx, name, blocksize) < 0)
     119                 :            :                 return -1;
     120                 :            : 
     121                 :            :         do {
     122                 :            :                 void *tmp;
     123                 :            : 
     124                 :          0 :                 tmp = realloc(*buf, *bufsz + blocksize);
     125         [ #  # ]:          0 :                 if (tmp == NULL) {
     126                 :          0 :                         free(*buf);
     127                 :          0 :                         *buf = NULL;
     128                 :          0 :                         *bufsz = 0;
     129                 :          0 :                         goto out;
     130                 :            :                 }
     131                 :          0 :                 *buf = tmp;
     132                 :            : 
     133                 :          0 :                 err = firmware_read_block(&ctx, RTE_PTR_ADD(*buf, *bufsz), blocksize);
     134         [ #  # ]:          0 :                 if (err < 0) {
     135                 :          0 :                         free(*buf);
     136                 :          0 :                         *buf = NULL;
     137                 :          0 :                         *bufsz = 0;
     138                 :          0 :                         goto out;
     139                 :            :                 }
     140                 :          0 :                 *bufsz += err;
     141                 :            : 
     142         [ #  # ]:          0 :         } while (err != 0);
     143                 :            : 
     144                 :            :         ret = 0;
     145                 :          0 : out:
     146                 :            :         firmware_close(&ctx);
     147                 :          0 :         return ret;
     148                 :            : }
     149                 :            : 
     150                 :            : RTE_EXPORT_INTERNAL_SYMBOL(rte_firmware_read)
     151                 :            : int
     152                 :          0 : rte_firmware_read(const char *name, void **buf, size_t *bufsz)
     153                 :            : {
     154                 :            :         char path[PATH_MAX];
     155                 :            :         int ret;
     156                 :            : 
     157                 :          0 :         ret = firmware_read(name, buf, bufsz);
     158         [ #  # ]:          0 :         if (ret < 0) {
     159                 :            :                 unsigned int i;
     160                 :            : 
     161         [ #  # ]:          0 :                 for (i = 0; i < RTE_DIM(compression_suffixes); i++) {
     162                 :          0 :                         snprintf(path, sizeof(path), "%s.%s", name, compression_suffixes[i]);
     163                 :          0 :                         path[PATH_MAX - 1] = '\0';
     164         [ #  # ]:          0 :                         if (access(path, F_OK) != 0)
     165                 :            :                                 continue;
     166                 :            : #ifndef RTE_HAS_LIBARCHIVE
     167                 :          0 :                         EAL_LOG(WARNING, "libarchive not linked, %s cannot be decompressed",
     168                 :            :                                 path);
     169                 :            : #else
     170                 :            :                         ret = firmware_read(path, buf, bufsz);
     171                 :            : #endif
     172                 :          0 :                         break;
     173                 :            :                 }
     174                 :            :         }
     175                 :          0 :         return ret;
     176                 :            : }