doc: whitespace changes in licenses
[dpdk.git] / examples / timer / main.c
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  * 
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  * 
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  * 
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #include <stdio.h>
35 #include <string.h>
36 #include <stdint.h>
37 #include <errno.h>
38 #include <sys/queue.h>
39
40 #include <rte_common.h>
41 #include <rte_memory.h>
42 #include <rte_memzone.h>
43 #include <rte_launch.h>
44 #include <rte_tailq.h>
45 #include <rte_eal.h>
46 #include <rte_per_lcore.h>
47 #include <rte_lcore.h>
48 #include <rte_cycles.h>
49 #include <rte_timer.h>
50 #include <rte_debug.h>
51
52 #include "main.h"
53
54 #define TIMER_RESOLUTION_CYCLES 20000000ULL /* around 10ms at 2 Ghz */
55
56 static struct rte_timer timer0;
57 static struct rte_timer timer1;
58
59 /* timer0 callback */
60 static void
61 timer0_cb(__attribute__((unused)) struct rte_timer *tim,
62           __attribute__((unused)) void *arg)
63 {
64         static unsigned counter = 0;
65         unsigned lcore_id = rte_lcore_id();
66
67         printf("%s() on lcore %u\n", __func__, lcore_id);
68
69         /* this timer is automatically reloaded until we decide to
70          * stop it, when counter reaches 20. */
71         if ((counter ++) == 20)
72                 rte_timer_stop(tim);
73 }
74
75 /* timer1 callback */
76 static void
77 timer1_cb(__attribute__((unused)) struct rte_timer *tim,
78           __attribute__((unused)) void *arg)
79 {
80         unsigned lcore_id = rte_lcore_id();
81         uint64_t hz;
82
83         printf("%s() on lcore %u\n", __func__, lcore_id);
84
85         /* reload it on another lcore */
86         hz = rte_get_timer_hz();
87         lcore_id = rte_get_next_lcore(lcore_id, 0, 1);
88         rte_timer_reset(tim, hz/3, SINGLE, lcore_id, timer1_cb, NULL);
89 }
90
91 static __attribute__((noreturn)) int
92 lcore_mainloop(__attribute__((unused)) void *arg)
93 {
94         uint64_t prev_tsc = 0, cur_tsc, diff_tsc;
95         unsigned lcore_id;
96
97         lcore_id = rte_lcore_id();
98         printf("Starting mainloop on core %u\n", lcore_id);
99
100         while (1) {
101                 /*
102                  * Call the timer handler on each core: as we don't
103                  * need a very precise timer, so only call
104                  * rte_timer_manage() every ~10ms (at 2Ghz). In a real
105                  * application, this will enhance performances as
106                  * reading the HPET timer is not efficient.
107                  */
108                 cur_tsc = rte_rdtsc();
109                 diff_tsc = cur_tsc - prev_tsc;
110                 if (diff_tsc > TIMER_RESOLUTION_CYCLES) {
111                         rte_timer_manage();
112                         prev_tsc = cur_tsc;
113                 }
114         }
115 }
116
117 int
118 MAIN(int argc, char **argv)
119 {
120         int ret;
121         uint64_t hz;
122         unsigned lcore_id;
123
124         /* init EAL */
125         ret = rte_eal_init(argc, argv);
126         if (ret < 0)
127                 rte_panic("Cannot init EAL\n");
128
129         /* init RTE timer library */
130         rte_timer_subsystem_init();
131
132         /* init timer structures */
133         rte_timer_init(&timer0);
134         rte_timer_init(&timer1);
135
136         /* load timer0, every second, on master lcore, reloaded automatically */
137         hz = rte_get_timer_hz();
138         lcore_id = rte_lcore_id();
139         rte_timer_reset(&timer0, hz, PERIODICAL, lcore_id, timer0_cb, NULL);
140
141         /* load timer1, every second/3, on next lcore, reloaded manually */
142         lcore_id = rte_get_next_lcore(lcore_id, 0, 1);
143         rte_timer_reset(&timer1, hz/3, SINGLE, lcore_id, timer1_cb, NULL);
144
145         /* call lcore_mainloop() on every slave lcore */
146         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
147                 rte_eal_remote_launch(lcore_mainloop, NULL, lcore_id);
148         }
149
150         /* call it on master lcore too */
151         (void) lcore_mainloop(NULL);
152
153         return 0;
154 }