Skip to content

Commit

Permalink
fs/mqueue/mq_check.c: group level error check for mq operations
Browse files Browse the repository at this point in the history
	- This commit creates an api mq_check() for mqueue module.
	  This api will check the mq descriptor value in the
	  mq des list of the calling task's group. This will help
	  to remove unwanted error in mq_send and mq_receive apis.
  • Loading branch information
ritesh55555 committed Jan 3, 2025
1 parent 086c48b commit 9382099
Show file tree
Hide file tree
Showing 12 changed files with 169 additions and 12 deletions.
2 changes: 1 addition & 1 deletion os/fs/mqueue/Make.defs
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@

ifneq ($(CONFIG_DISABLE_MQUEUE),y)

CSRCS += mq_open.c mq_close.c mq_unlink.c
CSRCS += mq_open.c mq_close.c mq_unlink.c mq_check.c

# Include POSIX message queue build support

Expand Down
116 changes: 116 additions & 0 deletions os/fs/mqueue/mq_check.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
/****************************************************************************
*
* Copyright 2024 Samsung Electronics All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*
****************************************************************************/
/************************************************************************
* fs/mqueue/mq_check.c
*
* Copyright (C) 2007, 2009, 2014 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <[email protected]>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
************************************************************************/

/************************************************************************
* Included Files
************************************************************************/

#include <tinyara/config.h>

#include <stdio.h>
#include <mqueue.h>
#include <sched.h>
#include <assert.h>
#include <errno.h>
#include <queue.h>

#include <tinyara/mqueue.h>
#include <tinyara/sched.h>
#include <tinyara/arch.h>

/************************************************************************
* Public Functions
************************************************************************/

/************************************************************************
* Name: mq_check
*
* Description:
* This function checks if a message queue descriptor is present in the
* calling task's group list of mq des.
*
* Parameters:
* mqdes - Message queue descriptor
*
* Return Value:
* OK - if mqdes is present in the calling task group list of mqdes
* EBADF - if mqdes is not present in the calling task group of mqdes
*
************************************************************************/

int mq_check(mqd_t mqdes)
{
int ret = -EBADF;
mqd_t mqdes_ptr;

/* If we are in irq hanlder, then we must NOT perform this check.
* Because in irq handler, we will not be able to find which task or
* task's group opened the current mqdes */
if (up_interrupt_context()) {
return OK;
}

FAR struct task_group_s *group = sched_self()->group;

sched_lock();
mqdes_ptr = (mqd_t)sq_peek(&group->tg_msgdesq);
while (mqdes_ptr) {
if (mqdes_ptr == mqdes) {
ret = OK;
break;
}
mqdes_ptr = (mqd_t)sq_next(mqdes_ptr);
}
sched_unlock();

return ret;
}
12 changes: 1 addition & 11 deletions os/fs/mqueue/mq_close.c
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,6 @@ int mq_close_group(mqd_t mqdes, FAR struct task_group_s *group)
int ret = OK;
FAR struct mqueue_inode_s *msgq;
FAR struct inode *inode;
mqd_t mqdes_ptr;

DEBUGASSERT(mqdes != NULL && group != NULL);

Expand All @@ -105,17 +104,8 @@ int mq_close_group(mqd_t mqdes, FAR struct task_group_s *group)
if (mqdes) {
sched_lock();

/* Check that mqdes is in one's group */
mqdes_ptr = (mqd_t)sq_peek(&group->tg_msgdesq);
while (mqdes_ptr) {
if (mqdes_ptr == mqdes) {
break;
}
mqdes_ptr = (mqd_t)sq_next(mqdes_ptr);
}

/* If there is no mqdes in one's group, skip to desclose and inode release. */
if (mqdes_ptr != NULL) {
if (mq_check(mqdes) == OK) {

/* Find the message queue associated with the message descriptor */

Expand Down
1 change: 1 addition & 0 deletions os/fs/mqueue/mq_open.c
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ mqd_t mq_open(FAR const char *mq_name, int oflags, ...)
errcode = ENOMEM;
goto errout_with_inode;
}
inode->i_crefs++;
} else {
/* The mqueue does not exists. Were we asked to create it? */

Expand Down
5 changes: 5 additions & 0 deletions os/include/mqueue.h
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,11 @@ int mq_setattr(mqd_t mqdes, FAR const struct mq_attr *mq_stat, FAR struct mq_att
* @since TizenRT v1.0
*/
int mq_getattr(mqd_t mqdes, FAR struct mq_attr *mq_stat);
/**
* @brief check mq descriptor in calling task's group's list of mq descriptors
* @details @b #include <mqueue.h> \n
*/
int mq_check(mqd_t mqdes);

#undef EXTERN
#ifdef __cplusplus
Expand Down
6 changes: 6 additions & 0 deletions os/kernel/mqueue/mq_getattr.c
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
#include <tinyara/config.h>

#include <mqueue.h>
#include <errno.h>
#include <tinyara/mqueue.h>

/************************************************************************
Expand Down Expand Up @@ -105,6 +106,11 @@ int mq_getattr(mqd_t mqdes, struct mq_attr *mq_stat)
{
int ret = ERROR;

if (mq_check(mqdes) != OK) {
set_errno(EBADF);
return ERROR;
}

if (mqdes && mq_stat) {
/* Return the attributes */

Expand Down
5 changes: 5 additions & 0 deletions os/kernel/mqueue/mq_notify.c
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,11 @@ int mq_notify(mqd_t mqdes, const struct sigevent *notification)
return ERROR;
}

if (mq_check(mqdes) != OK) {
set_errno(EBADF);
return ERROR;
}

/* Get a pointer to the message queue */

msgq = mqdes->msgq;
Expand Down
7 changes: 7 additions & 0 deletions os/kernel/mqueue/mq_receive.c
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@
* message queue.
* EINTR The call was interrupted by a signal handler.
* EINVAL Invalid 'msg' or 'mqdes'
* EBADF Mqdes is not present in calling task group's mq list.
*
* Assumptions:
*
Expand All @@ -145,6 +146,12 @@ ssize_t mq_receive(mqd_t mqdes, FAR char *msg, size_t msglen, FAR int *prio)
/* mq_receive() is a cancellation point */
(void)enter_cancellation_point();

if (mq_check(mqdes) != OK) {
leave_cancellation_point();
set_errno(EBADF);
return ERROR;
}

if (mq_verifyreceive(mqdes, msg, msglen) != OK) {
leave_cancellation_point();
return ERROR;
Expand Down
7 changes: 7 additions & 0 deletions os/kernel/mqueue/mq_send.c
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
* EAGAIN The queue was empty, and the O_NONBLOCK flag was set for the
* message queue description referred to by mqdes.
* EINVAL Either msg or mqdes is NULL or the value of prio is invalid.
* EBADF Mqdes is not present in calling task group's mq list.
* EPERM Message queue opened not opened for writing.
* EMSGSIZE 'msglen' was greater than the maxmsgsize attribute of the
* message queue.
Expand All @@ -149,6 +150,12 @@ int mq_send(mqd_t mqdes, FAR const char *msg, size_t msglen, int prio)
/* mq_send() is a cancellation point */
(void)enter_cancellation_point();

if (mq_check(mqdes) != OK) {
leave_cancellation_point();
set_errno(EBADF);
return ERROR;
}

if (mq_verifysend(mqdes, msg, msglen, prio) != OK) {
leave_cancellation_point();
return ERROR;
Expand Down
6 changes: 6 additions & 0 deletions os/kernel/mqueue/mq_setattr.c
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@

#include <fcntl.h> /* O_NONBLOCK */
#include <mqueue.h>
#include <errno.h>

#include <tinyara/mqueue.h>

Expand Down Expand Up @@ -114,6 +115,11 @@ int mq_setattr(mqd_t mqdes, const struct mq_attr *mq_stat, struct mq_attr *oldst
{
int ret = ERROR;

if (mq_check(mqdes) != OK) {
set_errno(EBADF);
return ERROR;
}

if (mqdes && mq_stat) {
/* Return the attributes if so requested */

Expand Down
7 changes: 7 additions & 0 deletions os/kernel/mqueue/mq_timedreceive.c
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ static void mq_rcvtimeout(int argc, uint32_t pid)
* message queue.
* EINTR The call was interrupted by a signal handler.
* EINVAL Invalid 'msg' or 'mqdes' or 'abstime'
* EBADF Mqdes is not present in calling task group's mq list.
* ETIMEDOUT The call timed out before a message could be transferred.
* ENOMEM The system lacks sufficient memory resources for watchdog.
*
Expand All @@ -209,6 +210,12 @@ ssize_t mq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen, FAR int *prio
/* mq_timedreceive() is not a cancellation point */
(void)enter_cancellation_point();

if (mq_check(mqdes) != OK) {
leave_cancellation_point();
set_errno(EBADF);
return ERROR;
}

/* Verify the input parameters and, in case of an error, set
* errno appropriately.
*/
Expand Down
7 changes: 7 additions & 0 deletions os/kernel/mqueue/mq_timedsend.c
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ static void mq_sndtimeout(int argc, uint32_t pid)
* EAGAIN The queue was empty, and the O_NONBLOCK flag was set for the
* message queue description referred to by mqdes.
* EINVAL Either msg or mqdes is NULL or the value of prio is invalid.
* EBADF Mqdes is not present in calling task group's mq list.
* EPERM Message queue opened not opened for writing.
* EMSGSIZE 'msglen' was greater than the maxmsgsize attribute of the
* message queue.
Expand All @@ -212,6 +213,12 @@ int mq_timedsend(mqd_t mqdes, FAR const char *msg, size_t msglen, int prio, FAR
/* mq_timedsend() is a cancellation point */
(void)enter_cancellation_point();

if (mq_check(mqdes) != OK) {
leave_cancellation_point();
set_errno(EBADF);
return ERROR;
}

/* Verify the input parameters -- setting errno appropriately
* on any failures to verify.
*/
Expand Down

0 comments on commit 9382099

Please sign in to comment.