lib/librte_eal/windows/eal.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2019 Intel Corporation
   3  */
   4
   5 #include <fcntl.h>
   6 #include <io.h>
   7 #include <share.h>
   8 #include <sys/stat.h>
   9
  10 #include <rte_debug.h>
  11 #include <rte_eal.h>
  12 #include <eal_memcfg.h>
  13 #include <rte_errno.h>
  14 #include <rte_lcore.h>
  15 #include <eal_thread.h>
  16 #include <eal_internal_cfg.h>
  17 #include <eal_filesystem.h>
  18 #include <eal_options.h>
  19 #include <eal_private.h>
  20 #include <rte_vfio.h>
  21
  22 #include "eal_hugepages.h"
  23 #include "eal_trace.h"
  24 #include "eal_windows.h"
  25
  26 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
  27
  28 /* define fd variable here, because file needs to be kept open for the
  29  * duration of the program, as we hold a write lock on it in the primary proc
  30  */
  31 static int mem_cfg_fd = -1;
  32
  33 /* internal configuration (per-core) */
  34 struct lcore_config lcore_config[RTE_MAX_LCORE];
  35
  36 /* Detect if we are a primary or a secondary process */
  37 enum rte_proc_type_t
  38 eal_proc_type_detect(void)
  39 {
  40         enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
  41         const char *pathname = eal_runtime_config_path();
  42         const struct rte_config *config = rte_eal_get_configuration();
  43
  44         /* if we can open the file but not get a write-lock we are a secondary
  45          * process. NOTE: if we get a file handle back, we keep that open
  46          * and don't close it to prevent a race condition between multiple opens
  47          */
  48         errno_t err = _sopen_s(&mem_cfg_fd, pathname,
  49                 _O_RDWR, _SH_DENYNO, _S_IREAD | _S_IWRITE);
  50         if (err == 0) {
  51                 OVERLAPPED soverlapped = { 0 };
  52                 soverlapped.Offset = sizeof(*config->mem_config);
  53                 soverlapped.OffsetHigh = 0;
  54
  55                 HANDLE hwinfilehandle = (HANDLE)_get_osfhandle(mem_cfg_fd);
  56
  57                 if (!LockFileEx(hwinfilehandle,
  58                         LOCKFILE_EXCLUSIVE_LOCK | LOCKFILE_FAIL_IMMEDIATELY, 0,
  59                         sizeof(*config->mem_config), 0, &soverlapped))
  60                         ptype = RTE_PROC_SECONDARY;
  61         }
  62
  63         RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
  64                 ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
  65
  66         return ptype;
  67 }
  68
  69 /* display usage */
  70 static void
  71 eal_usage(const char *prgname)
  72 {
  73         rte_usage_hook_t hook = eal_get_application_usage_hook();
  74
  75         printf("\nUsage: %s ", prgname);
  76         eal_common_usage();
  77         /* Allow the application to print its usage message too
  78          * if hook is set
  79          */
  80         if (hook) {
  81                 printf("===== Application Usage =====\n\n");
  82                 (hook)(prgname);
  83         }
  84 }
  85
  86 /* Parse the arguments for --log-level only */
  87 static void
  88 eal_log_level_parse(int argc, char **argv)
  89 {
  90         int opt;
  91         char **argvopt;
  92         int option_index;
  93         struct internal_config *internal_conf =
  94                 eal_get_internal_configuration();
  95
  96         argvopt = argv;
  97
  98         eal_reset_internal_config(internal_conf);
  99
 100         while ((opt = getopt_long(argc, argvopt, eal_short_options,
 101                 eal_long_options, &option_index)) != EOF) {
 102
 103                 int ret;
 104
 105                 /* getopt is not happy, stop right now */
 106                 if (opt == '?')
 107                         break;
 108
 109                 ret = (opt == OPT_LOG_LEVEL_NUM) ?
 110                         eal_parse_common_option(opt, optarg,
 111                                 internal_conf) : 0;
 112
 113                 /* common parser is not happy */
 114                 if (ret < 0)
 115                         break;
 116         }
 117
 118         optind = 0; /* reset getopt lib */
 119 }
 120
 121 /* Parse the argument given in the command line of the application */
 122 static int
 123 eal_parse_args(int argc, char **argv)
 124 {
 125         int opt, ret;
 126         char **argvopt;
 127         int option_index;
 128         char *prgname = argv[0];
 129         struct internal_config *internal_conf =
 130                 eal_get_internal_configuration();
 131
 132         argvopt = argv;
 133
 134         while ((opt = getopt_long(argc, argvopt, eal_short_options,
 135                 eal_long_options, &option_index)) != EOF) {
 136
 137                 int ret;
 138
 139                 /* getopt is not happy, stop right now */
 140                 if (opt == '?') {
 141                         eal_usage(prgname);
 142                         return -1;
 143                 }
 144
 145                 ret = eal_parse_common_option(opt, optarg, internal_conf);
 146                 /* common parser is not happy */
 147                 if (ret < 0) {
 148                         eal_usage(prgname);
 149                         return -1;
 150                 }
 151                 /* common parser handled this option */
 152                 if (ret == 0)
 153                         continue;
 154
 155                 switch (opt) {
 156                 case 'h':
 157                         eal_usage(prgname);
 158                         exit(EXIT_SUCCESS);
 159                 default:
 160                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
 161                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
 162                                         "on Windows\n", opt);
 163                         } else if (opt >= OPT_LONG_MIN_NUM &&
 164                                 opt < OPT_LONG_MAX_NUM) {
 165                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
 166                                         "on Windows\n",
 167                                         eal_long_options[option_index].name);
 168                         } else {
 169                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
 170                                         "on Windows\n", opt);
 171                         }
 172                         eal_usage(prgname);
 173                         return -1;
 174                 }
 175         }
 176
 177         if (eal_adjust_config(internal_conf) != 0)
 178                 return -1;
 179
 180         /* sanity checks */
 181         if (eal_check_common_options(internal_conf) != 0) {
 182                 eal_usage(prgname);
 183                 return -1;
 184         }
 185
 186         if (optind >= 0)
 187                 argv[optind - 1] = prgname;
 188         ret = optind - 1;
 189         optind = 0; /* reset getopt lib */
 190         return ret;
 191 }
 192
 193 static int
 194 sync_func(void *arg __rte_unused)
 195 {
 196         return 0;
 197 }
 198
 199 static void
 200 rte_eal_init_alert(const char *msg)
 201 {
 202         fprintf(stderr, "EAL: FATAL: %s\n", msg);
 203         RTE_LOG(ERR, EAL, "%s\n", msg);
 204 }
 205
 206 /* Stubs to enable EAL trace point compilation
 207  * until eal_common_trace.c can be compiled.
 208  */
 209
 210 RTE_DEFINE_PER_LCORE(volatile int, trace_point_sz);
 211 RTE_DEFINE_PER_LCORE(void *, trace_mem);
 212
 213 void
 214 __rte_trace_mem_per_thread_alloc(void)
 215 {
 216 }
 217
 218 void
 219 trace_mem_per_thread_free(void)
 220 {
 221 }
 222
 223 void
 224 __rte_trace_point_emit_field(size_t sz, const char *field,
 225         const char *type)
 226 {
 227         RTE_SET_USED(sz);
 228         RTE_SET_USED(field);
 229         RTE_SET_USED(type);
 230 }
 231
 232 int
 233 __rte_trace_point_register(rte_trace_point_t *trace, const char *name,
 234         void (*register_fn)(void))
 235 {
 236         RTE_SET_USED(trace);
 237         RTE_SET_USED(name);
 238         RTE_SET_USED(register_fn);
 239         return -ENOTSUP;
 240 }
 241
 242 int
 243 rte_eal_cleanup(void)
 244 {
 245         struct internal_config *internal_conf =
 246                 eal_get_internal_configuration();
 247
 248         eal_cleanup_config(internal_conf);
 249         return 0;
 250 }
 251
 252 /* Launch threads, called at application init(). */
 253 int
 254 rte_eal_init(int argc, char **argv)
 255 {
 256         int i, fctret, bscan;
 257         const struct rte_config *config = rte_eal_get_configuration();
 258         struct internal_config *internal_conf =
 259                 eal_get_internal_configuration();
 260
 261         rte_eal_log_init(NULL, 0);
 262
 263         eal_log_level_parse(argc, argv);
 264
 265         if (eal_create_cpu_map() < 0) {
 266                 rte_eal_init_alert("Cannot discover CPU and NUMA.");
 267                 /* rte_errno is set */
 268                 return -1;
 269         }
 270
 271         if (rte_eal_cpu_init() < 0) {
 272                 rte_eal_init_alert("Cannot detect lcores.");
 273                 rte_errno = ENOTSUP;
 274                 return -1;
 275         }
 276
 277         fctret = eal_parse_args(argc, argv);
 278         if (fctret < 0)
 279                 exit(1);
 280
 281         /* Prevent creation of shared memory files. */
 282         if (internal_conf->in_memory == 0) {
 283                 RTE_LOG(WARNING, EAL, "Multi-process support is requested, "
 284                         "but not available.\n");
 285                 internal_conf->in_memory = 1;
 286         }
 287
 288         if (!internal_conf->no_hugetlbfs && (eal_hugepage_info_init() < 0)) {
 289                 rte_eal_init_alert("Cannot get hugepage information");
 290                 rte_errno = EACCES;
 291                 return -1;
 292         }
 293
 294         if (internal_conf->memory == 0 && !internal_conf->force_sockets) {
 295                 if (internal_conf->no_hugetlbfs)
 296                         internal_conf->memory = MEMSIZE_IF_NO_HUGE_PAGE;
 297         }
 298
 299         if (eal_mem_win32api_init() < 0) {
 300                 rte_eal_init_alert("Cannot access Win32 memory management");
 301                 rte_errno = ENOTSUP;
 302                 return -1;
 303         }
 304
 305         if (eal_mem_virt2iova_init() < 0) {
 306                 /* Non-fatal error if physical addresses are not required. */
 307                 RTE_LOG(WARNING, EAL, "Cannot access virt2phys driver, "
 308                         "PA will not be available\n");
 309         }
 310
 311         if (rte_eal_memzone_init() < 0) {
 312                 rte_eal_init_alert("Cannot init memzone");
 313                 rte_errno = ENODEV;
 314                 return -1;
 315         }
 316
 317         if (rte_eal_memory_init() < 0) {
 318                 rte_eal_init_alert("Cannot init memory");
 319                 rte_errno = ENOMEM;
 320                 return -1;
 321         }
 322
 323         if (rte_eal_malloc_heap_init() < 0) {
 324                 rte_eal_init_alert("Cannot init malloc heap");
 325                 rte_errno = ENODEV;
 326                 return -1;
 327         }
 328
 329         if (rte_eal_tailqs_init() < 0) {
 330                 rte_eal_init_alert("Cannot init tail queues for objects");
 331                 rte_errno = EFAULT;
 332                 return -1;
 333         }
 334
 335         if (rte_eal_timer_init() < 0) {
 336                 rte_eal_init_alert("Cannot init TSC timer");
 337                 rte_errno = EFAULT;
 338                 return -1;
 339         }
 340
 341         __rte_thread_init(config->master_lcore,
 342                 &lcore_config[config->master_lcore].cpuset);
 343
 344         bscan = rte_bus_scan();
 345         if (bscan < 0) {
 346                 rte_eal_init_alert("Cannot init PCI");
 347                 rte_errno = ENODEV;
 348                 return -1;
 349         }
 350
 351         RTE_LCORE_FOREACH_SLAVE(i) {
 352
 353                 /*
 354                  * create communication pipes between master thread
 355                  * and children
 356                  */
 357                 if (_pipe(lcore_config[i].pipe_master2slave,
 358                         sizeof(char), _O_BINARY) < 0)
 359                         rte_panic("Cannot create pipe\n");
 360                 if (_pipe(lcore_config[i].pipe_slave2master,
 361                         sizeof(char), _O_BINARY) < 0)
 362                         rte_panic("Cannot create pipe\n");
 363
 364                 lcore_config[i].state = WAIT;
 365
 366                 /* create a thread for each lcore */
 367                 if (eal_thread_create(&lcore_config[i].thread_id) != 0)
 368                         rte_panic("Cannot create thread\n");
 369         }
 370
 371         /*
 372          * Launch a dummy function on all slave lcores, so that master lcore
 373          * knows they are all ready when this function returns.
 374          */
 375         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
 376         rte_eal_mp_wait_lcore();
 377         return fctret;
 378 }
 379
 380 int
 381 rte_vfio_container_dma_map(__rte_unused int container_fd,
 382                         __rte_unused uint64_t vaddr,
 383                         __rte_unused uint64_t iova,
 384                         __rte_unused uint64_t len)
 385 {
 386         return -1;
 387 }
 388
 389 int
 390 rte_vfio_container_dma_unmap(__rte_unused int container_fd,
 391                         __rte_unused uint64_t vaddr,
 392                         __rte_unused uint64_t iova,
 393                         __rte_unused uint64_t len)
 394 {
 395         return -1;
 396 }