[v5,4/8] eal: sys/queue.h implementation for windows

  Adding sys/queue.h on windows for supporting common code.
This is implementation has BSD-3-Clause licensing.

Signed-off-by: Ranjit Menon <ranjit.menon@intel.com>
Signed-off-by: Anand Rawat <anand.rawat@intel.com>
Reviewed-by: Jeff Shaw <jeffrey.b.shaw@intel.com>
---
 .../windows/eal/include/sys/queue.h           | 320 ++++++++++++++++++
 1 file changed, 320 insertions(+)
 create mode 100644 lib/librte_eal/windows/eal/include/sys/queue.h
  

-----Original Message-----
From: dev <dev-bounces@dpdk.org> On Behalf Of Anand Rawat
Sent: Monday, March 25, 2019 11:03 PM
To: dev@dpdk.org
Cc: anand.rawat@intel.com; pallavi.kadam@intel.com; ranjit.menon@intel.com; jeffrey.b.shaw@intel.com; bruce.richardson@intel.com; thomas@monjalon.net
Subject: [dpdk-dev] [PATCH v5 4/8] eal: sys/queue.h implementation for windows

Adding sys/queue.h on windows for supporting common code.
This is implementation has BSD-3-Clause licensing.

Signed-off-by: Ranjit Menon <ranjit.menon@intel.com>
Signed-off-by: Anand Rawat <anand.rawat@intel.com>
Reviewed-by: Jeff Shaw <jeffrey.b.shaw@intel.com>
Acked-by: Harini Ramakrishnan <harini.ramakrishnan@microsoft.com>
---
 .../windows/eal/include/sys/queue.h           | 320 ++++++++++++++++++
 1 file changed, 320 insertions(+)
 create mode 100644 lib/librte_eal/windows/eal/include/sys/queue.h

diff --git a/lib/librte_eal/windows/eal/include/sys/queue.h b/lib/librte_eal/windows/eal/include/sys/queue.h
new file mode 100644
index 000000000..5ee4916ad
--- /dev/null
+++ b/lib/librte_eal/windows/eal/include/sys/queue.h
@@ -0,0 +1,320 @@
+/*-
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Copyright (c) 1991, 1993
+ *	The Regents of the University of California.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. Neither the name of the University nor the names of its contributors
+ *    may be used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ */
+
+#ifndef _SYS_QUEUE_H_
+#define	_SYS_QUEUE_H_
+
+/*
+ * This file defines tail queues.
+ *
+ * A tail queue is headed by a pair of pointers, one to the head of the
+ * list and the other to the tail of the list. The elements are doubly
+ * linked so that an arbitrary element can be removed without a need to
+ * traverse the list. New elements can be added to the list before or
+ * after an existing element, at the head of the list, or at the end of
+ * the list. A tail queue may be traversed in either direction.
+ *
+ * Below is a summary of implemented functions where:
+ *  +  means the macro is available
+ *  -  means the macro is not available
+ *  s  means the macro is available but is slow (runs in O(n) time)
+ *
+ *				TAILQ
+ * _HEAD			+
+ * _CLASS_HEAD			+
+ * _HEAD_INITIALIZER		+
+ * _ENTRY			+
+ * _CLASS_ENTRY			+
+ * _INIT			+
+ * _EMPTY			+
+ * _FIRST			+
+ * _NEXT			+
+ * _PREV			+
+ * _LAST			+
+ * _LAST_FAST			+
+ * _FOREACH			+
+ * _FOREACH_FROM		+
+ * _FOREACH_SAFE		+
+ * _FOREACH_FROM_SAFE		+
+ * _FOREACH_REVERSE		+
+ * _FOREACH_REVERSE_FROM	+
+ * _FOREACH_REVERSE_SAFE	+
+ * _FOREACH_REVERSE_FROM_SAFE	+
+ * _INSERT_HEAD			+
+ * _INSERT_BEFORE		+
+ * _INSERT_AFTER		+
+ * _INSERT_TAIL			+
+ * _CONCAT			+
+ * _REMOVE_AFTER		-
+ * _REMOVE_HEAD			-
+ * _REMOVE			+
+ * _SWAP			+
+ *
+ */
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define	QMD_TRACE_ELEM(elem)
+#define	QMD_TRACE_HEAD(head)
+#define	TRACEBUF
+#define	TRACEBUF_INITIALIZER
+
+#define	TRASHIT(x)
+#define	QMD_IS_TRASHED(x)	0
+
+#define	QMD_SAVELINK(name, link)
+
+#ifdef __cplusplus
+/*
+ * In C++ there can be structure lists and class lists:
+ */
+#define	QUEUE_TYPEOF(type) type
+#else
+#define	QUEUE_TYPEOF(type) struct type
+#endif
+
+/*
+ * Tail queue declarations.
+ */
+#define	TAILQ_HEAD(name, type)						\
+struct name {								\
+	struct type *tqh_first;	/* first element */			\
+	struct type **tqh_last;	/* addr of last next element */		\
+	TRACEBUF							\
+}
+
+#define	TAILQ_CLASS_HEAD(name, type)					\
+struct name {								\
+	class type *tqh_first;	/* first element */			\
+	class type **tqh_last;	/* addr of last next element */		\
+	TRACEBUF							\
+}
+
+#define	TAILQ_HEAD_INITIALIZER(head)					\
+	{ NULL, &(head).tqh_first, TRACEBUF_INITIALIZER }
+
+#define	TAILQ_ENTRY(type)						\
+struct {								\
+	struct type *tqe_next;	/* next element */			\
+	struct type **tqe_prev;	/* address of previous next element */	\
+	TRACEBUF							\
+}
+
+#define	TAILQ_CLASS_ENTRY(type)						\
+struct {								\
+	class type *tqe_next;	/* next element */			\
+	class type **tqe_prev;	/* address of previous next element */	\
+	TRACEBUF							\
+}
+
+/*
+ * Tail queue functions.
+ */
+#define	QMD_TAILQ_CHECK_HEAD(head, field)
+#define	QMD_TAILQ_CHECK_TAIL(head, headname)
+#define	QMD_TAILQ_CHECK_NEXT(elm, field)
+#define	QMD_TAILQ_CHECK_PREV(elm, field)
+
+#define	TAILQ_CONCAT(head1, head2, field) do {				\
+	if (!TAILQ_EMPTY(head2)) {					\
+		*(head1)->tqh_last = (head2)->tqh_first;		\
+		(head2)->tqh_first->field.tqe_prev = (head1)->tqh_last;	\
+		(head1)->tqh_last = (head2)->tqh_last;			\
+		TAILQ_INIT((head2));					\
+		QMD_TRACE_HEAD(head1);					\
+		QMD_TRACE_HEAD(head2);					\
+	}								\
+} while (0)
+
+#define	TAILQ_EMPTY(head)	((head)->tqh_first == NULL)
+
+#define	TAILQ_FIRST(head)	((head)->tqh_first)
+
+#define	TAILQ_FOREACH(var, head, field)					\
+	for ((var) = TAILQ_FIRST((head));				\
+	    (var);							\
+	    (var) = TAILQ_NEXT((var), field))
+
+#define	TAILQ_FOREACH_FROM(var, head, field)				\
+	for ((var) = ((var) ? (var) : TAILQ_FIRST((head)));		\
+	    (var);							\
+	    (var) = TAILQ_NEXT((var), field))
+
+#define	TAILQ_FOREACH_SAFE(var, head, field, tvar)			\
+	for ((var) = TAILQ_FIRST((head));				\
+	    (var) && ((tvar) = TAILQ_NEXT((var), field), 1);		\
+	    (var) = (tvar))
+
+#define	TAILQ_FOREACH_FROM_SAFE(var, head, field, tvar)			\
+	for ((var) = ((var) ? (var) : TAILQ_FIRST((head)));		\
+	    (var) && ((tvar) = TAILQ_NEXT((var), field), 1);		\
+	    (var) = (tvar))
+
+#define	TAILQ_FOREACH_REVERSE(var, head, headname, field)		\
+	for ((var) = TAILQ_LAST((head), headname);			\
+	    (var);							\
+	    (var) = TAILQ_PREV((var), headname, field))
+
+#define	TAILQ_FOREACH_REVERSE_FROM(var, head, headname, field)		\
+	for ((var) = ((var) ? (var) : TAILQ_LAST((head), headname));	\
+	    (var);							\
+	    (var) = TAILQ_PREV((var), headname, field))
+
+#define	TAILQ_FOREACH_REVERSE_SAFE(var, head, headname, field, tvar)	\
+	for ((var) = TAILQ_LAST((head), headname);			\
+	    (var) && ((tvar) = TAILQ_PREV((var), headname, field), 1);	\
+	    (var) = (tvar))
+
+#define	TAILQ_FOREACH_REVERSE_FROM_SAFE(var, head, headname, field, tvar) \
+	for ((var) = ((var) ? (var) : TAILQ_LAST((head), headname));	\
+	    (var) && ((tvar) = TAILQ_PREV((var), headname, field), 1);	\
+	    (var) = (tvar))
+
+#define	TAILQ_INIT(head) do {						\
+	TAILQ_FIRST((head)) = NULL;					\
+	(head)->tqh_last = &TAILQ_FIRST((head));			\
+	QMD_TRACE_HEAD(head);						\
+} while (0)
+
+#define	TAILQ_INSERT_AFTER(head, listelm, elm, field) do {		\
+	QMD_TAILQ_CHECK_NEXT(listelm, field);				\
+	TAILQ_NEXT((elm), field) = TAILQ_NEXT((listelm), field);	\
+	if (TAILQ_NEXT((listelm), field) != NULL)			\
+		TAILQ_NEXT((elm), field)->field.tqe_prev =		\
+		    &TAILQ_NEXT((elm), field);				\
+	else {								\
+		(head)->tqh_last = &TAILQ_NEXT((elm), field);		\
+		QMD_TRACE_HEAD(head);					\
+	}								\
+	TAILQ_NEXT((listelm), field) = (elm);				\
+	(elm)->field.tqe_prev = &TAILQ_NEXT((listelm), field);		\
+	QMD_TRACE_ELEM(&(elm)->field);					\
+	QMD_TRACE_ELEM(&(listelm)->field);				\
+} while (0)
+
+#define	TAILQ_INSERT_BEFORE(listelm, elm, field) do {			\
+	QMD_TAILQ_CHECK_PREV(listelm, field);				\
+	(elm)->field.tqe_prev = (listelm)->field.tqe_prev;		\
+	TAILQ_NEXT((elm), field) = (listelm);				\
+	*(listelm)->field.tqe_prev = (elm);				\
+	(listelm)->field.tqe_prev = &TAILQ_NEXT((elm), field);		\
+	QMD_TRACE_ELEM(&(elm)->field);					\
+	QMD_TRACE_ELEM(&(listelm)->field);				\
+} while (0)
+
+#define	TAILQ_INSERT_HEAD(head, elm, field) do {			\
+	QMD_TAILQ_CHECK_HEAD(head, field);				\
+	TAILQ_NEXT((elm), field) = TAILQ_FIRST((head));			\
+	if (TAILQ_FIRST((head)) != NULL)				\
+		TAILQ_FIRST((head))->field.tqe_prev =			\
+		    &TAILQ_NEXT((elm), field);				\
+	else								\
+		(head)->tqh_last = &TAILQ_NEXT((elm), field);		\
+	TAILQ_FIRST((head)) = (elm);					\
+	(elm)->field.tqe_prev = &TAILQ_FIRST((head));			\
+	QMD_TRACE_HEAD(head);						\
+	QMD_TRACE_ELEM(&(elm)->field);					\
+} while (0)
+
+#define	TAILQ_INSERT_TAIL(head, elm, field) do {			\
+	QMD_TAILQ_CHECK_TAIL(head, field);				\
+	TAILQ_NEXT((elm), field) = NULL;				\
+	(elm)->field.tqe_prev = (head)->tqh_last;			\
+	*(head)->tqh_last = (elm);					\
+	(head)->tqh_last = &TAILQ_NEXT((elm), field);			\
+	QMD_TRACE_HEAD(head);						\
+	QMD_TRACE_ELEM(&(elm)->field);					\
+} while (0)
+
+#define	TAILQ_LAST(head, headname)					\
+	(*(((struct headname *)((head)->tqh_last))->tqh_last))
+
+/*
+ * The FAST function is fast in that it causes no data access other
+ * then the access to the head. The standard LAST function above
+ * will cause a data access of both the element you want and
+ * the previous element. FAST is very useful for instances when
+ * you may want to prefetch the last data element.
+ */
+#define	TAILQ_LAST_FAST(head, type, field)			\
+	(TAILQ_EMPTY(head) ? NULL : __containerof((head)->tqh_last,	\
+	QUEUE_TYPEOF(type), field.tqe_next))
+
+#define	TAILQ_NEXT(elm, field) ((elm)->field.tqe_next)
+
+#define	TAILQ_PREV(elm, headname, field)				\
+	(*(((struct headname *)((elm)->field.tqe_prev))->tqh_last))
+
+#define	TAILQ_REMOVE(head, elm, field) do {				\
+	QMD_SAVELINK(oldnext, (elm)->field.tqe_next);			\
+	QMD_SAVELINK(oldprev, (elm)->field.tqe_prev);			\
+	QMD_TAILQ_CHECK_NEXT(elm, field);				\
+	QMD_TAILQ_CHECK_PREV(elm, field);				\
+	if ((TAILQ_NEXT((elm), field)) != NULL)				\
+		TAILQ_NEXT((elm), field)->field.tqe_prev =		\
+		    (elm)->field.tqe_prev;				\
+	else {								\
+		(head)->tqh_last = (elm)->field.tqe_prev;		\
+		QMD_TRACE_HEAD(head);					\
+	}								\
+	*(elm)->field.tqe_prev = TAILQ_NEXT((elm), field);		\
+	TRASHIT(*oldnext);						\
+	TRASHIT(*oldprev);						\
+	QMD_TRACE_ELEM(&(elm)->field);					\
+} while (0)
+
+#define TAILQ_SWAP(head1, head2, type, field) do {			\
+	QUEUE_TYPEOF(type) * swap_first = (head1)->tqh_first;		\
+	QUEUE_TYPEOF(type) * *swap_last = (head1)->tqh_last;		\
+	(head1)->tqh_first = (head2)->tqh_first;			\
+	(head1)->tqh_last = (head2)->tqh_last;				\
+	(head2)->tqh_first = swap_first;				\
+	(head2)->tqh_last = swap_last;					\
+	swap_first = (head1)->tqh_first;				\
+	if (swap_first != NULL)						\
+		swap_first->field.tqe_prev = &(head1)->tqh_first;	\
+	else								\
+		(head1)->tqh_last = &(head1)->tqh_first;		\
+	swap_first = (head2)->tqh_first;				\
+	if (swap_first != NULL)			\
+		swap_first->field.tqe_prev = &(head2)->tqh_first;	\
+	else								\
+		(head2)->tqh_last = &(head2)->tqh_first;		\
+} while (0)
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _SYS_QUEUE_H_ */
  

On Mon, 25 Mar 2019 23:02:34 -0700
Anand Rawat <anand.rawat@intel.com> wrote:

> +/*-
> + * SPDX-License-Identifier: BSD-3-Clause
> + *
> + * Copyright (c) 1991, 1993
> + *	The Regents of the University of California.  All rights reserved.
> + *
> + * Redistribution and use in source and binary forms, with or without
> + * modification, are permitted provided that the following conditions
> + * are met:
> + * 1. Redistributions of source code must retain the above copyright
> + *    notice, this list of conditions and the following disclaimer.
> + * 2. Redistributions in binary form must reproduce the above copyright
> + *    notice, this list of conditions and the following disclaimer in the
> + *    documentation and/or other materials provided with the distribution.
> + * 3. Neither the name of the University nor the names of its contributors
> + *    may be used to endorse or promote products derived from this software
> + *    without specific prior written permission.
> + *
> + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
> + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> + * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
> + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
> + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
> + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
> + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
> + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
> + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
> + * SUCH DAMAGE.
> + *

If you have SPDX license identifier then the text boilerplate is unnecessary
and not desired.
  

26/03/2019 20:06, Stephen Hemminger:
> On Mon, 25 Mar 2019 23:02:34 -0700
> Anand Rawat <anand.rawat@intel.com> wrote:
> 
> > +/*-
> > + * SPDX-License-Identifier: BSD-3-Clause
> > + *
> > + * Copyright (c) 1991, 1993
> > + *	The Regents of the University of California.  All rights reserved.
> > + *
> > + * Redistribution and use in source and binary forms, with or without
> > + * modification, are permitted provided that the following conditions
> > + * are met:
> > + * 1. Redistributions of source code must retain the above copyright
> > + *    notice, this list of conditions and the following disclaimer.
> > + * 2. Redistributions in binary form must reproduce the above copyright
> > + *    notice, this list of conditions and the following disclaimer in the
> > + *    documentation and/or other materials provided with the distribution.
> > + * 3. Neither the name of the University nor the names of its contributors
> > + *    may be used to endorse or promote products derived from this software
> > + *    without specific prior written permission.
> > + *
> > + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
> > + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> > + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> > + * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
> > + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
> > + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
> > + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
> > + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
> > + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
> > + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
> > + * SUCH DAMAGE.
> > + *
> 
> If you have SPDX license identifier then the text boilerplate is unnecessary
> and not desired.  

Even better would be to get it as a dependency outside of DPDK.
Where this code come from?
How other projects on Windows get it?
  

On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> 26/03/2019 20:06, Stephen Hemminger:
> > On Mon, 25 Mar 2019 23:02:34 -0700
> > Anand Rawat <anand.rawat@intel.com> wrote:
> > 
> > > +/*-
> > > + * SPDX-License-Identifier: BSD-3-Clause
> > > + *
> > > + * Copyright (c) 1991, 1993
> > > + *	The Regents of the University of California.  All rights reserved.
> > > + *
> > > + * Redistribution and use in source and binary forms, with or without
> > > + * modification, are permitted provided that the following conditions
> > > + * are met:
> > > + * 1. Redistributions of source code must retain the above copyright
> > > + *    notice, this list of conditions and the following disclaimer.
> > > + * 2. Redistributions in binary form must reproduce the above copyright
> > > + *    notice, this list of conditions and the following disclaimer in the
> > > + *    documentation and/or other materials provided with the distribution.
> > > + * 3. Neither the name of the University nor the names of its contributors
> > > + *    may be used to endorse or promote products derived from this software
> > > + *    without specific prior written permission.
> > > + *
> > > + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
> > > + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> > > + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> > > + * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
> > > + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
> > > + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
> > > + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
> > > + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
> > > + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
> > > + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
> > > + * SUCH DAMAGE.
> > > + *
> > 
> > If you have SPDX license identifier then the text boilerplate is unnecessary
> > and not desired.  

I think we'd still need the Copyright statement there, right?

> 
> Even better would be to get it as a dependency outside of DPDK.
> Where this code come from?
> How other projects on Windows get it?
> 

It comes from FreeBSD 12.0, specifically
  https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h

It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
so we reproduce it here.

Would it better to have this as a dependency outside of DPDK? I think pulling a file
from the internet and applying a patch (where we'd have to maintain a patch file
inside of DPDK's repo anyway) would be overkill when we just need a few lines of
code that will change very infrequently.
  

26/03/2019 22:14, Jeff Shaw:
> On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > Even better would be to get it as a dependency outside of DPDK.
> > Where this code come from?
> > How other projects on Windows get it?
> 
> It comes from FreeBSD 12.0, specifically
>   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> 
> It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> so we reproduce it here.
> 
> Would it better to have this as a dependency outside of DPDK? I think pulling a file
> from the internet and applying a patch (where we'd have to maintain a patch file
> inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> code that will change very infrequently.

We already try to get the libbsd dependency on Linux.
Why not mandate libbsd for Windows?
It has this header file and a lot more:
	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h

Relying on libbsd may avoid copying other files for Windows port.
  

On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> 26/03/2019 22:14, Jeff Shaw:
> > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > Even better would be to get it as a dependency outside of DPDK.
> > > Where this code come from?
> > > How other projects on Windows get it?
> > 
> > It comes from FreeBSD 12.0, specifically
> >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > 
> > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > so we reproduce it here.
> > 
> > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > from the internet and applying a patch (where we'd have to maintain a patch file
> > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > code that will change very infrequently.
> 
> We already try to get the libbsd dependency on Linux.
> Why not mandate libbsd for Windows?
> It has this header file and a lot more:
> 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> 
> Relying on libbsd may avoid copying other files for Windows port.

I like that idea, though it doesn't look like libbsd builds on Windows, do you
know of a Windows version or one that doesn't depend on autotools to build?
  

26/03/2019 22:54, Jeff Shaw:
> On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> > 26/03/2019 22:14, Jeff Shaw:
> > > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > > Even better would be to get it as a dependency outside of DPDK.
> > > > Where this code come from?
> > > > How other projects on Windows get it?
> > > 
> > > It comes from FreeBSD 12.0, specifically
> > >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > > 
> > > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > > so we reproduce it here.
> > > 
> > > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > > from the internet and applying a patch (where we'd have to maintain a patch file
> > > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > > code that will change very infrequently.
> > 
> > We already try to get the libbsd dependency on Linux.
> > Why not mandate libbsd for Windows?
> > It has this header file and a lot more:
> > 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> > 
> > Relying on libbsd may avoid copying other files for Windows port.
> 
> I like that idea, though it doesn't look like libbsd builds on Windows, do you
> know of a Windows version or one that doesn't depend on autotools to build?

It seems libbsd is not packaged for Windows.
May be worth to ask opinions to libbsd maintainers.

Please could you list which other headers are required for the Windows port?
  

On Tue, Mar 26, 2019 at 11:23:50PM +0100, Thomas Monjalon wrote:
> 26/03/2019 22:54, Jeff Shaw:
> > On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> > > 26/03/2019 22:14, Jeff Shaw:
> > > > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > > > Even better would be to get it as a dependency outside of DPDK.
> > > > > Where this code come from?
> > > > > How other projects on Windows get it?
> > > > 
> > > > It comes from FreeBSD 12.0, specifically
> > > >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > > > 
> > > > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > > > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > > > so we reproduce it here.
> > > > 
> > > > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > > > from the internet and applying a patch (where we'd have to maintain a patch file
> > > > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > > > code that will change very infrequently.
> > > 
> > > We already try to get the libbsd dependency on Linux.
> > > Why not mandate libbsd for Windows?
> > > It has this header file and a lot more:
> > > 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> > > 
> > > Relying on libbsd may avoid copying other files for Windows port.
> > 
> > I like that idea, though it doesn't look like libbsd builds on Windows, do you
> > know of a Windows version or one that doesn't depend on autotools to build?
> 
> It seems libbsd is not packaged for Windows.
> May be worth to ask opinions to libbsd maintainers.
> 
> Please could you list which other headers are required for the Windows port?

For helloworld the only one is sys/queue.h.

The dpdk-draft-windows repo has at least these (non-empty) ones:
  dirent.h
  getopt.h
  net/ethernet.h
  net/socket.h
  netinet/in.h
  netinet/tcp.h
  pthread.h
  rand48.h
  sched.h
  sys/_iovec.h
  sys/_sockaddr_storage.h
  sys/_termios.h
  sys/_types.h
  sys/cdefs.h
  sys/mman.h
  sys/netbsd/queue.h
  sys/queue.h
  sys/sysctl.h
  syslog.h
  termios.h
  unistd.h

There will likely be more as more libraries are identified with dependencies on UNIX-like
headers.
  

26/03/2019 23:34, Jeff Shaw:
> On Tue, Mar 26, 2019 at 11:23:50PM +0100, Thomas Monjalon wrote:
> > 26/03/2019 22:54, Jeff Shaw:
> > > On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> > > > 26/03/2019 22:14, Jeff Shaw:
> > > > > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > > > > Even better would be to get it as a dependency outside of DPDK.
> > > > > > Where this code come from?
> > > > > > How other projects on Windows get it?
> > > > > 
> > > > > It comes from FreeBSD 12.0, specifically
> > > > >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > > > > 
> > > > > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > > > > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > > > > so we reproduce it here.
> > > > > 
> > > > > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > > > > from the internet and applying a patch (where we'd have to maintain a patch file
> > > > > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > > > > code that will change very infrequently.
> > > > 
> > > > We already try to get the libbsd dependency on Linux.
> > > > Why not mandate libbsd for Windows?
> > > > It has this header file and a lot more:
> > > > 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> > > > 
> > > > Relying on libbsd may avoid copying other files for Windows port.
> > > 
> > > I like that idea, though it doesn't look like libbsd builds on Windows, do you
> > > know of a Windows version or one that doesn't depend on autotools to build?
> > 
> > It seems libbsd is not packaged for Windows.
> > May be worth to ask opinions to libbsd maintainers.
> > 
> > Please could you list which other headers are required for the Windows port?
> 
> For helloworld the only one is sys/queue.h.
> 
> The dpdk-draft-windows repo has at least these (non-empty) ones:
>   dirent.h
>   getopt.h
>   net/ethernet.h
>   net/socket.h
>   netinet/in.h
>   netinet/tcp.h
>   pthread.h
>   rand48.h
>   sched.h
>   sys/_iovec.h
>   sys/_sockaddr_storage.h
>   sys/_termios.h
>   sys/_types.h
>   sys/cdefs.h
>   sys/mman.h
>   sys/netbsd/queue.h
>   sys/queue.h
>   sys/sysctl.h
>   syslog.h
>   termios.h
>   unistd.h
> 
> There will likely be more as more libraries are identified with dependencies on UNIX-like
> headers.

I would like we find a good solution for these headers.
How other cross-platform projects are getting such dependencies?
Is Cygwin a solution?
  

On Wed, Mar 27, 2019 at 12:00:49AM +0100, Thomas Monjalon wrote:
> 26/03/2019 23:34, Jeff Shaw:
> > On Tue, Mar 26, 2019 at 11:23:50PM +0100, Thomas Monjalon wrote:
> > > 26/03/2019 22:54, Jeff Shaw:
> > > > On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> > > > > 26/03/2019 22:14, Jeff Shaw:
> > > > > > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > > > > > Even better would be to get it as a dependency outside of DPDK.
> > > > > > > Where this code come from?
> > > > > > > How other projects on Windows get it?
> > > > > > 
> > > > > > It comes from FreeBSD 12.0, specifically
> > > > > >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > > > > > 
> > > > > > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > > > > > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > > > > > so we reproduce it here.
> > > > > > 
> > > > > > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > > > > > from the internet and applying a patch (where we'd have to maintain a patch file
> > > > > > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > > > > > code that will change very infrequently.
> > > > > 
> > > > > We already try to get the libbsd dependency on Linux.
> > > > > Why not mandate libbsd for Windows?
> > > > > It has this header file and a lot more:
> > > > > 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> > > > > 
> > > > > Relying on libbsd may avoid copying other files for Windows port.
> > > > 
> > > > I like that idea, though it doesn't look like libbsd builds on Windows, do you
> > > > know of a Windows version or one that doesn't depend on autotools to build?
> > > 
> > > It seems libbsd is not packaged for Windows.
> > > May be worth to ask opinions to libbsd maintainers.
> > > 
> > > Please could you list which other headers are required for the Windows port?
> > 
> > For helloworld the only one is sys/queue.h.
> > 
> > The dpdk-draft-windows repo has at least these (non-empty) ones:
> >   dirent.h
> >   getopt.h
> >   net/ethernet.h
> >   net/socket.h
> >   netinet/in.h
> >   netinet/tcp.h
> >   pthread.h
> >   rand48.h
> >   sched.h
> >   sys/_iovec.h
> >   sys/_sockaddr_storage.h
> >   sys/_termios.h
> >   sys/_types.h
> >   sys/cdefs.h
> >   sys/mman.h
> >   sys/netbsd/queue.h
> >   sys/queue.h
> >   sys/sysctl.h
> >   syslog.h
> >   termios.h
> >   unistd.h
> > 
> > There will likely be more as more libraries are identified with dependencies on UNIX-like
> > headers.
> 
> I would like we find a good solution for these headers.

I agree. I think the EAL is supposed to do this, however the current implementation generally
assums a UNIX OS under the EAL. The libbsd might be a possiblity.

> How other cross-platform projects are getting such dependencies?

One example is Python. I just briefly reviewed the code and they go through great lengths to
abstract the OS and implement custom, OS independent layers wherever required (e.g. sockets,
getopt). See Modules/posixmodule.c for a 14K LOC example.

Another example is Nginx. The underlying OS is always abstracted with disparate implementations
for, e.g. unix & windows. See src/os/unix and src/os/win32. An example is the "socket()" call
on unix, nginx "core" would call "ngx_socket()" which is a macro that is defined to use
"WSASocketW" on windows, and "socket" on unix.

> Is Cygwin a solution?

I think the goal is to be a native Windows application.
  

27/03/2019 00:43, Jeff Shaw:
> On Wed, Mar 27, 2019 at 12:00:49AM +0100, Thomas Monjalon wrote:
> > 26/03/2019 23:34, Jeff Shaw:
> > > On Tue, Mar 26, 2019 at 11:23:50PM +0100, Thomas Monjalon wrote:
> > > > 26/03/2019 22:54, Jeff Shaw:
> > > > > On Tue, Mar 26, 2019 at 10:47:54PM +0100, Thomas Monjalon wrote:
> > > > > > 26/03/2019 22:14, Jeff Shaw:
> > > > > > > On Tue, Mar 26, 2019 at 09:52:57PM +0100, Thomas Monjalon wrote:
> > > > > > > > Even better would be to get it as a dependency outside of DPDK.
> > > > > > > > Where this code come from?
> > > > > > > > How other projects on Windows get it?
> > > > > > > 
> > > > > > > It comes from FreeBSD 12.0, specifically
> > > > > > >   https://github.com/freebsd/freebsd/blob/releng/12.0/sys/sys/queue.h
> > > > > > > 
> > > > > > > It has been modified such that only the parts used by DPDK (i.e. TAILQ) are
> > > > > > > implemented. The other stuff has been deleted. Windows does not have sys/queue.h,
> > > > > > > so we reproduce it here.
> > > > > > > 
> > > > > > > Would it better to have this as a dependency outside of DPDK? I think pulling a file
> > > > > > > from the internet and applying a patch (where we'd have to maintain a patch file
> > > > > > > inside of DPDK's repo anyway) would be overkill when we just need a few lines of
> > > > > > > code that will change very infrequently.
> > > > > > 
> > > > > > We already try to get the libbsd dependency on Linux.
> > > > > > Why not mandate libbsd for Windows?
> > > > > > It has this header file and a lot more:
> > > > > > 	https://gitlab.freedesktop.org/libbsd/libbsd/blob/master/include/bsd/sys/queue.h
> > > > > > 
> > > > > > Relying on libbsd may avoid copying other files for Windows port.
> > > > > 
> > > > > I like that idea, though it doesn't look like libbsd builds on Windows, do you
> > > > > know of a Windows version or one that doesn't depend on autotools to build?
> > > > 
> > > > It seems libbsd is not packaged for Windows.
> > > > May be worth to ask opinions to libbsd maintainers.
> > > > 
> > > > Please could you list which other headers are required for the Windows port?
> > > 
> > > For helloworld the only one is sys/queue.h.
> > > 
> > > The dpdk-draft-windows repo has at least these (non-empty) ones:
> > >   dirent.h
> > >   getopt.h
> > >   net/ethernet.h
> > >   net/socket.h
> > >   netinet/in.h
> > >   netinet/tcp.h
> > >   pthread.h
> > >   rand48.h
> > >   sched.h
> > >   sys/_iovec.h
> > >   sys/_sockaddr_storage.h
> > >   sys/_termios.h
> > >   sys/_types.h
> > >   sys/cdefs.h
> > >   sys/mman.h
> > >   sys/netbsd/queue.h
> > >   sys/queue.h
> > >   sys/sysctl.h
> > >   syslog.h
> > >   termios.h
> > >   unistd.h
> > > 
> > > There will likely be more as more libraries are identified with dependencies on UNIX-like
> > > headers.
> > 
> > I would like we find a good solution for these headers.
> 
> I agree. I think the EAL is supposed to do this, however the current implementation generally
> assums a UNIX OS under the EAL. The libbsd might be a possiblity.

Yes, EAL is supposed to be the layer hiding the OS specifics.
It would be interesting to check how much libbsd may help EAL.

> > How other cross-platform projects are getting such dependencies?
> 
> One example is Python. I just briefly reviewed the code and they go through great lengths to
> abstract the OS and implement custom, OS independent layers wherever required (e.g. sockets,
> getopt). See Modules/posixmodule.c for a 14K LOC example.
> 
> Another example is Nginx. The underlying OS is always abstracted with disparate implementations
> for, e.g. unix & windows. See src/os/unix and src/os/win32. An example is the "socket()" call
> on unix, nginx "core" would call "ngx_socket()" which is a macro that is defined to use
> "WSASocketW" on windows, and "socket" on unix.

Yes we may need to introduce more wrappers.

> > Is Cygwin a solution?
> 
> I think the goal is to be a native Windows application.

Yes
  

On 3/26/2019 12:06 PM, Stephen Hemminger wrote:
> On Mon, 25 Mar 2019 23:02:34 -0700
> Anand Rawat <anand.rawat@intel.com> wrote:
> 
>> +/*-
>> + * SPDX-License-Identifier: BSD-3-Clause
>> + *
>> + * Copyright (c) 1991, 1993
>> + *	The Regents of the University of California.  All rights reserved.
>> + *
>> + * Redistribution and use in source and binary forms, with or without
>> + * modification, are permitted provided that the following conditions
>> + * are met:
>> + * 1. Redistributions of source code must retain the above copyright
>> + *    notice, this list of conditions and the following disclaimer.
>> + * 2. Redistributions in binary form must reproduce the above copyright
>> + *    notice, this list of conditions and the following disclaimer in the
>> + *    documentation and/or other materials provided with the distribution.
>> + * 3. Neither the name of the University nor the names of its contributors
>> + *    may be used to endorse or promote products derived from this software
>> + *    without specific prior written permission.
>> + *
>> + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
>> + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
>> + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
>> + * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
>> + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
>> + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
>> + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
>> + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
>> + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
>> + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
>> + * SUCH DAMAGE.
>> + *
> 
> If you have SPDX license identifier then the text boilerplate is unnecessary
> and not desired.
> 

The information I have received about the editing license text is to 
leave it as it is. Can continue to have boiler plate text until there is 
more clarity on it?