nuttx-apps/examples/sotest/main/sotest_main.c

/****************************************************************************
 * apps/examples/sotest/main/sotest_main.c
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 ****************************************************************************/

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
#  include <sys/mount.h>
#  include <sys/boardctl.h>
#endif

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <syslog.h>
#include <dlfcn.h>
#include <errno.h>
#include <nuttx/debug.h>
#include <unistd.h>

#include <nuttx/symtab.h>

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
#  include <nuttx/drivers/ramdisk.h>
#endif

/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/

/* Check configuration.  This is not all of the configuration settings that
 * are required -- only the more obvious.
 */

#ifndef CONFIG_LIBC_DLFCN
#  error "You must select CONFIG_LIBC_DLFCN in your configuration file"
#endif

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
#  ifndef CONFIG_FS_ROMFS
#    error "You must select CONFIG_FS_ROMFS in your configuration file"
#  endif

#  ifdef CONFIG_DISABLE_MOUNTPOINT
#    error "You must not disable mountpoints via CONFIG_DISABLE_MOUNTPOINT in your configuration file"
#  endif

  /* Describe the ROMFS file system */

#  define SECTORSIZE   64
#  define NSECTORS(b)  (((b)+SECTORSIZE-1)/SECTORSIZE)
#  define BINDIR       "/mnt/sotest/romfs"

#  ifndef CONFIG_EXAMPLES_SOTEST_DEVMINOR_MAX
#    define CONFIG_EXAMPLES_SOTEST_DEVMINOR_MAX 5
#  endif
#else
#  define BINDIR       CONFIG_EXAMPLES_SOTEST_BINDIR
#endif /* CONFIG_EXAMPLES_SOTEST_BUILTINFS */

#define SOTEST_DEVPATH_FMT "/dev/ram%d"

/****************************************************************************
 * Private Functions
 ****************************************************************************/

static void sotest_show_usage(FAR const char *progname)
{
#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  fprintf(stderr,
          "Usage: %s [--mount] [<modprint-path> <sotest-path>]\n",
          progname);
#else
  fprintf(stderr, "Usage: %s [--mount] [<sotest-path>]\n", progname);
#endif
}

/****************************************************************************
 * Symbols from Auto-Generated Code
 ****************************************************************************/

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
extern const unsigned char sotest_romfs_img[];
extern const unsigned int sotest_romfs_img_len;
#endif

extern const struct symtab_s g_sot_exports[];
extern const int g_sot_nexports;

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: sotest_main
 ****************************************************************************/

int main(int argc, FAR char *argv[])
{
  FAR const char *modprint_path = NULL;
  FAR const char *sotest_path = NULL;
  bool mount_only = false;
#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
  bool mounted_builtinfs = false;
  char devname[32];
#endif
#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  FAR void *handle1;
#endif
  FAR void *handle2;
  CODE void (*testfunc)(FAR const char *msg);
  FAR const char *msg;
  int ret;
#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
  struct boardioc_romdisk_s desc;
#endif

#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  if (argc == 2 && strcmp(argv[1], "--mount") == 0)
    {
      mount_only = true;
    }
  else if (argc == 3)
    {
      modprint_path = argv[1];
      sotest_path = argv[2];
    }
  else if (argc != 1)
    {
      sotest_show_usage(argv[0]);
      return EXIT_FAILURE;
    }
#else
  if (argc == 2 && strcmp(argv[1], "--mount") == 0)
    {
      mount_only = true;
    }
  else if (argc == 2)
    {
      sotest_path = argv[1];
    }
  else if (argc != 1)
    {
      sotest_show_usage(argv[0]);
      return EXIT_FAILURE;
    }
#endif

  /* Set the shared library symbol table */

  ret = dlsymtab((FAR struct symtab_s *)g_sot_exports, g_sot_nexports);
  if (ret < 0)
    {
      fprintf(stderr, "ERROR: dlsymtab failed: %d\n", ret);
      exit(EXIT_FAILURE);
    }

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
  if (sotest_path == NULL || mount_only)
    {
  /* Create a ROM disk for the ROMFS filesystem */

  desc.minor    = 0;                                   /* Minor device number of the ROM disk. */
  desc.nsectors = NSECTORS(sotest_romfs_img_len);      /* The number of sectors in the ROM disk */
  desc.sectsize = SECTORSIZE;                          /* The size of one sector in bytes */
  desc.image    = (FAR uint8_t *)sotest_romfs_img;     /* File system image */

  for (; desc.minor <= CONFIG_EXAMPLES_SOTEST_DEVMINOR_MAX; desc.minor++)
    {
      syslog(LOG_INFO, "main: Registering romdisk at /dev/ram%d\n",
             desc.minor);

      ret = boardctl(BOARDIOC_ROMDISK, (uintptr_t)&desc);
      if (ret >= 0)
        {
          break;
        }

      if (errno != EEXIST ||
          desc.minor == CONFIG_EXAMPLES_SOTEST_DEVMINOR_MAX)
        {
          fprintf(stderr, "ERROR: romdisk_register failed: %s\n",
                  strerror(errno));
          exit(EXIT_FAILURE);
        }
    }

  /* Mount the file system */

  sprintf(devname, SOTEST_DEVPATH_FMT, desc.minor);
  syslog(LOG_INFO, "main: Mounting ROMFS filesystem at "
         "target=%s with source=%s\n", BINDIR, devname);

  ret = mount(devname, BINDIR, "romfs", MS_RDONLY,
              NULL);
  if (ret < 0)
    {
      fprintf(stderr, "ERROR: mount(%s,%s,romfs) failed: %s\n",
              devname, BINDIR, strerror(errno));
      exit(EXIT_FAILURE);
    }

      mounted_builtinfs = true;
    }
#endif /* CONFIG_EXAMPLES_SOTEST_BUILTINFS */

  if (mount_only)
    {
      return EXIT_SUCCESS;
    }

#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  if (modprint_path == NULL)
    {
      modprint_path = BINDIR "/modprint";
    }
#endif

  if (sotest_path == NULL)
    {
      sotest_path = BINDIR "/sotest";
    }

#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  /* Install the first test shared library.  The first shared library only
   * verifies that symbols exported by one shared library can be used to
   * resolve undefined symbols in a second shared library.
   */

  handle1 = dlopen(modprint_path, RTLD_NOW | RTLD_LOCAL);
  if (handle1 == NULL)
    {
      fprintf(stderr, "ERROR: dlopen(%s) failed\n", modprint_path);
      exit(EXIT_FAILURE);
    }
#endif

  /* Install the second test shared library  */

  handle2 = dlopen(sotest_path, RTLD_NOW | RTLD_LOCAL);
  if (handle2 == NULL)
    {
      fprintf(stderr, "ERROR: dlopen(%s) failed\n", sotest_path);
      exit(EXIT_FAILURE);
    }

  /* Get symbols testfunc1 and msg1 from the second test shared library */

  testfunc = (CODE void (*)(FAR const char *))dlsym(handle2, "testfunc1");
  if (testfunc == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"testfunc1\"\n");
      exit(EXIT_FAILURE);
    }

  msg = (FAR const char *)dlsym(handle2, "g_msg1");
  if (msg == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"g_msg1\"\n");
      exit(EXIT_FAILURE);
    }

  /* Execute testfunc1 */

  testfunc(msg);

  /* Get symbols testfunc2 and msg2 */

  testfunc = (CODE void (*)(FAR const char *))dlsym(handle2, "testfunc2");
  if (testfunc == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"testfunc2\"\n");
      exit(EXIT_FAILURE);
    }

  msg = (FAR const char *)dlsym(handle2, "g_msg2");
  if (msg == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"g_msg2\"\n");
      exit(EXIT_FAILURE);
    }

  /* Execute testfunc2 */

  testfunc(msg);

  /* Get symbols testfunc3 and msg3 */

  testfunc = (CODE void (*)(FAR const char *))dlsym(handle2, "testfunc3");
  if (testfunc == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"testfunc3\"\n");
      exit(EXIT_FAILURE);
    }

  msg = (FAR const char *)dlsym(handle2, "g_msg3");
  if (msg == NULL)
    {
      fprintf(stderr, "ERROR: Failed to get symbol \"g_msg3\"\n");
      exit(EXIT_FAILURE);
    }

  /* Execute testfunc3 */

  testfunc(msg);

#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  /* This should fail because the second shared library depends on
   * the first.
   */

  ret = dlclose(handle1);
  if (ret == 0)
    {
      fprintf(stderr,
              "ERROR: dlclose(handle1) succeeded with a dependency\n");
      exit(EXIT_FAILURE);
    }
#endif

  /* Close the second shared library */

  ret = dlclose(handle2);
  if (ret < 0)
    {
      fprintf(stderr, "ERROR: dlclose(handle2) failed: %d\n", ret);
      exit(EXIT_FAILURE);
    }

#if CONFIG_LIBC_ELF_MAXDEPEND > 0
  /* Now we should be able to close the first shared library. */

  ret = dlclose(handle1);
  if (ret < 0)
    {
      fprintf(stderr, "ERROR: dlclose(handle1) failed: %d\n", ret);
      exit(EXIT_FAILURE);
    }
#endif

#ifdef CONFIG_EXAMPLES_SOTEST_BUILTINFS
  if (mounted_builtinfs)
    {
      ret = umount(BINDIR);
      if (ret < 0)
        {
          fprintf(stderr, "ERROR: umount(%s) failed: %d\n",
                  BINDIR, errno);
          exit(EXIT_FAILURE);
        }

      unlink(devname);
    }
#endif /* CONFIG_EXAMPLES_SOTEST_BUILTINFS */

  return EXIT_SUCCESS;
}