Berker Peksag | e7d4b2f | 2018-08-22 21:21:05 +0300 | [diff] [blame] | 1 | from test.support import (TESTFN, import_module, unlink, |
Serhiy Storchaka | 76b4765 | 2014-08-19 17:11:20 +0300 | [diff] [blame] | 2 | requires, _2G, _4G, gc_collect, cpython_only) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 3 | import unittest |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 4 | import os |
| 5 | import re |
| 6 | import itertools |
| 7 | import socket |
| 8 | import sys |
Antoine Pitrou | c53204b | 2013-08-05 23:17:30 +0200 | [diff] [blame] | 9 | import weakref |
Andrew M. Kuchling | e81b9cf | 2000-03-30 21:15:29 +0000 | [diff] [blame] | 10 | |
R. David Murray | a21e4ca | 2009-03-31 23:16:50 +0000 | [diff] [blame] | 11 | # Skip test if we can't import mmap. |
| 12 | mmap = import_module('mmap') |
| 13 | |
Andrew M. Kuchling | e81b9cf | 2000-03-30 21:15:29 +0000 | [diff] [blame] | 14 | PAGESIZE = mmap.PAGESIZE |
| 15 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 16 | class MmapTests(unittest.TestCase): |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 17 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 18 | def setUp(self): |
| 19 | if os.path.exists(TESTFN): |
| 20 | os.unlink(TESTFN) |
Fred Drake | 004d5e6 | 2000-10-23 17:22:08 +0000 | [diff] [blame] | 21 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 22 | def tearDown(self): |
Tim Peters | fd69208 | 2001-05-10 20:03:04 +0000 | [diff] [blame] | 23 | try: |
Fred Drake | 6278799 | 2001-05-11 14:29:21 +0000 | [diff] [blame] | 24 | os.unlink(TESTFN) |
Tim Peters | fd69208 | 2001-05-10 20:03:04 +0000 | [diff] [blame] | 25 | except OSError: |
| 26 | pass |
| 27 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 28 | def test_basic(self): |
| 29 | # Test mmap module on Unix systems and Windows |
| 30 | |
| 31 | # Create a file to be mmap'ed. |
Guido van Rossum | b358a2c | 2007-07-16 19:29:02 +0000 | [diff] [blame] | 32 | f = open(TESTFN, 'bw+') |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 33 | try: |
| 34 | # Write 2 pages worth of data to the file |
Guido van Rossum | b358a2c | 2007-07-16 19:29:02 +0000 | [diff] [blame] | 35 | f.write(b'\0'* PAGESIZE) |
| 36 | f.write(b'foo') |
| 37 | f.write(b'\0'* (PAGESIZE-3) ) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 38 | f.flush() |
| 39 | m = mmap.mmap(f.fileno(), 2 * PAGESIZE) |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 40 | finally: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 41 | f.close() |
| 42 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 43 | # Simple sanity checks |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 44 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 45 | tp = str(type(m)) # SF bug 128713: segfaulted on Linux |
Benjamin Peterson | e099b37 | 2009-04-04 17:09:35 +0000 | [diff] [blame] | 46 | self.assertEqual(m.find(b'foo'), PAGESIZE) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 47 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 48 | self.assertEqual(len(m), 2*PAGESIZE) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 49 | |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 50 | self.assertEqual(m[0], 0) |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 51 | self.assertEqual(m[0:3], b'\0\0\0') |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 52 | |
Hirokazu Yamamoto | 0654ccd | 2009-02-18 16:38:00 +0000 | [diff] [blame] | 53 | # Shouldn't crash on boundary (Issue #5292) |
| 54 | self.assertRaises(IndexError, m.__getitem__, len(m)) |
| 55 | self.assertRaises(IndexError, m.__setitem__, len(m), b'\0') |
| 56 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 57 | # Modify the file's content |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 58 | m[0] = b'3'[0] |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 59 | m[PAGESIZE +3: PAGESIZE +3+3] = b'bar' |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 61 | # Check that the modification worked |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 62 | self.assertEqual(m[0], b'3'[0]) |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 63 | self.assertEqual(m[0:3], b'3\0\0') |
| 64 | self.assertEqual(m[PAGESIZE-1 : PAGESIZE + 7], b'\0foobar\0') |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 65 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 66 | m.flush() |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 67 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 68 | # Test doing a regular expression match in an mmap'ed file |
Antoine Pitrou | fd03645 | 2008-08-19 17:56:33 +0000 | [diff] [blame] | 69 | match = re.search(b'[A-Za-z]+', m) |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 70 | if match is None: |
| 71 | self.fail('regex match on mmap failed!') |
| 72 | else: |
| 73 | start, end = match.span(0) |
| 74 | length = end - start |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 75 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 76 | self.assertEqual(start, PAGESIZE) |
| 77 | self.assertEqual(end, PAGESIZE + 6) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 78 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 79 | # test seeking around (try to overflow the seek implementation) |
| 80 | m.seek(0,0) |
| 81 | self.assertEqual(m.tell(), 0) |
| 82 | m.seek(42,1) |
| 83 | self.assertEqual(m.tell(), 42) |
| 84 | m.seek(0,2) |
| 85 | self.assertEqual(m.tell(), len(m)) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 86 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 87 | # Try to seek to negative position... |
| 88 | self.assertRaises(ValueError, m.seek, -1) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 89 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 90 | # Try to seek beyond end of mmap... |
| 91 | self.assertRaises(ValueError, m.seek, 1, 2) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 92 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 93 | # Try to seek to negative position... |
| 94 | self.assertRaises(ValueError, m.seek, -len(m)-1, 2) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 95 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 96 | # Try resizing map |
| 97 | try: |
| 98 | m.resize(512) |
| 99 | except SystemError: |
| 100 | # resize() not supported |
| 101 | # No messages are printed, since the output of this test suite |
| 102 | # would then be different across platforms. |
| 103 | pass |
| 104 | else: |
| 105 | # resize() is supported |
| 106 | self.assertEqual(len(m), 512) |
| 107 | # Check that we can no longer seek beyond the new size. |
| 108 | self.assertRaises(ValueError, m.seek, 513, 0) |
| 109 | |
| 110 | # Check that the underlying file is truncated too |
| 111 | # (bug #728515) |
Victor Stinner | a6d2c76 | 2011-06-30 18:20:11 +0200 | [diff] [blame] | 112 | f = open(TESTFN, 'rb') |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 113 | try: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 114 | f.seek(0, 2) |
| 115 | self.assertEqual(f.tell(), 512) |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 116 | finally: |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 117 | f.close() |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 118 | self.assertEqual(m.size(), 512) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 119 | |
Guido van Rossum | 456fe5d | 2007-07-16 19:42:05 +0000 | [diff] [blame] | 120 | m.close() |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 121 | |
| 122 | def test_access_parameter(self): |
| 123 | # Test for "access" keyword parameter |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 124 | mapsize = 10 |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 125 | with open(TESTFN, "wb") as fp: |
| 126 | fp.write(b"a"*mapsize) |
| 127 | with open(TESTFN, "rb") as f: |
| 128 | m = mmap.mmap(f.fileno(), mapsize, access=mmap.ACCESS_READ) |
| 129 | self.assertEqual(m[:], b'a'*mapsize, "Readonly memory map data incorrect.") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 130 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 131 | # Ensuring that readonly mmap can't be slice assigned |
| 132 | try: |
| 133 | m[:] = b'b'*mapsize |
| 134 | except TypeError: |
| 135 | pass |
| 136 | else: |
| 137 | self.fail("Able to write to readonly memory map") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 138 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 139 | # Ensuring that readonly mmap can't be item assigned |
| 140 | try: |
| 141 | m[0] = b'b' |
| 142 | except TypeError: |
| 143 | pass |
| 144 | else: |
| 145 | self.fail("Able to write to readonly memory map") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 146 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 147 | # Ensuring that readonly mmap can't be write() to |
| 148 | try: |
| 149 | m.seek(0,0) |
| 150 | m.write(b'abc') |
| 151 | except TypeError: |
| 152 | pass |
| 153 | else: |
| 154 | self.fail("Able to write to readonly memory map") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 155 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 156 | # Ensuring that readonly mmap can't be write_byte() to |
| 157 | try: |
| 158 | m.seek(0,0) |
| 159 | m.write_byte(b'd') |
| 160 | except TypeError: |
| 161 | pass |
| 162 | else: |
| 163 | self.fail("Able to write to readonly memory map") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 164 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 165 | # Ensuring that readonly mmap can't be resized |
| 166 | try: |
| 167 | m.resize(2*mapsize) |
| 168 | except SystemError: # resize is not universally supported |
| 169 | pass |
| 170 | except TypeError: |
| 171 | pass |
| 172 | else: |
| 173 | self.fail("Able to resize readonly memory map") |
| 174 | with open(TESTFN, "rb") as fp: |
| 175 | self.assertEqual(fp.read(), b'a'*mapsize, |
| 176 | "Readonly memory map data file was modified") |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 177 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 178 | # Opening mmap with size too big |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 179 | with open(TESTFN, "r+b") as f: |
| 180 | try: |
| 181 | m = mmap.mmap(f.fileno(), mapsize+1) |
| 182 | except ValueError: |
| 183 | # we do not expect a ValueError on Windows |
| 184 | # CAUTION: This also changes the size of the file on disk, and |
| 185 | # later tests assume that the length hasn't changed. We need to |
| 186 | # repair that. |
| 187 | if sys.platform.startswith('win'): |
| 188 | self.fail("Opening mmap with size+1 should work on Windows.") |
| 189 | else: |
| 190 | # we expect a ValueError on Unix, but not on Windows |
| 191 | if not sys.platform.startswith('win'): |
| 192 | self.fail("Opening mmap with size+1 should raise ValueError.") |
| 193 | m.close() |
Neal Norwitz | b567392 | 2002-09-05 21:48:07 +0000 | [diff] [blame] | 194 | if sys.platform.startswith('win'): |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 195 | # Repair damage from the resizing test. |
| 196 | with open(TESTFN, 'r+b') as f: |
| 197 | f.truncate(mapsize) |
Neal Norwitz | b567392 | 2002-09-05 21:48:07 +0000 | [diff] [blame] | 198 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 199 | # Opening mmap with access=ACCESS_WRITE |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 200 | with open(TESTFN, "r+b") as f: |
| 201 | m = mmap.mmap(f.fileno(), mapsize, access=mmap.ACCESS_WRITE) |
| 202 | # Modifying write-through memory map |
| 203 | m[:] = b'c'*mapsize |
| 204 | self.assertEqual(m[:], b'c'*mapsize, |
| 205 | "Write-through memory map memory not updated properly.") |
| 206 | m.flush() |
| 207 | m.close() |
| 208 | with open(TESTFN, 'rb') as f: |
| 209 | stuff = f.read() |
Guido van Rossum | b358a2c | 2007-07-16 19:29:02 +0000 | [diff] [blame] | 210 | self.assertEqual(stuff, b'c'*mapsize, |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 211 | "Write-through memory map data file not updated properly.") |
| 212 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 213 | # Opening mmap with access=ACCESS_COPY |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 214 | with open(TESTFN, "r+b") as f: |
| 215 | m = mmap.mmap(f.fileno(), mapsize, access=mmap.ACCESS_COPY) |
| 216 | # Modifying copy-on-write memory map |
| 217 | m[:] = b'd'*mapsize |
| 218 | self.assertEqual(m[:], b'd' * mapsize, |
| 219 | "Copy-on-write memory map data not written correctly.") |
| 220 | m.flush() |
| 221 | with open(TESTFN, "rb") as fp: |
| 222 | self.assertEqual(fp.read(), b'c'*mapsize, |
| 223 | "Copy-on-write test data file should not be modified.") |
| 224 | # Ensuring copy-on-write maps cannot be resized |
| 225 | self.assertRaises(TypeError, m.resize, 2*mapsize) |
| 226 | m.close() |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 227 | |
| 228 | # Ensuring invalid access parameter raises exception |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 229 | with open(TESTFN, "r+b") as f: |
| 230 | self.assertRaises(ValueError, mmap.mmap, f.fileno(), mapsize, access=4) |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 231 | |
| 232 | if os.name == "posix": |
Tim Peters | 00cafa0 | 2001-11-13 23:39:47 +0000 | [diff] [blame] | 233 | # Try incompatible flags, prot and access parameters. |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 234 | with open(TESTFN, "r+b") as f: |
| 235 | self.assertRaises(ValueError, mmap.mmap, f.fileno(), mapsize, |
| 236 | flags=mmap.MAP_PRIVATE, |
| 237 | prot=mmap.PROT_READ, access=mmap.ACCESS_WRITE) |
Tim Peters | 5ebfd36 | 2001-11-13 23:11:19 +0000 | [diff] [blame] | 238 | |
Antoine Pitrou | 7b50c2c | 2011-03-06 01:47:18 +0100 | [diff] [blame] | 239 | # Try writing with PROT_EXEC and without PROT_WRITE |
| 240 | prot = mmap.PROT_READ | getattr(mmap, 'PROT_EXEC', 0) |
Antoine Pitrou | 16a0a0b | 2011-03-06 01:11:03 +0100 | [diff] [blame] | 241 | with open(TESTFN, "r+b") as f: |
Antoine Pitrou | 7b50c2c | 2011-03-06 01:47:18 +0100 | [diff] [blame] | 242 | m = mmap.mmap(f.fileno(), mapsize, prot=prot) |
Antoine Pitrou | 16a0a0b | 2011-03-06 01:11:03 +0100 | [diff] [blame] | 243 | self.assertRaises(TypeError, m.write, b"abcdef") |
| 244 | self.assertRaises(TypeError, m.write_byte, 0) |
| 245 | m.close() |
| 246 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 247 | def test_bad_file_desc(self): |
| 248 | # Try opening a bad file descriptor... |
Andrew Svetlov | 6eda46d | 2012-12-17 22:55:31 +0200 | [diff] [blame] | 249 | self.assertRaises(OSError, mmap.mmap, -2, 4096) |
Neal Norwitz | 3b4fff8 | 2006-01-11 08:54:45 +0000 | [diff] [blame] | 250 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 251 | def test_tougher_find(self): |
| 252 | # Do a tougher .find() test. SF bug 515943 pointed out that, in 2.2, |
| 253 | # searching for data with embedded \0 bytes didn't work. |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 254 | with open(TESTFN, 'wb+') as f: |
Tim Peters | c9ffa06 | 2002-03-08 05:43:32 +0000 | [diff] [blame] | 255 | |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 256 | data = b'aabaac\x00deef\x00\x00aa\x00' |
| 257 | n = len(data) |
| 258 | f.write(data) |
| 259 | f.flush() |
| 260 | m = mmap.mmap(f.fileno(), n) |
Tim Peters | c9ffa06 | 2002-03-08 05:43:32 +0000 | [diff] [blame] | 261 | |
| 262 | for start in range(n+1): |
| 263 | for finish in range(start, n+1): |
| 264 | slice = data[start : finish] |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 265 | self.assertEqual(m.find(slice), data.find(slice)) |
Guido van Rossum | b358a2c | 2007-07-16 19:29:02 +0000 | [diff] [blame] | 266 | self.assertEqual(m.find(slice + b'x'), -1) |
Tim Peters | ddc82ea | 2003-01-13 21:38:45 +0000 | [diff] [blame] | 267 | m.close() |
Tim Peters | c9ffa06 | 2002-03-08 05:43:32 +0000 | [diff] [blame] | 268 | |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 269 | def test_find_end(self): |
| 270 | # test the new 'end' parameter works as expected |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 271 | with open(TESTFN, 'wb+') as f: |
| 272 | data = b'one two ones' |
| 273 | n = len(data) |
| 274 | f.write(data) |
| 275 | f.flush() |
| 276 | m = mmap.mmap(f.fileno(), n) |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 277 | |
Benjamin Peterson | e099b37 | 2009-04-04 17:09:35 +0000 | [diff] [blame] | 278 | self.assertEqual(m.find(b'one'), 0) |
| 279 | self.assertEqual(m.find(b'ones'), 8) |
| 280 | self.assertEqual(m.find(b'one', 0, -1), 0) |
| 281 | self.assertEqual(m.find(b'one', 1), 8) |
| 282 | self.assertEqual(m.find(b'one', 1, -1), 8) |
| 283 | self.assertEqual(m.find(b'one', 1, -2), -1) |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 284 | self.assertEqual(m.find(bytearray(b'one')), 0) |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 285 | |
| 286 | |
| 287 | def test_rfind(self): |
| 288 | # test the new 'end' parameter works as expected |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 289 | with open(TESTFN, 'wb+') as f: |
| 290 | data = b'one two ones' |
| 291 | n = len(data) |
| 292 | f.write(data) |
| 293 | f.flush() |
| 294 | m = mmap.mmap(f.fileno(), n) |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 295 | |
Benjamin Peterson | e099b37 | 2009-04-04 17:09:35 +0000 | [diff] [blame] | 296 | self.assertEqual(m.rfind(b'one'), 8) |
| 297 | self.assertEqual(m.rfind(b'one '), 0) |
| 298 | self.assertEqual(m.rfind(b'one', 0, -1), 8) |
| 299 | self.assertEqual(m.rfind(b'one', 0, -2), 0) |
| 300 | self.assertEqual(m.rfind(b'one', 1, -1), 8) |
| 301 | self.assertEqual(m.rfind(b'one', 1, -2), -1) |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 302 | self.assertEqual(m.rfind(bytearray(b'one')), 8) |
Georg Brandl | fceab5a | 2008-01-19 20:08:23 +0000 | [diff] [blame] | 303 | |
| 304 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 305 | def test_double_close(self): |
| 306 | # make sure a double close doesn't crash on Solaris (Bug# 665913) |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 307 | with open(TESTFN, 'wb+') as f: |
| 308 | f.write(2**16 * b'a') # Arbitrary character |
Tim Peters | c9ffa06 | 2002-03-08 05:43:32 +0000 | [diff] [blame] | 309 | |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 310 | with open(TESTFN, 'rb') as f: |
| 311 | mf = mmap.mmap(f.fileno(), 2**16, access=mmap.ACCESS_READ) |
| 312 | mf.close() |
| 313 | mf.close() |
Neal Norwitz | e604c02 | 2003-01-10 20:52:16 +0000 | [diff] [blame] | 314 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 315 | def test_entire_file(self): |
| 316 | # test mapping of entire file by passing 0 for map length |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 317 | with open(TESTFN, "wb+") as f: |
| 318 | f.write(2**16 * b'm') # Arbitrary character |
Tim Peters | c9ffa06 | 2002-03-08 05:43:32 +0000 | [diff] [blame] | 319 | |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 320 | with open(TESTFN, "rb+") as f, \ |
| 321 | mmap.mmap(f.fileno(), 0) as mf: |
| 322 | self.assertEqual(len(mf), 2**16, "Map size should equal file size.") |
| 323 | self.assertEqual(mf.read(2**16), 2**16 * b"m") |
Martin v. Löwis | 7fe60c0 | 2005-03-03 11:22:44 +0000 | [diff] [blame] | 324 | |
Antoine Pitrou | 85f4615 | 2011-01-15 16:17:07 +0000 | [diff] [blame] | 325 | def test_length_0_offset(self): |
| 326 | # Issue #10916: test mapping of remainder of file by passing 0 for |
| 327 | # map length with an offset doesn't cause a segfault. |
Antoine Pitrou | d0ebc75 | 2011-01-15 17:25:58 +0000 | [diff] [blame] | 328 | # NOTE: allocation granularity is currently 65536 under Win64, |
| 329 | # and therefore the minimum offset alignment. |
| 330 | with open(TESTFN, "wb") as f: |
| 331 | f.write((65536 * 2) * b'm') # Arbitrary character |
Antoine Pitrou | 85f4615 | 2011-01-15 16:17:07 +0000 | [diff] [blame] | 332 | |
| 333 | with open(TESTFN, "rb") as f: |
Antoine Pitrou | d0ebc75 | 2011-01-15 17:25:58 +0000 | [diff] [blame] | 334 | with mmap.mmap(f.fileno(), 0, offset=65536, access=mmap.ACCESS_READ) as mf: |
| 335 | self.assertRaises(IndexError, mf.__getitem__, 80000) |
Antoine Pitrou | 85f4615 | 2011-01-15 16:17:07 +0000 | [diff] [blame] | 336 | |
Antoine Pitrou | 305bc9e | 2011-01-20 21:07:24 +0000 | [diff] [blame] | 337 | def test_length_0_large_offset(self): |
| 338 | # Issue #10959: test mapping of a file by passing 0 for |
| 339 | # map length with a large offset doesn't cause a segfault. |
Antoine Pitrou | 305bc9e | 2011-01-20 21:07:24 +0000 | [diff] [blame] | 340 | with open(TESTFN, "wb") as f: |
| 341 | f.write(115699 * b'm') # Arbitrary character |
| 342 | |
| 343 | with open(TESTFN, "w+b") as f: |
| 344 | self.assertRaises(ValueError, mmap.mmap, f.fileno(), 0, |
| 345 | offset=2147418112) |
| 346 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 347 | def test_move(self): |
| 348 | # make move works everywhere (64-bit format problem earlier) |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 349 | with open(TESTFN, 'wb+') as f: |
Tim Peters | eba28be | 2005-03-28 01:08:02 +0000 | [diff] [blame] | 350 | |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 351 | f.write(b"ABCDEabcde") # Arbitrary character |
| 352 | f.flush() |
Neal Norwitz | 8856fb7 | 2005-12-18 03:34:22 +0000 | [diff] [blame] | 353 | |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 354 | mf = mmap.mmap(f.fileno(), 10) |
| 355 | mf.move(5, 0, 5) |
| 356 | self.assertEqual(mf[:], b"ABCDEABCDE", "Map move should have duplicated front 5") |
| 357 | mf.close() |
Neal Norwitz | 8856fb7 | 2005-12-18 03:34:22 +0000 | [diff] [blame] | 358 | |
Hirokazu Yamamoto | 16caab0 | 2009-03-31 13:44:06 +0000 | [diff] [blame] | 359 | # more excessive test |
| 360 | data = b"0123456789" |
| 361 | for dest in range(len(data)): |
| 362 | for src in range(len(data)): |
| 363 | for count in range(len(data) - max(dest, src)): |
| 364 | expected = data[:dest] + data[src:src+count] + data[dest+count:] |
| 365 | m = mmap.mmap(-1, len(data)) |
| 366 | m[:] = data |
| 367 | m.move(dest, src, count) |
| 368 | self.assertEqual(m[:], expected) |
| 369 | m.close() |
| 370 | |
Hirokazu Yamamoto | 2ca1501 | 2009-03-31 20:43:56 +0000 | [diff] [blame] | 371 | # segfault test (Issue 5387) |
| 372 | m = mmap.mmap(-1, 100) |
| 373 | offsets = [-100, -1, 0, 1, 100] |
| 374 | for source, dest, size in itertools.product(offsets, offsets, offsets): |
| 375 | try: |
| 376 | m.move(source, dest, size) |
| 377 | except ValueError: |
| 378 | pass |
Benjamin Peterson | ef3e4c2 | 2009-04-11 19:48:14 +0000 | [diff] [blame] | 379 | |
| 380 | offsets = [(-1, -1, -1), (-1, -1, 0), (-1, 0, -1), (0, -1, -1), |
| 381 | (-1, 0, 0), (0, -1, 0), (0, 0, -1)] |
| 382 | for source, dest, size in offsets: |
| 383 | self.assertRaises(ValueError, m.move, source, dest, size) |
| 384 | |
Hirokazu Yamamoto | 16caab0 | 2009-03-31 13:44:06 +0000 | [diff] [blame] | 385 | m.close() |
| 386 | |
Benjamin Peterson | ef3e4c2 | 2009-04-11 19:48:14 +0000 | [diff] [blame] | 387 | m = mmap.mmap(-1, 1) # single byte |
| 388 | self.assertRaises(ValueError, m.move, 0, 0, 2) |
| 389 | self.assertRaises(ValueError, m.move, 1, 0, 1) |
| 390 | self.assertRaises(ValueError, m.move, 0, 1, 1) |
| 391 | m.move(0, 0, 1) |
| 392 | m.move(0, 0, 0) |
| 393 | |
| 394 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 395 | def test_anonymous(self): |
| 396 | # anonymous mmap.mmap(-1, PAGE) |
| 397 | m = mmap.mmap(-1, PAGESIZE) |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 398 | for x in range(PAGESIZE): |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 399 | self.assertEqual(m[x], 0, |
| 400 | "anonymously mmap'ed contents should be zero") |
Neal Norwitz | 8856fb7 | 2005-12-18 03:34:22 +0000 | [diff] [blame] | 401 | |
Guido van Rossum | 805365e | 2007-05-07 22:24:25 +0000 | [diff] [blame] | 402 | for x in range(PAGESIZE): |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 403 | b = x & 0xff |
Guido van Rossum | b358a2c | 2007-07-16 19:29:02 +0000 | [diff] [blame] | 404 | m[x] = b |
| 405 | self.assertEqual(m[x], b) |
Neal Norwitz | 0e6bc8c | 2006-02-05 05:45:43 +0000 | [diff] [blame] | 406 | |
Charles-François Natali | 4dd453c | 2011-06-08 19:18:14 +0200 | [diff] [blame] | 407 | def test_read_all(self): |
| 408 | m = mmap.mmap(-1, 16) |
| 409 | self.addCleanup(m.close) |
| 410 | |
| 411 | # With no parameters, or None or a negative argument, reads all |
| 412 | m.write(bytes(range(16))) |
| 413 | m.seek(0) |
| 414 | self.assertEqual(m.read(), bytes(range(16))) |
| 415 | m.seek(8) |
| 416 | self.assertEqual(m.read(), bytes(range(8, 16))) |
| 417 | m.seek(16) |
| 418 | self.assertEqual(m.read(), b'') |
| 419 | m.seek(3) |
| 420 | self.assertEqual(m.read(None), bytes(range(3, 16))) |
| 421 | m.seek(4) |
| 422 | self.assertEqual(m.read(-1), bytes(range(4, 16))) |
| 423 | m.seek(5) |
| 424 | self.assertEqual(m.read(-2), bytes(range(5, 16))) |
| 425 | m.seek(9) |
| 426 | self.assertEqual(m.read(-42), bytes(range(9, 16))) |
| 427 | |
| 428 | def test_read_invalid_arg(self): |
| 429 | m = mmap.mmap(-1, 16) |
| 430 | self.addCleanup(m.close) |
| 431 | |
| 432 | self.assertRaises(TypeError, m.read, 'foo') |
| 433 | self.assertRaises(TypeError, m.read, 5.5) |
| 434 | self.assertRaises(TypeError, m.read, [1, 2, 3]) |
| 435 | |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 436 | def test_extended_getslice(self): |
| 437 | # Test extended slicing by comparing with list slicing. |
| 438 | s = bytes(reversed(range(256))) |
| 439 | m = mmap.mmap(-1, len(s)) |
| 440 | m[:] = s |
| 441 | self.assertEqual(m[:], s) |
| 442 | indices = (0, None, 1, 3, 19, 300, -1, -2, -31, -300) |
| 443 | for start in indices: |
| 444 | for stop in indices: |
| 445 | # Skip step 0 (invalid) |
| 446 | for step in indices[1:]: |
| 447 | self.assertEqual(m[start:stop:step], |
| 448 | s[start:stop:step]) |
| 449 | |
| 450 | def test_extended_set_del_slice(self): |
| 451 | # Test extended slicing by comparing with list slicing. |
| 452 | s = bytes(reversed(range(256))) |
| 453 | m = mmap.mmap(-1, len(s)) |
| 454 | indices = (0, None, 1, 3, 19, 300, -1, -2, -31, -300) |
| 455 | for start in indices: |
| 456 | for stop in indices: |
| 457 | # Skip invalid step 0 |
| 458 | for step in indices[1:]: |
| 459 | m[:] = s |
| 460 | self.assertEqual(m[:], s) |
| 461 | L = list(s) |
| 462 | # Make sure we have a slice of exactly the right length, |
| 463 | # but with different data. |
| 464 | data = L[start:stop:step] |
| 465 | data = bytes(reversed(data)) |
| 466 | L[start:stop:step] = data |
| 467 | m[start:stop:step] = data |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 468 | self.assertEqual(m[:], bytes(L)) |
Thomas Wouters | ed03b41 | 2007-08-28 21:37:11 +0000 | [diff] [blame] | 469 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 470 | def make_mmap_file (self, f, halfsize): |
| 471 | # Write 2 pages worth of data to the file |
| 472 | f.write (b'\0' * halfsize) |
| 473 | f.write (b'foo') |
| 474 | f.write (b'\0' * (halfsize - 3)) |
| 475 | f.flush () |
| 476 | return mmap.mmap (f.fileno(), 0) |
| 477 | |
Jesus Cea | 941bfcc | 2012-09-10 00:27:55 +0200 | [diff] [blame] | 478 | def test_empty_file (self): |
| 479 | f = open (TESTFN, 'w+b') |
| 480 | f.close() |
Jesus Cea | 1f2799b | 2012-09-10 22:49:50 +0200 | [diff] [blame] | 481 | with open(TESTFN, "rb") as f : |
| 482 | self.assertRaisesRegex(ValueError, |
| 483 | "cannot mmap an empty file", |
| 484 | mmap.mmap, f.fileno(), 0, |
| 485 | access=mmap.ACCESS_READ) |
Jesus Cea | 941bfcc | 2012-09-10 00:27:55 +0200 | [diff] [blame] | 486 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 487 | def test_offset (self): |
| 488 | f = open (TESTFN, 'w+b') |
| 489 | |
| 490 | try: # unlink TESTFN no matter what |
| 491 | halfsize = mmap.ALLOCATIONGRANULARITY |
| 492 | m = self.make_mmap_file (f, halfsize) |
| 493 | m.close () |
| 494 | f.close () |
| 495 | |
| 496 | mapsize = halfsize * 2 |
| 497 | # Try invalid offset |
| 498 | f = open(TESTFN, "r+b") |
| 499 | for offset in [-2, -1, None]: |
| 500 | try: |
| 501 | m = mmap.mmap(f.fileno(), mapsize, offset=offset) |
| 502 | self.assertEqual(0, 1) |
| 503 | except (ValueError, TypeError, OverflowError): |
| 504 | pass |
| 505 | else: |
| 506 | self.assertEqual(0, 0) |
| 507 | f.close() |
| 508 | |
| 509 | # Try valid offset, hopefully 8192 works on all OSes |
| 510 | f = open(TESTFN, "r+b") |
| 511 | m = mmap.mmap(f.fileno(), mapsize - halfsize, offset=halfsize) |
| 512 | self.assertEqual(m[0:3], b'foo') |
| 513 | f.close() |
Hirokazu Yamamoto | 0654ccd | 2009-02-18 16:38:00 +0000 | [diff] [blame] | 514 | |
| 515 | # Try resizing map |
| 516 | try: |
| 517 | m.resize(512) |
| 518 | except SystemError: |
| 519 | pass |
| 520 | else: |
| 521 | # resize() is supported |
| 522 | self.assertEqual(len(m), 512) |
| 523 | # Check that we can no longer seek beyond the new size. |
| 524 | self.assertRaises(ValueError, m.seek, 513, 0) |
| 525 | # Check that the content is not changed |
| 526 | self.assertEqual(m[0:3], b'foo') |
| 527 | |
| 528 | # Check that the underlying file is truncated too |
Victor Stinner | a6d2c76 | 2011-06-30 18:20:11 +0200 | [diff] [blame] | 529 | f = open(TESTFN, 'rb') |
Hirokazu Yamamoto | 0654ccd | 2009-02-18 16:38:00 +0000 | [diff] [blame] | 530 | f.seek(0, 2) |
| 531 | self.assertEqual(f.tell(), halfsize + 512) |
| 532 | f.close() |
| 533 | self.assertEqual(m.size(), halfsize + 512) |
| 534 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 535 | m.close() |
| 536 | |
| 537 | finally: |
| 538 | f.close() |
| 539 | try: |
| 540 | os.unlink(TESTFN) |
| 541 | except OSError: |
| 542 | pass |
| 543 | |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 544 | def test_subclass(self): |
| 545 | class anon_mmap(mmap.mmap): |
| 546 | def __new__(klass, *args, **kwargs): |
| 547 | return mmap.mmap.__new__(klass, -1, *args, **kwargs) |
| 548 | anon_mmap(PAGESIZE) |
| 549 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 550 | @unittest.skipUnless(hasattr(mmap, 'PROT_READ'), "needs mmap.PROT_READ") |
Christian Heimes | a156e09 | 2008-02-16 07:38:31 +0000 | [diff] [blame] | 551 | def test_prot_readonly(self): |
| 552 | mapsize = 10 |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 553 | with open(TESTFN, "wb") as fp: |
| 554 | fp.write(b"a"*mapsize) |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 555 | with open(TESTFN, "rb") as f: |
| 556 | m = mmap.mmap(f.fileno(), mapsize, prot=mmap.PROT_READ) |
| 557 | self.assertRaises(TypeError, m.write, "foo") |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 558 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 559 | def test_error(self): |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 560 | self.assertIs(mmap.error, OSError) |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 561 | |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 562 | def test_io_methods(self): |
| 563 | data = b"0123456789" |
Benjamin Peterson | 5dc8fab | 2010-10-31 01:44:49 +0000 | [diff] [blame] | 564 | with open(TESTFN, "wb") as fp: |
| 565 | fp.write(b"x"*len(data)) |
Serhiy Storchaka | 9e4861f | 2019-03-05 10:05:57 +0200 | [diff] [blame^] | 566 | with open(TESTFN, "r+b") as f: |
| 567 | m = mmap.mmap(f.fileno(), len(data)) |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 568 | # Test write_byte() |
| 569 | for i in range(len(data)): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 570 | self.assertEqual(m.tell(), i) |
Benjamin Peterson | e099b37 | 2009-04-04 17:09:35 +0000 | [diff] [blame] | 571 | m.write_byte(data[i]) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 572 | self.assertEqual(m.tell(), i+1) |
Benjamin Peterson | e099b37 | 2009-04-04 17:09:35 +0000 | [diff] [blame] | 573 | self.assertRaises(ValueError, m.write_byte, b"x"[0]) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 574 | self.assertEqual(m[:], data) |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 575 | # Test read_byte() |
| 576 | m.seek(0) |
| 577 | for i in range(len(data)): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 578 | self.assertEqual(m.tell(), i) |
| 579 | self.assertEqual(m.read_byte(), data[i]) |
| 580 | self.assertEqual(m.tell(), i+1) |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 581 | self.assertRaises(ValueError, m.read_byte) |
| 582 | # Test read() |
| 583 | m.seek(3) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 584 | self.assertEqual(m.read(3), b"345") |
| 585 | self.assertEqual(m.tell(), 6) |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 586 | # Test write() |
| 587 | m.seek(3) |
| 588 | m.write(b"bar") |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 589 | self.assertEqual(m.tell(), 6) |
| 590 | self.assertEqual(m[:], b"012bar6789") |
Serhiy Storchaka | 8490f5a | 2015-03-20 09:00:36 +0200 | [diff] [blame] | 591 | m.write(bytearray(b"baz")) |
| 592 | self.assertEqual(m.tell(), 9) |
| 593 | self.assertEqual(m[:], b"012barbaz9") |
| 594 | self.assertRaises(ValueError, m.write, b"ba") |
Hirokazu Yamamoto | 39c6dea | 2009-02-28 10:56:50 +0000 | [diff] [blame] | 595 | |
Hirokazu Yamamoto | 3cdd5cb | 2010-11-04 12:09:08 +0000 | [diff] [blame] | 596 | def test_non_ascii_byte(self): |
| 597 | for b in (129, 200, 255): # > 128 |
| 598 | m = mmap.mmap(-1, 1) |
| 599 | m.write_byte(b) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 600 | self.assertEqual(m[0], b) |
Hirokazu Yamamoto | 3cdd5cb | 2010-11-04 12:09:08 +0000 | [diff] [blame] | 601 | m.seek(0) |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 602 | self.assertEqual(m.read_byte(), b) |
Hirokazu Yamamoto | 3cdd5cb | 2010-11-04 12:09:08 +0000 | [diff] [blame] | 603 | m.close() |
| 604 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 605 | @unittest.skipUnless(os.name == 'nt', 'requires Windows') |
| 606 | def test_tagname(self): |
| 607 | data1 = b"0123456789" |
| 608 | data2 = b"abcdefghij" |
| 609 | assert len(data1) == len(data2) |
Hirokazu Yamamoto | 8e722bc | 2009-03-05 14:33:01 +0000 | [diff] [blame] | 610 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 611 | # Test same tag |
| 612 | m1 = mmap.mmap(-1, len(data1), tagname="foo") |
| 613 | m1[:] = data1 |
| 614 | m2 = mmap.mmap(-1, len(data2), tagname="foo") |
| 615 | m2[:] = data2 |
| 616 | self.assertEqual(m1[:], data2) |
| 617 | self.assertEqual(m2[:], data2) |
| 618 | m2.close() |
| 619 | m1.close() |
Hirokazu Yamamoto | 8e722bc | 2009-03-05 14:33:01 +0000 | [diff] [blame] | 620 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 621 | # Test different tag |
| 622 | m1 = mmap.mmap(-1, len(data1), tagname="foo") |
| 623 | m1[:] = data1 |
| 624 | m2 = mmap.mmap(-1, len(data2), tagname="boo") |
| 625 | m2[:] = data2 |
| 626 | self.assertEqual(m1[:], data1) |
| 627 | self.assertEqual(m2[:], data2) |
| 628 | m2.close() |
| 629 | m1.close() |
Hirokazu Yamamoto | 10c9937 | 2009-02-28 12:21:53 +0000 | [diff] [blame] | 630 | |
Serhiy Storchaka | 76b4765 | 2014-08-19 17:11:20 +0300 | [diff] [blame] | 631 | @cpython_only |
| 632 | @unittest.skipUnless(os.name == 'nt', 'requires Windows') |
| 633 | def test_sizeof(self): |
| 634 | m1 = mmap.mmap(-1, 100) |
| 635 | tagname = "foo" |
| 636 | m2 = mmap.mmap(-1, 100, tagname=tagname) |
Serhiy Storchaka | 996c3de | 2014-08-19 18:20:23 +0300 | [diff] [blame] | 637 | self.assertEqual(sys.getsizeof(m2), |
| 638 | sys.getsizeof(m1) + len(tagname) + 1) |
Serhiy Storchaka | 76b4765 | 2014-08-19 17:11:20 +0300 | [diff] [blame] | 639 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 640 | @unittest.skipUnless(os.name == 'nt', 'requires Windows') |
| 641 | def test_crasher_on_windows(self): |
| 642 | # Should not crash (Issue 1733986) |
| 643 | m = mmap.mmap(-1, 1000, tagname="foo") |
| 644 | try: |
| 645 | mmap.mmap(-1, 5000, tagname="foo")[:] # same tagname, but larger size |
| 646 | except: |
| 647 | pass |
| 648 | m.close() |
Hirokazu Yamamoto | 8e722bc | 2009-03-05 14:33:01 +0000 | [diff] [blame] | 649 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 650 | # Should not crash (Issue 5385) |
| 651 | with open(TESTFN, "wb") as fp: |
| 652 | fp.write(b"x"*10) |
| 653 | f = open(TESTFN, "r+b") |
| 654 | m = mmap.mmap(f.fileno(), 0) |
| 655 | f.close() |
| 656 | try: |
| 657 | m.resize(0) # will raise OSError |
| 658 | except: |
| 659 | pass |
| 660 | try: |
| 661 | m[:] |
| 662 | except: |
| 663 | pass |
| 664 | m.close() |
Hirokazu Yamamoto | 8e722bc | 2009-03-05 14:33:01 +0000 | [diff] [blame] | 665 | |
Serhiy Storchaka | 4376763 | 2013-11-03 21:31:38 +0200 | [diff] [blame] | 666 | @unittest.skipUnless(os.name == 'nt', 'requires Windows') |
| 667 | def test_invalid_descriptor(self): |
| 668 | # socket file descriptors are valid, but out of range |
| 669 | # for _get_osfhandle, causing a crash when validating the |
| 670 | # parameters to _get_osfhandle. |
| 671 | s = socket.socket() |
| 672 | try: |
| 673 | with self.assertRaises(OSError): |
| 674 | m = mmap.mmap(s.fileno(), 10) |
| 675 | finally: |
| 676 | s.close() |
Brian Curtin | ea47eaa | 2010-08-01 15:26:26 +0000 | [diff] [blame] | 677 | |
Georg Brandl | 0bccc18 | 2010-08-01 14:50:00 +0000 | [diff] [blame] | 678 | def test_context_manager(self): |
| 679 | with mmap.mmap(-1, 10) as m: |
| 680 | self.assertFalse(m.closed) |
| 681 | self.assertTrue(m.closed) |
| 682 | |
| 683 | def test_context_manager_exception(self): |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 684 | # Test that the OSError gets passed through |
Georg Brandl | 0bccc18 | 2010-08-01 14:50:00 +0000 | [diff] [blame] | 685 | with self.assertRaises(Exception) as exc: |
| 686 | with mmap.mmap(-1, 10) as m: |
Andrew Svetlov | f7a17b4 | 2012-12-25 16:47:37 +0200 | [diff] [blame] | 687 | raise OSError |
| 688 | self.assertIsInstance(exc.exception, OSError, |
Georg Brandl | 0bccc18 | 2010-08-01 14:50:00 +0000 | [diff] [blame] | 689 | "wrong exception raised in context manager") |
| 690 | self.assertTrue(m.closed, "context manager failed") |
| 691 | |
Antoine Pitrou | c53204b | 2013-08-05 23:17:30 +0200 | [diff] [blame] | 692 | def test_weakref(self): |
| 693 | # Check mmap objects are weakrefable |
| 694 | mm = mmap.mmap(-1, 16) |
| 695 | wr = weakref.ref(mm) |
| 696 | self.assertIs(wr(), mm) |
| 697 | del mm |
| 698 | gc_collect() |
| 699 | self.assertIs(wr(), None) |
| 700 | |
Berker Peksag | 6282e65 | 2016-03-02 19:30:18 +0200 | [diff] [blame] | 701 | def test_write_returning_the_number_of_bytes_written(self): |
| 702 | mm = mmap.mmap(-1, 16) |
| 703 | self.assertEqual(mm.write(b""), 0) |
| 704 | self.assertEqual(mm.write(b"x"), 1) |
| 705 | self.assertEqual(mm.write(b"yz"), 2) |
| 706 | self.assertEqual(mm.write(b"python"), 6) |
| 707 | |
Benjamin Peterson | 4c8b2cd | 2016-10-05 22:09:31 -0700 | [diff] [blame] | 708 | @unittest.skipIf(os.name == 'nt', 'cannot resize anonymous mmaps on Windows') |
Benjamin Peterson | cd04db0 | 2016-10-05 21:45:48 -0700 | [diff] [blame] | 709 | def test_resize_past_pos(self): |
| 710 | m = mmap.mmap(-1, 8192) |
| 711 | self.addCleanup(m.close) |
| 712 | m.read(5000) |
Benjamin Peterson | e06cc67 | 2016-10-05 22:00:05 -0700 | [diff] [blame] | 713 | try: |
| 714 | m.resize(4096) |
| 715 | except SystemError: |
| 716 | self.skipTest("resizing not supported") |
Benjamin Peterson | cd04db0 | 2016-10-05 21:45:48 -0700 | [diff] [blame] | 717 | self.assertEqual(m.read(14), b'') |
Benjamin Peterson | cf0b9da | 2016-10-05 22:00:24 -0700 | [diff] [blame] | 718 | self.assertRaises(ValueError, m.read_byte) |
Benjamin Peterson | cd04db0 | 2016-10-05 21:45:48 -0700 | [diff] [blame] | 719 | self.assertRaises(ValueError, m.write_byte, 42) |
| 720 | self.assertRaises(ValueError, m.write, b'abc') |
| 721 | |
Zackery Spytz | e9e3976 | 2018-06-05 06:59:41 -0600 | [diff] [blame] | 722 | def test_concat_repeat_exception(self): |
| 723 | m = mmap.mmap(-1, 16) |
| 724 | with self.assertRaises(TypeError): |
| 725 | m + m |
| 726 | with self.assertRaises(TypeError): |
| 727 | m * 2 |
| 728 | |
Berker Peksag | e7d4b2f | 2018-08-22 21:21:05 +0300 | [diff] [blame] | 729 | def test_flush_return_value(self): |
| 730 | # mm.flush() should return None on success, raise an |
| 731 | # exception on error under all platforms. |
| 732 | mm = mmap.mmap(-1, 16) |
| 733 | self.addCleanup(mm.close) |
| 734 | mm.write(b'python') |
| 735 | result = mm.flush() |
| 736 | self.assertIsNone(result) |
Berker Peksag | bc85475 | 2018-09-20 19:53:06 +0300 | [diff] [blame] | 737 | if sys.platform.startswith('linux'): |
| 738 | # 'offset' must be a multiple of mmap.PAGESIZE on Linux. |
| 739 | # See bpo-34754 for details. |
Berker Peksag | e7d4b2f | 2018-08-22 21:21:05 +0300 | [diff] [blame] | 740 | self.assertRaises(OSError, mm.flush, 1, len(b'python')) |
| 741 | |
Berker Peksag | 6282e65 | 2016-03-02 19:30:18 +0200 | [diff] [blame] | 742 | |
Antoine Pitrou | 97696cb | 2011-02-21 23:46:27 +0000 | [diff] [blame] | 743 | class LargeMmapTests(unittest.TestCase): |
| 744 | |
| 745 | def setUp(self): |
| 746 | unlink(TESTFN) |
| 747 | |
| 748 | def tearDown(self): |
| 749 | unlink(TESTFN) |
| 750 | |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 751 | def _make_test_file(self, num_zeroes, tail): |
Antoine Pitrou | 97696cb | 2011-02-21 23:46:27 +0000 | [diff] [blame] | 752 | if sys.platform[:3] == 'win' or sys.platform == 'darwin': |
| 753 | requires('largefile', |
| 754 | 'test requires %s bytes and a long time to run' % str(0x180000000)) |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 755 | f = open(TESTFN, 'w+b') |
| 756 | try: |
| 757 | f.seek(num_zeroes) |
| 758 | f.write(tail) |
| 759 | f.flush() |
Serhiy Storchaka | 05d3921 | 2016-05-23 08:41:48 +0300 | [diff] [blame] | 760 | except (OSError, OverflowError, ValueError): |
Martin Panter | e8d58d1 | 2015-09-07 02:57:47 +0000 | [diff] [blame] | 761 | try: |
| 762 | f.close() |
| 763 | except (OSError, OverflowError): |
| 764 | pass |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 765 | raise unittest.SkipTest("filesystem does not have largefile support") |
| 766 | return f |
Antoine Pitrou | 97696cb | 2011-02-21 23:46:27 +0000 | [diff] [blame] | 767 | |
Nadeem Vawda | ced1056 | 2011-05-07 13:01:50 +0200 | [diff] [blame] | 768 | def test_large_offset(self): |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 769 | with self._make_test_file(0x14FFFFFFF, b" ") as f: |
Antoine Pitrou | 97696cb | 2011-02-21 23:46:27 +0000 | [diff] [blame] | 770 | with mmap.mmap(f.fileno(), 0, offset=0x140000000, access=mmap.ACCESS_READ) as m: |
| 771 | self.assertEqual(m[0xFFFFFFF], 32) |
| 772 | |
| 773 | def test_large_filesize(self): |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 774 | with self._make_test_file(0x17FFFFFFF, b" ") as f: |
Richard Oudkerk | 0d09ba8 | 2013-02-13 12:18:03 +0000 | [diff] [blame] | 775 | if sys.maxsize < 0x180000000: |
| 776 | # On 32 bit platforms the file is larger than sys.maxsize so |
| 777 | # mapping the whole file should fail -- Issue #16743 |
| 778 | with self.assertRaises(OverflowError): |
| 779 | mmap.mmap(f.fileno(), 0x180000000, access=mmap.ACCESS_READ) |
| 780 | with self.assertRaises(ValueError): |
| 781 | mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ) |
Antoine Pitrou | 97696cb | 2011-02-21 23:46:27 +0000 | [diff] [blame] | 782 | with mmap.mmap(f.fileno(), 0x10000, access=mmap.ACCESS_READ) as m: |
| 783 | self.assertEqual(m.size(), 0x180000000) |
| 784 | |
Victor Stinner | 8c663fd | 2017-11-08 14:44:44 -0800 | [diff] [blame] | 785 | # Issue 11277: mmap() with large (~4 GiB) sparse files crashes on OS X. |
Nadeem Vawda | ced1056 | 2011-05-07 13:01:50 +0200 | [diff] [blame] | 786 | |
| 787 | def _test_around_boundary(self, boundary): |
| 788 | tail = b' DEARdear ' |
| 789 | start = boundary - len(tail) // 2 |
| 790 | end = start + len(tail) |
Nadeem Vawda | 909f6d2 | 2011-05-07 14:14:53 +0200 | [diff] [blame] | 791 | with self._make_test_file(start, tail) as f: |
Nadeem Vawda | c2bb073 | 2011-05-07 13:08:54 +0200 | [diff] [blame] | 792 | with mmap.mmap(f.fileno(), 0, access=mmap.ACCESS_READ) as m: |
Nadeem Vawda | ced1056 | 2011-05-07 13:01:50 +0200 | [diff] [blame] | 793 | self.assertEqual(m[start:end], tail) |
Nadeem Vawda | ced1056 | 2011-05-07 13:01:50 +0200 | [diff] [blame] | 794 | |
| 795 | @unittest.skipUnless(sys.maxsize > _4G, "test cannot run on 32-bit systems") |
| 796 | def test_around_2GB(self): |
| 797 | self._test_around_boundary(_2G) |
| 798 | |
| 799 | @unittest.skipUnless(sys.maxsize > _4G, "test cannot run on 32-bit systems") |
| 800 | def test_around_4GB(self): |
| 801 | self._test_around_boundary(_4G) |
| 802 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 803 | |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 804 | if __name__ == '__main__': |
Berker Peksag | e7d4b2f | 2018-08-22 21:21:05 +0300 | [diff] [blame] | 805 | unittest.main() |