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