Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 11 Dec 2017 20:47:27 +0000 (UTC)
From:      Alan Somers <asomers@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-stable@freebsd.org, svn-src-stable-11@freebsd.org
Subject:   svn commit: r326782 - in stable/11: lib/libcam/tests sys/cam
Message-ID:  <201712112047.vBBKlROC043733@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: asomers
Date: Mon Dec 11 20:47:26 2017
New Revision: 326782
URL: https://svnweb.freebsd.org/changeset/base/326782

Log:
  MFC r304443, r326034, r326065
  
  r304443 by imp:
  Improve the pattern matching so that internal *'s work, as well as
  [set] notation. This fixes pattern matching for recently added drives
  that would set the NCQ Trim being broken incorrectly.
  
  PR: 210686
  Tested-by: Tomoaki AOKI
  
  r326034:
  Fix multiple bugs in cam_strmatch
  
  * Wrongly matches strings that are shorter than the pattern
  * Fails to match negative character sets
  * Fails to match character sets that aren't at the end of the pattern
  * Fails to match character ranges
  
  Reviewed by:	imp
  Sponsored by:	Spectra Logic Corp
  Differential Revision:	https://reviews.freebsd.org/D13173
  
  r326065:
  Fix uninitialized variable from 326034
  
  Reported by:	Coverity
  CID:		1382887
  X-MFC-With:	326034
  Sponsored by:	Spectra Logic Corp

Added:
  stable/11/lib/libcam/tests/cam_test.c
     - copied unchanged from r326034, head/lib/libcam/tests/cam_test.c
Modified:
  stable/11/lib/libcam/tests/Makefile
  stable/11/lib/libcam/tests/libcam_test.c
  stable/11/sys/cam/cam.c
Directory Properties:
  stable/11/   (props changed)

Modified: stable/11/lib/libcam/tests/Makefile
==============================================================================
--- stable/11/lib/libcam/tests/Makefile	Mon Dec 11 20:36:01 2017	(r326781)
+++ stable/11/lib/libcam/tests/Makefile	Mon Dec 11 20:47:26 2017	(r326782)
@@ -1,6 +1,7 @@
 # $FreeBSD$
 
 ATF_TESTS_C+=	libcam_test
+ATF_TESTS_C+=	cam_test
 
 LIBADD+=	cam
 

Copied: stable/11/lib/libcam/tests/cam_test.c (from r326034, head/lib/libcam/tests/cam_test.c)
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ stable/11/lib/libcam/tests/cam_test.c	Mon Dec 11 20:47:26 2017	(r326782, copy of r326034, head/lib/libcam/tests/cam_test.c)
@@ -0,0 +1,111 @@
+/*-
+ * Copyright (c) 2017 Spectra Logic Corporation
+ * All rights reserved.
+ *
+ * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+ */
+
+/* Tests functions in sys/cam/cam.c */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+#include <errno.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <camlib.h>
+
+#include <atf-c.h>
+
+#define ATF_CHECK_NE(x, y) ATF_CHECK((x) != (y))
+
+ATF_TC_WITHOUT_HEAD(cam_strmatch);
+ATF_TC_BODY(cam_strmatch, tc)
+{
+	/* Basic fixed patterns */
+	ATF_CHECK_EQ(0, cam_strmatch("foo", "foo", 3));
+	ATF_CHECK_NE(0, cam_strmatch("foo", "bar", 3));
+	ATF_CHECK_NE(0, cam_strmatch("foo", "foobar", 3));
+
+	/* The str is not necessarily null-terminated */
+	ATF_CHECK_EQ(0, cam_strmatch("fooxuehfxeuf", "foo", 3));
+	ATF_CHECK_NE(0, cam_strmatch("foo\0bar", "foo", 7));
+
+	/* Eat trailing spaces, which get added by SAT */
+	ATF_CHECK_EQ(0, cam_strmatch("foo             ", "foo", 16));
+
+	/* '*' matches everything, like shell globbing */
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo*", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "*bar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foobar", "foo*x", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("foobarbaz", "*bar*", 9));
+	/* Even NUL */
+	ATF_CHECK_EQ(0, cam_strmatch("foo\0bar", "foo*", 7));
+	/* Or nothing */
+	ATF_CHECK_EQ(0, cam_strmatch("foo", "foo*", 3));
+	/* But stuff after the * still must match */
+	ATF_CHECK_NE(0, cam_strmatch("foo", "foo*x", 3));
+
+	/* '?' matches exactly one single character */
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo?ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foo", "foo?", 3));
+	/* Even NUL */
+	ATF_CHECK_EQ(0, cam_strmatch("foo\0bar", "foo?bar", 7));
+
+	/* '[]' contains a set of characters */
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo[abc]ar", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo[b]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foobar", "foo[ac]ar", 6));
+
+	/* '[]' can contain a range of characters, too */
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo[a-c]ar", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("fooxar", "foo[a-cx]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foodar", "foo[a-c]ar", 6));
+	
+	/* Back-to-back '[]' character sets */
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "fo[a-z][abc]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foAbar", "fo[a-z][abc]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foodar", "fo[a-z][abc]ar", 6));
+
+	/* A '^' negates a set of characters */
+	ATF_CHECK_NE(0, cam_strmatch("foobar", "foo[^abc]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foobar", "foo[^b]ar", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("foobar", "foo[^ac]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("foobar", "foo[^a-c]ar", 6));
+	ATF_CHECK_NE(0, cam_strmatch("fooxar", "foo[^a-cx]ar", 6));
+	ATF_CHECK_EQ(0, cam_strmatch("foodar", "foo[^a-c]ar", 6));
+
+	/* Outside of '[]' a ']' is just an ordinary character */
+	ATF_CHECK_EQ(0, cam_strmatch("f]o", "f]o", 3));
+	ATF_CHECK_NE(0, cam_strmatch("foo", "f]o", 3));
+
+	/* Matching a literal '[' requires specifying a range */
+	ATF_CHECK_EQ(0, cam_strmatch("f[o", "f[[]o", 3));
+	ATF_CHECK_NE(0, cam_strmatch("foo", "f[[]o", 3));
+}
+
+ATF_TP_ADD_TCS(tp)
+{
+	ATF_TP_ADD_TC(tp, cam_strmatch);
+
+	return (atf_no_error());
+}

Modified: stable/11/lib/libcam/tests/libcam_test.c
==============================================================================
--- stable/11/lib/libcam/tests/libcam_test.c	Mon Dec 11 20:36:01 2017	(r326781)
+++ stable/11/lib/libcam/tests/libcam_test.c	Mon Dec 11 20:47:26 2017	(r326782)
@@ -24,6 +24,8 @@
  * SUCH DAMAGE.
  */
 
+/* Tests functions in lib/libcam/camlib.c */
+
 #include <sys/cdefs.h>
 __FBSDID("$FreeBSD$");
 

Modified: stable/11/sys/cam/cam.c
==============================================================================
--- stable/11/sys/cam/cam.c	Mon Dec 11 20:36:01 2017	(r326781)
+++ stable/11/sys/cam/cam.c	Mon Dec 11 20:47:26 2017	(r326782)
@@ -207,32 +207,89 @@ cam_strvis_sbuf(struct sbuf *sb, const u_int8_t *src, 
 /*
  * Compare string with pattern, returning 0 on match.
  * Short pattern matches trailing blanks in name,
- * wildcard '*' in pattern matches rest of name,
- * wildcard '?' matches a single non-space character.
+ * Shell globbing rules apply: * matches 0 or more characters,
+ * ? matchces one character, [...] denotes a set to match one char,
+ * [^...] denotes a complimented set to match one character.
+ * Spaces in str used to match anything in the pattern string
+ * but was removed because it's a bug. No current patterns require
+ * it, as far as I know, but it's impossible to know what drives
+ * returned.
+ *
+ * Each '*' generates recursion, so keep the number of * in check.
  */
 int
 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
 {
 
-	while (*pattern != '\0'&& str_len > 0) {  
-
+	while (*pattern != '\0' && str_len > 0) {  
 		if (*pattern == '*') {
-			return (0);
-		}
-		if ((*pattern != *str)
-		 && (*pattern != '?' || *str == ' ')) {
+			pattern++;
+			if (*pattern == '\0')
+				return (0);
+			do {
+				if (cam_strmatch(str, pattern, str_len) == 0)
+					return (0);
+				str++;
+				str_len--;
+			} while (str_len > 0);
 			return (1);
+		} else if (*pattern == '[') {
+			int negate_range, ok;
+			uint8_t pc = UCHAR_MAX;
+			uint8_t sc;
+
+			ok = 0;
+			sc = *str++;
+			str_len--;
+			pattern++;
+			if ((negate_range = (*pattern == '^')) != 0)
+				pattern++;
+			while ((*pattern != ']') && *pattern != '\0') {
+				if (*pattern == '-') {
+					if (pattern[1] == '\0') /* Bad pattern */
+						return (1);
+					if (sc >= pc && sc <= pattern[1])
+						ok = 1;
+					pattern++;
+				} else if (*pattern == sc)
+					ok = 1;
+				pc = *pattern;
+				pattern++;
+			}
+			if (ok == negate_range)
+				return (1);
+			pattern++;
+		} else if (*pattern == '?') {
+			/*
+			 * NB: || *str == ' ' of the old code is a bug and was
+			 * removed.  If you add it back, keep this the last if
+			 * before the naked else */
+			pattern++;
+			str++;
+			str_len--;
+		} else {
+			if (*str != *pattern)
+				return (1);
+			pattern++;
+			str++;
+			str_len--;
 		}
+	}
+
+	/* '*' is allowed to match nothing, so gobble it */
+	while (*pattern == '*')
 		pattern++;
-		str++;
-		str_len--;
+
+	if ( *pattern != '\0') {
+		/* Pattern not fully consumed.  Not a match */
+		return (1);
 	}
+
+	/* Eat trailing spaces, which get added by SAT */
 	while (str_len > 0 && *str == ' ') {
 		str++;
 		str_len--;
 	}
-	if (str_len > 0 && *str == 0)
-		str_len = 0;
 
 	return (str_len);
 }



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201712112047.vBBKlROC043733>