Skip to content

libc: add strerror() to minimal libc #16527

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

Closed
wants to merge 1 commit into from
Closed

libc: add strerror() to minimal libc #16527

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 lib/libc/minimal/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ zephyr_library_sources(
source/string/strncasecmp.c
source/string/strstr.c
source/string/string.c
source/string/strerror.c
source/stdout/prf.c
source/stdout/stdout_console.c
source/stdout/sprintf.c
Expand Down
1 change: 1 addition & 0 deletions lib/libc/minimal/include/string.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ extern char *strcat(char *_MLIBC_RESTRICT dest,
extern char *strncat(char *_MLIBC_RESTRICT d, const char *_MLIBC_RESTRICT s,
size_t n);
extern char *strstr(const char *s, const char *find);
extern char *strerror(int e);

extern int memcmp(const void *m1, const void *m2, size_t n);
extern void *memmove(void *d, const void *s, size_t n);
Expand Down
112 changes: 112 additions & 0 deletions lib/libc/minimal/source/string/__strerror.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
/*
* Copyright © 2005-2014 Rich Felker, et al.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

/* From: https://fossies.org/dox/musl-1.1.22/____strerror_8h_source.html */

E(EILSEQ, "Illegal byte sequence")
E(EDOM, "Domain error")
E(ERANGE, "Result not representable")

E(ENOTTY, "Not a tty")
E(EACCES, "Permission denied")
E(EPERM, "Operation not permitted")
E(ENOENT, "No such file or directory")
E(ESRCH, "No such process")
E(EEXIST, "File exists")

E(ENOSPC, "No space left on device")
E(ENOMEM, "Out of memory")

E(EBUSY, "Resource busy")
E(EINTR, "Interrupted system call")
E(EAGAIN, "Resource temporarily unavailable")
E(ESPIPE, "Invalid seek")

E(EXDEV, "Cross-device link")
E(EROFS, "Read-only file system")
E(ENOTEMPTY, "Directory not empty")

E(ECONNRESET, "Connection reset by peer")
E(ETIMEDOUT, "Operation timed out")
E(ECONNREFUSED, "Connection refused")
E(EHOSTDOWN, "Host is down")
E(EHOSTUNREACH, "Host is unreachable")
E(EADDRINUSE, "Address in use")

E(EPIPE, "Broken pipe")
E(EIO, "I/O error")
E(ENXIO, "No such device or address")
E(ENOTBLK, "Block device required")
E(ENODEV, "No such device")
E(ENOTDIR, "Not a directory")
E(EISDIR, "Is a directory")
E(ETXTBSY, "Text file busy")
E(ENOEXEC, "Exec format error")

E(EINVAL, "Invalid argument")

E(E2BIG, "Argument list too long")
E(ELOOP, "Symbolic link loop")
E(ENAMETOOLONG, "Filename too long")
E(ENFILE, "Too many open files in system")
E(EMFILE, "No file descriptors available")
E(EBADF, "Bad file descriptor")
E(ECHILD, "No child process")
E(EFAULT, "Bad address")
E(EFBIG, "File too large")
E(EMLINK, "Too many links")
E(ENOLCK, "No locks available")

E(EDEADLK, "Resource deadlock would occur")
E(ECANCELED, "Operation canceled")
E(ENOSYS, "Function not implemented")
E(ENOMSG, "No message of desired type")
E(ENOSTR, "Device not a stream")
E(ENODATA, "No data available")
E(ETIME, "Device timeout")
E(ENOSR, "Out of streams resources")
E(EPROTO, "Protocol error")
E(EBADMSG, "Bad message")
E(ENOTSOCK, "Not a socket")
E(EDESTADDRREQ, "Destination address required")
E(EMSGSIZE, "Message too large")
E(EPROTOTYPE, "Protocol wrong type for socket")
E(ENOPROTOOPT, "Protocol not available")
E(EPROTONOSUPPORT, "Protocol not supported")
E(ESOCKTNOSUPPORT, "Socket type not supported")
E(ENOTSUP, "Not supported")
E(EPFNOSUPPORT, "Protocol family not supported")
E(EAFNOSUPPORT, "Address family not supported by protocol")
E(EADDRNOTAVAIL, "Address not available")
E(ENETDOWN, "Network is down")
E(ENETUNREACH, "Network unreachable")
E(ENETRESET, "Connection reset by network")
E(ECONNABORTED, "Connection aborted")
E(ENOBUFS, "No buffer space available")
E(EISCONN, "Socket is connected")
E(ENOTCONN, "Socket not connected")
E(ESHUTDOWN, "Cannot send after socket shutdown")
E(EALREADY, "Operation already in progress")
E(EINPROGRESS, "Operation in progress")

E(0, "No error information")
Copy link
Contributor

@rakons rakons Jun 5, 2019

Choose a reason for hiding this comment

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

0 - operation finished successfully?
Moreover - the current implementation of strerror function requires this one to be the last one. It has to be commented or the implementation should be changed.

48 changes: 48 additions & 0 deletions lib/libc/minimal/source/string/strerror.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/*
* Copyright © 2005-2014 Rich Felker, et al.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

/* Based on: https://fossies.org/dox/musl-1.1.22/strerror_8c_source.html */

#include <errno.h>

#define E(a, b) ((unsigned char)a),
Copy link
Contributor

@rakons rakons Jun 5, 2019

Choose a reason for hiding this comment

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

Do not cast to unsigned char here - you are removing a compiler warning if any code does not fit 8 bit (I get that it should be not an issue, but it seems not to make any sense to remove this warning if it happens).

static const unsigned char errid[] = {
#include "__strerror.h"
};

#undef E
#define E(a, b) b,
static const char * const errmsg[] = {
#include "__strerror.h"
};

char *strerror(int e)
{
int i;

for (i = 0; errid[i] && errid[i] != e; i++) {
Copy link
Contributor

@rakons rakons Jun 5, 2019

Choose a reason for hiding this comment

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

why not:

for (i=0; i<ARRAY_SIZE(errid); i++) {
   if (errid[i] == e) {
      return errmsg[i];
   }
}
return "No error description found";

This way no special mark inside the errid has to be implemented.

/* intentionally left blank */
}
return (char *)errmsg[i];
Copy link
Contributor

@rakons rakons Jun 5, 2019

Choose a reason for hiding this comment

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

I cannot agree about removing "const" modifier like here. It is very risky. I would prefer to have a non-standard strerror implementation that returns const char* instead of such a dirty trick.

}