eal: do not panic on interrupt thread init
[dpdk.git] / lib / librte_eal / bsdapp / eal / eal.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
5  *   Copyright(c) 2014 6WIND S.A.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <stdint.h>
38 #include <string.h>
39 #include <stdarg.h>
40 #include <unistd.h>
41 #include <pthread.h>
42 #include <syslog.h>
43 #include <getopt.h>
44 #include <sys/file.h>
45 #include <stddef.h>
46 #include <errno.h>
47 #include <limits.h>
48 #include <errno.h>
49 #include <sys/mman.h>
50 #include <sys/queue.h>
51
52 #include <rte_common.h>
53 #include <rte_debug.h>
54 #include <rte_memory.h>
55 #include <rte_memzone.h>
56 #include <rte_launch.h>
57 #include <rte_eal.h>
58 #include <rte_eal_memconfig.h>
59 #include <rte_errno.h>
60 #include <rte_per_lcore.h>
61 #include <rte_lcore.h>
62 #include <rte_log.h>
63 #include <rte_random.h>
64 #include <rte_cycles.h>
65 #include <rte_string_fns.h>
66 #include <rte_cpuflags.h>
67 #include <rte_interrupts.h>
68 #include <rte_bus.h>
69 #include <rte_pci.h>
70 #include <rte_dev.h>
71 #include <rte_devargs.h>
72 #include <rte_common.h>
73 #include <rte_version.h>
74 #include <rte_atomic.h>
75 #include <malloc_heap.h>
76
77 #include "eal_private.h"
78 #include "eal_thread.h"
79 #include "eal_internal_cfg.h"
80 #include "eal_filesystem.h"
81 #include "eal_hugepages.h"
82 #include "eal_options.h"
83
84 #define MEMSIZE_IF_NO_HUGE_PAGE (64ULL * 1024ULL * 1024ULL)
85
86 /* Allow the application to print its usage message too if set */
87 static rte_usage_hook_t rte_application_usage_hook = NULL;
88 /* early configuration structure, when memory config is not mmapped */
89 static struct rte_mem_config early_mem_config;
90
91 /* define fd variable here, because file needs to be kept open for the
92  * duration of the program, as we hold a write lock on it in the primary proc */
93 static int mem_cfg_fd = -1;
94
95 static struct flock wr_lock = {
96                 .l_type = F_WRLCK,
97                 .l_whence = SEEK_SET,
98                 .l_start = offsetof(struct rte_mem_config, memseg),
99                 .l_len = sizeof(early_mem_config.memseg),
100 };
101
102 /* Address of global and public configuration */
103 static struct rte_config rte_config = {
104                 .mem_config = &early_mem_config,
105 };
106
107 /* internal configuration (per-core) */
108 struct lcore_config lcore_config[RTE_MAX_LCORE];
109
110 /* internal configuration */
111 struct internal_config internal_config;
112
113 /* used by rte_rdtsc() */
114 int rte_cycles_vmware_tsc_map;
115
116 /* Return a pointer to the configuration structure */
117 struct rte_config *
118 rte_eal_get_configuration(void)
119 {
120         return &rte_config;
121 }
122
123 /* parse a sysfs (or other) file containing one integer value */
124 int
125 eal_parse_sysfs_value(const char *filename, unsigned long *val)
126 {
127         FILE *f;
128         char buf[BUFSIZ];
129         char *end = NULL;
130
131         if ((f = fopen(filename, "r")) == NULL) {
132                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
133                         __func__, filename);
134                 return -1;
135         }
136
137         if (fgets(buf, sizeof(buf), f) == NULL) {
138                 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
139                         __func__, filename);
140                 fclose(f);
141                 return -1;
142         }
143         *val = strtoul(buf, &end, 0);
144         if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
145                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
146                                 __func__, filename);
147                 fclose(f);
148                 return -1;
149         }
150         fclose(f);
151         return 0;
152 }
153
154
155 /* create memory configuration in shared/mmap memory. Take out
156  * a write lock on the memsegs, so we can auto-detect primary/secondary.
157  * This means we never close the file while running (auto-close on exit).
158  * We also don't lock the whole file, so that in future we can use read-locks
159  * on other parts, e.g. memzones, to detect if there are running secondary
160  * processes. */
161 static void
162 rte_eal_config_create(void)
163 {
164         void *rte_mem_cfg_addr;
165         int retval;
166
167         const char *pathname = eal_runtime_config_path();
168
169         if (internal_config.no_shconf)
170                 return;
171
172         if (mem_cfg_fd < 0){
173                 mem_cfg_fd = open(pathname, O_RDWR | O_CREAT, 0660);
174                 if (mem_cfg_fd < 0)
175                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
176         }
177
178         retval = ftruncate(mem_cfg_fd, sizeof(*rte_config.mem_config));
179         if (retval < 0){
180                 close(mem_cfg_fd);
181                 rte_panic("Cannot resize '%s' for rte_mem_config\n", pathname);
182         }
183
184         retval = fcntl(mem_cfg_fd, F_SETLK, &wr_lock);
185         if (retval < 0){
186                 close(mem_cfg_fd);
187                 rte_exit(EXIT_FAILURE, "Cannot create lock on '%s'. Is another primary "
188                                 "process running?\n", pathname);
189         }
190
191         rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
192                                 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
193
194         if (rte_mem_cfg_addr == MAP_FAILED){
195                 rte_panic("Cannot mmap memory for rte_config\n");
196         }
197         memcpy(rte_mem_cfg_addr, &early_mem_config, sizeof(early_mem_config));
198         rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
199 }
200
201 /* attach to an existing shared memory config */
202 static void
203 rte_eal_config_attach(void)
204 {
205         void *rte_mem_cfg_addr;
206         const char *pathname = eal_runtime_config_path();
207
208         if (internal_config.no_shconf)
209                 return;
210
211         if (mem_cfg_fd < 0){
212                 mem_cfg_fd = open(pathname, O_RDWR);
213                 if (mem_cfg_fd < 0)
214                         rte_panic("Cannot open '%s' for rte_mem_config\n", pathname);
215         }
216
217         rte_mem_cfg_addr = mmap(NULL, sizeof(*rte_config.mem_config),
218                                 PROT_READ | PROT_WRITE, MAP_SHARED, mem_cfg_fd, 0);
219         close(mem_cfg_fd);
220         if (rte_mem_cfg_addr == MAP_FAILED)
221                 rte_panic("Cannot mmap memory for rte_config\n");
222
223         rte_config.mem_config = (struct rte_mem_config *) rte_mem_cfg_addr;
224 }
225
226 /* Detect if we are a primary or a secondary process */
227 enum rte_proc_type_t
228 eal_proc_type_detect(void)
229 {
230         enum rte_proc_type_t ptype = RTE_PROC_PRIMARY;
231         const char *pathname = eal_runtime_config_path();
232
233         /* if we can open the file but not get a write-lock we are a secondary
234          * process. NOTE: if we get a file handle back, we keep that open
235          * and don't close it to prevent a race condition between multiple opens */
236         if (((mem_cfg_fd = open(pathname, O_RDWR)) >= 0) &&
237                         (fcntl(mem_cfg_fd, F_SETLK, &wr_lock) < 0))
238                 ptype = RTE_PROC_SECONDARY;
239
240         RTE_LOG(INFO, EAL, "Auto-detected process type: %s\n",
241                         ptype == RTE_PROC_PRIMARY ? "PRIMARY" : "SECONDARY");
242
243         return ptype;
244 }
245
246 /* Sets up rte_config structure with the pointer to shared memory config.*/
247 static void
248 rte_config_init(void)
249 {
250         rte_config.process_type = internal_config.process_type;
251
252         switch (rte_config.process_type){
253         case RTE_PROC_PRIMARY:
254                 rte_eal_config_create();
255                 break;
256         case RTE_PROC_SECONDARY:
257                 rte_eal_config_attach();
258                 rte_eal_mcfg_wait_complete(rte_config.mem_config);
259                 break;
260         case RTE_PROC_AUTO:
261         case RTE_PROC_INVALID:
262                 rte_panic("Invalid process type\n");
263         }
264 }
265
266 /* display usage */
267 static void
268 eal_usage(const char *prgname)
269 {
270         printf("\nUsage: %s ", prgname);
271         eal_common_usage();
272         /* Allow the application to print its usage message too if hook is set */
273         if ( rte_application_usage_hook ) {
274                 printf("===== Application Usage =====\n\n");
275                 rte_application_usage_hook(prgname);
276         }
277 }
278
279 /* Set a per-application usage message */
280 rte_usage_hook_t
281 rte_set_application_usage_hook( rte_usage_hook_t usage_func )
282 {
283         rte_usage_hook_t        old_func;
284
285         /* Will be NULL on the first call to denote the last usage routine. */
286         old_func                                        = rte_application_usage_hook;
287         rte_application_usage_hook      = usage_func;
288
289         return old_func;
290 }
291
292 static inline size_t
293 eal_get_hugepage_mem_size(void)
294 {
295         uint64_t size = 0;
296         unsigned i, j;
297
298         for (i = 0; i < internal_config.num_hugepage_sizes; i++) {
299                 struct hugepage_info *hpi = &internal_config.hugepage_info[i];
300                 if (hpi->hugedir != NULL) {
301                         for (j = 0; j < RTE_MAX_NUMA_NODES; j++) {
302                                 size += hpi->hugepage_sz * hpi->num_pages[j];
303                         }
304                 }
305         }
306
307         return (size < SIZE_MAX) ? (size_t)(size) : SIZE_MAX;
308 }
309
310 /* Parse the arguments for --log-level only */
311 static void
312 eal_log_level_parse(int argc, char **argv)
313 {
314         int opt;
315         char **argvopt;
316         int option_index;
317         const int old_optind = optind;
318         const int old_optopt = optopt;
319         const int old_optreset = optreset;
320         char * const old_optarg = optarg;
321
322         argvopt = argv;
323         optind = 1;
324         optreset = 1;
325
326         eal_reset_internal_config(&internal_config);
327
328         while ((opt = getopt_long(argc, argvopt, eal_short_options,
329                                   eal_long_options, &option_index)) != EOF) {
330
331                 int ret;
332
333                 /* getopt is not happy, stop right now */
334                 if (opt == '?')
335                         break;
336
337                 ret = (opt == OPT_LOG_LEVEL_NUM) ?
338                         eal_parse_common_option(opt, optarg, &internal_config) : 0;
339
340                 /* common parser is not happy */
341                 if (ret < 0)
342                         break;
343         }
344
345         /* restore getopt lib */
346         optind = old_optind;
347         optopt = old_optopt;
348         optreset = old_optreset;
349         optarg = old_optarg;
350 }
351
352 /* Parse the argument given in the command line of the application */
353 static int
354 eal_parse_args(int argc, char **argv)
355 {
356         int opt, ret;
357         char **argvopt;
358         int option_index;
359         char *prgname = argv[0];
360         const int old_optind = optind;
361         const int old_optopt = optopt;
362         const int old_optreset = optreset;
363         char * const old_optarg = optarg;
364
365         argvopt = argv;
366         optind = 1;
367         optreset = 1;
368
369         while ((opt = getopt_long(argc, argvopt, eal_short_options,
370                                   eal_long_options, &option_index)) != EOF) {
371
372                 /* getopt is not happy, stop right now */
373                 if (opt == '?') {
374                         eal_usage(prgname);
375                         ret = -1;
376                         goto out;
377                 }
378
379                 ret = eal_parse_common_option(opt, optarg, &internal_config);
380                 /* common parser is not happy */
381                 if (ret < 0) {
382                         eal_usage(prgname);
383                         ret = -1;
384                         goto out;
385                 }
386                 /* common parser handled this option */
387                 if (ret == 0)
388                         continue;
389
390                 switch (opt) {
391                 case 'h':
392                         eal_usage(prgname);
393                         exit(EXIT_SUCCESS);
394                 default:
395                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
396                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
397                                         "on FreeBSD\n", opt);
398                         } else if (opt >= OPT_LONG_MIN_NUM &&
399                                    opt < OPT_LONG_MAX_NUM) {
400                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
401                                         "on FreeBSD\n",
402                                         eal_long_options[option_index].name);
403                         } else {
404                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
405                                         "on FreeBSD\n", opt);
406                         }
407                         eal_usage(prgname);
408                         ret = -1;
409                         goto out;
410                 }
411         }
412
413         if (eal_adjust_config(&internal_config) != 0) {
414                 ret = -1;
415                 goto out;
416         }
417
418         /* sanity checks */
419         if (eal_check_common_options(&internal_config) != 0) {
420                 eal_usage(prgname);
421                 ret = -1;
422                 goto out;
423         }
424
425         if (optind >= 0)
426                 argv[optind-1] = prgname;
427         ret = optind-1;
428
429 out:
430         /* restore getopt lib */
431         optind = old_optind;
432         optopt = old_optopt;
433         optreset = old_optreset;
434         optarg = old_optarg;
435
436         return ret;
437 }
438
439 static void
440 eal_check_mem_on_local_socket(void)
441 {
442         const struct rte_memseg *ms;
443         int i, socket_id;
444
445         socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
446
447         ms = rte_eal_get_physmem_layout();
448
449         for (i = 0; i < RTE_MAX_MEMSEG; i++)
450                 if (ms[i].socket_id == socket_id &&
451                                 ms[i].len > 0)
452                         return;
453
454         RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
455                         "memory on local socket!\n");
456 }
457
458 static int
459 sync_func(__attribute__((unused)) void *arg)
460 {
461         return 0;
462 }
463
464 inline static void
465 rte_eal_mcfg_complete(void)
466 {
467         /* ALL shared mem_config related INIT DONE */
468         if (rte_config.process_type == RTE_PROC_PRIMARY)
469                 rte_config.mem_config->magic = RTE_MAGIC;
470 }
471
472 /* return non-zero if hugepages are enabled. */
473 int rte_eal_has_hugepages(void)
474 {
475         return !internal_config.no_hugetlbfs;
476 }
477
478 /* Abstraction for port I/0 privilege */
479 int
480 rte_eal_iopl_init(void)
481 {
482         static int fd;
483
484         fd = open("/dev/io", O_RDWR);
485         if (fd < 0)
486                 return -1;
487         /* keep fd open for iopl */
488         return 0;
489 }
490
491 static void rte_eal_init_alert(const char *msg)
492 {
493         fprintf(stderr, "EAL: FATAL: %s\n", msg);
494         RTE_LOG(ERR, EAL, "%s\n", msg);
495 }
496
497 /* Launch threads, called at application init(). */
498 int
499 rte_eal_init(int argc, char **argv)
500 {
501         int i, fctret, ret;
502         pthread_t thread_id;
503         static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
504         char cpuset[RTE_CPU_AFFINITY_STR_LEN];
505         char thread_name[RTE_MAX_THREAD_NAME_LEN];
506
507         /* checks if the machine is adequate */
508         if (!rte_cpu_is_supported()) {
509                 rte_eal_init_alert("unsupported cpu type.");
510                 rte_errno = ENOTSUP;
511                 return -1;
512         }
513
514         if (!rte_atomic32_test_and_set(&run_once)) {
515                 rte_eal_init_alert("already called initialization.");
516                 rte_errno = EALREADY;
517                 return -1;
518         }
519
520         thread_id = pthread_self();
521
522         eal_log_level_parse(argc, argv);
523
524         /* set log level as early as possible */
525         rte_set_log_level(internal_config.log_level);
526
527         if (rte_eal_cpu_init() < 0) {
528                 rte_eal_init_alert("Cannot detect lcores.");
529                 rte_errno = ENOTSUP;
530                 return -1;
531         }
532
533         fctret = eal_parse_args(argc, argv);
534         if (fctret < 0) {
535                 rte_eal_init_alert("Invalid 'command line' arguments.");
536                 rte_errno = EINVAL;
537                 rte_atomic32_clear(&run_once);
538                 return -1;
539         }
540
541         if (internal_config.no_hugetlbfs == 0 &&
542                         internal_config.process_type != RTE_PROC_SECONDARY &&
543                         eal_hugepage_info_init() < 0) {
544                 rte_eal_init_alert("Cannot get hugepage information.");
545                 rte_errno = EACCES;
546                 rte_atomic32_clear(&run_once);
547                 return -1;
548         }
549
550         if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
551                 if (internal_config.no_hugetlbfs)
552                         internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
553                 else
554                         internal_config.memory = eal_get_hugepage_mem_size();
555         }
556
557         if (internal_config.vmware_tsc_map == 1) {
558 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
559                 rte_cycles_vmware_tsc_map = 1;
560                 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
561                                 "you must have monitor_control.pseudo_perfctr = TRUE\n");
562 #else
563                 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
564                                 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
565 #endif
566         }
567
568         rte_srand(rte_rdtsc());
569
570         rte_config_init();
571
572         if (rte_eal_memory_init() < 0) {
573                 rte_eal_init_alert("Cannot init memory\n");
574                 rte_errno = ENOMEM;
575                 return -1;
576         }
577
578         if (rte_eal_memzone_init() < 0) {
579                 rte_eal_init_alert("Cannot init memzone\n");
580                 rte_errno = ENODEV;
581                 return -1;
582         }
583
584         if (rte_eal_tailqs_init() < 0) {
585                 rte_eal_init_alert("Cannot init tail queues for objects\n");
586                 rte_errno = EFAULT;
587                 return -1;
588         }
589
590         if (rte_eal_alarm_init() < 0) {
591                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
592                 /* rte_eal_alarm_init sets rte_errno on failure. */
593                 return -1;
594         }
595
596         if (rte_eal_intr_init() < 0) {
597                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
598                 return -1;
599         }
600
601         if (rte_eal_timer_init() < 0) {
602                 rte_eal_init_alert("Cannot init HPET or TSC timers\n");
603                 rte_errno = ENOTSUP;
604                 return -1;
605         }
606
607         if (rte_eal_pci_init() < 0)
608                 rte_panic("Cannot init PCI\n");
609
610         eal_check_mem_on_local_socket();
611
612         if (eal_plugins_init() < 0)
613                 rte_panic("Cannot init plugins\n");
614
615         eal_thread_init_master(rte_config.master_lcore);
616
617         ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
618
619         RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
620                 rte_config.master_lcore, thread_id, cpuset,
621                 ret == 0 ? "" : "...");
622
623         if (rte_bus_scan())
624                 rte_panic("Cannot scan the buses for devices\n");
625
626         RTE_LCORE_FOREACH_SLAVE(i) {
627
628                 /*
629                  * create communication pipes between master thread
630                  * and children
631                  */
632                 if (pipe(lcore_config[i].pipe_master2slave) < 0)
633                         rte_panic("Cannot create pipe\n");
634                 if (pipe(lcore_config[i].pipe_slave2master) < 0)
635                         rte_panic("Cannot create pipe\n");
636
637                 lcore_config[i].state = WAIT;
638
639                 /* create a thread for each lcore */
640                 ret = pthread_create(&lcore_config[i].thread_id, NULL,
641                                      eal_thread_loop, NULL);
642                 if (ret != 0)
643                         rte_panic("Cannot create thread\n");
644
645                 /* Set thread_name for aid in debugging. */
646                 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
647                                 "lcore-slave-%d", i);
648                 rte_thread_setname(lcore_config[i].thread_id, thread_name);
649         }
650
651         /*
652          * Launch a dummy function on all slave lcores, so that master lcore
653          * knows they are all ready when this function returns.
654          */
655         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
656         rte_eal_mp_wait_lcore();
657
658         /* Probe all the buses and devices/drivers on them */
659         if (rte_bus_probe())
660                 rte_panic("Cannot probe devices\n");
661
662         /* Probe & Initialize PCI devices */
663         if (rte_eal_pci_probe())
664                 rte_panic("Cannot probe PCI\n");
665
666         if (rte_eal_dev_init() < 0)
667                 rte_panic("Cannot init pmd devices\n");
668
669         rte_eal_mcfg_complete();
670
671         return fctret;
672 }
673
674 /* get core role */
675 enum rte_lcore_role_t
676 rte_eal_lcore_role(unsigned lcore_id)
677 {
678         return rte_config.lcore_role[lcore_id];
679 }
680
681 enum rte_proc_type_t
682 rte_eal_process_type(void)
683 {
684         return rte_config.process_type;
685 }