05f0c1f90d6236ca3930e18736dd757b3164ecc3
[deb_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 = 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 = 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         while ((opt = getopt_long(argc, argvopt, eal_short_options,
327                                   eal_long_options, &option_index)) != EOF) {
328
329                 int ret;
330
331                 /* getopt is not happy, stop right now */
332                 if (opt == '?')
333                         break;
334
335                 ret = (opt == OPT_LOG_LEVEL_NUM) ?
336                         eal_parse_common_option(opt, optarg, &internal_config) : 0;
337
338                 /* common parser is not happy */
339                 if (ret < 0)
340                         break;
341         }
342
343         /* restore getopt lib */
344         optind = old_optind;
345         optopt = old_optopt;
346         optreset = old_optreset;
347         optarg = old_optarg;
348 }
349
350 /* Parse the argument given in the command line of the application */
351 static int
352 eal_parse_args(int argc, char **argv)
353 {
354         int opt, ret;
355         char **argvopt;
356         int option_index;
357         char *prgname = argv[0];
358         const int old_optind = optind;
359         const int old_optopt = optopt;
360         const int old_optreset = optreset;
361         char * const old_optarg = optarg;
362
363         argvopt = argv;
364         optind = 1;
365         optreset = 1;
366
367         while ((opt = getopt_long(argc, argvopt, eal_short_options,
368                                   eal_long_options, &option_index)) != EOF) {
369
370                 /* getopt is not happy, stop right now */
371                 if (opt == '?') {
372                         eal_usage(prgname);
373                         ret = -1;
374                         goto out;
375                 }
376
377                 ret = eal_parse_common_option(opt, optarg, &internal_config);
378                 /* common parser is not happy */
379                 if (ret < 0) {
380                         eal_usage(prgname);
381                         ret = -1;
382                         goto out;
383                 }
384                 /* common parser handled this option */
385                 if (ret == 0)
386                         continue;
387
388                 switch (opt) {
389                 case 'h':
390                         eal_usage(prgname);
391                         exit(EXIT_SUCCESS);
392                 default:
393                         if (opt < OPT_LONG_MIN_NUM && isprint(opt)) {
394                                 RTE_LOG(ERR, EAL, "Option %c is not supported "
395                                         "on FreeBSD\n", opt);
396                         } else if (opt >= OPT_LONG_MIN_NUM &&
397                                    opt < OPT_LONG_MAX_NUM) {
398                                 RTE_LOG(ERR, EAL, "Option %s is not supported "
399                                         "on FreeBSD\n",
400                                         eal_long_options[option_index].name);
401                         } else {
402                                 RTE_LOG(ERR, EAL, "Option %d is not supported "
403                                         "on FreeBSD\n", opt);
404                         }
405                         eal_usage(prgname);
406                         ret = -1;
407                         goto out;
408                 }
409         }
410
411         if (eal_adjust_config(&internal_config) != 0) {
412                 ret = -1;
413                 goto out;
414         }
415
416         /* sanity checks */
417         if (eal_check_common_options(&internal_config) != 0) {
418                 eal_usage(prgname);
419                 ret = -1;
420                 goto out;
421         }
422
423         if (optind >= 0)
424                 argv[optind-1] = prgname;
425         ret = optind-1;
426
427 out:
428         /* restore getopt lib */
429         optind = old_optind;
430         optopt = old_optopt;
431         optreset = old_optreset;
432         optarg = old_optarg;
433
434         return ret;
435 }
436
437 static void
438 eal_check_mem_on_local_socket(void)
439 {
440         const struct rte_memseg *ms;
441         int i, socket_id;
442
443         socket_id = rte_lcore_to_socket_id(rte_config.master_lcore);
444
445         ms = rte_eal_get_physmem_layout();
446
447         for (i = 0; i < RTE_MAX_MEMSEG; i++)
448                 if (ms[i].socket_id == socket_id &&
449                                 ms[i].len > 0)
450                         return;
451
452         RTE_LOG(WARNING, EAL, "WARNING: Master core has no "
453                         "memory on local socket!\n");
454 }
455
456 static int
457 sync_func(__attribute__((unused)) void *arg)
458 {
459         return 0;
460 }
461
462 inline static void
463 rte_eal_mcfg_complete(void)
464 {
465         /* ALL shared mem_config related INIT DONE */
466         if (rte_config.process_type == RTE_PROC_PRIMARY)
467                 rte_config.mem_config->magic = RTE_MAGIC;
468 }
469
470 /* return non-zero if hugepages are enabled. */
471 int rte_eal_has_hugepages(void)
472 {
473         return !internal_config.no_hugetlbfs;
474 }
475
476 /* Abstraction for port I/0 privilege */
477 int
478 rte_eal_iopl_init(void)
479 {
480         static int fd;
481
482         fd = open("/dev/io", O_RDWR);
483         if (fd < 0)
484                 return -1;
485         /* keep fd open for iopl */
486         return 0;
487 }
488
489 static void rte_eal_init_alert(const char *msg)
490 {
491         fprintf(stderr, "EAL: FATAL: %s\n", msg);
492         RTE_LOG(ERR, EAL, "%s\n", msg);
493 }
494
495 /* Launch threads, called at application init(). */
496 int
497 rte_eal_init(int argc, char **argv)
498 {
499         int i, fctret, ret;
500         pthread_t thread_id;
501         static rte_atomic32_t run_once = RTE_ATOMIC32_INIT(0);
502         char cpuset[RTE_CPU_AFFINITY_STR_LEN];
503         char thread_name[RTE_MAX_THREAD_NAME_LEN];
504
505         /* checks if the machine is adequate */
506         if (!rte_cpu_is_supported()) {
507                 rte_eal_init_alert("unsupported cpu type.");
508                 rte_errno = ENOTSUP;
509                 return -1;
510         }
511
512         if (!rte_atomic32_test_and_set(&run_once)) {
513                 rte_eal_init_alert("already called initialization.");
514                 rte_errno = EALREADY;
515                 return -1;
516         }
517
518         thread_id = pthread_self();
519
520         eal_reset_internal_config(&internal_config);
521
522         /* set log level as early as possible */
523         eal_log_level_parse(argc, argv);
524
525         if (rte_eal_cpu_init() < 0) {
526                 rte_eal_init_alert("Cannot detect lcores.");
527                 rte_errno = ENOTSUP;
528                 return -1;
529         }
530
531         fctret = eal_parse_args(argc, argv);
532         if (fctret < 0) {
533                 rte_eal_init_alert("Invalid 'command line' arguments.");
534                 rte_errno = EINVAL;
535                 rte_atomic32_clear(&run_once);
536                 return -1;
537         }
538
539         if (internal_config.no_hugetlbfs == 0 &&
540                         internal_config.process_type != RTE_PROC_SECONDARY &&
541                         eal_hugepage_info_init() < 0) {
542                 rte_eal_init_alert("Cannot get hugepage information.");
543                 rte_errno = EACCES;
544                 rte_atomic32_clear(&run_once);
545                 return -1;
546         }
547
548         if (internal_config.memory == 0 && internal_config.force_sockets == 0) {
549                 if (internal_config.no_hugetlbfs)
550                         internal_config.memory = MEMSIZE_IF_NO_HUGE_PAGE;
551                 else
552                         internal_config.memory = eal_get_hugepage_mem_size();
553         }
554
555         if (internal_config.vmware_tsc_map == 1) {
556 #ifdef RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT
557                 rte_cycles_vmware_tsc_map = 1;
558                 RTE_LOG (DEBUG, EAL, "Using VMWARE TSC MAP, "
559                                 "you must have monitor_control.pseudo_perfctr = TRUE\n");
560 #else
561                 RTE_LOG (WARNING, EAL, "Ignoring --vmware-tsc-map because "
562                                 "RTE_LIBRTE_EAL_VMWARE_TSC_MAP_SUPPORT is not set\n");
563 #endif
564         }
565
566         rte_srand(rte_rdtsc());
567
568         rte_config_init();
569
570         if (rte_eal_memory_init() < 0) {
571                 rte_eal_init_alert("Cannot init memory\n");
572                 rte_errno = ENOMEM;
573                 return -1;
574         }
575
576         if (rte_eal_memzone_init() < 0) {
577                 rte_eal_init_alert("Cannot init memzone\n");
578                 rte_errno = ENODEV;
579                 return -1;
580         }
581
582         if (rte_eal_tailqs_init() < 0) {
583                 rte_eal_init_alert("Cannot init tail queues for objects\n");
584                 rte_errno = EFAULT;
585                 return -1;
586         }
587
588         if (rte_eal_alarm_init() < 0) {
589                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
590                 /* rte_eal_alarm_init sets rte_errno on failure. */
591                 return -1;
592         }
593
594         if (rte_eal_intr_init() < 0) {
595                 rte_eal_init_alert("Cannot init interrupt-handling thread\n");
596                 return -1;
597         }
598
599         if (rte_eal_timer_init() < 0) {
600                 rte_eal_init_alert("Cannot init HPET or TSC timers\n");
601                 rte_errno = ENOTSUP;
602                 return -1;
603         }
604
605         eal_check_mem_on_local_socket();
606
607         if (eal_plugins_init() < 0)
608                 rte_eal_init_alert("Cannot init plugins\n");
609
610         eal_thread_init_master(rte_config.master_lcore);
611
612         ret = eal_thread_dump_affinity(cpuset, RTE_CPU_AFFINITY_STR_LEN);
613
614         RTE_LOG(DEBUG, EAL, "Master lcore %u is ready (tid=%p;cpuset=[%s%s])\n",
615                 rte_config.master_lcore, thread_id, cpuset,
616                 ret == 0 ? "" : "...");
617
618         if (rte_bus_scan()) {
619                 rte_eal_init_alert("Cannot scan the buses for devices\n");
620                 rte_errno = ENODEV;
621                 return -1;
622         }
623
624         RTE_LCORE_FOREACH_SLAVE(i) {
625
626                 /*
627                  * create communication pipes between master thread
628                  * and children
629                  */
630                 if (pipe(lcore_config[i].pipe_master2slave) < 0)
631                         rte_panic("Cannot create pipe\n");
632                 if (pipe(lcore_config[i].pipe_slave2master) < 0)
633                         rte_panic("Cannot create pipe\n");
634
635                 lcore_config[i].state = WAIT;
636
637                 /* create a thread for each lcore */
638                 ret = pthread_create(&lcore_config[i].thread_id, NULL,
639                                      eal_thread_loop, NULL);
640                 if (ret != 0)
641                         rte_panic("Cannot create thread\n");
642
643                 /* Set thread_name for aid in debugging. */
644                 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
645                                 "lcore-slave-%d", i);
646                 rte_thread_setname(lcore_config[i].thread_id, thread_name);
647         }
648
649         /*
650          * Launch a dummy function on all slave lcores, so that master lcore
651          * knows they are all ready when this function returns.
652          */
653         rte_eal_mp_remote_launch(sync_func, NULL, SKIP_MASTER);
654         rte_eal_mp_wait_lcore();
655
656         /* Probe all the buses and devices/drivers on them */
657         if (rte_bus_probe()) {
658                 rte_eal_init_alert("Cannot probe devices\n");
659                 rte_errno = ENOTSUP;
660                 return -1;
661         }
662
663         rte_eal_mcfg_complete();
664
665         return fctret;
666 }
667
668 /* get core role */
669 enum rte_lcore_role_t
670 rte_eal_lcore_role(unsigned lcore_id)
671 {
672         return rte_config.lcore_role[lcore_id];
673 }
674
675 enum rte_proc_type_t
676 rte_eal_process_type(void)
677 {
678         return rte_config.process_type;
679 }