From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <gaetan.rivet@6wind.com>
Received: from mail-wr0-f194.google.com (mail-wr0-f194.google.com
 [209.85.128.194]) by dpdk.org (Postfix) with ESMTP id DEC7B7286
 for <dev@dpdk.org>; Wed, 21 Mar 2018 18:16:05 +0100 (CET)
Received: by mail-wr0-f194.google.com with SMTP id c24so5987822wrc.6
 for <dev@dpdk.org>; Wed, 21 Mar 2018 10:16:05 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=6wind-com.20150623.gappssmtp.com; s=20150623;
 h=from:to:cc:subject:date:message-id:in-reply-to:references
 :in-reply-to:references;
 bh=6eZGoRLBzWwv3l2iaVF6qtwccKDlyB5ZmUHYY78ogm0=;
 b=P/bpchrvZR7USjgYPyB7PoHcaFu+1uoFfAiyQBeQt8aUd/DjCFY33jPCuuvB26QJB0
 zT7uQE/+Bzbdsk0jKG+R4opjqg62RSKoxYxIlXRDPsYqRV53YiphvhApJ9RVJw5PrnIF
 FkYzhGigmldYtf4iHEtm+q8M6q/LVmMrto2eYg5rFpzKXKxM6ksnk15TXFR93Dlr5kye
 WinfwX7HPtukc750U0ZDlTjQGK+OKJUbMP8qGSh2BtvbKGyBXZZtH16psicd8ewfqk4x
 27KnWOz/NICZ80Iy2tSdmet7MANrv4FcADOHVtQ0FCspALnjuI16NYgo+wvTPImPcPBI
 cRUA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20161025;
 h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to
 :references:in-reply-to:references;
 bh=6eZGoRLBzWwv3l2iaVF6qtwccKDlyB5ZmUHYY78ogm0=;
 b=n1XAY7sN2fGu9NihVNzee92ocpI9bTE1ZOTvr6RVkFmHClO64nCKzvxlARenYxph4E
 VBunZPNUo45shHzMZiW1OWg/C/LjGaHBFmlQJ5/s1QkrmgglUoUt1MQmDiCCmgdlj8KP
 trTiHCLAIDDidGVMUIAqBFa7Tiz01XvF6CLbbwD2vhMxtgskDnsVHS6kxjyXrc624+mb
 l6dzX6RC3n8icynSZF09juaFwxbGCcELxiy6JIWiKEs7rUKcEYgyNHZiMtKYk6B8IOYN
 aNUEajhobLcV5ZfAu4/A5ysPdTDoMe+0LskFiKLvHWFGkGbJx96w2A16nkco2Rn56rpp
 ZTow==
X-Gm-Message-State: AElRT7EUs4fQ1Js/GDZ2IIv+30+KgIR4sdwKmIT+wtwT5TIvZcRm6f/g
 DGm5g/cP12U/SsbQP6jyYIuk+VB4
X-Google-Smtp-Source: AG47ELvevb0hrF6t3zPwgyXVvFJFAfyKFHdqVPfL+RNv3TkyXNS2YBS7IdOfMUJY2Jy5YDNHO/DSSQ==
X-Received: by 10.223.135.115 with SMTP id 48mr10123808wrz.27.1521652564948;
 Wed, 21 Mar 2018 10:16:04 -0700 (PDT)
Received: from bidouze.dev.6wind.com. (host.78.145.23.62.rev.coltfrance.com.
 [62.23.145.78])
 by smtp.gmail.com with ESMTPSA id l10sm4224101wrf.37.2018.03.21.10.16.03
 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Wed, 21 Mar 2018 10:16:04 -0700 (PDT)
From: Gaetan Rivet <gaetan.rivet@6wind.com>
To: dev@dpdk.org
Cc: Gaetan Rivet <gaetan.rivet@6wind.com>
Date: Wed, 21 Mar 2018 18:15:26 +0100
Message-Id: <efa7a6109770614e515ad47cf48c5c1ad0cacda2.1521652453.git.gaetan.rivet@6wind.com>
X-Mailer: git-send-email 2.11.0
In-Reply-To: <cover.1521652453.git.gaetan.rivet@6wind.com>
References: <cover.1521124599.git.gaetan.rivet@6wind.com>
 <cover.1521652453.git.gaetan.rivet@6wind.com>
In-Reply-To: <cover.1521652453.git.gaetan.rivet@6wind.com>
References: <cover.1521652453.git.gaetan.rivet@6wind.com>
Subject: [dpdk-dev] [PATCH v2 05/18] eal/dev: add device iterator interface
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 21 Mar 2018 17:16:06 -0000

A device iterator allows iterating over a set of devices.
This set is defined by the two descriptions offered,

  * rte_bus
  * rte_class

Only one description can be provided, or both. It is not allowed to
provide no description at all.

Each layer of abstraction then performs a filter based on the
description provided. This filtering allows iterating on their internal
set of devices, stopping when a match is valid and returning the current
iteration context.

This context allows starting the next iteration from the same point and
going forward.

Signed-off-by: Gaetan Rivet <gaetan.rivet@6wind.com>
---
 lib/librte_eal/common/include/rte_dev.h | 47 +++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/lib/librte_eal/common/include/rte_dev.h b/lib/librte_eal/common/include/rte_dev.h
index b688f1efd..937ff6079 100644
--- a/lib/librte_eal/common/include/rte_dev.h
+++ b/lib/librte_eal/common/include/rte_dev.h
@@ -263,6 +263,53 @@ __attribute__((used)) = str
 static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
 __attribute__((used)) = str
 
+/**
+ * Iteration context.
+ *
+ * This context carries over the current iteration state.
+ */
+struct rte_dev_iterator {
+	const char *devstr; /**< device string. */
+	const char *busstr; /**< bus-related part of device string. */
+	const char *clsstr; /**< class-related part of device string. */
+	struct rte_bus *bus; /**< bus handle. */
+	struct rte_class *cls; /**< class handle. */
+	struct rte_device *device; /**< current position. */
+	void *class_device; /**< additional specialized context. */
+};
+
+/**
+ * Device iteration function.
+ *
+ * Find the next device matching properties passed in parameters.
+ * The function takes an additional ``start`` parameter, that is
+ * used as starting context when relevant.
+ *
+ * The function returns the current element in the iteration.
+ * This return value will potentially be used as a start parameter
+ * in subsequent calls to the function.
+ *
+ * The additional iterator parameter is only there if a specific
+ * implementation needs additional context. It must not be modified by
+ * the iteration function itself.
+ *
+ * @param start
+ *   Starting iteration context.
+ *
+ * @param devstr
+ *   Device description string.
+ *
+ * @param it
+ *   Device iterator.
+ *
+ * @return
+ *   The address of the current element matching the device description
+ *   string.
+ */
+typedef void *(*rte_dev_iterate_t)(const void *start,
+				   const char *devstr,
+				   const struct rte_dev_iterator *it);
+
 #ifdef __cplusplus
 }
 #endif
-- 
2.11.0