LCOV - code coverage report
Current view: top level - spdk/examples/bdev/hello_world - hello_bdev.c (source / functions) Hit Total Coverage
Test: Combined Lines: 85 168 50.6 %
Date: 2024-11-19 17:56:50 Functions: 7 11 63.6 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 22 348 6.3 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2018 Intel Corporation.
       3                 :            :  *   All rights reserved.
       4                 :            :  */
       5                 :            : 
       6                 :            : #include "spdk/stdinc.h"
       7                 :            : #include "spdk/thread.h"
       8                 :            : #include "spdk/bdev.h"
       9                 :            : #include "spdk/env.h"
      10                 :            : #include "spdk/event.h"
      11                 :            : #include "spdk/log.h"
      12                 :            : #include "spdk/string.h"
      13                 :            : #include "spdk/bdev_zone.h"
      14                 :            : 
      15                 :            : static char *g_bdev_name = "Malloc0";
      16                 :            : 
      17                 :            : /*
      18                 :            :  * We'll use this struct to gather housekeeping hello_context to pass between
      19                 :            :  * our events and callbacks.
      20                 :            :  */
      21                 :            : struct hello_context_t {
      22                 :            :         struct spdk_bdev *bdev;
      23                 :            :         struct spdk_bdev_desc *bdev_desc;
      24                 :            :         struct spdk_io_channel *bdev_io_channel;
      25                 :            :         char *buff;
      26                 :            :         uint32_t buff_size;
      27                 :            :         char *bdev_name;
      28                 :            :         struct spdk_bdev_io_wait_entry bdev_io_wait;
      29                 :            : };
      30                 :            : 
      31                 :            : /*
      32                 :            :  * Usage function for printing parameters that are specific to this application
      33                 :            :  */
      34                 :            : static void
      35                 :          0 : hello_bdev_usage(void)
      36                 :            : {
      37         [ #  # ]:          0 :         printf(" -b <bdev>                 name of the bdev to use\n");
      38                 :          0 : }
      39                 :            : 
      40                 :            : /*
      41                 :            :  * This function is called to parse the parameters that are specific to this application
      42                 :            :  */
      43                 :            : static int
      44                 :         24 : hello_bdev_parse_arg(int ch, char *arg)
      45                 :            : {
      46         [ +  + ]:         24 :         switch (ch) {
      47                 :         22 :         case 'b':
      48                 :         24 :                 g_bdev_name = arg;
      49                 :         24 :                 break;
      50                 :          0 :         default:
      51                 :          0 :                 return -EINVAL;
      52                 :            :         }
      53                 :         24 :         return 0;
      54                 :          2 : }
      55                 :            : 
      56                 :            : /*
      57                 :            :  * Callback function for read io completion.
      58                 :            :  */
      59                 :            : static void
      60                 :         24 : read_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
      61                 :            : {
      62                 :         24 :         struct hello_context_t *hello_context = cb_arg;
      63                 :            : 
      64   [ +  -  #  # ]:         24 :         if (success) {
      65   [ #  #  #  # ]:         24 :                 SPDK_NOTICELOG("Read string from bdev : %s\n", hello_context->buff);
      66                 :          2 :         } else {
      67                 :          0 :                 SPDK_ERRLOG("bdev io read error\n");
      68                 :            :         }
      69                 :            : 
      70                 :            :         /* Complete the bdev io and close the channel */
      71                 :         24 :         spdk_bdev_free_io(bdev_io);
      72   [ #  #  #  # ]:         24 :         spdk_put_io_channel(hello_context->bdev_io_channel);
      73   [ #  #  #  # ]:         24 :         spdk_bdev_close(hello_context->bdev_desc);
      74                 :         24 :         SPDK_NOTICELOG("Stopping app\n");
      75         [ +  - ]:         24 :         spdk_app_stop(success ? 0 : -1);
      76                 :         24 : }
      77                 :            : 
      78                 :            : static void
      79                 :         24 : hello_read(void *arg)
      80                 :            : {
      81                 :         24 :         struct hello_context_t *hello_context = arg;
      82                 :         24 :         int rc = 0;
      83                 :            : 
      84                 :         24 :         SPDK_NOTICELOG("Reading io\n");
      85   [ #  #  #  #  :         26 :         rc = spdk_bdev_read(hello_context->bdev_desc, hello_context->bdev_io_channel,
             #  #  #  # ]
      86   [ #  #  #  #  :         24 :                             hello_context->buff, 0, hello_context->buff_size, read_complete,
             #  #  #  # ]
      87                 :          2 :                             hello_context);
      88                 :            : 
      89         [ -  + ]:         24 :         if (rc == -ENOMEM) {
      90                 :          0 :                 SPDK_NOTICELOG("Queueing io\n");
      91                 :            :                 /* In case we cannot perform I/O now, queue I/O */
      92   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.bdev = hello_context->bdev;
          #  #  #  #  #  
                      # ]
      93   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_fn = hello_read;
                   #  # ]
      94   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_arg = hello_context;
                   #  # ]
      95   [ #  #  #  #  :          0 :                 spdk_bdev_queue_io_wait(hello_context->bdev, hello_context->bdev_io_channel,
             #  #  #  # ]
      96         [ #  # ]:          0 :                                         &hello_context->bdev_io_wait);
      97         [ -  + ]:         24 :         } else if (rc) {
      98         [ #  # ]:          0 :                 SPDK_ERRLOG("%s error while reading from bdev: %d\n", spdk_strerror(-rc), rc);
      99   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     100   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     101                 :          0 :                 spdk_app_stop(-1);
     102                 :          0 :         }
     103                 :         24 : }
     104                 :            : 
     105                 :            : /*
     106                 :            :  * Callback function for write io completion.
     107                 :            :  */
     108                 :            : static void
     109                 :         24 : write_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
     110                 :            : {
     111                 :         24 :         struct hello_context_t *hello_context = cb_arg;
     112                 :            : 
     113                 :            :         /* Complete the I/O */
     114                 :         24 :         spdk_bdev_free_io(bdev_io);
     115                 :            : 
     116   [ +  +  #  # ]:         24 :         if (success) {
     117                 :         24 :                 SPDK_NOTICELOG("bdev io write completed successfully\n");
     118                 :          2 :         } else {
     119                 :          0 :                 SPDK_ERRLOG("bdev io write error: %d\n", EIO);
     120   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     121   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     122                 :          0 :                 spdk_app_stop(-1);
     123                 :          0 :                 return;
     124                 :            :         }
     125                 :            : 
     126                 :            :         /* Zero the buffer so that we can use it for reading */
     127   [ -  +  #  #  :         24 :         memset(hello_context->buff, 0, hello_context->buff_size);
          #  #  #  #  #  
                      # ]
     128                 :            : 
     129                 :         24 :         hello_read(hello_context);
     130                 :          2 : }
     131                 :            : 
     132                 :            : static void
     133                 :         24 : hello_write(void *arg)
     134                 :            : {
     135                 :         24 :         struct hello_context_t *hello_context = arg;
     136                 :         24 :         int rc = 0;
     137                 :            : 
     138                 :         24 :         SPDK_NOTICELOG("Writing to the bdev\n");
     139   [ #  #  #  #  :         26 :         rc = spdk_bdev_write(hello_context->bdev_desc, hello_context->bdev_io_channel,
             #  #  #  # ]
     140   [ #  #  #  #  :         24 :                              hello_context->buff, 0, hello_context->buff_size, write_complete,
             #  #  #  # ]
     141                 :          2 :                              hello_context);
     142                 :            : 
     143         [ -  + ]:         24 :         if (rc == -ENOMEM) {
     144                 :          0 :                 SPDK_NOTICELOG("Queueing io\n");
     145                 :            :                 /* In case we cannot perform I/O now, queue I/O */
     146   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.bdev = hello_context->bdev;
          #  #  #  #  #  
                      # ]
     147   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_fn = hello_write;
                   #  # ]
     148   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_arg = hello_context;
                   #  # ]
     149   [ #  #  #  #  :          0 :                 spdk_bdev_queue_io_wait(hello_context->bdev, hello_context->bdev_io_channel,
             #  #  #  # ]
     150         [ #  # ]:          0 :                                         &hello_context->bdev_io_wait);
     151         [ -  + ]:         24 :         } else if (rc) {
     152         [ #  # ]:          0 :                 SPDK_ERRLOG("%s error while writing to bdev: %d\n", spdk_strerror(-rc), rc);
     153   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     154   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     155                 :          0 :                 spdk_app_stop(-1);
     156                 :          0 :         }
     157                 :         24 : }
     158                 :            : 
     159                 :            : static void
     160                 :          0 : hello_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev,
     161                 :            :                     void *event_ctx)
     162                 :            : {
     163                 :          0 :         SPDK_NOTICELOG("Unsupported bdev event: type %d\n", type);
     164                 :          0 : }
     165                 :            : 
     166                 :            : static void
     167                 :          0 : reset_zone_complete(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg)
     168                 :            : {
     169                 :          0 :         struct hello_context_t *hello_context = cb_arg;
     170                 :            : 
     171                 :            :         /* Complete the I/O */
     172                 :          0 :         spdk_bdev_free_io(bdev_io);
     173                 :            : 
     174   [ #  #  #  # ]:          0 :         if (!success) {
     175                 :          0 :                 SPDK_ERRLOG("bdev io reset zone error: %d\n", EIO);
     176   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     177   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     178                 :          0 :                 spdk_app_stop(-1);
     179                 :          0 :                 return;
     180                 :            :         }
     181                 :            : 
     182                 :          0 :         hello_write(hello_context);
     183                 :          0 : }
     184                 :            : 
     185                 :            : static void
     186                 :          0 : hello_reset_zone(void *arg)
     187                 :            : {
     188                 :          0 :         struct hello_context_t *hello_context = arg;
     189                 :          0 :         int rc = 0;
     190                 :            : 
     191   [ #  #  #  #  :          0 :         rc = spdk_bdev_zone_management(hello_context->bdev_desc, hello_context->bdev_io_channel,
             #  #  #  # ]
     192                 :          0 :                                        0, SPDK_BDEV_ZONE_RESET, reset_zone_complete, hello_context);
     193                 :            : 
     194         [ #  # ]:          0 :         if (rc == -ENOMEM) {
     195                 :          0 :                 SPDK_NOTICELOG("Queueing io\n");
     196                 :            :                 /* In case we cannot perform I/O now, queue I/O */
     197   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.bdev = hello_context->bdev;
          #  #  #  #  #  
                      # ]
     198   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_fn = hello_reset_zone;
                   #  # ]
     199   [ #  #  #  #  :          0 :                 hello_context->bdev_io_wait.cb_arg = hello_context;
                   #  # ]
     200   [ #  #  #  #  :          0 :                 spdk_bdev_queue_io_wait(hello_context->bdev, hello_context->bdev_io_channel,
             #  #  #  # ]
     201         [ #  # ]:          0 :                                         &hello_context->bdev_io_wait);
     202         [ #  # ]:          0 :         } else if (rc) {
     203         [ #  # ]:          0 :                 SPDK_ERRLOG("%s error while resetting zone: %d\n", spdk_strerror(-rc), rc);
     204   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     205   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     206                 :          0 :                 spdk_app_stop(-1);
     207                 :          0 :         }
     208                 :          0 : }
     209                 :            : 
     210                 :            : /*
     211                 :            :  * Our initial event that kicks off everything from main().
     212                 :            :  */
     213                 :            : static void
     214                 :         24 : hello_start(void *arg1)
     215                 :            : {
     216                 :         24 :         struct hello_context_t *hello_context = arg1;
     217                 :            :         uint32_t buf_align;
     218                 :         24 :         int rc = 0;
     219   [ #  #  #  # ]:         24 :         hello_context->bdev = NULL;
     220   [ #  #  #  # ]:         24 :         hello_context->bdev_desc = NULL;
     221                 :            : 
     222                 :         24 :         SPDK_NOTICELOG("Successfully started the application\n");
     223                 :            : 
     224                 :            :         /*
     225                 :            :          * There can be many bdevs configured, but this application will only use
     226                 :            :          * the one input by the user at runtime.
     227                 :            :          *
     228                 :            :          * Open the bdev by calling spdk_bdev_open_ext() with its name.
     229                 :            :          * The function will return a descriptor
     230                 :            :          */
     231   [ #  #  #  # ]:         24 :         SPDK_NOTICELOG("Opening the bdev %s\n", hello_context->bdev_name);
     232   [ #  #  #  # ]:         26 :         rc = spdk_bdev_open_ext(hello_context->bdev_name, true, hello_bdev_event_cb, NULL,
     233         [ #  # ]:          2 :                                 &hello_context->bdev_desc);
     234         [ -  + ]:         24 :         if (rc) {
     235   [ #  #  #  # ]:          0 :                 SPDK_ERRLOG("Could not open bdev: %s\n", hello_context->bdev_name);
     236                 :          0 :                 spdk_app_stop(-1);
     237                 :          0 :                 return;
     238                 :            :         }
     239                 :            : 
     240                 :            :         /* A bdev pointer is valid while the bdev is opened. */
     241   [ #  #  #  #  :         24 :         hello_context->bdev = spdk_bdev_desc_get_bdev(hello_context->bdev_desc);
             #  #  #  # ]
     242                 :            : 
     243                 :            : 
     244                 :         24 :         SPDK_NOTICELOG("Opening io channel\n");
     245                 :            :         /* Open I/O channel */
     246   [ #  #  #  #  :         24 :         hello_context->bdev_io_channel = spdk_bdev_get_io_channel(hello_context->bdev_desc);
             #  #  #  # ]
     247   [ +  +  #  #  :         24 :         if (hello_context->bdev_io_channel == NULL) {
                   #  # ]
     248                 :          0 :                 SPDK_ERRLOG("Could not create bdev I/O channel!!\n");
     249   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     250                 :          0 :                 spdk_app_stop(-1);
     251                 :          0 :                 return;
     252                 :            :         }
     253                 :            : 
     254                 :            :         /* Allocate memory for the write buffer.
     255                 :            :          * Initialize the write buffer with the string "Hello World!"
     256                 :            :          */
     257   [ #  #  #  #  :         43 :         hello_context->buff_size = spdk_bdev_get_block_size(hello_context->bdev) *
             #  #  #  # ]
     258   [ #  #  #  # ]:         24 :                                    spdk_bdev_get_write_unit_size(hello_context->bdev);
     259   [ #  #  #  # ]:         24 :         buf_align = spdk_bdev_get_buf_align(hello_context->bdev);
     260   [ #  #  #  #  :         24 :         hello_context->buff = spdk_dma_zmalloc(hello_context->buff_size, buf_align, NULL);
             #  #  #  # ]
     261   [ +  +  #  #  :         24 :         if (!hello_context->buff) {
                   #  # ]
     262                 :          0 :                 SPDK_ERRLOG("Failed to allocate buffer\n");
     263   [ #  #  #  # ]:          0 :                 spdk_put_io_channel(hello_context->bdev_io_channel);
     264   [ #  #  #  # ]:          0 :                 spdk_bdev_close(hello_context->bdev_desc);
     265                 :          0 :                 spdk_app_stop(-1);
     266                 :          0 :                 return;
     267                 :            :         }
     268   [ -  +  #  #  :         24 :         snprintf(hello_context->buff, hello_context->buff_size, "%s", "Hello World!\n");
             #  #  #  # ]
     269                 :            : 
     270   [ -  +  #  #  :         24 :         if (spdk_bdev_is_zoned(hello_context->bdev)) {
                   #  # ]
     271                 :          0 :                 hello_reset_zone(hello_context);
     272                 :            :                 /* If bdev is zoned, the callback, reset_zone_complete, will call hello_write() */
     273                 :          0 :                 return;
     274                 :            :         }
     275                 :            : 
     276                 :         24 :         hello_write(hello_context);
     277                 :          2 : }
     278                 :            : 
     279                 :            : int
     280                 :         24 : main(int argc, char **argv)
     281                 :            : {
     282                 :         24 :         struct spdk_app_opts opts = {};
     283                 :         24 :         int rc = 0;
     284                 :         24 :         struct hello_context_t hello_context = {};
     285                 :            : 
     286                 :            :         /* Set default values in opts structure. */
     287                 :         24 :         spdk_app_opts_init(&opts, sizeof(opts));
     288                 :         24 :         opts.name = "hello_bdev";
     289                 :         24 :         opts.rpc_addr = NULL;
     290                 :            : 
     291                 :            :         /*
     292                 :            :          * Parse built-in SPDK command line parameters as well
     293                 :            :          * as our custom one(s).
     294                 :            :          */
     295   [ -  +  -  + ]:         26 :         if ((rc = spdk_app_parse_args(argc, argv, &opts, "b:", NULL, hello_bdev_parse_arg,
     296                 :          2 :                                       hello_bdev_usage)) != SPDK_APP_PARSE_ARGS_SUCCESS) {
     297         [ #  # ]:          0 :                 exit(rc);
     298                 :            :         }
     299         [ #  # ]:         24 :         hello_context.bdev_name = g_bdev_name;
     300                 :            : 
     301                 :            :         /*
     302                 :            :          * spdk_app_start() will initialize the SPDK framework, call hello_start(),
     303                 :            :          * and then block until spdk_app_stop() is called (or if an initialization
     304                 :            :          * error occurs, spdk_app_start() will return with rc even without calling
     305                 :            :          * hello_start().
     306                 :            :          */
     307                 :         24 :         rc = spdk_app_start(&opts, hello_start, &hello_context);
     308         [ +  + ]:         24 :         if (rc) {
     309                 :          0 :                 SPDK_ERRLOG("ERROR starting application\n");
     310                 :          0 :         }
     311                 :            : 
     312                 :            :         /* At this point either spdk_app_stop() was called, or spdk_app_start()
     313                 :            :          * failed because of internal error.
     314                 :            :          */
     315                 :            : 
     316                 :            :         /* When the app stops, free up memory that we allocated. */
     317         [ #  # ]:         24 :         spdk_dma_free(hello_context.buff);
     318                 :            : 
     319                 :            :         /* Gracefully close out all of the SPDK subsystems. */
     320                 :         24 :         spdk_app_fini();
     321                 :         24 :         return rc;
     322                 :            : }

Generated by: LCOV version 1.15