itri-sofa/sofa

SOFA (Software Orchestrated Flash Array) is a log-structured flash array management system

sofa's Issues

Eliminate the use of dangerous fgets()

Reported by Cppcheck:

[src/common/sofa_config.c:972]: (error) Buffer is accessed out of bounds: osdisk_name

The corresponding code:

    if (fgets(osdisk_name, CFG_VALSET_STR_LEN, fp) != NULL) {
        if (osdisk_name[0] != 0) {
            _remove_char_str(osdisk_name, strlen(osdisk_name), '\n');
            set_config_item(STR_OSDISK_NAME, osdisk_name, NULL);
            strcpy(osdisk_ret, osdisk_name);
            syslog(LOG_INFO, "[SOFA] USERD INFO get os disk: %s\n",
                   osdisk_name);
            ret = 0;
        } else {

Quoted from Deprecated string input functions - fget:

The fgets ("file get string") function is similar to the gets function. This function is deprecated -- that means it is obsolete and it is strongly suggested you do not use it -- because it is dangerous. It is dangerous because if the input data contains a null character, you can't tell. Don't use fgets unless you know the data cannot contain a null. Don't use it to read files edited by the user because, if the user inserts a null character, you should either handle it properly or print a clear error message. Always use getline or getdelim instead of fgets if you can.

Missing NOTICE file for copyright ownership

Each source file contains the ASF notice:

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file

• distributed with this work for additional information regarding copyright ownership.

However, there is no NOTICE file, which should contain the copyright owner information.
Example in Apache Impala: https://github.com/apache/impala/blob/master/NOTICE.txt

Uncertain license terms for sofa kernel module

The source file src/sofa_main/sofa_module_init.c declares itself as Apache License v2. However, by the end of this file, the kernel module are about to be registered as GPL via the macro MODULE_LICENSE("GPL"). The incompatibility between GPLv2/v3 and Apache License were discussed here: https://www.apache.org/licenses/GPL-compatibility.html

Therefore, the current implementation causes the uncertainty regarding licensing terms in sofa module for Linux kernel.

Clarify license terms for third-party packages

Not every piece of code is written by ITRI. For example, the files in directory src_miscComp/sofa_monitor/SOFAUI/web/jLego/js/addOns/jQuery are indeed from external jQuery, which is licensed in MIT-style licensing terms. The top-level documentation should clarify and address the third-party packages.

odd-unstable/even-stable style of versioning is dropped in Linux kernel

The file release_notes.txt mentions the following policy on versions:

Our SOFA starts with 1.0.0 version and follows the rule of Linux Kernel release.

However, such odd-unstable/even-stable style of versioning is already dropped by Linux kernel. Thus, it is not an effective role model to refer.

indicate the wrong years of publication for copyright ( No need to cover the future time).

Please refer to the link provided by jserv.
https://en.wikipedia.org/wiki/Copyright_notice

Decouple Linux kernel module from sofa package

The build script attempts to package sofa.ko into single RPM, that causes several problems:

1. The generated RPM is coupled with certain Linux kernel version/build. Once the system is upgraded, the user space services might fail to interact with newer kernels.
2. It is unlikely to deploy packages to different machines even with the consistent hardware configurations because of insistent Linux kernel configurations.
3. Since kernel module and user space programs have different licensing terms (GPL vs. Apache license), it is really confusing to declare single license for RPM.

To overcome the above, decoupling Linux kernel modules from sofa package is a feasible approach. That is, there should be at least two packages: 1) sofa service/utility; 2) sofa kernel module for Linux;

Unable to build Linux kernel module for v4.15

I managed to build sofa on Ubuntu Linux 18.04-LTS which is based on Linux kernel version 4.15. However, I failed to build Linux kernel module. Here are the instructions to reproduce:

cd src
sh build_sofa.sh

The build system complained as following:

sofa/src/storage_core/lfsm/common/mem_manager.c: In function 'init_memory_manager':
sofa/src/storage_core/lfsm/common/mem_manager.c:42:10: error: implicit declaration of function 'bioset_init'; did you mean 'bio_init'? [-Werror=implicit-function-declaration]
          bioset_init(&memMgr.bioset, bio_pool_size, 0,
          ^~~~~~~~~~~
          bio_init
sofa/src/storage_core/lfsm/common/mem_manager.c: In function 'rel_memory_manager':
sofa/src/storage_core/lfsm/common/mem_manager.c:115:5: error: implicit declaration of function 'bioset_exit'; did you mean 'bioset_free'? [-Werror=implicit-function-declaration]
     bioset_exit(&memMgr.bioset);
     ^~~~~~~~~~~
     bioset_free
cc1: some warnings being treated as errors