Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[libc] Provide sys/queue.h #78081

Merged
merged 6 commits into from
Jan 19, 2024
Merged

[libc] Provide sys/queue.h #78081

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7c725a9
[libc] Provide sys/queue.h
petrhosek Jan 14, 2024
fe8a1d1
Implement the remaining SLIST and STAILQ macros
petrhosek Jan 17, 2024
9a13c0a
Address review feedback
petrhosek Jan 18, 2024
5b89ca8
Fix tests
petrhosek Jan 18, 2024
668192b
Address review feedback
petrhosek Jan 18, 2024
6230748
Address review feedback
petrhosek Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions libc/config/baremetal/arm/headers.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ set(TARGET_PUBLIC_HEADERS
libc.include.stdlib
libc.include.string
libc.include.strings
libc.include.sys_queue
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be nice to add this header to the other targets as well since it should still work, and that will make sure that it's being tested by our upstream builders.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

)
1 change: 1 addition & 0 deletions libc/config/baremetal/riscv/headers.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ set(TARGET_PUBLIC_HEADERS
libc.include.stdlib
libc.include.string
libc.include.strings
libc.include.sys_queue
)
9 changes: 9 additions & 0 deletions libc/include/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,15 @@ add_gen_header(
.llvm_libc_common_h
)

add_header(
sys_queue
HDR
sys/queue.h
DEPENDS
.llvm-libc-macros.null_macro
.llvm-libc-macros.offsetof_macro
)

add_gen_header(
sys_random
DEF_FILE sys/random.h.def
Expand Down
6 changes: 6 additions & 0 deletions libc/include/llvm-libc-macros/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,12 @@ add_macro_header(
math-macros.h
)

add_macro_header(
offsetof_macro
HDR
offsetof-macro.h
)

add_macro_header(
sched_macros
HDR
Expand Down
15 changes: 15 additions & 0 deletions libc/include/llvm-libc-macros/offsetof-macro.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
//===-- Definition of the offsetof macro ----------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef __LLVM_LIBC_MACROS_OFFSETOF_MACRO_H
#define __LLVM_LIBC_MACROS_OFFSETOF_MACRO_H

#define __need_offsetof
#include <stddef.h>

#endif // __LLVM_LIBC_MACROS_OFFSETOF_MACRO_H
259 changes: 259 additions & 0 deletions libc/include/sys/queue.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,259 @@
//===-- Macros defined in sys/queue.h header file -------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef __LLVM_LIBC_MACROS_SYS_QUEUE_MACROS_H
#define __LLVM_LIBC_MACROS_SYS_QUEUE_MACROS_H

#include <llvm-libc-macros/null-macro.h>
#include <llvm-libc-macros/offsetof-macro.h>

#ifdef __cplusplus
#define QUEUE_TYPEOF(type) type
#else
#define QUEUE_TYPEOF(type) struct type
#endif

// Singly-linked list definitions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These macros seem overall fine, we normally organize our headers a bit differently. The macros should go in llvm-libc-macros/sys-queue-macros.h, which will leave this header practically empty. That's fine though, since that will allow you to use the path include/llvm-libc-macros/sys-queue-macros.h in your test which should make it guaranteed to grab the right file.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


#define SLIST_HEAD(name, type) \
struct name { \
struct type *first; \
}

#define SLIST_CLASS_HEAD(name, type) \
struct name { \
class type *first; \
}

#define SLIST_HEAD_INITIALIZER(head) \
{ NULL }

#define SLIST_ENTRY(type) \
struct { \
struct type *next; \
}

#define SLIST_CLASS_ENTRY(type) \
struct { \
class type *next; \
}

// Singly-linked list access methods.

#define SLIST_EMPTY(head) ((head)->first == NULL)
#define SLIST_FIRST(head) ((head)->first)
#define SLIST_NEXT(elem, field) ((elem)->field.next)

#define SLIST_FOREACH(var, head, field) \
for ((var) = SLIST_FIRST(head); (var); (var) = SLIST_NEXT(var, field))

#define SLIST_FOREACH_FROM(var, head, field) \
for ((var) = ((var) ? (var) : SLIST_FIRST(head)); (var); \
(var) = SLIST_NEXT(var, field))
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved

#define SLIST_FOREACH_SAFE(var, head, field, tvar) \
for ((var) = SLIST_FIRST(head); \
(var) && ((tvar) = SLIST_NEXT(var, field), 1); (var) = (tvar))

#define SLIST_FOREACH_FROM_SAFE(var, head, field, tvar) \
for ((var) = ((var) ? (var) : SLIST_FIRST(head)); \
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved
(var) && ((tvar) = SLIST_NEXT(var, field), 1); (var) = (tvar))

// Singly-linked list functions.

#define SLIST_CONCAT(head1, head2, type, field) \
do { \
if (SLIST_EMPTY(head1)) { \
if ((SLIST_FIRST(head1) = SLIST_FIRST(head2)) != NULL) \
SLIST_INIT(head2); \
} else if (!SLIST_EMPTY(head2)) { \
QUEUE_TYPEOF(type) *cur = SLIST_FIRST(head1); \
while (SLIST_NEXT(cur, field) != NULL) \
cur = SLIST_NEXT(cur, field); \
SLIST_NEXT(cur, field) = SLIST_FIRST(head2); \
SLIST_INIT(head2); \
} \
} while (0)

#define SLIST_INIT(head) \
do { \
SLIST_FIRST(head) = NULL; \
} while (0)

#define SLIST_INSERT_AFTER(slistelem, elem, field) \
do { \
SLIST_NEXT(elem, field) = SLIST_NEXT(slistelem, field); \
SLIST_NEXT(slistelem, field) = (elem); \
} while (0)

#define SLIST_INSERT_HEAD(head, elem, field) \
do { \
SLIST_NEXT(elem, field) = SLIST_FIRST(head); \
SLIST_FIRST(head) = (elem); \
} while (0)

#define SLIST_REMOVE(head, elem, type, field) \
do { \
if (SLIST_FIRST(head) == (elem)) { \
SLIST_REMOVE_HEAD(head, field); \
} else { \
QUEUE_TYPEOF(type) *cur = SLIST_FIRST(head); \
while (SLIST_NEXT(elem, field) != (elem)) \
cur = SLIST_NEXT(elem, field); \
SLIST_REMOVE_AFTER(cur, field); \
} \
} while (0)

#define SLIST_REMOVE_AFTER(elem, field) \
do { \
SLIST_NEXT(elem, field) = SLIST_NEXT(SLIST_NEXT(elem, field), field); \
} while (0)

#define SLIST_REMOVE_HEAD(head, field) \
do { \
SLIST_FIRST(head) = SLIST_NEXT(SLIST_FIRST(head), field); \
} while (0)

#define SLIST_SWAP(head1, head2, type) \
do { \
QUEUE_TYPEOF(type) *first = SLIST_FIRST(head1); \
SLIST_FIRST(head1) = SLIST_FIRST(head2); \
SLIST_FIRST(head2) = first; \
} while (0)

// Singly-linked tail queue definitions.

#define STAILQ_HEAD(name, type) \
struct name { \
struct type *first; \
struct type **last; \
}

#define STAILQ_CLASS_HEAD(name, type) \
struct name { \
class type *first; \
class type **last; \
}

#define STAILQ_HEAD_INITIALIZER(head) \
{ NULL, &(head).first }

#define STAILQ_ENTRY(type) \
struct { \
struct type *next; \
}

#define STAILQ_CLASS_ENTRY(type) \
struct { \
class type *next; \
}

// Singly-linked tail queue access methods.

#define STAILQ_EMPTY(head) ((head)->first == NULL)
#define STAILQ_FIRST(head) ((head)->first)
#define STAILQ_LAST(head, type, field) \
STAILQ_EMPTY(head) \
? NULL \
: (QUEUE_TYPEOF(type) *)((char *)(head)->last - \
offsetof(QUEUE_TYPEOF(type), field))
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved
#define STAILQ_NEXT(elem, field) ((elem)->field.next)

#define STAILQ_FOREACH(var, head, field) \
for ((var) = STAILQ_FIRST(head); (var); (var) = STAILQ_NEXT(var, field))

#define STAILQ_FOREACH_FROM(var, head, field) \
for ((var) = ((var) ? (var) : STAILQ_FIRST(head)); (var); \
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved
(var) = STAILQ_NEXT(var, field))

#define STAILQ_FOREACH_SAFE(var, head, field, tvar) \
for ((var) = STAILQ_FIRST(head); \
(var) && ((tvar) = STAILQ_NEXT(var, field), 1); (var) = (tvar))

#define STAILQ_FOREACH_SAFE(var, head, field, tvar) \
for ((var) = ((var) ? (var) : STAILQ_FIRST(head)); \
(var) && ((tvar) = STAILQ_NEXT(var, field), 1); (var) = (tvar))
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved

// Singly-linked tail queue functions.

#define STAILQ_CONCAT(head1, head2, type, field) \
do { \
if (!STAILQ_EMPTY(head2)) { \
*(head1)->last = (head2)->first; \
(head1)->last = (head2)->last; \
STAILQ_INIT(head2); \
} \
} while (0)

#define STAILQ_INIT(head) \
do { \
STAILQ_FIRST(head) = NULL; \
(head)->last = &STAILQ_FIRST(head); \
} while (0)

#define STAILQ_INSERT_AFTER(head, listelem, elem, field) \
do { \
if ((STAILQ_NEXT(elem, field) = STAILQ_NEXT(listelem, field)) == NULL) \
(head)->last = &STAILQ_NEXT(elem, field); \
STAILQ_NEXT(listelem, field) = (elem); \
} while (0)

#define STAILQ_INSERT_HEAD(head, elem, field) \
do { \
if ((STAILQ_NEXT(elem, field) = STAILQ_FIRST(head)) == NULL) \
(head)->last = &STAILQ_NEXT(elem, field); \
STAILQ_FIRST(head) = (elem); \
} while (0)

#define STAILQ_INSERT_TAIL(head, elem, field) \
do { \
STAILQ_NEXT(elem, field) = NULL; \
*(head)->last = (elem); \
(head)->last = &STAILQ_NEXT(elem, field); \
} while (0)

#define STAILQ_REMOVE(head, elem, type, field) \
do { \
if (STAILQ_FIRST(head) == (elem)) { \
STAILQ_REMOVE_HEAD(head, field); \
} else { \
QUEUE_TYPEOF(type) *cur = STAILQ_FIRST(head); \
while (STAILQ_NEXT(elem, field) != (elem)) \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be:

while (STAILQ_NEXT(cur, field) != (elem) \

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

cur = STAILQ_NEXT(cur, field); \
STAILQ_REMOVE_AFTER(head, cur, field); \
} \
} while (0)

#define STAILQ_REMOVE_AFTER(head, elem, field) \
do { \
if ((STAILQ_NEXT(elem, field) = \
STAILQ_NEXT(STAILQ_NEXT(elem, field), field)) == NULL) \
(head)->last = &STAILQ_NEXT(elem, field); \
} while (0)

#define STAILQ_REMOVE_HEAD(head, field) \
do { \
if ((STAILQ_FIRST(head) = STAILQ_NEXT(STAILQ_FIRST(head), field)) == NULL) \
(head)->last = &STAILQ_FIRST(head); \
} while (0)

#define STAILQ_SWAP(head1, head2, type) \
do { \
QUEUE_TYPEOF(type) *first = STAILQ_FIRST(head1); \
QUEUE_TYPEOF(type) **last = (head1)->last; \
STAILQ_FIRST(head1) = STAILQ_FIRST(head2); \
(head1)->last = (head2)->last; \
STAILQ_FIRST(head2) = first; \
(head2)->last = last; \
if (STAILQ_EMPTY(head1)) \
(head1)->last = &STAILQ_FIRST(head1); \
if (STAILQ_EMPTY(head2)) \
(head2)->last = &STAILQ_FIRST(head2); \
} while (0)
nickdesaulniers marked this conversation as resolved.
Show resolved Hide resolved

#endif // __LLVM_LIBC_MACROS_SYS_QUEUE_MACROS_H
1 change: 1 addition & 0 deletions libc/test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ if(LIBC_TARGET_ARCHITECTURE_IS_GPU AND
return()
endif()

add_subdirectory(include)
add_subdirectory(src)
add_subdirectory(utils)

Expand Down
13 changes: 13 additions & 0 deletions libc/test/include/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
add_custom_target(libc_include_tests)

add_libc_test(
sys_queue_test
SUITE
libc_include_tests
SRCS
sys/queue_test.cpp
DEPENDS
libc.include.sys_queue
libc.src.__support.char_vector
libc.src.__support.CPP.string
)