fs: zms: add input validation of fs pointer for api

Add checks on the fs pointer passed through the api before using to
avoid causing an exception

Signed-off-by: Theis Mejnertsen <[email protected]>

Author: OmegaRelay

include/zephyr/fs/zms.h

@@ -85,7 +85,7 @@ struct zms_fs {
  * @retval 0 on success.
  * @retval -ENOTSUP if the detected file system is not ZMS.
  * @retval -EPROTONOSUPPORT if the ZMS version is not supported.
- * @retval -EINVAL if any of the flash parameters or the sector layout is invalid.
+ * @retval -EINVAL if `fs` is NULL or any of the flash parameters or the sector layout is invalid.
  * @retval -ENXIO if there is a device error.
  * @retval -EIO if there is a memory read/write error.
  */
@@ -101,6 +101,7 @@ int zms_mount(struct zms_fs *fs);
  * @retval -EACCES if `fs` is not mounted.
  * @retval -ENXIO if there is a device error.
  * @retval -EIO if there is a memory read/write error.
+ * @retval -EINVAL if `fs` is NULL.
  */
 int zms_clear(struct zms_fs *fs);
 
@@ -124,7 +125,7 @@ int zms_clear(struct zms_fs *fs);
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -ENXIO if there is a device error.
  * @retval -EIO if there is a memory read/write error.
- * @retval -EINVAL if `len` is invalid.
+ * @retval -EINVAL if `fs` is NULL or `len` is invalid.
  * @retval -ENOSPC if no space is left on the device.
  */
 ssize_t zms_write(struct zms_fs *fs, uint32_t id, const void *data, size_t len);
@@ -139,6 +140,7 @@ ssize_t zms_write(struct zms_fs *fs, uint32_t id, const void *data, size_t len);
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -ENXIO if there is a device error.
  * @retval -EIO if there is a memory read/write error.
+ * @retval -EINVAL if `fs` is NULL.
  */
 int zms_delete(struct zms_fs *fs, uint32_t id);
 
@@ -157,6 +159,7 @@ int zms_delete(struct zms_fs *fs, uint32_t id);
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -EIO if there is a memory read/write error.
  * @retval -ENOENT if there is no entry with the given `id`.
+ * @retval -EINVAL if `fs` is NULL.
  */
 ssize_t zms_read(struct zms_fs *fs, uint32_t id, void *data, size_t len);
 
@@ -177,6 +180,7 @@ ssize_t zms_read(struct zms_fs *fs, uint32_t id, void *data, size_t len);
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -EIO if there is a memory read/write error.
  * @retval -ENOENT if there is no entry with the given `id` and history counter.
+ * @retval -EINVAL if `fs` is NULL.
  */
 ssize_t zms_read_hist(struct zms_fs *fs, uint32_t id, void *data, size_t len, uint32_t cnt);
 
@@ -192,6 +196,7 @@ ssize_t zms_read_hist(struct zms_fs *fs, uint32_t id, void *data, size_t len, ui
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -EIO if there is a memory read/write error.
  * @retval -ENOENT if there is no entry with the given id.
+ * @retval -EINVAL if `fs` is NULL.
  */
 ssize_t zms_get_data_length(struct zms_fs *fs, uint32_t id);
 
@@ -207,6 +212,7 @@ ssize_t zms_get_data_length(struct zms_fs *fs, uint32_t id);
  * @retval Number of free bytes (>= 0) on success.
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -EIO if there is a memory read/write error.
+ * @retval -EINVAL if `fs` is NULL.
  */
 ssize_t zms_calc_free_space(struct zms_fs *fs);
 
@@ -217,6 +223,7 @@ ssize_t zms_calc_free_space(struct zms_fs *fs);
  *
  * @retval >=0 Number of free bytes in the currently active sector
  * @retval -EACCES if ZMS is still not initialized.
+ * @retval -EINVAL if `fs` is NULL.
  */
 ssize_t zms_active_sector_free_space(struct zms_fs *fs);
 
@@ -234,6 +241,7 @@ ssize_t zms_active_sector_free_space(struct zms_fs *fs);
  * @retval 0 on success.
  * @retval -EACCES if ZMS is still not initialized.
  * @retval -EIO if there is a memory read/write error.
+ * @retval -EINVAL if `fs` is NULL.
  */
 int zms_sector_use_next(struct zms_fs *fs);
 

subsys/fs/zms/zms.c

@@ -1101,6 +1101,11 @@ int zms_clear(struct zms_fs *fs)
 	int rc;
 	uint64_t addr;
 
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	if (!fs->ready) {
 		LOG_ERR("zms not initialized");
 		return -EACCES;
@@ -1395,6 +1400,11 @@ int zms_mount(struct zms_fs *fs)
 	struct flash_pages_info info;
 	size_t write_block_size;
 
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	k_mutex_init(&fs->zms_lock);
 
 	fs->flash_parameters = flash_get_parameters(fs->flash_device);
@@ -1465,6 +1475,11 @@ ssize_t zms_write(struct zms_fs *fs, uint32_t id, const void *data, size_t len)
 	uint32_t gc_count;
 	uint32_t required_space = 0U; /* no space, appropriate for delete ate */
 
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	if (!fs->ready) {
 		LOG_ERR("zms not initialized");
 		return -EACCES;
@@ -1615,6 +1630,10 @@ ssize_t zms_read_hist(struct zms_fs *fs, uint32_t id, void *data, size_t len, ui
 #ifdef CONFIG_ZMS_DATA_CRC
 	uint32_t computed_data_crc;
 #endif
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
 
 	if (!fs->ready) {
 		LOG_ERR("zms not initialized");
@@ -1739,6 +1758,12 @@ ssize_t zms_calc_free_space(struct zms_fs *fs)
 	uint64_t data_wra = 0U;
 	uint8_t current_cycle;
 	ssize_t free_space = 0;
+
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	const uint32_t second_to_last_offset = (2 * fs->ate_size);
 
 	if (!fs->ready) {
@@ -1839,6 +1864,11 @@ ssize_t zms_calc_free_space(struct zms_fs *fs)
 
 ssize_t zms_active_sector_free_space(struct zms_fs *fs)
 {
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	if (!fs->ready) {
 		LOG_ERR("ZMS not initialized");
 		return -EACCES;
@@ -1851,6 +1881,11 @@ int zms_sector_use_next(struct zms_fs *fs)
 {
 	int ret;
 
+	if (!fs) {
+		LOG_ERR("Invalid fs");
+		return -EINVAL;
+	}
+
 	if (!fs->ready) {
 		LOG_ERR("ZMS not initialized");
 		return -EACCES;