4-8

Author: jsinglet

c/misra/src/rules/RULE-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql renamed to c/misra/src/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql

@@ -1,13 +1,13 @@
 /**
  * @id c/misra/object-with-no-pointer-dereference-should-be-opaque
- * @name RULE-4-8: The implementation of an object shall be hidden if a pointer to its structure or union is never dereferenced within a translation unit
+ * @name DIR-4-8: The implementation of an object shall be hidden if a pointer to its structure or union is never dereferenced within a translation unit
  * @description If a pointer to a structure or union is never dereferenced within a translation
  *              unit, then the implementation of the object should be hidden to prevent
  *              unintentional changes.
  * @kind problem
  * @precision very-high
  * @problem.severity error
- * @tags external/misra/id/rule-4-8
+ * @tags external/misra/id/dir-4-8
  *       readability
  *       maintainability
  *       external/misra/obligation/advisory

c/misra/test/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.expected

@@ -0,0 +1,6 @@
+| test.c:10:8:10:9 | s4 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test.c:10:8:10:9 | s4 | s4 | test.c:0:0:0:0 | test.c | test.c |
+| test.h:3:8:3:9 | s1 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test.h:3:8:3:9 | s1 | s1 | test.c:0:0:0:0 | test.c | test.c |
+| test_2.c:7:8:7:9 | s2 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test_2.c:7:8:7:9 | s2 | s2 | test_2.c:0:0:0:0 | test_2.c | test_2.c |
+| test_shared.h:15:8:15:20 | only_test2_s2 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test_shared.h:15:8:15:20 | only_test2_s2 | only_test2_s2 | test_2.c:0:0:0:0 | test_2.c | test_2.c |
+| test_shared.h:19:7:19:15 | shared_u1 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test_shared.h:19:7:19:15 | shared_u1 | shared_u1 | test.c:0:0:0:0 | test.c | test.c |
+| test_shared.h:19:7:19:15 | shared_u1 | $@ is not opaque but no pointer to it is dereferenced within the translation unit $@. | test_shared.h:19:7:19:15 | shared_u1 | shared_u1 | test_2.c:0:0:0:0 | test_2.c | test_2.c |

c/misra/test/rules/DIR-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.qlref

@@ -0,0 +1 @@
+rules/RULE-4-8/ObjectWithNoPointerDereferenceShouldBeOpaque.ql

c/misra/test/rules/DIR-4-8/test.c

@@ -0,0 +1,46 @@
+#include "test.h"
+#include "test_shared.h"
+struct s3 {
+  int v1;
+  struct s3_1 {
+    int a;
+  } v2; // COMPLIANT
+};      // COMPLIANT
+
+struct s4 {
+  int v1;
+}; // NON_COMPLIANT
+
+typedef struct s3 s3_t;
+typedef struct s4 s4_t;
+
+void *f1(struct s1 *p1) { return (void *)p1; }
+
+void *f2(struct s2 *p1) {
+  int v1 = p1->v1;
+  return p1;
+}
+
+s3_t *f3(s3_t *p1) {
+  int v1 = p1[0].v1;
+  return p1;
+}
+
+void *f4(s4_t *p1) { return p1; }
+
+void *f5(struct only_test1_s1 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}
+
+void *f6(struct shared_s1 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}
+
+void *f7(union shared_u1 *p1) { return (void *)p1; }
+
+void *f8(union shared_u2 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}

c/misra/test/rules/DIR-4-8/test.h

@@ -0,0 +1,10 @@
+#ifndef TEST_H_
+#define TEST_H_
+struct s1 {
+  int v1;
+}; // NON_COMPLIANT
+
+struct s2 {
+  int v1;
+};     // COMPLIANT
+#endif // TEST_H_

c/misra/test/rules/DIR-4-8/test_2.c

@@ -0,0 +1,46 @@
+#include "test_shared.h"
+
+struct s1 {
+  float v1;
+}; // COMPLIANT
+
+struct s2 {
+  float v1;
+}; // NON_COMPLIANT
+
+struct s3 {
+  float v1;
+}; // COMPLIANT
+
+void *f1(struct s1 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}
+
+void *f2(struct s2 *p1) { return (void *)p1; }
+
+void *f3(struct only_test2_s1 *p1) {
+  int v1 = (*p1).v1;
+  return (void *)p1;
+}
+
+void *f4(struct only_test2_s1 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}
+
+void *f5(struct only_test2_s2 *p1) { return (void *)p1; }
+
+void *f6(union shared_u1 *p1) { return (void *)p1; }
+
+void *f7(union shared_u2 *p1) {
+  int v1 = p1->v1;
+  return (void *)p1;
+}
+
+void *f8(void) {
+  struct s3 v1;
+  return (void *)0;
+}
+
+void *f9(struct s3 *p1) { return (void *)p1; }

c/misra/test/rules/DIR-4-8/test_shared.h

@@ -0,0 +1,28 @@
+#ifndef TEST_SHARED_H_
+#define TEST_SHARED_H_
+struct shared_s1 {
+  int v1;
+}; // COMPLIANT
+
+struct only_test1_s1 {
+  int v1;
+}; // COMPLIANT
+
+struct only_test2_s1 {
+  int v1;
+}; // COMPLIANT
+
+struct only_test2_s2 {
+  int v1;
+}; // NON_COMPLIANT
+
+union shared_u1 {
+  int v1;
+  float v2;
+}; // NON_COMPLIANT
+
+union shared_u2 {
+  int v1;
+  float v2;
+};     // COMPLIANT
+#endif // TEST_SHARED_H_

cpp/common/src/codingstandards/cpp/exclusions/c/Pointers1.qll

@@ -149,7 +149,7 @@ predicate isPointers1QueryMetadata(Query query, string queryId, string ruleId) {
   queryId =
     // `@id` for the `objectWithNoPointerDereferenceShouldBeOpaque` query
     "c/misra/object-with-no-pointer-dereference-should-be-opaque" and
-  ruleId = "RULE-4-8"
+  ruleId = "DIR-4-8"
   or
   query =
     // `Query` instance for the `pointerShouldPointToConstTypeWhenPossible` query

rule_packages/c/Pointers1.json

@@ -294,7 +294,7 @@
       ],
       "title": "The address of an object with automatic storage shall not be copied to another object that persists after the first object has ceased to exist"
     },
-    "RULE-4-8": {
+    "DIR-4-8": {
       "properties": {
         "obligation": "advisory"
       },