Changeset 3545 for trunk/kStuff/include/k/kDefs.h

Timestamp:

Aug 25, 2007, 7:15:18 PM (18 years ago)

Author:

bird

Message:

Helpers and macros.

File:

• trunk/kStuff/include/k/kDefs.h (modified) (1 diff)

trunk/kStuff/include/k/kDefs.h

@@ -379 +379 @@
 #define K_BIT64(bit)            ( KU64_C(1) << (bit))
 
-/** @} */
-
-#endif
-
+
+/** @name Parameter validation macros
+ * @{ */
+
+/** Return/Crash validation of a string argument. */
+#define K_VALIDATE_STRING(str) \
+    do { \
+        if (!K_VALID_PTR(str)) \
+            return KERR_INVALID_POINTER; \
+        kHlpStrLen(str); \
+    } while (0)
+
+/** Return/Crash validation of an optional string argument. */
+#define K_VALIDATE_OPTIONAL_STRING(str) \
+    do { \
+        if (str) \
+            K_VALIDATE_STRING(str); \
+    } while (0)
+
+/** Return/Crash validation of an output buffer. */
+#define K_VALIDATE_BUFFER(buf, cb) \
+    do { \
+        if (!K_VALID_PTR(buf)) \
+            return KERR_INVALID_POINTER; \
+        if ((cb) != 0) \
+        { \
+            KU8             __b; \
+            KU8 volatile   *__pb = (KU8 volatile *)(buf); \
+            KSIZE           __cbPage1 = 0x1000 - ((KUPTR)(__pb) & 0xfff); /* ASSUMES page size! */ \
+            __b = *__pb; *__pb = 0xff; *__pb = __b; \
+            if ((cb) > __cbPage1) \
+            { \
+                KSIZE __cb = (cb) - __cbPage1; \
+                __pb -= __cbPage1; \
+                for (;;) \
+                { \
+                    __b = *__pb; *__pb = 0xff; *__pb = __b; \
+                    if (__cb < 0x1000) \
+                        break; \
+                    __pb += 0x1000; \
+                    __cb -= 0x1000; \
+                } \
+            } \
+        } \
+        else \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** Return/Crash validation of an optional output buffer. */
+#define K_VALIDATE_OPTIONAL_BUFFER(buf, cb) \
+    do { \
+        if ((buf) && (cb) != 0) \
+            K_VALIDATE_BUFFER(buf, cb); \
+    } while (0)
+
+/** Return validation of an enum argument. */
+#define K_VALIDATE_ENUM(arg, enumname) \
+    do { \
+        if ((arg) <= enumname##_INVALID || (arg) >= enumname##_END) \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** Return validation of a flags argument. */
+#define K_VALIDATE_FLAGS(arg, AllowedMask) \
+    do { \
+        if ((arg) & ~(AllowedMask)) \
+            return KERR_INVALID_PARAMETER; \
+    } while (0)
+
+/** @} */
+
+/** @} */
+
+#endif
+