[thirdparty/pciutils.git] / ls-tree.c

/*
 *	The PCI Utilities -- Show Bus Tree
 *
 *	Copyright (c) 1997--2021 Martin Mares <mj@ucw.cz>
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#include <stdarg.h>
#include <stdio.h>
#include <string.h>

#include "lspci.h"

struct bridge host_bridge = { NULL, NULL, NULL, NULL, NULL, 0, ~0, 0, ~0, NULL };

static struct bus *
find_bus(struct bridge *b, unsigned int domain, unsigned int n)
{
  struct bus *bus;

  for (bus=b->first_bus; bus; bus=bus->sibling)
    if (bus->domain == domain && bus->number == n)
      break;
  return bus;
}

static struct device *
find_device(struct pci_dev *dd)
{
  struct device *d;

  if (!dd)
    return NULL;
  for (d=first_dev; d; d=d->next)
    if (d->dev == dd)
      break;
  return d;
}

static struct bus *
new_bus(struct bridge *b, unsigned int domain, unsigned int n)
{
  struct bus *bus = xmalloc(sizeof(struct bus));
  bus->domain = domain;
  bus->number = n;
  bus->sibling = NULL;
  bus->first_dev = NULL;
  bus->last_dev = &bus->first_dev;
  bus->parent_bridge = b;
  if (b->last_bus)
    b->last_bus->sibling = bus;
  b->last_bus = bus;
  if (!b->first_bus)
    b->first_bus = bus;
  return bus;
}

static void
insert_dev(struct device *d, struct bridge *b)
{
  struct pci_dev *p = d->dev;
  struct device *parent = NULL;
  struct bus *bus = NULL;

  if (p->known_fields & PCI_FILL_PARENT)
    parent = find_device(p->parent);

  if (parent && parent->bridge)
    {
      bus = parent->bridge->first_bus;
      if (!bus)
        bus = new_bus(parent->bridge, p->domain, p->bus);
    }

  if (!bus && ! (bus = find_bus(b, p->domain, p->bus)))
    {
      struct bridge *c;
      for (c=b->child; c; c=c->next)
	if (c->domain == (unsigned)p->domain && c->secondary <= p->bus && p->bus <= c->subordinate)
          {
            insert_dev(d, c);
            return;
          }
      bus = new_bus(b, p->domain, p->bus);
    }
  /* Simple insertion at the end _does_ guarantee the correct order as the
   * original device list was sorted by (domain, bus, devfn) lexicographically
   * and all devices on the new list have the same bus number.
   */
  *bus->last_dev = d;
  bus->last_dev = &d->bus_next;
  d->bus_next = NULL;
  d->parent_bus = bus;
}

void
grow_tree(void)
{
  struct device *d;
  struct bridge **last_br, *b;

  /* Build list of bridges */

  last_br = &host_bridge.chain;
  for (d=first_dev; d; d=d->next)
    {
      struct pci_dev *dd = d->dev;
      word class = dd->device_class;
      byte ht = d->no_config_access ? -1 : (get_conf_byte(d, PCI_HEADER_TYPE) & 0x7f);
      if ((class >> 8) == PCI_BASE_CLASS_BRIDGE &&
	  (ht == PCI_HEADER_TYPE_BRIDGE || ht == PCI_HEADER_TYPE_CARDBUS))
	{
	  b = xmalloc(sizeof(struct bridge));
	  b->domain = dd->domain;
	  if (ht == PCI_HEADER_TYPE_BRIDGE)
	    {
	      b->primary = get_conf_byte(d, PCI_PRIMARY_BUS);
	      b->secondary = get_conf_byte(d, PCI_SECONDARY_BUS);
	      b->subordinate = get_conf_byte(d, PCI_SUBORDINATE_BUS);
	    }
	  else
	    {
	      b->primary = get_conf_byte(d, PCI_CB_PRIMARY_BUS);
	      b->secondary = get_conf_byte(d, PCI_CB_CARD_BUS);
	      b->subordinate = get_conf_byte(d, PCI_CB_SUBORDINATE_BUS);
	    }
	  *last_br = b;
	  last_br = &b->chain;
	  b->next = b->child = NULL;
	  b->first_bus = NULL;
	  b->last_bus = NULL;
	  b->br_dev = d;
	  d->bridge = b;
	  pacc->debug("Tree: bridge %04x:%02x:%02x.%d: %02x -> %02x-%02x\n",
	    dd->domain, dd->bus, dd->dev, dd->func,
	    b->primary, b->secondary, b->subordinate);
	}
    }

  /* Append additional bridges reported by libpci via d->parent */

  for (d=first_dev; d; d=d->next)
    {
      struct device *parent = NULL;
      if (d->dev->known_fields & PCI_FILL_PARENT)
        parent = find_device(d->dev->parent);
      if (!parent || parent->bridge)
        continue;
      b = xmalloc(sizeof(struct bridge));
      b->domain = parent->dev->domain;
      b->primary = parent->dev->bus;
      b->secondary = d->dev->bus;
      /* At this stage subordinate number is unknown, so set it to secondary bus number. */
      b->subordinate = b->secondary;
      *last_br = b;
      last_br = &b->chain;
      b->next = b->child = NULL;
      b->first_bus = NULL;
      b->last_bus = NULL;
      b->br_dev = parent;
      parent->bridge = b;
      pacc->debug("Tree: bridge %04x:%02x:%02x.%d\n", b->domain,
        parent->dev->bus, parent->dev->dev, parent->dev->func);
    }
  *last_br = NULL;

  /* Create a bridge tree */

  for (b=&host_bridge; b; b=b->chain)
    {
      struct device *br_dev = b->br_dev;
      struct bridge *c, *best = NULL;
      struct device *parent = NULL;

      if (br_dev && (br_dev->dev->known_fields & PCI_FILL_PARENT))
        parent = find_device(br_dev->dev->parent);
      if (parent)
        best = parent->bridge;
      if (!best)
      for (c=&host_bridge; c; c=c->chain)
	if (c != b && (c == &host_bridge || b->domain == c->domain) &&
	    b->primary >= c->secondary && b->primary <= c->subordinate &&
	    (!best || best->subordinate - best->primary > c->subordinate - c->primary))
	  best = c;
      if (best)
	{
	  b->next = best->child;
	  best->child = b;
	}
    }

  /* Insert secondary bus for each bridge */

  for (b=&host_bridge; b; b=b->chain)
    if (!find_bus(b, b->domain, b->secondary))
      new_bus(b, b->domain, b->secondary);

  /* Create bus structs and link devices */

  for (d=first_dev; d; d=d->next)
    insert_dev(d, &host_bridge);
}

#define LINE_BUF_SIZE 1024

static void
print_it(char *line, char *p)
{
  *p = 0;
  fputs(line, stdout);
  if (p >= line + LINE_BUF_SIZE - 1)
    fputs("...", stdout);
  putchar('\n');
  for (p=line; *p; p++)
    if (*p == '+' || *p == '|')
      *p = '|';
    else
      *p = ' ';
}

static void show_tree_bridge(struct bridge *, char *, char *);

static char * FORMAT_CHECK(printf, 3, 4)
tree_printf(char *line, char *p, char *fmt, ...)
{
  va_list args;
  int space = line + LINE_BUF_SIZE - 1 - p;

  if (space <= 0)
    return p;

  va_start(args, fmt);
  int res = vsnprintf(p, space, fmt, args);
  if (res < 0)
    {
      /* Ancient C libraries return -1 on overflow and they do not truncate the output properly. */
      *p = 0;
      p += space;
    }
  else if (res >= space)
    {
      /* Ancient C libraries do not truncate the output properly. */
      *(p+space-1) = 0;
      p += space;
    }
  else
    p += res;

  va_end(args);
  return p;
}

static void
show_tree_dev(struct device *d, char *line, char *p)
{
  struct pci_dev *q = d->dev;
  struct bridge *b;
  char namebuf[256];

  p = tree_printf(line, p, "%02x.%x", q->dev, q->func);
  for (b=&host_bridge; b; b=b->chain)
    if (b->br_dev == d)
      {
	if (b->secondary == 0)
	  p = tree_printf(line, p, "-");
	else if (b->secondary == b->subordinate)
	  p = tree_printf(line, p, "-[%02x]-", b->secondary);
	else
	  p = tree_printf(line, p, "-[%02x-%02x]-", b->secondary, b->subordinate);
        show_tree_bridge(b, line, p);
        return;
      }
  if (verbose)
    p = tree_printf(line, p, "  %s",
		    pci_lookup_name(pacc, namebuf, sizeof(namebuf),
				    PCI_LOOKUP_VENDOR | PCI_LOOKUP_DEVICE,
				    q->vendor_id, q->device_id));
  print_it(line, p);
}

static void
show_tree_bus(struct bus *b, char *line, char *p)
{
  if (!b->first_dev)
    print_it(line, p);
  else if (!b->first_dev->bus_next)
    {
      p = tree_printf(line, p, "--");
      show_tree_dev(b->first_dev, line, p);
    }
  else
    {
      struct device *d = b->first_dev;
      while (d->bus_next)
	{
	  char *p2 = tree_printf(line, p, "+-");
	  show_tree_dev(d, line, p2);
	  d = d->bus_next;
	}
      p = tree_printf(line, p, "\\-");
      show_tree_dev(d, line, p);
    }
}

static void
show_tree_bridge(struct bridge *b, char *line, char *p)
{
  *p++ = '-';
  if (!b->first_bus->sibling)
    {
      if (b == &host_bridge)
        p = tree_printf(line, p, "[%04x:%02x]-", b->domain, b->first_bus->number);
      show_tree_bus(b->first_bus, line, p);
    }
  else
    {
      struct bus *u = b->first_bus;
      char *k;

      while (u->sibling)
        {
          k = tree_printf(line, p, "+-[%04x:%02x]-", u->domain, u->number);
          show_tree_bus(u, line, k);
          u = u->sibling;
        }
      k = tree_printf(line, p, "\\-[%04x:%02x]-", u->domain, u->number);
      show_tree_bus(u, line, k);
    }
}

void
show_forest(struct pci_filter *filter)
{
  char line[LINE_BUF_SIZE];
  if (filter == NULL)
    show_tree_bridge(&host_bridge, line, line);
  else
    {
      struct bridge *b;
      for (b=&host_bridge; b; b=b->chain)
        {
          if (b->br_dev && pci_filter_match(filter, b->br_dev->dev))
            {
                struct pci_dev *d = b->br_dev->dev;
                char *p = line;
                p = tree_printf(line, p, "%04x:%02x:", d->domain_16, d->bus);
                show_tree_dev(b->br_dev, line, p);
            }
        }
    }
}
Commit	Line	Data
c7a34993 MM	1	/*
	2	* The PCI Utilities -- Show Bus Tree
	3	*
d1b22bb0	4	* Copyright (c) 1997--2021 Martin Mares <mj@ucw.cz>
c7a34993 MM	5	*
	6	* Can be freely distributed and used under the terms of the GNU GPL.
	7	*/
	8
76d47191	9	#include <stdarg.h>
c7a34993 MM	10	#include <stdio.h>
	11	#include <string.h>
	12
	13	#include "lspci.h"
	14
b1cff3a4	15	struct bridge host_bridge = { NULL, NULL, NULL, NULL, NULL, 0, ~0, 0, ~0, NULL };
c7a34993 MM	16
	17	static struct bus *
	18	find_bus(struct bridge *b, unsigned int domain, unsigned int n)
	19	{
	20	struct bus *bus;
	21
	22	for (bus=b->first_bus; bus; bus=bus->sibling)
	23	if (bus->domain == domain && bus->number == n)
	24	break;
	25	return bus;
	26	}
	27
67954c8b PR	28	static struct device *
	29	find_device(struct pci_dev *dd)
	30	{
	31	struct device *d;
	32
	33	if (!dd)
	34	return NULL;
	35	for (d=first_dev; d; d=d->next)
	36	if (d->dev == dd)
	37	break;
	38	return d;
	39	}
	40
c7a34993 MM	41	static struct bus *
	42	new_bus(struct bridge *b, unsigned int domain, unsigned int n)
	43	{
	44	struct bus *bus = xmalloc(sizeof(struct bus));
	45	bus->domain = domain;
	46	bus->number = n;
b1cff3a4	47	bus->sibling = NULL;
c7a34993 MM	48	bus->first_dev = NULL;
c7a34993 MM	49	bus->last_dev = &bus->first_dev;
6b056c8e	50	bus->parent_bridge = b;
b1cff3a4 PR	51	if (b->last_bus)
	52	b->last_bus->sibling = bus;
	53	b->last_bus = bus;
	54	if (!b->first_bus)
	55	b->first_bus = bus;
c7a34993 MM	56	return bus;
	57	}
	58
	59	static void
	60	insert_dev(struct device d, struct bridge b)
	61	{
	62	struct pci_dev *p = d->dev;
67954c8b PR	63	struct device *parent = NULL;
	64	struct bus *bus = NULL;
	65
	66	if (p->known_fields & PCI_FILL_PARENT)
	67	parent = find_device(p->parent);
c7a34993	68
67954c8b PR	69	if (parent && parent->bridge)
	70	{
	71	bus = parent->bridge->first_bus;
	72	if (!bus)
	73	bus = new_bus(parent->bridge, p->domain, p->bus);
	74	}
	75
	76	if (!bus && ! (bus = find_bus(b, p->domain, p->bus)))
c7a34993 MM	77	{
	78	struct bridge *c;
	79	for (c=b->child; c; c=c->next)
ab61451d	80	if (c->domain == (unsigned)p->domain && c->secondary <= p->bus && p->bus <= c->subordinate)
c7a34993 MM	81	{
	82	insert_dev(d, c);
	83	return;
	84	}
	85	bus = new_bus(b, p->domain, p->bus);
	86	}
	87	/* Simple insertion at the end _does_ guarantee the correct order as the
	88	* original device list was sorted by (domain, bus, devfn) lexicographically
	89	* and all devices on the new list have the same bus number.
	90	*/
	91	*bus->last_dev = d;
6b056c8e MM	92	bus->last_dev = &d->bus_next;
	93	d->bus_next = NULL;
	94	d->parent_bus = bus;
c7a34993 MM	95	}
c7a34993 MM	96
6b056c8e	97	void
c7a34993 MM	98	grow_tree(void)
c7a34993 MM	99	{
6b056c8e	100	struct device *d;
c7a34993 MM	101	struct bridge *last_br, b;
	102
	103	/* Build list of bridges */
	104
	105	last_br = &host_bridge.chain;
	106	for (d=first_dev; d; d=d->next)
	107	{
f558905d MM	108	struct pci_dev *dd = d->dev;
f558905d MM	109	word class = dd->device_class;
832b07a8	110	byte ht = d->no_config_access ? -1 : (get_conf_byte(d, PCI_HEADER_TYPE) & 0x7f);
f558905d	111	if ((class >> 8) == PCI_BASE_CLASS_BRIDGE &&
c7a34993 MM	112	(ht == PCI_HEADER_TYPE_BRIDGE \|\| ht == PCI_HEADER_TYPE_CARDBUS))
	113	{
	114	b = xmalloc(sizeof(struct bridge));
f558905d	115	b->domain = dd->domain;
c7a34993 MM	116	if (ht == PCI_HEADER_TYPE_BRIDGE)
	117	{
	118	b->primary = get_conf_byte(d, PCI_PRIMARY_BUS);
	119	b->secondary = get_conf_byte(d, PCI_SECONDARY_BUS);
	120	b->subordinate = get_conf_byte(d, PCI_SUBORDINATE_BUS);
	121	}
	122	else
	123	{
	124	b->primary = get_conf_byte(d, PCI_CB_PRIMARY_BUS);
	125	b->secondary = get_conf_byte(d, PCI_CB_CARD_BUS);
	126	b->subordinate = get_conf_byte(d, PCI_CB_SUBORDINATE_BUS);
	127	}
	128	*last_br = b;
	129	last_br = &b->chain;
	130	b->next = b->child = NULL;
	131	b->first_bus = NULL;
b1cff3a4	132	b->last_bus = NULL;
c7a34993	133	b->br_dev = d;
6b056c8e	134	d->bridge = b;
f558905d MM	135	pacc->debug("Tree: bridge %04x:%02x:%02x.%d: %02x -> %02x-%02x\n",
	136	dd->domain, dd->bus, dd->dev, dd->func,
	137	b->primary, b->secondary, b->subordinate);
c7a34993 MM	138	}
c7a34993 MM	139	}
67954c8b PR	140
	141	/* Append additional bridges reported by libpci via d->parent */
	142
	143	for (d=first_dev; d; d=d->next)
	144	{
	145	struct device *parent = NULL;
	146	if (d->dev->known_fields & PCI_FILL_PARENT)
	147	parent = find_device(d->dev->parent);
	148	if (!parent \|\| parent->bridge)
	149	continue;
	150	b = xmalloc(sizeof(struct bridge));
	151	b->domain = parent->dev->domain;
	152	b->primary = parent->dev->bus;
	153	b->secondary = d->dev->bus;
	154	/* At this stage subordinate number is unknown, so set it to secondary bus number. */
	155	b->subordinate = b->secondary;
	156	*last_br = b;
	157	last_br = &b->chain;
	158	b->next = b->child = NULL;
	159	b->first_bus = NULL;
	160	b->last_bus = NULL;
	161	b->br_dev = parent;
	162	parent->bridge = b;
	163	pacc->debug("Tree: bridge %04x:%02x:%02x.%d\n", b->domain,
	164	parent->dev->bus, parent->dev->dev, parent->dev->func);
	165	}
c7a34993 MM	166	*last_br = NULL;
	167
	168	/* Create a bridge tree */
	169
	170	for (b=&host_bridge; b; b=b->chain)
	171	{
67954c8b PR	172	struct device *br_dev = b->br_dev;
	173	struct bridge c, best = NULL;
	174	struct device *parent = NULL;
	175
	176	if (br_dev && (br_dev->dev->known_fields & PCI_FILL_PARENT))
	177	parent = find_device(br_dev->dev->parent);
	178	if (parent)
	179	best = parent->bridge;
	180	if (!best)
c7a34993 MM	181	for (c=&host_bridge; c; c=c->chain)
	182	if (c != b && (c == &host_bridge \|\| b->domain == c->domain) &&
	183	b->primary >= c->secondary && b->primary <= c->subordinate &&
	184	(!best \|\| best->subordinate - best->primary > c->subordinate - c->primary))
	185	best = c;
	186	if (best)
	187	{
	188	b->next = best->child;
	189	best->child = b;
	190	}
	191	}
	192
	193	/* Insert secondary bus for each bridge */
	194
	195	for (b=&host_bridge; b; b=b->chain)
	196	if (!find_bus(b, b->domain, b->secondary))
	197	new_bus(b, b->domain, b->secondary);
	198
	199	/* Create bus structs and link devices */
	200
6b056c8e MM	201	for (d=first_dev; d; d=d->next)
6b056c8e MM	202	insert_dev(d, &host_bridge);
c7a34993 MM	203	}
c7a34993 MM	204
d1b22bb0 MM	205	#define LINE_BUF_SIZE 1024
d1b22bb0 MM	206
c7a34993 MM	207	static void
	208	print_it(char line, char p)
	209	{
c7a34993 MM	210	*p = 0;
c7a34993 MM	211	fputs(line, stdout);
d1b22bb0 MM	212	if (p >= line + LINE_BUF_SIZE - 1)
	213	fputs("...", stdout);
	214	putchar('\n');
c7a34993 MM	215	for (p=line; *p; p++)
	216	if (p == '+' \|\| p == '\|')
	217	*p = '\|';
	218	else
	219	*p = ' ';
	220	}
	221
	222	static void show_tree_bridge(struct bridge , char , char *);
	223
76d47191 MM	224	static char * FORMAT_CHECK(printf, 3, 4)
	225	tree_printf(char line, char p, char *fmt, ...)
	226	{
	227	va_list args;
d1b22bb0	228	int space = line + LINE_BUF_SIZE - 1 - p;
76d47191	229
d1b22bb0	230	if (space <= 0)
76d47191 MM	231	return p;
	232
	233	va_start(args, fmt);
d1b22bb0	234	int res = vsnprintf(p, space, fmt, args);
76d47191 MM	235	if (res < 0)
76d47191 MM	236	{
d1b22bb0 MM	237	/* Ancient C libraries return -1 on overflow and they do not truncate the output properly. */
	238	*p = 0;
	239	p += space;
76d47191	240	}
d1b22bb0	241	else if (res >= space)
7eb8b947 PR	242	{
	243	/* Ancient C libraries do not truncate the output properly. */
	244	*(p+space-1) = 0;
	245	p += space;
	246	}
76d47191 MM	247	else
	248	p += res;
	249
	250	va_end(args);
	251	return p;
	252	}
	253
c7a34993 MM	254	static void
	255	show_tree_dev(struct device d, char line, char *p)
	256	{
	257	struct pci_dev *q = d->dev;
	258	struct bridge *b;
	259	char namebuf[256];
	260
76d47191	261	p = tree_printf(line, p, "%02x.%x", q->dev, q->func);
c7a34993 MM	262	for (b=&host_bridge; b; b=b->chain)
	263	if (b->br_dev == d)
	264	{
fd9c6a29 PR	265	if (b->secondary == 0)
	266	p = tree_printf(line, p, "-");
	267	else if (b->secondary == b->subordinate)
76d47191	268	p = tree_printf(line, p, "-[%02x]-", b->secondary);
c7a34993	269	else
76d47191	270	p = tree_printf(line, p, "-[%02x-%02x]-", b->secondary, b->subordinate);
c7a34993 MM	271	show_tree_bridge(b, line, p);
	272	return;
	273	}
	274	if (verbose)
76d47191 MM	275	p = tree_printf(line, p, " %s",
	276	pci_lookup_name(pacc, namebuf, sizeof(namebuf),
	277	PCI_LOOKUP_VENDOR \| PCI_LOOKUP_DEVICE,
	278	q->vendor_id, q->device_id));
c7a34993 MM	279	print_it(line, p);
	280	}
	281
	282	static void
	283	show_tree_bus(struct bus b, char line, char *p)
	284	{
	285	if (!b->first_dev)
	286	print_it(line, p);
6b056c8e	287	else if (!b->first_dev->bus_next)
c7a34993	288	{
76d47191	289	p = tree_printf(line, p, "--");
c7a34993 MM	290	show_tree_dev(b->first_dev, line, p);
	291	}
	292	else
	293	{
	294	struct device *d = b->first_dev;
6b056c8e	295	while (d->bus_next)
c7a34993	296	{
76d47191 MM	297	char *p2 = tree_printf(line, p, "+-");
76d47191 MM	298	show_tree_dev(d, line, p2);
6b056c8e	299	d = d->bus_next;
c7a34993	300	}
76d47191 MM	301	p = tree_printf(line, p, "\\-");
76d47191 MM	302	show_tree_dev(d, line, p);
c7a34993 MM	303	}
	304	}
	305
	306	static void
	307	show_tree_bridge(struct bridge b, char line, char *p)
	308	{
	309	*p++ = '-';
	310	if (!b->first_bus->sibling)
	311	{
	312	if (b == &host_bridge)
76d47191	313	p = tree_printf(line, p, "[%04x:%02x]-", b->domain, b->first_bus->number);
c7a34993 MM	314	show_tree_bus(b->first_bus, line, p);
	315	}
	316	else
	317	{
	318	struct bus *u = b->first_bus;
	319	char *k;
	320
	321	while (u->sibling)
	322	{
76d47191	323	k = tree_printf(line, p, "+-[%04x:%02x]-", u->domain, u->number);
c7a34993 MM	324	show_tree_bus(u, line, k);
	325	u = u->sibling;
	326	}
76d47191	327	k = tree_printf(line, p, "\\-[%04x:%02x]-", u->domain, u->number);
c7a34993 MM	328	show_tree_bus(u, line, k);
	329	}
	330	}
	331
	332	void
888ddf0e	333	show_forest(struct pci_filter *filter)
c7a34993	334	{
76d47191	335	char line[LINE_BUF_SIZE];
888ddf0e GK	336	if (filter == NULL)
	337	show_tree_bridge(&host_bridge, line, line);
	338	else
	339	{
	340	struct bridge *b;
	341	for (b=&host_bridge; b; b=b->chain)
	342	{
	343	if (b->br_dev && pci_filter_match(filter, b->br_dev->dev))
	344	{
	345	struct pci_dev *d = b->br_dev->dev;
	346	char *p = line;
76d47191	347	p = tree_printf(line, p, "%04x:%02x:", d->domain_16, d->bus);
888ddf0e GK	348	show_tree_dev(b->br_dev, line, p);
	349	}
	350	}
	351	}
c7a34993	352	}