sem_getvalue.c 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. /****************************************************************************
  2. * libs/libc/semaphore/sem_getvalue.c
  3. *
  4. * Copyright (C) 2007-2009, 2011 Gregory Nutt. All rights reserved.
  5. * Author: Gregory Nutt <gnutt@nuttx.org>
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in
  15. * the documentation and/or other materials provided with the
  16. * distribution.
  17. * 3. Neither the name NuttX nor the names of its contributors may be
  18. * used to endorse or promote products derived from this software
  19. * without specific prior written permission.
  20. *
  21. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24. * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25. * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27. * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28. * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29. * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32. * POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. ****************************************************************************/
  35. /****************************************************************************
  36. * Included Files
  37. ****************************************************************************/
  38. #include <nuttx/config.h>
  39. #include <sys/types.h>
  40. #include <errno.h>
  41. #include <nuttx/semaphore.h>
  42. /****************************************************************************
  43. * Public Functions
  44. ****************************************************************************/
  45. /****************************************************************************
  46. * Name: nxsem_get_value
  47. *
  48. * Description:
  49. * This function updates the location referenced by 'sval' argument to
  50. * have the value of the semaphore referenced by 'sem' without effecting
  51. * the state of the semaphore. The updated value represents the actual
  52. * semaphore value that occurred at some unspecified time during the call,
  53. * but may not reflect the actual value of the semaphore when it is
  54. * returned to the calling task.
  55. *
  56. * If 'sem' is locked, then the object to which 'sval' points shall either
  57. * be zero or a negative number whose absolute value represents the number
  58. * of tasks waiting for the semaphore.
  59. *
  60. * Input Parameters:
  61. * sem - Semaphore descriptor
  62. * sval - Buffer by which the value is returned
  63. *
  64. * Returned Value:
  65. * This is an internal OS interface and should not be used by applications.
  66. * It follows the NuttX internal error return policy: Zero (OK) is
  67. * returned on success. A negated errno value is returned on failure.
  68. *
  69. ****************************************************************************/
  70. int nxsem_get_value(FAR sem_t *sem, FAR int *sval)
  71. {
  72. if (sem != NULL && sval != NULL)
  73. {
  74. *sval = sem->semcount;
  75. return OK;
  76. }
  77. return -EINVAL;
  78. }
  79. /****************************************************************************
  80. * Name: sem_getvalue
  81. *
  82. * Description:
  83. * This function updates the location referenced by 'sval' argument to
  84. * have the value of the semaphore referenced by 'sem' without effecting
  85. * the state of the semaphore. The updated value represents the actual
  86. * semaphore value that occurred at some unspecified time during the call,
  87. * but may not reflect the actual value of the semaphore when it is
  88. * returned to the calling task.
  89. *
  90. * If 'sem' is locked, then the object to which 'sval' points shall either
  91. * be zero or a negative number whose absolute value represents the number
  92. * of tasks waiting for the semaphore.
  93. *
  94. * Input Parameters:
  95. * sem - Semaphore descriptor
  96. * sval - Buffer by which the value is returned
  97. *
  98. * This returns zero (OK) if successful. Otherwise, -1 (ERROR) is
  99. * returned and the errno value is set appropriately.
  100. *
  101. ****************************************************************************/
  102. int sem_getvalue(FAR sem_t *sem, FAR int *sval)
  103. {
  104. int ret;
  105. ret = nxsem_get_value(sem, sval);
  106. if (ret < 0)
  107. {
  108. set_errno(-ret);
  109. ret = ERROR;
  110. }
  111. return ret;
  112. }