zmake 0.1.0

A Make/ninja-build file generator from Kconfig/YAML config files

ZMake - A Make/ninja-build file generator from Kconfig/YAML

• ZMake - A Make/ninja-build file generator from Kconfig/YAML
  • 1. Overview
  • 2. How to intsall
  • 3. How to use
  • 4. YAML Configuration
  • 5. How to add one module
  • 6. TODO

1. Overview

This is a Make/ninja-build file generator from Kconfig/YAML config files for the modularized softwares. It makes use of Make, Ninja-build and Kconfiglib. For Kconfiglib, more details could be found at github.com/ulfalizer/Kconfiglib.

The following features are supplied:

1. Project are configured by YAML file;

2. Tools and basic options for CC/AR/LD could be specified;

3. Multiple applications and libraries are supported;

4. Multiple level modules are supported;

5. Each module has its own public and/or private header files, source files(C/C++/assembly), Kconfig scripts and YAML configuration file;

6. All the files that belongs to one module are placed in one directory;

7. The following attribute of the libraries could be specified:

   • Name;
   • corresponding Kconfig option that are used to enable/disable this module;
   • Source files;
   • Public header directory;
   • Compiler flags;

8. The following attribute of the applications could be specified:

   • Name;
   • corresponding Kconfig option that are used to enable/disable this module;
   • Source files;
   • Compiler flags;
   • linker flags;
   • libraries depended that are used to include corresponding hedear files and libraries for this module;

9. The following attribute of the source files could be specified:

   • Compiler flags;

10. Kconfig scripts starts at Kconfig or other name specified by -k "Kconfig file" in the root directory, and defconfig file specified by -d "defconfig file" could be specified;

11. Build order are decided by the defined order in YAML configuration files for Makefile;

12. Build order are decided by the depends in YAML configuration files for Ninja build.

2. How to intsall

Before installation of ZMake:

1. Python3 and build tools(Make or Ninja-build) should be installed;

2. Kconfiglib should be installed:

   <path/of/demo>$ pip3 install kconfiglib
   

   Note that Kconfiglib path may be need to be added to 'PATH' environment variable; for Linux, execute export PATH=$PATH:~/.local/bin in the shell or add this command to ~/.bashrc or ~/.bash_profile;

ZMake could be installed by pip3:

$ pip3 install zmake

ZMake could be installed from source code:

$ git clone https://github.com/matthewzu/zmake.git
$ cd zmake
zmake $ python setup.py sdist bdist_wheel
zmake $ pip3 install dist/zmake-0.1.0.tar.gz

3. How to use

1. Create a source code directory with demo files:

   $ zmake-demo <path/of/demo>
   

2. Generate build script by one of the following commands:

   <path/of/demo>$ zmake <path/of/project>                     # generate Makefile
   <path/of/demo>$ zmake <path/of/project> -g ninja            # generate build.ninja
   <path/of/demo>$ zmake <path/of/project> -V                  # generate Makefile with verbose output enabled
   <path/of/demo>$ zmake <path/of/project> -d test_defconfig   # generate Makefile with defconfig file
   

   Note that: * The build log will be saved in <path/of/project>/zmake.log; * Makefile or build.ninja will be egnerated in <path/of/project>; * The more options could be used:

   $ zmake -h
   usage: zmake [-h] [-v] [-V] [-k "Kconfig file"] [-y "YAML file"]
               [-d "defconfig file" | -m "Source Code Path"] [-g {make,ninja}]
               project
   
   ZMake build Generator
   
   positional arguments:
     project               project path
   
   optional arguments:
     -h, --help            show this help message and exit
     -v, --version         show version
     -V, --verbose         enable verbose output
     -k "Kconfig file", --kconfig "Kconfig file"
                           specify Kconfig root configuration file, "Kconfig" by default
     -y "YAML file", --yaml "YAML file"
                           specify YAML root configuration file, "top.yml" by default
     -d "defconfig file", --defconfig "defconfig file"
                           specify defconfig file
     -m "Source Code Path", --menuconfig "Source Code Path"
                           enable menuconfig method, used after project created ONLY
     -g {make,ninja}, --generator {make,ninja}
                           build generator, "make" by default
   

3. Configure/build/clean project:

   <path/of/project>$ make config     # configuration project
   <path/of/project>$ make            # build project
   <path/of/project>$ make clean      # clean project
   <path/of/project>$ make V=1        # build project with verbose output enabled
   <path/of/project>$
   <path/of/project>$ ninja config    # configuration project
   <path/of/project>$ ninja           # build project
   <path/of/project>$ ninja clean     # clean project
   <path/of/project>$ ninja -v        # build project with verbose output enabled
   

4. YAML Configuration

YAML root configuration file (top.yml by default) should be created in the root directory and include the the references to other configuration files or ZMake Entity configurations. For example:

# zmake top configuartion

# includes, note that file contents MUST NOT be overlapped,
# otherwise the latter will overwrite the former.

includes:
  - mod1/mod11/mod11.yml  # library mod11 yaml
  - mod1/mod12/mod12.yml  # library mod12 yaml
  - mod2/mod2.yml         # library mod2 yaml
  - main/main.yml         # application main/mani2 yaml

# entities defines for the following types:
#   1)'var':    variables that is used to save build arguments or intermediate variables,
#   could be be referenced by '$(variable name)';
#   2)'target': target for build command(make/ninja...);
#   3)'app':    applications that could be executed;
#   4)'lib':    libraries that could be linked to applications.

# system variables
#   1)SRC_PATH: path for source code, predefined by ZMake
#   2)PRJ_PATH: path for project, predefined by ZMake

# customer variables
#
# example:
#
#   variable name:  # must be unique for all entities
#     type: var
#     desc: xxx # optional, description that is only for display
#     val:  xxx # string that could include references to other variables
                # that have beed defined, such as '$(var_name)', or any value

CC:
  type: var
  desc: compiler for objects, must be defined
  val:  gcc -MD

AR:
  type: var
  desc: archiver for libraries, must be defined
  val:  ar

LD:
  type: var
  desc: linker for applications, must be defined
  val:  gcc

# libraries
#
# example:
#
# library name:             # must be unique for all entities
#   type:       lib
#   desc:       xxx         # optional, description that is only for display
#   opt:        CONFIG_XXX  # optional, Kconfig option that decides whether library is enabled:
#                           #   if present, it must be a Kconfig option that will be 'y' or 'n';
#                           #   if absent, library will be will be forced to enable.
#   src:                    # list, source files or directories:
#     - $(ZMake variable name)/xxx/xxx.c
#     - $(ZMake variable name)/xxx  # for directory, all source files in it will be involved
#   hdrdirs:                # optional, list, public header file directories
#     - $(ZMake variable name)/xxx
#   cflags:                 # optional, additional compiler flags for C files
#     all:      xxx         # compiler flags for all C files
#     xxx.c:    xxx         # compiler flags for xxx.c
#   cppflags:               # optional, additional compiler flags for cpp files
#     all:      xxx         # compiler flags for all CPP files
#     xxx.cpp:  xxx         # compiler flags for xxx.cpp
#   asmflags:   xxx         # optional, additional compiler flags for assembly files
#     all:      xxx         # compiler flags for all assembly files
#     xxx.s:    xxx         # compiler flags for xxx.s
#     xxx.S:    xxx         # compiler flags for xxx.S

# applications
#
# example:
#
# application name:         # must be unique for all entities
#   type:       app
#   desc:       xxx         # optional, description that is only for display
#   opt:        CONFIG_XXX  # optional, Kconfig option that decides whether application is enabled:
#                           #   if present, it must be a Kconfig option that will be 'y' or 'n';
#                           #   if absent, application will be will be forced to enable.
#   src:                    # list, source files or directories:
#     - $(ZMake variable name)/xxx/xxx.c
#     - $(ZMake variable name)/xxx  # for directory, all source files in it will be involved
#   cflags:                 # optional, additional compiler flags for C files
#     all:      xxx         # compiler flags for all C files
#     xxx.c:    xxx         # compiler flags for xxx.c
#   cppflags:               # optional, additional compiler flags for cpp files
#     all:      xxx         # compiler flags for all CPP files
#     xxx.cpp:  xxx         # compiler flags for xxx.cpp
#   asmflags:   xxx         # optional, additional compiler flags for assembly files
#     all:      xxx         # compiler flags for all assembly files
#     xxx.s:    xxx         # compiler flags for xxx.s
#     xxx.S:    xxx         # compiler flags for xxx.S
#   linkflags:  xxx         # optional, additional linker flags
#   libs:       xxx         # optional, list, libraries depended:
#     - xxx

# system targets
#
#   1)config:     confogure project
#   2)all:        building all applications/libraries, default target
#   3)clean:      clean all compiled files
#
#   To enable verbose output, add "V=1" option for make or add "-v" for ninja.

# customer targets
#
# example:
#
# target name:      # must be unique for all entities
#   type: target
#   desc: xxx # optional, description that is only for display
#   cmd:  xxx # optional, commands that need be executed with description:
#     desc:   command
#   deps: xxx # optional, modules depended:
#     - xxx
#
# Note that 'cmd' and 'deps' MUST NOT be absent at the same time.

Then libraries and applications could be defined as the following:

mod11:
  type:         lib
  desc:         moudle11 library
  opt:          CONFIG_MODULE11
  src:
    - $(SRC_PATH)/mod1/mod11
  hdrdirs:
    - $(SRC_PATH)/mod1/mod11/include
  cflags:
    all:      -DMOD11
    mod11.c:  -DMOD11_MOD11 -I$(SRC_PATH)/mod1/mod11/include

main:
  type:   app
  desc:   main application
  src:
    - $(SRC_PATH)/main/main.c
  cflags:
    - all:  -DMAIN
  libs:
    - mod11
    - mod12

5. How to add one module

1. Create one directory in the framework;
2. Add souce files and YAML configuration file to this module;
3. Add public header directory with public header files to this module as you need;
4. Add private header files to this module as you need;
5. Add Kconfig files(*.config) to this module锛宎nd include them from Kconfig in the root directory of the framework.

6. TODO

1. Add support for dynamic library.