451fbd24f7f8fe1a1e2a2f4574434b9dbfcc77be
[dpdk.git] / lib / librte_eal / linuxapp / eal / eal_pci.c
1 /*-
2  *   BSD LICENSE
3  * 
4  *   Copyright(c) 2010-2014 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 <ctype.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <string.h>
38 #include <stdarg.h>
39 #include <unistd.h>
40 #include <inttypes.h>
41 #include <sys/types.h>
42 #include <sys/stat.h>
43 #include <fcntl.h>
44 #include <stdarg.h>
45 #include <errno.h>
46 #include <dirent.h>
47 #include <limits.h>
48 #include <sys/queue.h>
49 #include <sys/mman.h>
50 #include <sys/ioctl.h>
51
52 #include <rte_interrupts.h>
53 #include <rte_log.h>
54 #include <rte_pci.h>
55 #include <rte_common.h>
56 #include <rte_launch.h>
57 #include <rte_memory.h>
58 #include <rte_memzone.h>
59 #include <rte_tailq.h>
60 #include <rte_eal.h>
61 #include <rte_eal_memconfig.h>
62 #include <rte_per_lcore.h>
63 #include <rte_lcore.h>
64 #include <rte_malloc.h>
65 #include <rte_string_fns.h>
66 #include <rte_debug.h>
67 #include <rte_devargs.h>
68
69 #include "rte_pci_dev_ids.h"
70 #include "eal_filesystem.h"
71 #include "eal_private.h"
72
73 /**
74  * @file
75  * PCI probing under linux
76  *
77  * This code is used to simulate a PCI probe by parsing information in
78  * sysfs. Moreover, when a registered driver matches a device, the
79  * kernel driver currently using it is unloaded and replaced by
80  * igb_uio module, which is a very minimal userland driver for Intel
81  * network card, only providing access to PCI BAR to applications, and
82  * enabling bus master.
83  */
84
85 struct uio_map {
86         void *addr;
87         uint64_t offset;
88         uint64_t size;
89         uint64_t phaddr;
90 };
91
92 /*
93  * For multi-process we need to reproduce all PCI mappings in secondary
94  * processes, so save them in a tailq.
95  */
96 struct uio_resource {
97         TAILQ_ENTRY(uio_resource) next;
98
99         struct rte_pci_addr pci_addr;
100         char path[PATH_MAX];
101         size_t nb_maps;
102         struct uio_map maps[PCI_MAX_RESOURCE];
103 };
104
105 TAILQ_HEAD(uio_res_list, uio_resource);
106
107 static struct uio_res_list *uio_res_list = NULL;
108 static int pci_parse_sysfs_value(const char *filename, uint64_t *val);
109
110 /* forward prototype of function called in pci_switch_module below */
111 static int pci_uio_map_resource(struct rte_pci_device *dev);
112
113 #ifdef RTE_EAL_UNBIND_PORTS
114 #define PROC_MODULES "/proc/modules"
115
116 #define IGB_UIO_NAME "igb_uio"
117
118 #define UIO_DRV_PATH  "/sys/bus/pci/drivers/%s"
119
120 /* maximum time to wait that /dev/uioX appears */
121 #define UIO_DEV_WAIT_TIMEOUT 3 /* seconds */
122
123 /*
124  * Check that a kernel module is loaded. Returns 0 on success, or if the
125  * parameter is NULL, or -1 if the module is not loaded.
126  */
127 static int
128 pci_uio_check_module(const char *module_name)
129 {
130         FILE *f;
131         unsigned i;
132         char buf[BUFSIZ];
133
134         if (module_name == NULL)
135                 return 0;
136
137         f = fopen(PROC_MODULES, "r");
138         if (f == NULL) {
139                 RTE_LOG(ERR, EAL, "Cannot open "PROC_MODULES": %s\n", 
140                                 strerror(errno));
141                 return -1;
142         }
143
144         while(fgets(buf, sizeof(buf), f) != NULL) {
145
146                 for (i = 0; i < sizeof(buf) && buf[i] != '\0'; i++) {
147                         if (isspace(buf[i]))
148                             buf[i] = '\0';
149                 }
150
151                 if (strncmp(buf, module_name, sizeof(buf)) == 0) {
152                         fclose(f);
153                         return 0;
154                 }
155         }
156         fclose(f);
157         return -1;
158 }
159
160 /* bind a PCI to the kernel module driver */
161 static int
162 pci_bind_device(struct rte_pci_device *dev, char dr_path[])
163 {
164         FILE *f;
165         int n;
166         char buf[BUFSIZ];
167         char dev_bind[PATH_MAX];
168         struct rte_pci_addr *loc = &dev->addr;
169
170         n = rte_snprintf(dev_bind, sizeof(dev_bind), "%s/bind", dr_path);
171         if ((n < 0) || (n >= (int)sizeof(buf))) {
172                 RTE_LOG(ERR, EAL, "Cannot rte_snprintf device bind path\n");
173                 return -1;
174         }
175
176         f = fopen(dev_bind, "w");
177         if (f == NULL) {
178                 RTE_LOG(ERR, EAL, "Cannot open %s\n", dev_bind);
179                 return -1;
180         }
181         n = rte_snprintf(buf, sizeof(buf), PCI_PRI_FMT "\n",
182                          loc->domain, loc->bus, loc->devid, loc->function);
183         if ((n < 0) || (n >= (int)sizeof(buf))) {
184                 RTE_LOG(ERR, EAL, "Cannot rte_snprintf PCI infos\n");
185                 fclose(f);
186                 return -1;
187         }
188         if (fwrite(buf, n, 1, f) == 0) {
189                 fclose(f);
190                 return -1;
191         }
192
193         fclose(f);
194         return 0;
195 }
196
197 static int
198 pci_uio_bind_device(struct rte_pci_device *dev, const char *module_name)
199 {
200         FILE *f;
201         int n;
202         char buf[BUFSIZ];
203         char uio_newid[PATH_MAX];
204         char uio_bind[PATH_MAX];
205
206         n = rte_snprintf(uio_newid, sizeof(uio_newid), UIO_DRV_PATH "/new_id", module_name);
207         if ((n < 0) || (n >= (int)sizeof(uio_newid))) {
208                 RTE_LOG(ERR, EAL, "Cannot rte_snprintf uio_newid name\n");
209                 return -1;
210         }
211
212         n = rte_snprintf(uio_bind, sizeof(uio_bind), UIO_DRV_PATH, module_name);
213         if ((n < 0) || (n >= (int)sizeof(uio_bind))) {
214                 RTE_LOG(ERR, EAL, "Cannot rte_snprintf uio_bind name\n");
215                 return -1;
216         }
217
218         n = rte_snprintf(buf, sizeof(buf), "%x %x\n",
219                         dev->id.vendor_id, dev->id.device_id);
220         if ((n < 0) || (n >= (int)sizeof(buf))) {
221                 RTE_LOG(ERR, EAL, "Cannot rte_snprintf vendor_id/device_id\n");
222                 return -1;
223         }
224
225         f = fopen(uio_newid, "w");
226         if (f == NULL) {
227                 RTE_LOG(ERR, EAL, "Cannot open %s\n", uio_newid);
228                 return -1;
229         }
230         if (fwrite(buf, n, 1, f) == 0) {
231                 fclose(f);
232                 return -1;
233         }
234         fclose(f);
235
236         pci_bind_device(dev, uio_bind);
237         return 0;
238 }
239
240 /* unbind kernel driver for this device */
241 static int
242 pci_unbind_kernel_driver(struct rte_pci_device *dev)
243 {
244         int n;
245         FILE *f;
246         char filename[PATH_MAX];
247         char buf[BUFSIZ];
248         struct rte_pci_addr *loc = &dev->addr;
249
250         /* open /sys/bus/pci/devices/AAAA:BB:CC.D/driver */
251         rte_snprintf(filename, sizeof(filename),
252                  SYSFS_PCI_DEVICES "/" PCI_PRI_FMT "/driver/unbind",
253                  loc->domain, loc->bus, loc->devid, loc->function);
254
255         f = fopen(filename, "w");
256         if (f == NULL) /* device was not bound */
257                 return 0;
258
259         n = rte_snprintf(buf, sizeof(buf), PCI_PRI_FMT "\n",
260                      loc->domain, loc->bus, loc->devid, loc->function);
261         if ((n < 0) || (n >= (int)sizeof(buf))) {
262                 RTE_LOG(ERR, EAL, "%s(): rte_snprintf failed\n", __func__);
263                 goto error;
264         }
265         if (fwrite(buf, n, 1, f) == 0) {
266                 RTE_LOG(ERR, EAL, "%s(): could not write to %s\n", __func__,
267                                 filename);
268                 goto error;
269         }
270
271         fclose(f);
272         return 0;
273
274 error:
275         fclose(f);
276         return -1;
277 }
278
279
280 static int
281 pci_switch_module(struct rte_pci_driver *dr, struct rte_pci_device *dev,
282                 int uio_status, const char *module_name)
283 {
284         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
285                 /* check that our driver is loaded */
286                 if (uio_status != 0 &&
287                                 (uio_status = pci_uio_check_module(module_name)) != 0)
288                         rte_exit(EXIT_FAILURE, "The %s module is required by the "
289                                         "%s driver\n", module_name, dr->name);
290
291                 /* unbind current driver, bind ours */
292                 if (pci_unbind_kernel_driver(dev) < 0)
293                         return -1;
294                 if (pci_uio_bind_device(dev, module_name) < 0)
295                         return -1;
296         }
297         /* map the NIC resources */
298         if (pci_uio_map_resource(dev) < 0)
299                 return -1;
300
301         return 0;
302 }
303
304 #endif /* ifdef EAL_UNBIND_PORTS */
305
306 /* map a particular resource from a file */
307 static void *
308 pci_map_resource(void *requested_addr, const char *devname, off_t offset,
309                  size_t size)
310 {
311         int fd;
312         void *mapaddr;
313
314 #ifdef RTE_EAL_UNBIND_PORTS
315         /*
316          * open devname, and mmap it: it can take some time to
317          * appear, so we wait some time before returning an error
318          */
319         unsigned n;
320         for (n = 0; n < UIO_DEV_WAIT_TIMEOUT*10; n++) {
321                 errno = 0;
322                 if ((fd = open(devname, O_RDWR)) < 0 && errno != ENOENT)
323                         break;
324                 usleep(100000);
325         }
326 #else
327         /*
328          * open devname, to mmap it
329          */
330         fd = open(devname, O_RDWR);
331 #endif
332         if (fd < 0) {
333                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
334                         devname, strerror(errno));
335                 goto fail;
336         }
337
338         /* Map the PCI memory resource of device */
339         mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
340                         MAP_SHARED, fd, offset);
341         close(fd);
342         if (mapaddr == MAP_FAILED ||
343                         (requested_addr != NULL && mapaddr != requested_addr)) {
344                 RTE_LOG(ERR, EAL, "%s(): cannot mmap(%s(%d), %p, 0x%lx, 0x%lx):"
345                         " %s (%p)\n", __func__, devname, fd, requested_addr,
346                         (unsigned long)size, (unsigned long)offset,
347                         strerror(errno), mapaddr);
348                 goto fail;
349         }
350
351         RTE_LOG(DEBUG, EAL, "  PCI memory mapped at %p\n", mapaddr);
352
353         return mapaddr;
354
355 fail:
356         return NULL;
357 }
358
359 #define OFF_MAX              ((uint64_t)(off_t)-1)
360 static ssize_t
361 pci_uio_get_mappings(const char *devname, struct uio_map maps[], size_t nb_maps)
362 {
363         size_t i;
364         char dirname[PATH_MAX];
365         char filename[PATH_MAX];
366         uint64_t offset, size;
367
368         for (i = 0; i != nb_maps; i++) {
369  
370                 /* check if map directory exists */
371                 rte_snprintf(dirname, sizeof(dirname), 
372                         "%s/maps/map%u", devname, i);
373  
374                 if (access(dirname, F_OK) != 0)
375                         break;
376  
377                 /* get mapping offset */
378                 rte_snprintf(filename, sizeof(filename),
379                         "%s/offset", dirname);
380                 if (pci_parse_sysfs_value(filename, &offset) < 0) {
381                         RTE_LOG(ERR, EAL,
382                                 "%s(): cannot parse offset of %s\n",
383                                 __func__, dirname);
384                         return (-1);
385                 }
386  
387                 /* get mapping size */
388                 rte_snprintf(filename, sizeof(filename),
389                         "%s/size", dirname);
390                 if (pci_parse_sysfs_value(filename, &size) < 0) {
391                         RTE_LOG(ERR, EAL,
392                                 "%s(): cannot parse size of %s\n",
393                                 __func__, dirname);
394                         return (-1);
395                 }
396  
397                 /* get mapping physical address */
398                 rte_snprintf(filename, sizeof(filename),
399                         "%s/addr", dirname);
400                 if (pci_parse_sysfs_value(filename, &maps[i].phaddr) < 0) {
401                         RTE_LOG(ERR, EAL,
402                                 "%s(): cannot parse addr of %s\n",
403                                 __func__, dirname);
404                         return (-1);
405                 }
406
407                 if ((offset > OFF_MAX) || (size > SIZE_MAX)) {
408                         RTE_LOG(ERR, EAL,
409                                 "%s(): offset/size exceed system max value\n",
410                                 __func__); 
411                         return (-1);
412                 }
413
414                 maps[i].offset = offset;
415                 maps[i].size = size;
416         }
417         return (i);
418 }
419
420 static int
421 pci_uio_map_secondary(struct rte_pci_device *dev)
422 {
423         size_t i;
424         struct uio_resource *uio_res;
425
426         TAILQ_FOREACH(uio_res, uio_res_list, next) {
427
428                 /* skip this element if it doesn't match our PCI address */
429                 if (memcmp(&uio_res->pci_addr, &dev->addr, sizeof(dev->addr)))
430                         continue;
431
432                 for (i = 0; i != uio_res->nb_maps; i++) {
433                         if (pci_map_resource(uio_res->maps[i].addr,
434                                              uio_res->path,
435                                              (off_t)uio_res->maps[i].offset,
436                                              (size_t)uio_res->maps[i].size)
437                             != uio_res->maps[i].addr) {
438                                 RTE_LOG(ERR, EAL,
439                                         "Cannot mmap device resource\n");
440                                 return (-1);
441                         }
442                 }
443                 return (0);
444         }
445
446         RTE_LOG(ERR, EAL, "Cannot find resource for device\n");
447         return -1;
448 }
449
450 static int pci_mknod_uio_dev(const char *sysfs_uio_path, unsigned uio_num)
451 {
452         FILE *f;
453         char filename[PATH_MAX];
454         int ret;
455         unsigned major, minor;
456         dev_t dev;
457
458         /* get the name of the sysfs file that contains the major and minor
459          * of the uio device and read its content */
460         rte_snprintf(filename, sizeof(filename), "%s/dev", sysfs_uio_path);
461
462         f = fopen(filename, "r");
463         if (f == NULL) {
464                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs to get major:minor\n",
465                         __func__);
466                 return -1;
467         }
468
469         ret = fscanf(f, "%d:%d", &major, &minor);
470         if (ret != 2) {
471                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs to get major:minor\n",
472                         __func__);
473                 fclose(f);
474                 return -1;
475         }
476         fclose(f);
477
478         /* create the char device "mknod /dev/uioX c major minor" */
479         rte_snprintf(filename, sizeof(filename), "/dev/uio%u", uio_num);
480         dev = makedev(major, minor);
481         ret = mknod(filename, S_IFCHR | S_IRUSR | S_IWUSR, dev);
482         if (f == NULL) {
483                 RTE_LOG(ERR, EAL, "%s(): mknod() failed %s\n",
484                         __func__, strerror(errno));
485                 return -1;
486         }
487
488         return ret;
489 }
490
491 /*
492  * Return the uioX char device used for a pci device. On success, return
493  * the UIO number and fill dstbuf string with the path of the device in
494  * sysfs. On error, return a negative value. In this case dstbuf is
495  * invalid.
496  */
497 static int pci_get_uio_dev(struct rte_pci_device *dev, char *dstbuf,
498                            unsigned int buflen)
499 {
500         struct rte_pci_addr *loc = &dev->addr;
501         unsigned int uio_num;
502         struct dirent *e;
503         DIR *dir;
504         char dirname[PATH_MAX];
505
506         /* depending on kernel version, uio can be located in uio/uioX
507          * or uio:uioX */
508
509         rte_snprintf(dirname, sizeof(dirname),
510                  SYSFS_PCI_DEVICES "/" PCI_PRI_FMT "/uio",
511                  loc->domain, loc->bus, loc->devid, loc->function);
512
513         dir = opendir(dirname);
514         if (dir == NULL) {
515                 /* retry with the parent directory */
516                 rte_snprintf(dirname, sizeof(dirname),
517                          SYSFS_PCI_DEVICES "/" PCI_PRI_FMT,
518                          loc->domain, loc->bus, loc->devid, loc->function);
519                 dir = opendir(dirname);
520
521                 if (dir == NULL) {
522                         RTE_LOG(ERR, EAL, "Cannot opendir %s\n", dirname);
523                         return -1;
524                 }
525         }
526
527         /* take the first file starting with "uio" */
528         while ((e = readdir(dir)) != NULL) {
529                 /* format could be uio%d ...*/
530                 int shortprefix_len = sizeof("uio") - 1;
531                 /* ... or uio:uio%d */
532                 int longprefix_len = sizeof("uio:uio") - 1; 
533                 char *endptr;
534
535                 if (strncmp(e->d_name, "uio", 3) != 0)
536                         continue;
537
538                 /* first try uio%d */
539                 errno = 0;
540                 uio_num = strtoull(e->d_name + shortprefix_len, &endptr, 10);
541                 if (errno == 0 && endptr != (e->d_name + shortprefix_len)) {
542                         rte_snprintf(dstbuf, buflen, "%s/uio%u", dirname, uio_num);
543                         break;
544                 }
545
546                 /* then try uio:uio%d */
547                 errno = 0;
548                 uio_num = strtoull(e->d_name + longprefix_len, &endptr, 10);
549                 if (errno == 0 && endptr != (e->d_name + longprefix_len)) {
550                         rte_snprintf(dstbuf, buflen, "%s/uio:uio%u", dirname, uio_num);
551                         break;
552                 }
553         }
554         closedir(dir);
555
556         /* No uio resource found */
557         if (e == NULL)
558                 return -1;
559
560         /* create uio device if we've been asked to */
561         if (internal_config.create_uio_dev && pci_mknod_uio_dev(dstbuf, uio_num) < 0)
562                 RTE_LOG(WARNING, EAL, "Cannot create /dev/uio%u\n", uio_num);
563
564         return uio_num;
565 }
566
567 /* map the PCI resource of a PCI device in virtual memory */
568 static int
569 pci_uio_map_resource(struct rte_pci_device *dev)
570 {
571         int i, j;
572         char dirname[PATH_MAX];
573         char devname[PATH_MAX]; /* contains the /dev/uioX */
574         void *mapaddr;
575         int uio_num;
576         uint64_t phaddr;
577         uint64_t offset;
578         uint64_t pagesz;
579         ssize_t nb_maps;
580         struct rte_pci_addr *loc = &dev->addr;
581         struct uio_resource *uio_res;
582         struct uio_map *maps;
583
584         dev->intr_handle.fd = -1;
585         dev->intr_handle.type = RTE_INTR_HANDLE_UNKNOWN;
586
587         /* secondary processes - use already recorded details */
588         if (rte_eal_process_type() != RTE_PROC_PRIMARY)
589                 return (pci_uio_map_secondary(dev));
590
591         /* find uio resource */
592         uio_num = pci_get_uio_dev(dev, dirname, sizeof(dirname));
593         if (uio_num < 0) {
594                 RTE_LOG(WARNING, EAL, "  "PCI_PRI_FMT" not managed by UIO driver, "
595                                 "skipping\n", loc->domain, loc->bus, loc->devid, loc->function);
596                 return -1;
597         }
598         rte_snprintf(devname, sizeof(devname), "/dev/uio%u", uio_num);
599
600         /* save fd if in primary process */
601         dev->intr_handle.fd = open(devname, O_RDWR);
602         if (dev->intr_handle.fd < 0) {
603                 RTE_LOG(ERR, EAL, "Cannot open %s: %s\n",
604                         devname, strerror(errno));
605                 return -1;
606         }
607         dev->intr_handle.type = RTE_INTR_HANDLE_UIO;
608
609         /* allocate the mapping details for secondary processes*/
610         if ((uio_res = rte_zmalloc("UIO_RES", sizeof (*uio_res), 0)) == NULL) {
611                 RTE_LOG(ERR, EAL,
612                         "%s(): cannot store uio mmap details\n", __func__);
613                 return (-1);
614         }
615
616         rte_snprintf(uio_res->path, sizeof(uio_res->path), "%s", devname);
617         memcpy(&uio_res->pci_addr, &dev->addr, sizeof(uio_res->pci_addr));
618
619         /* collect info about device mappings */
620         nb_maps = pci_uio_get_mappings(dirname, uio_res->maps,
621                                        RTE_DIM(uio_res->maps));
622         if (nb_maps < 0) {
623                 rte_free(uio_res);
624                 return (nb_maps);
625         }
626
627         uio_res->nb_maps = nb_maps;
628
629         /* Map all BARs */
630         pagesz = sysconf(_SC_PAGESIZE);
631
632         maps = uio_res->maps;
633         for (i = 0; i != PCI_MAX_RESOURCE; i++) {
634
635                 /* skip empty BAR */
636                 if ((phaddr = dev->mem_resource[i].phys_addr) == 0)
637                         continue;
638
639                 for (j = 0; j != nb_maps && (phaddr != maps[j].phaddr ||
640                                 dev->mem_resource[i].len != maps[j].size);
641                                 j++)
642                         ;
643
644                 /* if matching map is found, then use it */
645                 if (j != nb_maps) {
646                         offset = j * pagesz;
647                         if (maps[j].addr != NULL ||
648                             (mapaddr = pci_map_resource(NULL, devname,
649                                                         (off_t)offset,
650                                                         (size_t)maps[j].size)
651                             ) == NULL) {
652                                 rte_free(uio_res);
653                                 return (-1);
654                         }
655
656                         maps[j].addr = mapaddr;
657                         maps[j].offset = offset;
658                         dev->mem_resource[i].addr = mapaddr;
659                 }
660         }
661
662         TAILQ_INSERT_TAIL(uio_res_list, uio_res, next);
663
664         return (0);
665 }
666
667 /* parse the "resource" sysfs file */
668 #define IORESOURCE_MEM  0x00000200
669
670 static int
671 pci_parse_sysfs_resource(const char *filename, struct rte_pci_device *dev)
672 {
673         FILE *f;
674         char buf[BUFSIZ];
675         union pci_resource_info {
676                 struct {
677                         char *phys_addr;
678                         char *end_addr;
679                         char *flags;
680                 };
681                 char *ptrs[PCI_RESOURCE_FMT_NVAL];
682         } res_info;
683         int i;
684         uint64_t phys_addr, end_addr, flags;
685
686         f = fopen(filename, "r");
687         if (f == NULL) {
688                 RTE_LOG(ERR, EAL, "Cannot open sysfs resource\n");
689                 return -1;
690         }
691
692         for (i = 0; i<PCI_MAX_RESOURCE; i++) {
693
694                 if (fgets(buf, sizeof(buf), f) == NULL) {
695                         RTE_LOG(ERR, EAL, 
696                                 "%s(): cannot read resource\n", __func__);
697                         goto error;
698                 }
699
700                 if (rte_strsplit(buf, sizeof(buf), res_info.ptrs, 3, ' ') != 3) {
701                         RTE_LOG(ERR, EAL, 
702                                 "%s(): bad resource format\n", __func__);
703                         goto error;
704                 }
705                 errno = 0;
706                 phys_addr = strtoull(res_info.phys_addr, NULL, 16);
707                 end_addr = strtoull(res_info.end_addr, NULL, 16);
708                 flags = strtoull(res_info.flags, NULL, 16);
709                 if (errno != 0) {
710                         RTE_LOG(ERR, EAL, 
711                                 "%s(): bad resource format\n", __func__);
712                         goto error;
713                 }
714
715                 if (flags & IORESOURCE_MEM) {
716                         dev->mem_resource[i].phys_addr = phys_addr;
717                         dev->mem_resource[i].len = end_addr - phys_addr + 1;
718                         /* not mapped for now */
719                         dev->mem_resource[i].addr = NULL; 
720                 }
721         }
722         fclose(f);
723         return 0;
724
725 error:
726         fclose(f);
727         return -1;
728 }
729
730 /* 
731  * parse a sysfs file containing one integer value 
732  * different to the eal version, as it needs to work with 64-bit values
733  */ 
734 static int 
735 pci_parse_sysfs_value(const char *filename, uint64_t *val) 
736 {
737         FILE *f;
738         char buf[BUFSIZ];
739         char *end = NULL;
740  
741         f = fopen(filename, "r");
742         if (f == NULL) {
743                 RTE_LOG(ERR, EAL, "%s(): cannot open sysfs value %s\n",
744                         __func__, filename);
745                 return -1;
746         }
747  
748         if (fgets(buf, sizeof(buf), f) == NULL) {
749                 RTE_LOG(ERR, EAL, "%s(): cannot read sysfs value %s\n",
750                         __func__, filename);
751                 fclose(f);
752                 return -1;
753         }
754         *val = strtoull(buf, &end, 0);
755         if ((buf[0] == '\0') || (end == NULL) || (*end != '\n')) {
756                 RTE_LOG(ERR, EAL, "%s(): cannot parse sysfs value %s\n",
757                                 __func__, filename);
758                 fclose(f);
759                 return -1;
760         }
761         fclose(f);
762         return 0;
763 }
764
765 /* Compare two PCI device addresses. */
766 static int
767 pci_addr_comparison(struct rte_pci_addr *addr, struct rte_pci_addr *addr2)
768 {
769         uint64_t dev_addr = (addr->domain << 24) + (addr->bus << 16) + (addr->devid << 8) + addr->function;
770         uint64_t dev_addr2 = (addr2->domain << 24) + (addr2->bus << 16) + (addr2->devid << 8) + addr2->function;
771
772         if (dev_addr > dev_addr2)
773                 return 1;
774         else
775                 return 0;
776 }
777
778
779 /* Scan one pci sysfs entry, and fill the devices list from it. */
780 static int
781 pci_scan_one(const char *dirname, uint16_t domain, uint8_t bus,
782              uint8_t devid, uint8_t function)
783 {
784         char filename[PATH_MAX];
785         unsigned long tmp;
786         struct rte_pci_device *dev;
787
788         dev = malloc(sizeof(*dev));
789         if (dev == NULL) {
790                 return -1;
791         }
792
793         memset(dev, 0, sizeof(*dev));
794         dev->addr.domain = domain;
795         dev->addr.bus = bus;
796         dev->addr.devid = devid;
797         dev->addr.function = function;
798
799         /* get vendor id */
800         rte_snprintf(filename, sizeof(filename), "%s/vendor", dirname);
801         if (eal_parse_sysfs_value(filename, &tmp) < 0) {
802                 free(dev);
803                 return -1;
804         }
805         dev->id.vendor_id = (uint16_t)tmp;
806
807         /* get device id */
808         rte_snprintf(filename, sizeof(filename), "%s/device", dirname);
809         if (eal_parse_sysfs_value(filename, &tmp) < 0) {
810                 free(dev);
811                 return -1;
812         }
813         dev->id.device_id = (uint16_t)tmp;
814
815         /* get subsystem_vendor id */
816         rte_snprintf(filename, sizeof(filename), "%s/subsystem_vendor",
817                  dirname);
818         if (eal_parse_sysfs_value(filename, &tmp) < 0) {
819                 free(dev);
820                 return -1;
821         }
822         dev->id.subsystem_vendor_id = (uint16_t)tmp;
823
824         /* get subsystem_device id */
825         rte_snprintf(filename, sizeof(filename), "%s/subsystem_device",
826                  dirname);
827         if (eal_parse_sysfs_value(filename, &tmp) < 0) {
828                 free(dev);
829                 return -1;
830         }
831         dev->id.subsystem_device_id = (uint16_t)tmp;
832
833         /* get max_vfs */
834         dev->max_vfs = 0;
835         rte_snprintf(filename, sizeof(filename), "%s/max_vfs", dirname);
836         if (!access(filename, F_OK) && 
837             eal_parse_sysfs_value(filename, &tmp) == 0) {
838                 dev->max_vfs = (uint16_t)tmp;
839         }
840
841         /* get numa node */
842         rte_snprintf(filename, sizeof(filename), "%s/numa_node",
843                  dirname);
844         if (access(filename, R_OK) != 0) {
845                 /* if no NUMA support just set node to 0 */
846                 dev->numa_node = -1;
847         } else {
848                 if (eal_parse_sysfs_value(filename, &tmp) < 0) {
849                         free(dev);
850                         return -1;
851                 }
852                 dev->numa_node = tmp;
853         }
854
855         /* parse resources */
856         rte_snprintf(filename, sizeof(filename), "%s/resource", dirname);
857         if (pci_parse_sysfs_resource(filename, dev) < 0) {
858                 RTE_LOG(ERR, EAL, "%s(): cannot parse resource\n", __func__);
859                 free(dev);
860                 return -1;
861         }
862
863         /* device is valid, add in list (sorted) */
864         if (TAILQ_EMPTY(&pci_device_list)) {
865                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
866         }       
867         else {
868                 struct rte_pci_device *dev2 = NULL;
869
870                 TAILQ_FOREACH(dev2, &pci_device_list, next) {
871                         if (pci_addr_comparison(&dev->addr, &dev2->addr))
872                                 continue;
873                         else {
874                                 TAILQ_INSERT_BEFORE(dev2, dev, next);
875                                 return 0;
876                         }
877                 }
878                 TAILQ_INSERT_TAIL(&pci_device_list, dev, next);
879         }
880                                 
881         return 0;
882 }
883
884 /*
885  * split up a pci address into its constituent parts.
886  */
887 static int
888 parse_pci_addr_format(const char *buf, int bufsize, uint16_t *domain,
889                 uint8_t *bus, uint8_t *devid, uint8_t *function)
890 {
891         /* first split on ':' */
892         union splitaddr {
893                 struct {
894                         char *domain;
895                         char *bus;
896                         char *devid;
897                         char *function;
898                 };
899                 char *str[PCI_FMT_NVAL]; /* last element-separator is "." not ":" */
900         } splitaddr;
901
902         char *buf_copy = strndup(buf, bufsize);
903         if (buf_copy == NULL)
904                 return -1;
905
906         if (rte_strsplit(buf_copy, bufsize, splitaddr.str, PCI_FMT_NVAL, ':')
907                         != PCI_FMT_NVAL - 1)
908                 goto error;
909         /* final split is on '.' between devid and function */
910         splitaddr.function = strchr(splitaddr.devid,'.');
911         if (splitaddr.function == NULL)
912                 goto error;
913         *splitaddr.function++ = '\0';
914
915         /* now convert to int values */
916         errno = 0;
917         *domain = (uint16_t)strtoul(splitaddr.domain, NULL, 16);
918         *bus = (uint8_t)strtoul(splitaddr.bus, NULL, 16);
919         *devid = (uint8_t)strtoul(splitaddr.devid, NULL, 16);
920         *function = (uint8_t)strtoul(splitaddr.function, NULL, 10);
921         if (errno != 0)
922                 goto error;
923
924         free(buf_copy); /* free the copy made with strdup */
925         return 0;
926 error:
927         free(buf_copy);
928         return -1;
929 }
930
931 /*
932  * Scan the content of the PCI bus, and the devices in the devices
933  * list
934  */
935 static int
936 pci_scan(void)
937 {
938         struct dirent *e;
939         DIR *dir;
940         char dirname[PATH_MAX];
941         uint16_t domain;
942         uint8_t bus, devid, function;
943
944         dir = opendir(SYSFS_PCI_DEVICES);
945         if (dir == NULL) {
946                 RTE_LOG(ERR, EAL, "%s(): opendir failed: %s\n",
947                         __func__, strerror(errno));
948                 return -1;
949         }
950
951         while ((e = readdir(dir)) != NULL) {
952                 if (e->d_name[0] == '.')
953                         continue;
954
955                 if (parse_pci_addr_format(e->d_name, sizeof(e->d_name), &domain,
956                                 &bus, &devid, &function) != 0)
957                         continue;
958
959                 rte_snprintf(dirname, sizeof(dirname), "%s/%s", SYSFS_PCI_DEVICES,
960                          e->d_name);
961                 if (pci_scan_one(dirname, domain, bus, devid, function) < 0)
962                         goto error;
963         }
964         closedir(dir);
965         return 0;
966
967 error:
968         closedir(dir);
969         return -1;
970 }
971
972 /*
973  * If vendor/device ID match, call the devinit() function of the
974  * driver.
975  */
976 int
977 rte_eal_pci_probe_one_driver(struct rte_pci_driver *dr, struct rte_pci_device *dev)
978 {
979         struct rte_pci_id *id_table;
980
981         for (id_table = dr->id_table ; id_table->vendor_id != 0; id_table++) {
982
983                 /* check if device's identifiers match the driver's ones */
984                 if (id_table->vendor_id != dev->id.vendor_id &&
985                                 id_table->vendor_id != PCI_ANY_ID)
986                         continue;
987                 if (id_table->device_id != dev->id.device_id &&
988                                 id_table->device_id != PCI_ANY_ID)
989                         continue;
990                 if (id_table->subsystem_vendor_id != dev->id.subsystem_vendor_id &&
991                                 id_table->subsystem_vendor_id != PCI_ANY_ID)
992                         continue;
993                 if (id_table->subsystem_device_id != dev->id.subsystem_device_id &&
994                                 id_table->subsystem_device_id != PCI_ANY_ID)
995                         continue;
996
997                 struct rte_pci_addr *loc = &dev->addr;
998
999                 RTE_LOG(DEBUG, EAL, "PCI device "PCI_PRI_FMT" on NUMA socket %i\n",
1000                                 loc->domain, loc->bus, loc->devid, loc->function,
1001                                 dev->numa_node);
1002
1003                 RTE_LOG(DEBUG, EAL, "  probe driver: %x:%x %s\n", dev->id.vendor_id,
1004                                 dev->id.device_id, dr->name);
1005
1006                 /* no initialization when blacklisted, return without error */
1007                 if (dev->devargs != NULL &&
1008                         dev->devargs->type == RTE_DEVTYPE_BLACKLISTED_PCI) {
1009                         RTE_LOG(DEBUG, EAL, "  Device is blacklisted, not initializing\n");
1010                         return 0;
1011                 }
1012
1013 #ifdef RTE_EAL_UNBIND_PORTS
1014                 if (dr->drv_flags & RTE_PCI_DRV_NEED_IGB_UIO) {
1015                         /* unbind driver and load uio resources for Intel NICs */
1016                         if (pci_switch_module(dr, dev, 1, IGB_UIO_NAME) < 0)
1017                                 return -1;
1018                 } else if (dr->drv_flags & RTE_PCI_DRV_FORCE_UNBIND &&
1019                            rte_eal_process_type() == RTE_PROC_PRIMARY) {
1020                         /* unbind current driver */
1021                         if (pci_unbind_kernel_driver(dev) < 0)
1022                                 return -1;
1023                 }
1024 #else
1025                 if (dr->drv_flags & RTE_PCI_DRV_NEED_IGB_UIO)
1026                         /* just map resources for Intel NICs */
1027                         if (pci_uio_map_resource(dev) < 0)
1028                                 return -1;
1029 #endif
1030
1031                 /* reference driver structure */
1032                 dev->driver = dr;
1033
1034                 /* call the driver devinit() function */
1035                 return dr->devinit(dr, dev);
1036         }
1037         /* return positive value if driver is not found */
1038         return 1;
1039 }
1040
1041 /* Init the PCI EAL subsystem */
1042 int
1043 rte_eal_pci_init(void)
1044 {
1045         TAILQ_INIT(&pci_driver_list);
1046         TAILQ_INIT(&pci_device_list);
1047         uio_res_list = RTE_TAILQ_RESERVE_BY_IDX(RTE_TAILQ_PCI, uio_res_list);
1048
1049         /* for debug purposes, PCI can be disabled */
1050         if (internal_config.no_pci)
1051                 return 0;
1052
1053         if (pci_scan() < 0) {
1054                 RTE_LOG(ERR, EAL, "%s(): Cannot scan PCI bus\n", __func__);
1055                 return -1;
1056         }
1057         return 0;
1058 }