nuttx/lib
patacongo cf3d515a6b Fix a couple of recently introduced build problems
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3463 42af7a65-404d-4744-a932-0658087f49c3
2011-04-04 21:02:15 +00:00
..
libgen Move more files into subdirectories under lib/ 2011-03-30 22:17:36 +00:00
math Move more files into subdirectories under lib/ 2011-03-30 21:58:17 +00:00
misc Move memory manager into user space 2011-04-03 20:41:49 +00:00
mqueue Move more functions out of sched/ to lib/; proxies almost build 2011-04-02 01:23:08 +00:00
net Move more files into subdirectories under lib/ 2011-03-30 21:58:17 +00:00
pthread Fix a couple of recently introduced build problems 2011-04-04 21:02:15 +00:00
queue Move more files into subdirectories under lib/ 2011-03-30 21:15:57 +00:00
sched Move more functions out of sched/ to lib/; proxies almost build 2011-04-02 01:23:08 +00:00
semaphore Kernel build mostly successful 2011-04-02 15:25:22 +00:00
signal Kernel build mostly successful 2011-04-02 15:25:22 +00:00
stdio Kernel build mostly successful 2011-04-02 15:25:22 +00:00
stdlib Move more functions out of sched/ to lib/; proxies almost build 2011-04-02 01:23:08 +00:00
string Kernel build mostly successful 2011-04-02 15:25:22 +00:00
time Move more files into subdirectories under lib/ 2011-03-30 21:15:57 +00:00
unistd Kernel build mostly successful 2011-04-02 15:25:22 +00:00
lib_internal.h
Makefile Kernel build mostly successful 2011-04-02 15:25:22 +00:00
README.txt Kernel build mostly successful 2011-04-02 15:25:22 +00:00

lib
===

This directory contains numerous, small functions typically associated with
what you would expect to find in a standard C library.  The sub-directories
in this directory contain standard interface that can be executed by user-
mode programs.

Normally, NuttX is built with no protection and all threads running in kerne-
mode.  In that model, there is no real architectural distinction between
what is a kernel-mode program and what is a user-mode program; the system is
more like on multi-threaded program that all runs in kernel-mode.

But if the CONFIG_NUTTX_KERNEL option is selected, NuttX will be built into
distinct user-mode and kernel-mode sections.  In that case, most of the
code in the nuttx/ directory will run in kernel-mode with with exceptions
of (1) the user-mode "proxies" found in syscall/proxies, and (2) the
standard C library functions found in this directory.  In this build model,
it is critical to separate the user-mode OS interfaces in this way.

Sub-Directories
===============

The files in the lib/ directory are organized (mostly) according which file
in the include/ directory provides the prototype for library functions.  So
we have:

  libgen    - libgen.h
  math      - math.h and fixedmath.h
  mqueue    - pthread.h
  net       - Various network-related header files: netinet/ether.h, arpa/inet.h
  pthread   - pthread.h
  queue     - queue.h
  sched     - sched.h
  semaphore - semaphore.h
  stdio     - stdio.h
  stdlib    - stdlib.h
  string    - string.h
  time      - time.h
  unistd    - unistd.h

There is also a misc/ subdirectory that contains various internal functions
and interfaces from header files that are too few to warrant their own sub-
directory:

 misc       - Nonstandard "glue" logic, debug.h, crc32.h, dirent.h