Skip to content

[libc] Add the <endian.h> header. #125168

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.

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

Merged
merged 4 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions libc/config/linux/aarch64/headers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ set(TARGET_PUBLIC_HEADERS
libc.include.ctype
libc.include.dlfcn
libc.include.elf
libc.include.endian
libc.include.errno
libc.include.features
libc.include.fenv
Expand Down
1 change: 1 addition & 0 deletions libc/config/linux/x86_64/headers.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ set(TARGET_PUBLIC_HEADERS
libc.include.dirent
libc.include.dlfcn
libc.include.elf
libc.include.endian
libc.include.errno
libc.include.fcntl
libc.include.features
Expand Down
1 change: 1 addition & 0 deletions libc/docs/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ if (SPHINX_FOUND)
assert
cpio
ctype
endian
errno
fenv
float
Expand Down
1 change: 1 addition & 0 deletions libc/docs/headers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Implementation Status
complex
cpio
ctype
endian
errno
fenv
float
Expand Down
9 changes: 9 additions & 0 deletions libc/include/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,15 @@ add_header_macro(
.llvm_libc_common_h
)

add_header_macro(
endian
../libc/include/endian.yaml
endian.h
DEPENDS
.llvm-libc-macros.endian_macros
.llvm_libc_common_h
)

add_header_macro(
features
../libc/include/features.yaml
Expand Down
17 changes: 17 additions & 0 deletions libc/include/endian.h.def
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
//===-- POSIX header endian.h ---------------------------------------------===//
//
// 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_ENDIAN_H
#define LLVM_LIBC_ENDIAN_H

#include "__llvm-libc-common.h"
#include "llvm-libc-macros/endian-macros.h"

%%public_api()

#endif // LLVM_LIBC_ENDIAN_H
9 changes: 9 additions & 0 deletions libc/include/endian.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
header: endian.h
header_template: endian.h.def
standards:
- POSIX
macros: []
types: []
enums: []
objects: []
functions: []
6 changes: 6 additions & 0 deletions libc/include/llvm-libc-macros/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,12 @@ add_macro_header(
elf-macros.h
)

add_macro_header(
endian_macros
HDR
endian-macros.h
)

add_macro_header(
locale_macros
HDR
Expand Down
16 changes: 16 additions & 0 deletions libc/include/llvm-libc-macros/endian-macros.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
//===-- Definition of macros from endian.h --------------------------------===//
//
// 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_ENDIAN_MACROS_H
#define LLVM_LIBC_MACROS_ENDIAN_MACROS_H

#define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
#define BIG_ENDIAN __ORDER_BIG_ENDIAN__
#define BYTE_ORDER __BYTE_ORDER__

#endif // LLVM_LIBC_MACROS_ENDIAN_MACROS_H
32 changes: 32 additions & 0 deletions libc/utils/docgen/endian.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
macros:
LITTLE_ENDIAN:
in-latest-posix: ''
BIG_ENDIAN:
in-latest-posix: ''
BYTE_ORDER:
in-latest-posix: ''
be16toh:
in-latest-posix: ''
be32toh:
in-latest-posix: ''
be64toh:
in-latest-posix: ''
htobe16:
in-latest-posix: ''
htobe32:
in-latest-posix: ''
htobe64:
in-latest-posix: ''
htole16:
in-latest-posix: ''
htole32:
in-latest-posix: ''
htole64:
in-latest-posix: ''
le16toh:
in-latest-posix: ''
le32toh:
in-latest-posix: ''
le64toh:
in-latest-posix: ''

Copy link
Member

Choose a reason for hiding this comment

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

Do you mind stubbing out the rest of the functions listed at https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/endian.h.html? Otherwise, we will render a doc where it looks like our implementation of endian.h is complete; it's not, since we don't have the functions defined. That way, folks know what to expect, and can find more places to contribute.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

I added these as macros because glibc, musl, and FreeBSD all implement them as macros. According to the POSIX standard, they can be either functions or macros.

I would like to implement these in following patches : )

Copy link
Member

Choose a reason for hiding this comment

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

SGTM; thanks! I wonder what happens if someone needs to link against them as strong symbols...