鸿蒙轻内核M核源码分析系列之Newlib C

时间：2022-05-09 14:04:46

鸿蒙轻内核M核源码分析系列之Newlib C

LiteOS-M内核LibC实现有2种，可以根据需求进行二选一，分别是musl libC和newlibc。本文先学习下Newlib C的实现代码。文中所涉及的源码，均可以在开源站点https://gitee.com/openharmony/kernel_liteos_m 获取。

使用Musl C库的时候，内核提供了基于LOS_XXX适配实现pthread、mqeue、fs、semaphore、time等模块的posix接口(//kernel/liteos_m/kal/posix)。内核提供的posix接口与musl中的标准C库接口共同组成LiteOS-M的LibC。编译时使用arm-none-eabi-gcc，但只使用其工具链的编译功能，通过加上-nostdinc与-nostdlib强制使用我们自己改造后的musl-C。

社区及三方厂商开发多使用公版工具链arm-none-eabi-gcc加上私有定制优化进行编译，LiteOS-M内核也支持公版arm-none-eabi-gcc C库编译内核运行。newlib是小型C库，针对posix接口涉及系统调用的部分，newlib提供一些需要系统适配的钩子函数，例如_exit()，_open()，_close()，_gettimeofday()等，操作系统适配这些钩子，就可以使用公版newlib工具链编译运行程序。

1、Newlib C文件系统

在使用Newlib C并且使能支持POSIX FS API时(可以在kernel\liteos-m\目录下，执行make meuconfig弹出配置界面，路径为Compat-Choose libc implementation)，如下图所示。可以使用文件kal\libc\newlib\porting\src\fs.c中定义的文件系统操作接口。这些是标准的POSIX接口，如果想了解POSIX用法，可以在linux平台输入 man -a 函数名称，比如man -a opendir来打开函数的手册。

鸿蒙轻内核M核源码分析系列之Newlib C

1.1 函数mount、umount和umount2

这些函数的用法，函数实现和musl c部分一致。

  1. int mount(const char *source, const char *target,
  2. const char *filesystemtype, unsigned long mountflags,
  3. const void *data)
  4. {
  5. return LOS_FsMount(source, target, filesystemtype, mountflags, data);
  6. }
  8. int umount(const char *target)
  9. {
  10. return LOS_FsUmount(target);
  11. }
  13. int umount2(const char *target, int flag)
  14. {
  15. return LOS_FsUmount2(target, flag);
  16. }

1.2 文件操作接口

以下划线开头的函数实现是newlib c的钩子函数实现。有关newlib的钩子函数调用过程下文专门分析下。

  1. int _open(const char *path, int oflag, ...)
  2. {
  3. va_list vaList;
  4. va_start(vaList, oflag);
  5. int ret;
  6. ret = LOS_Open(path, oflag);
  7. va_end(vaList);
  8. return ret;
  9. }
  11. int _close(int fd)
  12. {
  13. return LOS_Close(fd);
  14. }
  16. ssize_t _read(int fd, void *buf, size_t nbyte)
  17. {
  18. return LOS_Read(fd, buf, nbyte);
  19. }
  21. ssize_t _write(int fd, const void *buf, size_t nbyte)
  22. {
  23. return LOS_Write(fd, buf, nbyte);
  24. }
  26. off_t _lseek(int fd, off_t offset, int whence)
  27. {
  28. return LOS_Lseek(fd, offset, whence);
  29. }
  31. int _unlink(const char *path)
  32. {
  33. return LOS_Unlink(path);
  34. }
  36. int _fstat(int fd, struct stat *buf)
  37. {
  38. return LOS_Fstat(fd, buf);
  39. }
  41. int _stat(const char *path, struct stat *buf)
  42. {
  43. return LOS_Stat(path, buf);
  44. }
  46. int fsync(int fd)
  47. {
  48. return LOS_Fsync(fd);
  49. }
  51. int mkdir(const char *path, mode_t mode)
  52. {
  53. return LOS_Mkdir(path, mode);
  54. }
  56. DIR *opendir(const char *dirName)
  57. {
  58. return LOS_Opendir(dirName);
  59. }
  61. struct dirent *readdir(DIR *dir)
  62. {
  63. return LOS_Readdir(dir);
  64. }
  66. int closedir(DIR *dir)
  67. {
  68. return LOS_Closedir(dir);
  69. }
  71. int rmdir(const char *path)
  72. {
  73. return LOS_Unlink(path);
  74. }
  76. int rename(const char *oldName, const char *newName)
  77. {
  78. return LOS_Rename(oldName, newName);
  79. }
  81. int statfs(const char *path, struct statfs *buf)
  82. {
  83. return LOS_Statfs(path, buf);
  84. }
  86. int ftruncate(int fd, off_t length)
  87. {
  88. return LOS_Ftruncate(fd, length);
  89. }

在newlib没有使能使能支持POSIX FS API时时，需要提供这些钩子函数的空的实现，返回-1错误码即可。

  1. int _open(const char *path, int oflag, ...)
  2. {
  3. return -1;
  4. }
  6. int _close(int fd)
  7. {
  8. return -1;
  9. }
  11. ssize_t _read(int fd, void *buf, size_t nbyte)
  12. {
  13. return -1;
  14. }
  16. ssize_t _write(int fd, const void *buf, size_t nbyte)
  17. {
  18. return -1;
  19. }
  21. off_t _lseek(int fd, off_t offset, int whence)
  22. {
  23. return -1;
  24. }
  26. int _unlink(const char *path)
  27. {
  28. return -1;
  29. }
  31. int _fstat(int fd, struct stat *buf)
  32. {
  33. return -1;
  34. }
  36. int _stat(const char *path, struct stat *buf)
  37. {
  38. return -1;
  39. }

2、Newlib C内存分配释放

newlibc 的malloc适配参考The Red Hat newlib C Library-malloc。实现malloc适配有以下两种方法：

  • 实现 _sbrk_r 函数。这种方法中，内存分配函数使用newlib中的。
  • 实现 _malloc_r, _realloc_r, _free_r, _memalign_r, _malloc_usable_size_r等。这种方法中，内存分配函数可以使用内核的。

为了方便地根据业务进行内存分配算法调优和问题定位，推荐选择后者。内核的内存函数定义在文件kal\libc\newlib\porting\src\malloc.c中。源码片段如下，代码实现比较简单，不再分析源码。

  1. ......
  2. void __wrap__free_r(struct _reent *reent, void *aptr)
  3. {
  4. if (aptr == NULL) {
  5. return;
  6. }
  8. LOS_MemFree(OS_SYS_MEM_ADDR, aptr);
  9. }
  11. size_t __wrap__malloc_usable_size_r(struct _reent *reent, void *aptr)
  12. {
  13. return 0;
  14. }
  16. void *__wrap__malloc_r(struct _reent *reent, size_t nbytes)
  17. {
  18. if (nbytes == 0) {
  19. return NULL;
  20. }
  22. return LOS_MemAlloc(OS_SYS_MEM_ADDR, nbytes);
  23. }
  25. void *__wrap__memalign_r(struct _reent *reent, size_t align, size_t nbytes)
  26. {
  27. if (nbytes == 0) {
  28. return NULL;
  29. }
  31. return LOS_MemAllocAlign(OS_SYS_MEM_ADDR, nbytes, align);
  32. }
  33. ......

可能已经注意到函数命名由__wrap_加上钩子函数名称两部分组成。这是因为newlib中已经存在这些函数的符号，因此需要用到gcc的wrap的链接选项替换这些函数符号为内核的实现，在设备开发板的配置文件中，比如//device/board/fnlink/v200zr/liteos_m/config.gni，新增这些函数的wrap链接选项，示例如下：

  1. board_ld_flags += [
  2. "-Wl,--wrap=_malloc_r",
  3. "-Wl,--wrap=_realloc_r",
  4. "-Wl,--wrap=_free_r",
  5. "-Wl,--wrap=_memalign_r",
  6. "-Wl,--wrap=_malloc_usable_size_r",
  7. ]

3、Newlib钩子函数介绍

以open函数的钩子函数_open为例来介绍newlib的钩子函数的调用过程。open()函数实现在newlib-cygwin\newlib\libc\syscalls\sysopen.c中，该函数会进一步调用函数_open_r，这是个可重入函数Reentrant Function，支持在多线程中运行。

  1. int
  2. open (const char *file,
  3. int flags, ...)
  4. {
  5. va_list ap;
  6. int ret;
  8. va_start (ap, flags);
  9. ret = _open_r (_REENT, file, flags, va_arg (ap, int));
  10. va_end (ap);
  11. return ret;
  12. }

所有的可重入函数定义在文件夹newlib-cygwin\newlib\libc\reent，函数_open_r定义在该文件夹的文件newlib-cygwin\newlib\libc\reent\openr.c里。函数代码如下：

  1. int
  2. _open_r (struct _reent *ptr,
  3. const char *file,
  4. int flags,
  5. int mode)
  6. {
  7. int ret;
  9. errno = 0;
  10. if ((ret = _open (file, flags, mode)) == -1 && errno != 0)
  11. ptr->_errno = errno;
  12. return ret;
  13. }

函数_open_r如上述代码所示，会进一步调用函数_open，该函数，以arm硬件平台为例，实现在newlib-cygwin\libgloss\arm\syscalls.c文件里。newlib目录是和硬件平台无关的痛殴他那个功能实现，libloss目录是底层的驱动实现，以各个硬件平台为文件夹进行组织。在特定硬件平台的目录下的syscalls.c文件里面实现了newlib需要的各个桩函数：

  1. /* Forward prototypes. */
  2. int _system (const char *);
  3. int _rename (const char *, const char *);
  4. int _isatty (int);
  5. clock_t _times (struct tms *);
  6. int _gettimeofday (struct timeval *, void *);
  7. int _unlink (const char *);
  8. int _link (const char *, const char *);
  9. int _stat (const char *, struct stat *);
  10. int _fstat (int, struct stat *);
  11. int _swistat (int fd, struct stat * st);
  12. void * _sbrk (ptrdiff_t);
  13. pid_t _getpid (void);
  14. int _close (int);
  15. clock_t _clock (void);
  16. int _swiclose (int);
  17. int _open (const char *, int, ...);
  18. int _swiopen (const char *, int);
  19. int _write (int, const void *, size_t);
  20. int _swiwrite (int, const void *, size_t);
  21. _off_t _lseek (int, _off_t, int);
  22. _off_t _swilseek (int, _off_t, int);
  23. int _read (int, void *, size_t);
  24. int _swiread (int, void *, size_t);
  25. void initialise_monitor_handles (void);

对于上文提到的函数_open，源码如下。后续不再继续分析了，LiteOS-M内核会提供这些钩子函数的实现。

  1. int
  2. _open (const char * path, int flags, ...)
  3. {
  4. return _swiopen (path, flags);
  5. }

小结

本文学习了LiteOS-M内核Newlib C的实现，特别是文件系统和内存分配释放部分，最后介绍了Newlib钩子函数。

原文链接：https://harmonyos.51cto.com

标签：

相关文章