1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
|
/*
* xloop_main.c
*
* Written by Theodore Ts'o, 3/29/93
*
* Copyright 1993 by Theodore Ts'o. Redistribution of this file is
* permitted under the GNU General Public License.
*
* DES encryption plus some minor changes by Werner Almesberger, 30-MAY-1993
* more DES encryption plus IDEA encryption by Nicholas J. Leon, June 20, 1996
*
* Modularized and updated for 1.1.16 kernel - Mitch Dsouza 28th May 1994
* Adapted for 1.3.59 kernel - Andries Brouwer, 1 Feb 1996
*
* Fixed do_xloop_request() re-entrancy - Vincent.Renardias@waw.com Mar 20, 1997
*
* Added devfs support - Richard Gooch <rgooch@atnf.csiro.au> 16-Jan-1998
*
* Handle sparse backing files correctly - Kenn Humborg, Jun 28, 1998
*
* Loadable modules and other fixes by AK, 1998
*
* Make real block number available to downstream transfer functions, enables
* CBC (and relatives) mode encryption requiring unique IVs per data block.
* Reed H. Petty, rhp@draper.net
*
* Maximum number of xloop devices now dynamic via max_xloop module parameter.
* Russell Kroll <rkroll@exploits.org> 19990701
*
* Maximum number of xloop devices when compiled-in now selectable by passing
* max_xloop=<1-255> to the kernel on boot.
* Erik I. Bolsø, <eriki@himolde.no>, Oct 31, 1999
*
* Completely rewrite request handling to be make_request_fn style and
* non blocking, pushing work to a helper thread. Lots of fixes from
* Al Viro too.
* Jens Axboe <axboe@suse.de>, Nov 2000
*
* Support up to 256 xloop devices
* Heinz Mauelshagen <mge@sistina.com>, Feb 2002
*
* Support for falling back on the write file operation when the address space
* operations write_begin is not available on the backing filesystem.
* Anton Altaparmakov, 16 Feb 2005
*
* Support for using file formats.
* Manuel Bentele <development@manuel-bentele.de>, 2019
*
* Still To Fix:
* - Advisory locking is ignored here.
* - Should use an own CAP_* category instead of CAP_SYS_ADMIN
*
*/
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/sched.h>
#include <linux/fs.h>
#include <linux/file.h>
#include <linux/stat.h>
#include <linux/errno.h>
#include <linux/major.h>
#include <linux/wait.h>
#include <linux/blkdev.h>
#include <linux/blkpg.h>
#include <linux/init.h>
#include <linux/swap.h>
#include <linux/slab.h>
#include <linux/compat.h>
#include <linux/suspend.h>
#include <linux/freezer.h>
#include <linux/mutex.h>
#include <linux/writeback.h>
#include <linux/completion.h>
#include <linux/highmem.h>
#include <linux/kthread.h>
#include <linux/splice.h>
#include <linux/sysfs.h>
#include <linux/miscdevice.h>
#include <linux/falloc.h>
#include <linux/uio.h>
#include <linux/ioprio.h>
#include <linux/blk-cgroup.h>
#include <linux/version.h>
#ifdef CONFIG_DEBUG_FS
#include <linux/debugfs.h>
#endif
#include "xloop_file_fmt.h"
#include "xloop_main.h"
#include <linux/uaccess.h>
static DEFINE_IDR(xloop_index_idr);
static DEFINE_MUTEX(xloop_ctl_mutex);
static int max_part;
static int part_shift;
struct device *xloop_device_to_dev(struct xloop_device *xlo)
{
return disk_to_dev(xlo->xlo_disk);
}
EXPORT_SYMBOL(xloop_device_to_dev);
static int transfer_xor(struct xloop_device *xlo, int cmd,
struct page *raw_page, unsigned raw_off,
struct page *xloop_page, unsigned xloop_off,
int size, sector_t real_block)
{
char *raw_buf = kmap_atomic(raw_page) + raw_off;
char *xloop_buf = kmap_atomic(xloop_page) + xloop_off;
char *in, *out, *key;
int i, keysize;
if (cmd == READ) {
in = raw_buf;
out = xloop_buf;
} else {
in = xloop_buf;
out = raw_buf;
}
key = xlo->xlo_encrypt_key;
keysize = xlo->xlo_encrypt_key_size;
for (i = 0; i < size; i++)
*out++ = *in++ ^ key[(i & 511) % keysize];
kunmap_atomic(xloop_buf);
kunmap_atomic(raw_buf);
cond_resched();
return 0;
}
static int xor_init(struct xloop_device *xlo, const struct xloop_info64 *info)
{
if (unlikely(info->xlo_encrypt_key_size <= 0))
return -EINVAL;
return 0;
}
static struct xloop_func_table none_funcs = {
.number = XLO_CRYPT_NONE,
};
static struct xloop_func_table xor_funcs = {
.number = XLO_CRYPT_XOR,
.transfer = transfer_xor,
.init = xor_init
};
/* xfer_funcs[0] is special - its release function is never called */
static struct xloop_func_table *xfer_funcs[MAX_XLO_CRYPT] = {
&none_funcs,
&xor_funcs
};
static loff_t get_xloop_size(struct xloop_device *xlo, struct file *file)
{
return xloop_file_fmt_sector_size(xlo->xlo_fmt, file, xlo->xlo_offset,
xlo->xlo_sizelimit);
}
static void __xloop_update_dio(struct xloop_device *xlo, bool dio)
{
struct file *file = xlo->xlo_backing_file;
struct address_space *mapping = file->f_mapping;
struct inode *inode = mapping->host;
unsigned short sb_bsize = 0;
unsigned dio_align = 0;
bool use_dio;
if (inode->i_sb->s_bdev) {
sb_bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
dio_align = sb_bsize - 1;
}
/*
* We support direct I/O only if xlo_offset is aligned with the
* logical I/O size of backing device, and the logical block
* size of xloop is bigger than the backing device's and the xloop
* needn't transform transfer.
*
* TODO: the above condition may be loosed in the future, and
* direct I/O may be switched runtime at that time because most
* of requests in sane applications should be PAGE_SIZE aligned
*/
if (dio) {
if (queue_logical_block_size(xlo->xlo_queue) >= sb_bsize &&
!(xlo->xlo_offset & dio_align) &&
mapping->a_ops->direct_IO &&
!xlo->transfer)
use_dio = true;
else
use_dio = false;
} else {
use_dio = false;
}
if (xlo->use_dio == use_dio)
return;
/* flush dirty pages before changing direct IO */
xloop_file_fmt_flush(xlo->xlo_fmt);
/*
* The flag of XLO_FLAGS_DIRECT_IO is handled similarly with
* XLO_FLAGS_READ_ONLY, both are set from kernel, and losetup
* will get updated by ioctl(XLOOP_GET_STATUS)
*/
if (xlo->xlo_state == Xlo_bound)
blk_mq_freeze_queue(xlo->xlo_queue);
xlo->use_dio = use_dio;
if (use_dio) {
blk_queue_flag_clear(QUEUE_FLAG_NOMERGES, xlo->xlo_queue);
xlo->xlo_flags |= XLO_FLAGS_DIRECT_IO;
} else {
blk_queue_flag_set(QUEUE_FLAG_NOMERGES, xlo->xlo_queue);
xlo->xlo_flags &= ~XLO_FLAGS_DIRECT_IO;
}
if (xlo->xlo_state == Xlo_bound)
blk_mq_unfreeze_queue(xlo->xlo_queue);
}
/**
* xloop_validate_block_size() - validates the passed in block size
* @bsize: size to validate
*/
static int
xloop_validate_block_size(unsigned short bsize)
{
if (bsize < 512 || bsize > PAGE_SIZE || !is_power_of_2(bsize))
return -EINVAL;
return 0;
}
/**
* xloop_set_size() - sets device size and notifies userspace
* @xlo: struct xloop_device to set the size for
* @size: new size of the xloop device
*
* Callers must validate that the size passed into this function fits into
* a sector_t, eg using xloop_validate_size()
*/
static void xloop_set_size(struct xloop_device *xlo, loff_t size)
{
struct block_device *bdev = xlo->xlo_device;
#if LINUX_VERSION_CODE < KERNEL_VERSION(5, 7, 0)
sector_t capacity;
#endif
bd_set_size(bdev, size << SECTOR_SHIFT);
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 7, 0)
set_capacity_revalidate_and_notify(xlo->xlo_disk, size, false);
#else
capacity = get_capacity(xlo->xlo_disk);
set_capacity(xlo->xlo_disk, size);
if (capacity != size && capacity != 0 && size != 0) {
char *envp[] = { "RESIZE=1", NULL };
kobject_uevent_env(&disk_to_dev(xlo->xlo_disk)->kobj, KOBJ_CHANGE,
envp);
}
#endif
}
static void xlo_complete_rq(struct request *rq)
{
struct xloop_cmd *cmd = blk_mq_rq_to_pdu(rq);
blk_status_t ret = BLK_STS_OK;
if (!cmd->use_aio || cmd->ret < 0 || cmd->ret == blk_rq_bytes(rq) ||
req_op(rq) != REQ_OP_READ) {
if (cmd->ret < 0)
ret = errno_to_blk_status(cmd->ret);
goto end_io;
}
/*
* Short READ - if we got some data, advance our request and
* retry it. If we got no data, end the rest with EIO.
*/
if (cmd->ret) {
blk_update_request(rq, BLK_STS_OK, cmd->ret);
cmd->ret = 0;
blk_mq_requeue_request(rq, true);
} else {
if (cmd->use_aio) {
struct bio *bio = rq->bio;
while (bio) {
zero_fill_bio(bio);
bio = bio->bi_next;
}
}
ret = BLK_STS_IOERR;
end_io:
blk_mq_end_request(rq, ret);
}
}
static int do_req_filebacked(struct xloop_device *xlo, struct request *rq)
{
struct xloop_cmd *cmd = blk_mq_rq_to_pdu(rq);
/*
* xlo_write_simple and xlo_read_simple should have been covered
* by io submit style function like xlo_rw_aio(), one blocker
* is that xlo_read_simple() need to call flush_dcache_page after
* the page is written from kernel, and it isn't easy to handle
* this in io submit style function which submits all segments
* of the req at one time. And direct read IO doesn't need to
* run flush_dcache_page().
*/
switch (req_op(rq)) {
case REQ_OP_FLUSH:
return xloop_file_fmt_flush(xlo->xlo_fmt);
case REQ_OP_WRITE_ZEROES:
return xloop_file_fmt_write_zeros(xlo->xlo_fmt, rq);
case REQ_OP_DISCARD:
return xloop_file_fmt_discard(xlo->xlo_fmt, rq);
case REQ_OP_WRITE:
if (cmd->use_aio)
return xloop_file_fmt_write_aio(xlo->xlo_fmt, rq);
else
return xloop_file_fmt_write(xlo->xlo_fmt, rq);
case REQ_OP_READ:
if (cmd->use_aio)
return xloop_file_fmt_read_aio(xlo->xlo_fmt, rq);
else
return xloop_file_fmt_read(xlo->xlo_fmt, rq);
default:
WARN_ON_ONCE(1);
return -EIO;
}
}
static inline void xloop_update_dio(struct xloop_device *xlo)
{
__xloop_update_dio(xlo, (xlo->xlo_backing_file->f_flags & O_DIRECT) |
xlo->use_dio);
}
static void xloop_reread_partitions(struct xloop_device *xlo,
struct block_device *bdev)
{
int rc;
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 5, 0)
mutex_lock(&bdev->bd_mutex);
rc = bdev_disk_changed(bdev, false);
mutex_unlock(&bdev->bd_mutex);
#else
rc = blkdev_reread_part(bdev);
#endif
if (rc)
dev_warn(xloop_device_to_dev(xlo), "partition scan failed (rc=%d)\n",
rc);
}
static inline int is_xloop_device(struct file *file)
{
struct inode *i = file->f_mapping->host;
return i && S_ISBLK(i->i_mode) && MAJOR(i->i_rdev) == XLOOP_MAJOR;
}
static int xloop_validate_file(struct file *file, struct block_device *bdev)
{
struct inode *inode = file->f_mapping->host;
struct file *f = file;
/* Avoid recursion */
while (is_xloop_device(f)) {
struct xloop_device *l;
if (f->f_mapping->host->i_bdev == bdev)
return -EBADF;
l = f->f_mapping->host->i_bdev->bd_disk->private_data;
if (l->xlo_state != Xlo_bound) {
return -EINVAL;
}
f = l->xlo_backing_file;
}
if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
return -EINVAL;
return 0;
}
/*
* xloop_change_fd switched the backing store of a xloopback device to
* a new file. This is useful for operating system installers to free up
* the original file and in High Availability environments to switch to
* an alternative location for the content in case of server meltdown.
* This can only work if the xloop device is used read-only, and if the
* new backing store is the same size and type as the old backing store.
*/
static int xloop_change_fd(struct xloop_device *xlo, struct block_device *bdev,
unsigned int arg)
{
struct file *file = NULL, *old_file;
int error;
bool partscan;
error = mutex_lock_killable(&xloop_ctl_mutex);
if (error)
return error;
error = -ENXIO;
if (xlo->xlo_state != Xlo_bound)
goto out_err;
/* the xloop device has to be read-only */
error = -EINVAL;
if (!(xlo->xlo_flags & XLO_FLAGS_READ_ONLY))
goto out_err;
error = -EBADF;
file = fget(arg);
if (!file)
goto out_err;
error = xloop_validate_file(file, bdev);
if (error)
goto out_err;
old_file = xlo->xlo_backing_file;
error = -EINVAL;
/* size of the new backing store needs to be the same */
if (get_xloop_size(xlo, file) != get_xloop_size(xlo, old_file))
goto out_err;
/* and ... switch */
blk_mq_freeze_queue(xlo->xlo_queue);
mapping_set_gfp_mask(old_file->f_mapping, xlo->old_gfp_mask);
xlo->xlo_backing_file = file;
xlo->old_gfp_mask = mapping_gfp_mask(file->f_mapping);
mapping_set_gfp_mask(file->f_mapping,
xlo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
xloop_update_dio(xlo);
blk_mq_unfreeze_queue(xlo->xlo_queue);
partscan = xlo->xlo_flags & XLO_FLAGS_PARTSCAN;
mutex_unlock(&xloop_ctl_mutex);
/*
* We must drop file reference outside of xloop_ctl_mutex as dropping
* the file ref can take bd_mutex which creates circular locking
* dependency.
*/
fput(old_file);
if (partscan)
xloop_reread_partitions(xlo, bdev);
return 0;
out_err:
mutex_unlock(&xloop_ctl_mutex);
if (file)
fput(file);
return error;
}
/* xloop sysfs attributes */
static ssize_t xloop_attr_show(struct device *dev, char *page,
ssize_t (*callback)(struct xloop_device *, char *))
{
struct gendisk *disk = dev_to_disk(dev);
struct xloop_device *xlo = disk->private_data;
return callback(xlo, page);
}
#define XLOOP_ATTR_RO(_name) \
static ssize_t xloop_attr_##_name##_show(struct xloop_device *, char *); \
static ssize_t xloop_attr_do_show_##_name(struct device *d, \
struct device_attribute *attr, char *b) \
{ \
return xloop_attr_show(d, b, xloop_attr_##_name##_show); \
} \
static struct device_attribute xloop_attr_##_name = \
__ATTR(_name, 0444, xloop_attr_do_show_##_name, NULL);
static ssize_t xloop_attr_backing_file_show(struct xloop_device *xlo, char *buf)
{
ssize_t ret;
char *p = NULL;
spin_lock_irq(&xlo->xlo_lock);
if (xlo->xlo_backing_file)
p = file_path(xlo->xlo_backing_file, buf, PAGE_SIZE - 1);
spin_unlock_irq(&xlo->xlo_lock);
if (IS_ERR_OR_NULL(p))
ret = PTR_ERR(p);
else {
ret = strlen(p);
memmove(buf, p, ret);
buf[ret++] = '\n';
buf[ret] = 0;
}
return ret;
}
static ssize_t xloop_attr_file_fmt_type_show(struct xloop_device *xlo,
char *buf)
{
ssize_t len = 0;
len = xloop_file_fmt_print_type(xlo->xlo_fmt->file_fmt_type, buf);
len += sprintf(buf + len, "\n");
return len;
}
static ssize_t xloop_attr_offset_show(struct xloop_device *xlo, char *buf)
{
return sprintf(buf, "%llu\n", (unsigned long long)xlo->xlo_offset);
}
static ssize_t xloop_attr_sizelimit_show(struct xloop_device *xlo, char *buf)
{
return sprintf(buf, "%llu\n", (unsigned long long)xlo->xlo_sizelimit);
}
static ssize_t xloop_attr_autoclear_show(struct xloop_device *xlo, char *buf)
{
int autoclear = (xlo->xlo_flags & XLO_FLAGS_AUTOCLEAR);
return sprintf(buf, "%s\n", autoclear ? "1" : "0");
}
static ssize_t xloop_attr_partscan_show(struct xloop_device *xlo, char *buf)
{
int partscan = (xlo->xlo_flags & XLO_FLAGS_PARTSCAN);
return sprintf(buf, "%s\n", partscan ? "1" : "0");
}
static ssize_t xloop_attr_dio_show(struct xloop_device *xlo, char *buf)
{
int dio = (xlo->xlo_flags & XLO_FLAGS_DIRECT_IO);
return sprintf(buf, "%s\n", dio ? "1" : "0");
}
XLOOP_ATTR_RO(backing_file);
XLOOP_ATTR_RO(file_fmt_type);
XLOOP_ATTR_RO(offset);
XLOOP_ATTR_RO(sizelimit);
XLOOP_ATTR_RO(autoclear);
XLOOP_ATTR_RO(partscan);
XLOOP_ATTR_RO(dio);
static struct attribute *xloop_attrs[] = {
&xloop_attr_backing_file.attr,
&xloop_attr_file_fmt_type.attr,
&xloop_attr_offset.attr,
&xloop_attr_sizelimit.attr,
&xloop_attr_autoclear.attr,
&xloop_attr_partscan.attr,
&xloop_attr_dio.attr,
NULL,
};
static struct attribute_group xloop_attribute_group = {
.name = "xloop",
.attrs= xloop_attrs,
};
static void xloop_sysfs_init(struct xloop_device *xlo)
{
xlo->sysfs_inited = !sysfs_create_group(&disk_to_dev(xlo->xlo_disk)->kobj,
&xloop_attribute_group);
}
static void xloop_sysfs_exit(struct xloop_device *xlo)
{
if (xlo->sysfs_inited)
sysfs_remove_group(&disk_to_dev(xlo->xlo_disk)->kobj,
&xloop_attribute_group);
}
static void xloop_config_discard(struct xloop_device *xlo)
{
struct file *file = xlo->xlo_backing_file;
struct inode *inode = file->f_mapping->host;
struct request_queue *q = xlo->xlo_queue;
u32 granularity, max_discard_sectors;
/*
* If the backing device is a block device, mirror its zeroing
* capability. Set the discard sectors to the block device's zeroing
* capabilities because xloop discards result in blkdev_issue_zeroout(),
* not blkdev_issue_discard(). This maintains consistent behavior with
* file-backed xloop devices: discarded regions read back as zero.
*/
if (S_ISBLK(inode->i_mode) && !xlo->xlo_encrypt_key_size) {
struct request_queue *backingq;
backingq = bdev_get_queue(inode->i_bdev);
max_discard_sectors = backingq->limits.max_write_zeroes_sectors;
granularity = backingq->limits.discard_granularity ?:
queue_physical_block_size(backingq);
/*
* We use punch hole to reclaim the free space used by the
* image a.k.a. discard. However we do not support discard if
* encryption is enabled, because it may give an attacker
* useful information.
*/
} else if (!file->f_op->fallocate || xlo->xlo_encrypt_key_size) {
max_discard_sectors = 0;
granularity = 0;
} else {
max_discard_sectors = UINT_MAX >> 9;
granularity = inode->i_sb->s_blocksize;
}
if (max_discard_sectors) {
q->limits.discard_granularity = granularity;
blk_queue_max_discard_sectors(q, max_discard_sectors);
blk_queue_max_write_zeroes_sectors(q, max_discard_sectors);
blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
} else {
q->limits.discard_granularity = 0;
blk_queue_max_discard_sectors(q, 0);
blk_queue_max_write_zeroes_sectors(q, 0);
blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
}
q->limits.discard_alignment = 0;
}
static void xloop_unprepare_queue(struct xloop_device *xlo)
{
kthread_flush_worker(&xlo->worker);
kthread_stop(xlo->worker_task);
}
static int xloop_kthread_worker_fn(void *worker_ptr)
{
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 8, 0)
current->flags |= PF_LOCAL_THROTTLE | PF_MEMALLOC_NOIO;
#else
current->flags |= PF_LESS_THROTTLE | PF_MEMALLOC_NOIO;
#endif
return kthread_worker_fn(worker_ptr);
}
static int xloop_prepare_queue(struct xloop_device *xlo)
{
kthread_init_worker(&xlo->worker);
xlo->worker_task = kthread_run(xloop_kthread_worker_fn,
&xlo->worker, "xloop%d", xlo->xlo_number);
if (IS_ERR(xlo->worker_task))
return -ENOMEM;
set_user_nice(xlo->worker_task, MIN_NICE);
return 0;
}
static void xloop_update_rotational(struct xloop_device *xlo)
{
struct file *file = xlo->xlo_backing_file;
struct inode *file_inode = file->f_mapping->host;
struct block_device *file_bdev = file_inode->i_sb->s_bdev;
struct request_queue *q = xlo->xlo_queue;
bool nonrot = true;
/* not all filesystems (e.g. tmpfs) have a sb->s_bdev */
if (file_bdev)
nonrot = blk_queue_nonrot(bdev_get_queue(file_bdev));
if (nonrot)
blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
else
blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
}
static int
xloop_release_xfer(struct xloop_device *xlo)
{
int err = 0;
struct xloop_func_table *xfer = xlo->xlo_encryption;
if (xfer) {
if (xfer->release)
err = xfer->release(xlo);
xlo->transfer = NULL;
xlo->xlo_encryption = NULL;
module_put(xfer->owner);
}
return err;
}
static int
xloop_init_xfer(struct xloop_device *xlo, struct xloop_func_table *xfer,
const struct xloop_info64 *i)
{
int err = 0;
if (xfer) {
struct module *owner = xfer->owner;
if (!try_module_get(owner))
return -EINVAL;
if (xfer->init)
err = xfer->init(xlo, i);
if (err)
module_put(owner);
else
xlo->xlo_encryption = xfer;
}
return err;
}
/**
* xloop_set_status_from_info - configure device from xloop_info
* @xlo: struct xloop_device to configure
* @info: struct xloop_info64 to configure the device with
*
* Configures the xloop device parameters according to the passed
* in xloop_info64 configuration.
*/
static int
xloop_set_status_from_info(struct xloop_device *xlo,
const struct xloop_info64 *info)
{
int err;
struct xloop_func_table *xfer;
kuid_t uid = current_uid();
if ((unsigned int) info->xlo_encrypt_key_size > XLO_KEY_SIZE)
return -EINVAL;
err = xloop_release_xfer(xlo);
if (err)
return err;
if (info->xlo_encrypt_type) {
unsigned int type = info->xlo_encrypt_type;
if (type >= MAX_XLO_CRYPT)
return -EINVAL;
xfer = xfer_funcs[type];
if (xfer == NULL)
return -EINVAL;
} else
xfer = NULL;
err = xloop_init_xfer(xlo, xfer, info);
if (err)
return err;
xlo->xlo_offset = info->xlo_offset;
xlo->xlo_sizelimit = info->xlo_sizelimit;
memcpy(xlo->xlo_file_name, info->xlo_file_name, XLO_NAME_SIZE);
memcpy(xlo->xlo_crypt_name, info->xlo_crypt_name, XLO_NAME_SIZE);
xlo->xlo_file_name[XLO_NAME_SIZE-1] = 0;
xlo->xlo_crypt_name[XLO_NAME_SIZE-1] = 0;
if (!xfer)
xfer = &none_funcs;
xlo->transfer = xfer->transfer;
xlo->ioctl = xfer->ioctl;
xlo->xlo_flags = info->xlo_flags;
xlo->xlo_encrypt_key_size = info->xlo_encrypt_key_size;
xlo->xlo_init[0] = info->xlo_init[0];
xlo->xlo_init[1] = info->xlo_init[1];
if (info->xlo_encrypt_key_size) {
memcpy(xlo->xlo_encrypt_key, info->xlo_encrypt_key,
info->xlo_encrypt_key_size);
xlo->xlo_key_owner = uid;
}
return 0;
}
static int xloop_configure(struct xloop_device *xlo, fmode_t mode,
struct block_device *bdev,
const struct xloop_config *config)
{
struct file *file;
struct inode *inode;
struct address_space *mapping;
struct block_device *claimed_bdev = NULL;
int error;
loff_t size;
bool partscan;
unsigned short bsize;
/* This is safe, since we have a reference from open(). */
__module_get(THIS_MODULE);
error = -EBADF;
file = fget(config->fd);
if (!file)
goto out;
/*
* If we don't hold exclusive handle for the device, upgrade to it
* here to avoid changing device under exclusive owner.
*/
if (!(mode & FMODE_EXCL)) {
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 9, 0)
claimed_bdev = bdev->bd_contains;
error = bd_prepare_to_claim(bdev, claimed_bdev, xloop_configure);
if (error)
goto out_putf;
#else
claimed_bdev = bd_start_claiming(bdev, xloop_configure);
if (IS_ERR(claimed_bdev)) {
error = PTR_ERR(claimed_bdev);
goto out_putf;
}
#endif
}
error = mutex_lock_killable(&xloop_ctl_mutex);
if (error)
goto out_bdev;
error = -EBUSY;
if (xlo->xlo_state != Xlo_unbound)
goto out_unlock;
error = xloop_validate_file(file, bdev);
if (error)
goto out_unlock;
mapping = file->f_mapping;
inode = mapping->host;
if ((config->info.xlo_flags & ~XLOOP_CONFIGURE_SETTABLE_FLAGS) != 0) {
error = -EINVAL;
goto out_unlock;
}
if (config->block_size) {
error = xloop_validate_block_size(config->block_size);
if (error)
goto out_unlock;
}
error = xloop_set_status_from_info(xlo, &config->info);
if (error)
goto out_unlock;
if (!(file->f_mode & FMODE_WRITE) || !(mode & FMODE_WRITE) ||
!file->f_op->write_iter)
xlo->xlo_flags |= XLO_FLAGS_READ_ONLY;
error = xloop_prepare_queue(xlo);
if (error)
goto out_unlock;
error = xloop_file_fmt_init(xlo->xlo_fmt,
config->info.xlo_file_fmt_type);
if (error)
goto out_unlock;
set_device_ro(bdev, (xlo->xlo_flags & XLO_FLAGS_READ_ONLY) != 0);
xlo->use_dio = xlo->xlo_flags & XLO_FLAGS_DIRECT_IO;
xlo->xlo_device = bdev;
xlo->xlo_backing_file = file;
xlo->old_gfp_mask = mapping_gfp_mask(mapping);
mapping_set_gfp_mask(mapping, xlo->old_gfp_mask & ~(__GFP_IO|__GFP_FS));
if (!(xlo->xlo_flags & XLO_FLAGS_READ_ONLY) && file->f_op->fsync)
blk_queue_write_cache(xlo->xlo_queue, true, false);
if (config->block_size)
bsize = config->block_size;
else if ((xlo->xlo_backing_file->f_flags & O_DIRECT) && inode->i_sb->s_bdev)
/* In case of direct I/O, match underlying block size */
bsize = bdev_logical_block_size(inode->i_sb->s_bdev);
else
bsize = 512;
blk_queue_logical_block_size(xlo->xlo_queue, bsize);
blk_queue_physical_block_size(xlo->xlo_queue, bsize);
blk_queue_io_min(xlo->xlo_queue, bsize);
xloop_update_rotational(xlo);
xloop_update_dio(xlo);
xloop_sysfs_init(xlo);
size = get_xloop_size(xlo, file);
xloop_set_size(xlo, size);
set_blocksize(bdev, S_ISBLK(inode->i_mode) ?
block_size(inode->i_bdev) : PAGE_SIZE);
xlo->xlo_state = Xlo_bound;
if (part_shift)
xlo->xlo_flags |= XLO_FLAGS_PARTSCAN;
partscan = xlo->xlo_flags & XLO_FLAGS_PARTSCAN;
if (partscan)
xlo->xlo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
/* Grab the block_device to prevent its destruction after we
* put /dev/xloopXX inode. Later in __xloop_clr_fd() we bdput(bdev).
*/
bdgrab(bdev);
mutex_unlock(&xloop_ctl_mutex);
if (partscan)
xloop_reread_partitions(xlo, bdev);
if (claimed_bdev)
bd_abort_claiming(bdev, claimed_bdev, xloop_configure);
return 0;
out_unlock:
mutex_unlock(&xloop_ctl_mutex);
out_bdev:
if (claimed_bdev)
bd_abort_claiming(bdev, claimed_bdev, xloop_configure);
out_putf:
fput(file);
out:
/* This is safe: open() is still holding a reference. */
module_put(THIS_MODULE);
return error;
}
static int __xloop_clr_fd(struct xloop_device *xlo, bool release)
{
struct file *filp = NULL;
gfp_t gfp = xlo->old_gfp_mask;
struct block_device *bdev = xlo->xlo_device;
int err = 0;
bool partscan = false;
int xlo_number;
mutex_lock(&xloop_ctl_mutex);
if (WARN_ON_ONCE(xlo->xlo_state != Xlo_rundown)) {
err = -ENXIO;
goto out_unlock;
}
filp = xlo->xlo_backing_file;
if (filp == NULL) {
err = -EINVAL;
goto out_unlock;
}
/* freeze request queue during the transition */
blk_mq_freeze_queue(xlo->xlo_queue);
xloop_file_fmt_exit(xlo->xlo_fmt);
spin_lock_irq(&xlo->xlo_lock);
xlo->xlo_backing_file = NULL;
spin_unlock_irq(&xlo->xlo_lock);
xloop_release_xfer(xlo);
xlo->transfer = NULL;
xlo->ioctl = NULL;
xlo->xlo_device = NULL;
xlo->xlo_encryption = NULL;
xlo->xlo_offset = 0;
xlo->xlo_sizelimit = 0;
xlo->xlo_encrypt_key_size = 0;
memset(xlo->xlo_encrypt_key, 0, XLO_KEY_SIZE);
memset(xlo->xlo_crypt_name, 0, XLO_NAME_SIZE);
memset(xlo->xlo_file_name, 0, XLO_NAME_SIZE);
blk_queue_logical_block_size(xlo->xlo_queue, 512);
blk_queue_physical_block_size(xlo->xlo_queue, 512);
blk_queue_io_min(xlo->xlo_queue, 512);
if (bdev) {
bdput(bdev);
invalidate_bdev(bdev);
bdev->bd_inode->i_mapping->wb_err = 0;
}
set_capacity(xlo->xlo_disk, 0);
xloop_sysfs_exit(xlo);
if (bdev) {
bd_set_size(bdev, 0);
/* let user-space know about this change */
kobject_uevent(&disk_to_dev(bdev->bd_disk)->kobj, KOBJ_CHANGE);
}
mapping_set_gfp_mask(filp->f_mapping, gfp);
/* This is safe: open() is still holding a reference. */
module_put(THIS_MODULE);
blk_mq_unfreeze_queue(xlo->xlo_queue);
partscan = xlo->xlo_flags & XLO_FLAGS_PARTSCAN && bdev;
xlo_number = xlo->xlo_number;
xloop_unprepare_queue(xlo);
out_unlock:
mutex_unlock(&xloop_ctl_mutex);
if (partscan) {
/*
* bd_mutex has been held already in release path, so don't
* acquire it if this function is called in such case.
*
* If the reread partition isn't from release path, xlo_refcnt
* must be at least one and it can only become zero when the
* current holder is released.
*/
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 5, 0)
if (!release)
mutex_lock(&bdev->bd_mutex);
err = bdev_disk_changed(bdev, false);
#else
err = blkdev_reread_part(bdev);
#endif
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 5, 0)
if (!release)
mutex_unlock(&bdev->bd_mutex);
#endif
if (err)
dev_warn(xloop_device_to_dev(xlo), "partition scan failed "
"(rc=%d)\n", err);
/* Device is gone, no point in returning error */
err = 0;
}
/*
* xlo->xlo_state is set to Xlo_unbound here after above partscan has
* finished.
*
* There cannot be anybody else entering __xloop_clr_fd() as
* xlo->xlo_backing_file is already cleared and Xlo_rundown state
* protects us from all the other places trying to change the 'xlo'
* device.
*/
mutex_lock(&xloop_ctl_mutex);
xlo->xlo_flags = 0;
if (!part_shift)
xlo->xlo_disk->flags |= GENHD_FL_NO_PART_SCAN;
xlo->xlo_state = Xlo_unbound;
mutex_unlock(&xloop_ctl_mutex);
/*
* Need not hold xloop_ctl_mutex to fput backing file.
* Calling fput holding xloop_ctl_mutex triggers a circular
* lock dependency possibility warning as fput can take
* bd_mutex which is usually taken before xloop_ctl_mutex.
*/
if (filp)
fput(filp);
return err;
}
static int xloop_clr_fd(struct xloop_device *xlo)
{
int err;
err = mutex_lock_killable(&xloop_ctl_mutex);
if (err)
return err;
if (xlo->xlo_state != Xlo_bound) {
mutex_unlock(&xloop_ctl_mutex);
return -ENXIO;
}
/*
* If we've explicitly asked to tear down the xloop device,
* and it has an elevated reference count, set it for auto-teardown when
* the last reference goes away. This stops $!~#$@ udev from
* preventing teardown because it decided that it needs to run blkid on
* the xloopback device whenever they appear. xfstests is notorious for
* failing tests because blkid via udev races with a losetup
* <dev>/do something like mkfs/losetup -d <dev> causing the losetup -d
* command to fail with EBUSY.
*/
if (atomic_read(&xlo->xlo_refcnt) > 1) {
xlo->xlo_flags |= XLO_FLAGS_AUTOCLEAR;
mutex_unlock(&xloop_ctl_mutex);
return 0;
}
xlo->xlo_state = Xlo_rundown;
mutex_unlock(&xloop_ctl_mutex);
return __xloop_clr_fd(xlo, false);
}
static int
xloop_set_status(struct xloop_device *xlo, const struct xloop_info64 *info)
{
int err;
struct block_device *bdev;
kuid_t uid = current_uid();
int prev_xlo_flags;
bool partscan = false;
bool size_changed = false;
err = mutex_lock_killable(&xloop_ctl_mutex);
if (err)
return err;
if (xlo->xlo_encrypt_key_size &&
!uid_eq(xlo->xlo_key_owner, uid) &&
!capable(CAP_SYS_ADMIN)) {
err = -EPERM;
goto out_unlock;
}
if (xlo->xlo_state != Xlo_bound) {
err = -ENXIO;
goto out_unlock;
}
if (xlo->xlo_offset != info->xlo_offset ||
xlo->xlo_sizelimit != info->xlo_sizelimit) {
size_changed = true;
sync_blockdev(xlo->xlo_device);
invalidate_bdev(xlo->xlo_device);
}
/* I/O need to be drained during transfer transition */
blk_mq_freeze_queue(xlo->xlo_queue);
if (size_changed && xlo->xlo_device->bd_inode->i_mapping->nrpages) {
/* If any pages were dirtied after invalidate_bdev(), try again */
err = -EAGAIN;
dev_warn(xloop_device_to_dev(xlo), "xloop device has still dirty "
"pages (nrpages=%lu)\n",
xlo->xlo_device->bd_inode->i_mapping->nrpages);
goto out_unfreeze;
}
prev_xlo_flags = xlo->xlo_flags;
err = xloop_set_status_from_info(xlo, info);
if (err)
goto out_unfreeze;
/* Mask out flags that can't be set using XLOOP_SET_STATUS. */
xlo->xlo_flags &= XLOOP_SET_STATUS_SETTABLE_FLAGS;
/* For those flags, use the previous values instead */
xlo->xlo_flags |= prev_xlo_flags & ~XLOOP_SET_STATUS_SETTABLE_FLAGS;
/* For flags that can't be cleared, use previous values too */
xlo->xlo_flags |= prev_xlo_flags & ~XLOOP_SET_STATUS_CLEARABLE_FLAGS;
if (xlo->xlo_fmt->file_fmt_type != info->xlo_file_fmt_type) {
/* xloop file format has changed, so change file format driver */
err = xloop_file_fmt_change(xlo->xlo_fmt, info->xlo_file_fmt_type);
if (err)
goto out_unfreeze;
/* After change of the file format, recalculate the capacity of
* the loop device. */
size_changed = true;
}
if (size_changed) {
loff_t new_size = get_xloop_size(xlo, xlo->xlo_backing_file);
xloop_set_size(xlo, new_size);
}
xloop_config_discard(xlo);
/* update dio if xlo_offset or transfer is changed */
__xloop_update_dio(xlo, xlo->use_dio);
out_unfreeze:
blk_mq_unfreeze_queue(xlo->xlo_queue);
if (!err && (xlo->xlo_flags & XLO_FLAGS_PARTSCAN) &&
!(prev_xlo_flags & XLO_FLAGS_PARTSCAN)) {
xlo->xlo_disk->flags &= ~GENHD_FL_NO_PART_SCAN;
bdev = xlo->xlo_device;
partscan = true;
}
out_unlock:
mutex_unlock(&xloop_ctl_mutex);
if (partscan)
xloop_reread_partitions(xlo, bdev);
return err;
}
static int
xloop_get_status(struct xloop_device *xlo, struct xloop_info64 *info)
{
struct path path;
struct kstat stat;
int ret;
ret = mutex_lock_killable(&xloop_ctl_mutex);
if (ret)
return ret;
if (xlo->xlo_state != Xlo_bound) {
mutex_unlock(&xloop_ctl_mutex);
return -ENXIO;
}
memset(info, 0, sizeof(*info));
info->xlo_number = xlo->xlo_number;
info->xlo_offset = xlo->xlo_offset;
info->xlo_sizelimit = xlo->xlo_sizelimit;
info->xlo_flags = xlo->xlo_flags;
memcpy(info->xlo_file_name, xlo->xlo_file_name, XLO_NAME_SIZE);
memcpy(info->xlo_crypt_name, xlo->xlo_crypt_name, XLO_NAME_SIZE);
info->xlo_encrypt_type =
xlo->xlo_encryption ? xlo->xlo_encryption->number : 0;
if (xlo->xlo_encrypt_key_size && capable(CAP_SYS_ADMIN)) {
info->xlo_encrypt_key_size = xlo->xlo_encrypt_key_size;
memcpy(info->xlo_encrypt_key, xlo->xlo_encrypt_key,
xlo->xlo_encrypt_key_size);
}
/* Drop xloop_ctl_mutex while we call into the filesystem. */
path = xlo->xlo_backing_file->f_path;
path_get(&path);
mutex_unlock(&xloop_ctl_mutex);
ret = vfs_getattr(&path, &stat, STATX_INO, AT_STATX_SYNC_AS_STAT);
if (!ret) {
info->xlo_device = huge_encode_dev(stat.dev);
info->xlo_inode = stat.ino;
info->xlo_rdevice = huge_encode_dev(stat.rdev);
}
path_put(&path);
return ret;
}
static void
xloop_info64_from_old(const struct xloop_info *info, struct xloop_info64 *info64)
{
memset(info64, 0, sizeof(*info64));
info64->xlo_number = info->xlo_number;
info64->xlo_device = info->xlo_device;
info64->xlo_inode = info->xlo_inode;
info64->xlo_rdevice = info->xlo_rdevice;
info64->xlo_offset = info->xlo_offset;
info64->xlo_sizelimit = 0;
info64->xlo_encrypt_type = info->xlo_encrypt_type;
info64->xlo_encrypt_key_size = info->xlo_encrypt_key_size;
info64->xlo_flags = info->xlo_flags;
info64->xlo_init[0] = info->xlo_init[0];
info64->xlo_init[1] = info->xlo_init[1];
info64->xlo_file_fmt_type = info->xlo_file_fmt_type;
if (info->xlo_encrypt_type == XLO_CRYPT_CRYPTOAPI)
memcpy(info64->xlo_crypt_name, info->xlo_name, XLO_NAME_SIZE);
else
memcpy(info64->xlo_file_name, info->xlo_name, XLO_NAME_SIZE);
memcpy(info64->xlo_encrypt_key, info->xlo_encrypt_key, XLO_KEY_SIZE);
}
static int
xloop_info64_to_old(const struct xloop_info64 *info64, struct xloop_info *info)
{
memset(info, 0, sizeof(*info));
info->xlo_number = info64->xlo_number;
info->xlo_device = info64->xlo_device;
info->xlo_inode = info64->xlo_inode;
info->xlo_rdevice = info64->xlo_rdevice;
info->xlo_offset = info64->xlo_offset;
info->xlo_encrypt_type = info64->xlo_encrypt_type;
info->xlo_encrypt_key_size = info64->xlo_encrypt_key_size;
info->xlo_flags = info64->xlo_flags;
info->xlo_init[0] = info64->xlo_init[0];
info->xlo_init[1] = info64->xlo_init[1];
info->xlo_file_fmt_type = info64->xlo_file_fmt_type;
if (info->xlo_encrypt_type == XLO_CRYPT_CRYPTOAPI)
memcpy(info->xlo_name, info64->xlo_crypt_name, XLO_NAME_SIZE);
else
memcpy(info->xlo_name, info64->xlo_file_name, XLO_NAME_SIZE);
memcpy(info->xlo_encrypt_key, info64->xlo_encrypt_key, XLO_KEY_SIZE);
/* error in case values were truncated */
if (info->xlo_device != info64->xlo_device ||
info->xlo_rdevice != info64->xlo_rdevice ||
info->xlo_inode != info64->xlo_inode ||
info->xlo_offset != info64->xlo_offset)
return -EOVERFLOW;
return 0;
}
static int
xloop_set_status_old(struct xloop_device *xlo, const struct xloop_info __user *arg)
{
struct xloop_info info;
struct xloop_info64 info64;
if (copy_from_user(&info, arg, sizeof (struct xloop_info)))
return -EFAULT;
xloop_info64_from_old(&info, &info64);
return xloop_set_status(xlo, &info64);
}
static int
xloop_set_status64(struct xloop_device *xlo, const struct xloop_info64 __user *arg)
{
struct xloop_info64 info64;
if (copy_from_user(&info64, arg, sizeof (struct xloop_info64)))
return -EFAULT;
return xloop_set_status(xlo, &info64);
}
static int
xloop_get_status_old(struct xloop_device *xlo, struct xloop_info __user *arg) {
struct xloop_info info;
struct xloop_info64 info64;
int err;
if (!arg)
return -EINVAL;
err = xloop_get_status(xlo, &info64);
if (!err)
err = xloop_info64_to_old(&info64, &info);
if (!err && copy_to_user(arg, &info, sizeof(info)))
err = -EFAULT;
return err;
}
static int
xloop_get_status64(struct xloop_device *xlo, struct xloop_info64 __user *arg) {
struct xloop_info64 info64;
int err;
if (!arg)
return -EINVAL;
err = xloop_get_status(xlo, &info64);
if (!err && copy_to_user(arg, &info64, sizeof(info64)))
err = -EFAULT;
return err;
}
static int xloop_set_capacity(struct xloop_device *xlo)
{
loff_t size;
if (unlikely(xlo->xlo_state != Xlo_bound))
return -ENXIO;
size = get_xloop_size(xlo, xlo->xlo_backing_file);
xloop_set_size(xlo, size);
return 0;
}
static int xloop_set_dio(struct xloop_device *xlo, unsigned long arg)
{
int error = -ENXIO;
if (xlo->xlo_state != Xlo_bound)
goto out;
__xloop_update_dio(xlo, !!arg);
if (xlo->use_dio == !!arg)
return 0;
error = -EINVAL;
out:
return error;
}
static int xloop_set_block_size(struct xloop_device *xlo, unsigned long arg)
{
int err = 0;
if (xlo->xlo_state != Xlo_bound)
return -ENXIO;
err = xloop_validate_block_size(arg);
if (err)
return err;
if (xlo->xlo_queue->limits.logical_block_size == arg)
return 0;
sync_blockdev(xlo->xlo_device);
invalidate_bdev(xlo->xlo_device);
blk_mq_freeze_queue(xlo->xlo_queue);
/* invalidate_bdev should have truncated all the pages */
if (xlo->xlo_device->bd_inode->i_mapping->nrpages) {
err = -EAGAIN;
dev_warn(xloop_device_to_dev(xlo), "xloop device has still dirty "
"pages (nrpages=%lu)\n",
xlo->xlo_device->bd_inode->i_mapping->nrpages);
goto out_unfreeze;
}
blk_queue_logical_block_size(xlo->xlo_queue, arg);
blk_queue_physical_block_size(xlo->xlo_queue, arg);
blk_queue_io_min(xlo->xlo_queue, arg);
xloop_update_dio(xlo);
out_unfreeze:
blk_mq_unfreeze_queue(xlo->xlo_queue);
return err;
}
static int xlo_simple_ioctl(struct xloop_device *xlo, unsigned int cmd,
unsigned long arg)
{
int err;
err = mutex_lock_killable(&xloop_ctl_mutex);
if (err)
return err;
switch (cmd) {
case XLOOP_SET_CAPACITY:
err = xloop_set_capacity(xlo);
break;
case XLOOP_SET_DIRECT_IO:
err = xloop_set_dio(xlo, arg);
break;
case XLOOP_SET_BLOCK_SIZE:
err = xloop_set_block_size(xlo, arg);
break;
default:
err = xlo->ioctl ? xlo->ioctl(xlo, cmd, arg) : -EINVAL;
}
mutex_unlock(&xloop_ctl_mutex);
return err;
}
static int xlo_ioctl(struct block_device *bdev, fmode_t mode,
unsigned int cmd, unsigned long arg)
{
struct xloop_device *xlo = bdev->bd_disk->private_data;
void __user *argp = (void __user *) arg;
int err;
switch (cmd) {
case XLOOP_SET_FD: {
/*
* Legacy case - pass in a zeroed out struct xloop_config with
* only the file descriptor set , which corresponds with the
* default parameters we'd have used otherwise.
*/
struct xloop_config config;
memset(&config, 0, sizeof(config));
config.fd = arg;
return xloop_configure(xlo, mode, bdev, &config);
}
case XLOOP_CONFIGURE: {
struct xloop_config config;
if (copy_from_user(&config, argp, sizeof(config)))
return -EFAULT;
return xloop_configure(xlo, mode, bdev, &config);
}
case XLOOP_CHANGE_FD:
return xloop_change_fd(xlo, bdev, arg);
case XLOOP_CLR_FD:
return xloop_clr_fd(xlo);
case XLOOP_SET_STATUS:
err = -EPERM;
if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
err = xloop_set_status_old(xlo, argp);
}
break;
case XLOOP_GET_STATUS:
return xloop_get_status_old(xlo, argp);
case XLOOP_SET_STATUS64:
err = -EPERM;
if ((mode & FMODE_WRITE) || capable(CAP_SYS_ADMIN)) {
err = xloop_set_status64(xlo, argp);
}
break;
case XLOOP_GET_STATUS64:
return xloop_get_status64(xlo, argp);
case XLOOP_SET_CAPACITY:
case XLOOP_SET_DIRECT_IO:
case XLOOP_SET_BLOCK_SIZE:
if (!(mode & FMODE_WRITE) && !capable(CAP_SYS_ADMIN))
return -EPERM;
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 4, 0)
fallthrough;
#else
/* fall through */
#endif
default:
err = xlo_simple_ioctl(xlo, cmd, arg);
break;
}
return err;
}
#ifdef CONFIG_COMPAT
struct compat_xloop_info {
compat_int_t xlo_number; /* ioctl r/o */
compat_dev_t xlo_device; /* ioctl r/o */
compat_ulong_t xlo_inode; /* ioctl r/o */
compat_dev_t xlo_rdevice; /* ioctl r/o */
compat_int_t xlo_offset;
compat_int_t xlo_encrypt_type;
compat_int_t xlo_encrypt_key_size; /* ioctl w/o */
compat_int_t xlo_flags; /* ioctl r/o */
char xlo_name[XLO_NAME_SIZE];
unsigned char xlo_encrypt_key[XLO_KEY_SIZE]; /* ioctl w/o */
compat_ulong_t xlo_init[2];
char reserved[4];
compat_int_t xlo_file_fmt_type;
};
/*
* Transfer 32-bit compatibility structure in userspace to 64-bit xloop info
* - noinlined to reduce stack space usage in main part of driver
*/
static noinline int
xloop_info64_from_compat(const struct compat_xloop_info __user *arg,
struct xloop_info64 *info64)
{
struct compat_xloop_info info;
if (copy_from_user(&info, arg, sizeof(info)))
return -EFAULT;
memset(info64, 0, sizeof(*info64));
info64->xlo_number = info.xlo_number;
info64->xlo_device = info.xlo_device;
info64->xlo_inode = info.xlo_inode;
info64->xlo_rdevice = info.xlo_rdevice;
info64->xlo_offset = info.xlo_offset;
info64->xlo_sizelimit = 0;
info64->xlo_encrypt_type = info.xlo_encrypt_type;
info64->xlo_encrypt_key_size = info.xlo_encrypt_key_size;
info64->xlo_flags = info.xlo_flags;
info64->xlo_init[0] = info.xlo_init[0];
info64->xlo_init[1] = info.xlo_init[1];
info64->xlo_file_fmt_type = info.xlo_file_fmt_type;
if (info.xlo_encrypt_type == XLO_CRYPT_CRYPTOAPI)
memcpy(info64->xlo_crypt_name, info.xlo_name, XLO_NAME_SIZE);
else
memcpy(info64->xlo_file_name, info.xlo_name, XLO_NAME_SIZE);
memcpy(info64->xlo_encrypt_key, info.xlo_encrypt_key, XLO_KEY_SIZE);
return 0;
}
/*
* Transfer 64-bit xloop info to 32-bit compatibility structure in userspace
* - noinlined to reduce stack space usage in main part of driver
*/
static noinline int
xloop_info64_to_compat(const struct xloop_info64 *info64,
struct compat_xloop_info __user *arg)
{
struct compat_xloop_info info;
memset(&info, 0, sizeof(info));
info.xlo_number = info64->xlo_number;
info.xlo_device = info64->xlo_device;
info.xlo_inode = info64->xlo_inode;
info.xlo_rdevice = info64->xlo_rdevice;
info.xlo_offset = info64->xlo_offset;
info.xlo_encrypt_type = info64->xlo_encrypt_type;
info.xlo_encrypt_key_size = info64->xlo_encrypt_key_size;
info.xlo_flags = info64->xlo_flags;
info.xlo_init[0] = info64->xlo_init[0];
info.xlo_init[1] = info64->xlo_init[1];
info.xlo_file_fmt_type = info64->xlo_file_fmt_type;
if (info.xlo_encrypt_type == XLO_CRYPT_CRYPTOAPI)
memcpy(info.xlo_name, info64->xlo_crypt_name, XLO_NAME_SIZE);
else
memcpy(info.xlo_name, info64->xlo_file_name, XLO_NAME_SIZE);
memcpy(info.xlo_encrypt_key, info64->xlo_encrypt_key, XLO_KEY_SIZE);
/* error in case values were truncated */
if (info.xlo_device != info64->xlo_device ||
info.xlo_rdevice != info64->xlo_rdevice ||
info.xlo_inode != info64->xlo_inode ||
info.xlo_offset != info64->xlo_offset ||
info.xlo_init[0] != info64->xlo_init[0] ||
info.xlo_init[1] != info64->xlo_init[1] ||
info.xlo_file_fmt_type != info64->xlo_file_fmt_type)
return -EOVERFLOW;
if (copy_to_user(arg, &info, sizeof(info)))
return -EFAULT;
return 0;
}
static int
xloop_set_status_compat(struct xloop_device *xlo,
const struct compat_xloop_info __user *arg)
{
struct xloop_info64 info64;
int ret;
ret = xloop_info64_from_compat(arg, &info64);
if (ret < 0)
return ret;
return xloop_set_status(xlo, &info64);
}
static int
xloop_get_status_compat(struct xloop_device *xlo,
struct compat_xloop_info __user *arg)
{
struct xloop_info64 info64;
int err;
if (!arg)
return -EINVAL;
err = xloop_get_status(xlo, &info64);
if (!err)
err = xloop_info64_to_compat(&info64, arg);
return err;
}
static int xlo_compat_ioctl(struct block_device *bdev, fmode_t mode,
unsigned int cmd, unsigned long arg)
{
struct xloop_device *xlo = bdev->bd_disk->private_data;
int err;
switch(cmd) {
case XLOOP_SET_STATUS:
err = xloop_set_status_compat(xlo,
(const struct compat_xloop_info __user *)arg);
break;
case XLOOP_GET_STATUS:
err = xloop_get_status_compat(xlo,
(struct compat_xloop_info __user *)arg);
break;
case XLOOP_SET_CAPACITY:
case XLOOP_CLR_FD:
case XLOOP_GET_STATUS64:
case XLOOP_SET_STATUS64:
case XLOOP_CONFIGURE:
arg = (unsigned long) compat_ptr(arg);
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 4, 0)
fallthrough;
#else
/* fall through */
#endif
case XLOOP_SET_FD:
case XLOOP_CHANGE_FD:
case XLOOP_SET_BLOCK_SIZE:
case XLOOP_SET_DIRECT_IO:
err = xlo_ioctl(bdev, mode, cmd, arg);
break;
default:
err = -ENOIOCTLCMD;
break;
}
return err;
}
#endif
static int xlo_open(struct block_device *bdev, fmode_t mode)
{
struct xloop_device *xlo;
int err;
err = mutex_lock_killable(&xloop_ctl_mutex);
if (err)
return err;
xlo = bdev->bd_disk->private_data;
if (!xlo) {
err = -ENXIO;
goto out;
}
atomic_inc(&xlo->xlo_refcnt);
out:
mutex_unlock(&xloop_ctl_mutex);
return err;
}
static void xlo_release(struct gendisk *disk, fmode_t mode)
{
struct xloop_device *xlo;
mutex_lock(&xloop_ctl_mutex);
xlo = disk->private_data;
if (atomic_dec_return(&xlo->xlo_refcnt))
goto out_unlock;
if (xlo->xlo_flags & XLO_FLAGS_AUTOCLEAR) {
if (xlo->xlo_state != Xlo_bound)
goto out_unlock;
xlo->xlo_state = Xlo_rundown;
mutex_unlock(&xloop_ctl_mutex);
/*
* In autoclear mode, stop the xloop thread
* and remove configuration after last close.
*/
__xloop_clr_fd(xlo, true);
return;
} else if (xlo->xlo_state == Xlo_bound) {
/*
* Otherwise keep thread (if running) and config,
* but flush possible ongoing bios in thread.
*/
blk_mq_freeze_queue(xlo->xlo_queue);
blk_mq_unfreeze_queue(xlo->xlo_queue);
}
out_unlock:
mutex_unlock(&xloop_ctl_mutex);
}
static const struct block_device_operations xlo_fops = {
.owner = THIS_MODULE,
.open = xlo_open,
.release = xlo_release,
.ioctl = xlo_ioctl,
#ifdef CONFIG_COMPAT
.compat_ioctl = xlo_compat_ioctl,
#endif
};
/*
* And now the modules code and kernel interface.
*/
static int max_xloop;
module_param(max_xloop, int, 0444);
MODULE_PARM_DESC(max_xloop, "Maximum number of xloop devices");
module_param(max_part, int, 0444);
MODULE_PARM_DESC(max_part, "Maximum number of partitions per xloop device");
MODULE_LICENSE("GPL");
MODULE_ALIAS_BLOCKDEV_MAJOR(XLOOP_MAJOR);
int xloop_register_transfer(struct xloop_func_table *funcs)
{
unsigned int n = funcs->number;
if (n >= MAX_XLO_CRYPT || xfer_funcs[n])
return -EINVAL;
xfer_funcs[n] = funcs;
return 0;
}
static int unregister_transfer_cb(int id, void *ptr, void *data)
{
struct xloop_device *xlo = ptr;
struct xloop_func_table *xfer = data;
mutex_lock(&xloop_ctl_mutex);
if (xlo->xlo_encryption == xfer)
xloop_release_xfer(xlo);
mutex_unlock(&xloop_ctl_mutex);
return 0;
}
int xloop_unregister_transfer(int number)
{
unsigned int n = number;
struct xloop_func_table *xfer;
if (n == 0 || n >= MAX_XLO_CRYPT || (xfer = xfer_funcs[n]) == NULL)
return -EINVAL;
xfer_funcs[n] = NULL;
idr_for_each(&xloop_index_idr, &unregister_transfer_cb, xfer);
return 0;
}
EXPORT_SYMBOL(xloop_register_transfer);
EXPORT_SYMBOL(xloop_unregister_transfer);
static blk_status_t xloop_queue_rq(struct blk_mq_hw_ctx *hctx,
const struct blk_mq_queue_data *bd)
{
struct request *rq = bd->rq;
struct xloop_cmd *cmd = blk_mq_rq_to_pdu(rq);
struct xloop_device *xlo = rq->q->queuedata;
blk_mq_start_request(rq);
if (xlo->xlo_state != Xlo_bound)
return BLK_STS_IOERR;
switch (req_op(rq)) {
case REQ_OP_FLUSH:
case REQ_OP_DISCARD:
case REQ_OP_WRITE_ZEROES:
cmd->use_aio = false;
break;
default:
cmd->use_aio = xlo->use_dio;
break;
}
/* always use the first bio's css */
#ifdef CONFIG_BLK_CGROUP
if (cmd->use_aio && rq->bio && rq->bio->bi_blkg) {
cmd->css = &bio_blkcg(rq->bio)->css;
css_get(cmd->css);
} else
#endif
cmd->css = NULL;
kthread_queue_work(&xlo->worker, &cmd->work);
return BLK_STS_OK;
}
static void xloop_handle_cmd(struct xloop_cmd *cmd)
{
struct request *rq = blk_mq_rq_from_pdu(cmd);
const bool write = op_is_write(req_op(rq));
struct xloop_device *xlo = rq->q->queuedata;
int ret = 0;
if (write && (xlo->xlo_flags & XLO_FLAGS_READ_ONLY)) {
ret = -EIO;
goto failed;
}
ret = do_req_filebacked(xlo, rq);
failed:
/* complete non-aio request */
if (!cmd->use_aio || ret) {
if (ret == -EOPNOTSUPP)
cmd->ret = ret;
else
cmd->ret = ret ? -EIO : 0;
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 9, 0)
if (likely(!blk_should_fake_timeout(rq->q)))
blk_mq_complete_request(rq);
#else
blk_mq_complete_request(rq);
#endif
}
}
static void xloop_queue_work(struct kthread_work *work)
{
struct xloop_cmd *cmd =
container_of(work, struct xloop_cmd, work);
xloop_handle_cmd(cmd);
}
static int xloop_init_request(struct blk_mq_tag_set *set, struct request *rq,
unsigned int hctx_idx, unsigned int numa_node)
{
struct xloop_cmd *cmd = blk_mq_rq_to_pdu(rq);
kthread_init_work(&cmd->work, xloop_queue_work);
return 0;
}
static const struct blk_mq_ops xloop_mq_ops = {
.queue_rq = xloop_queue_rq,
.init_request = xloop_init_request,
.complete = xlo_complete_rq,
};
static struct dentry *xloop_dbgfs_dir;
static int xloop_add(struct xloop_device **l, int i)
{
struct xloop_device *xlo;
struct gendisk *disk;
int err;
err = -ENOMEM;
xlo = kzalloc(sizeof(*xlo), GFP_KERNEL);
if (!xlo)
goto out;
xlo->xlo_state = Xlo_unbound;
/* allocate id, if @id >= 0, we're requesting that specific id */
if (i >= 0) {
err = idr_alloc(&xloop_index_idr, xlo, i, i + 1, GFP_KERNEL);
if (err == -ENOSPC)
err = -EEXIST;
} else {
err = idr_alloc(&xloop_index_idr, xlo, 0, 0, GFP_KERNEL);
}
if (err < 0)
goto out_free_dev;
i = err;
err = -ENOMEM;
xlo->tag_set.ops = &xloop_mq_ops;
xlo->tag_set.nr_hw_queues = 1;
xlo->tag_set.queue_depth = 128;
xlo->tag_set.numa_node = NUMA_NO_NODE;
xlo->tag_set.cmd_size = sizeof(struct xloop_cmd);
#if LINUX_VERSION_CODE >= KERNEL_VERSION(5, 8, 0)
xlo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE | BLK_MQ_F_STACKING;
#else
xlo->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
#endif
xlo->tag_set.driver_data = xlo;
err = blk_mq_alloc_tag_set(&xlo->tag_set);
if (err)
goto out_free_idr;
xlo->xlo_queue = blk_mq_init_queue(&xlo->tag_set);
if (IS_ERR(xlo->xlo_queue)) {
err = PTR_ERR(xlo->xlo_queue);
goto out_cleanup_tags;
}
xlo->xlo_queue->queuedata = xlo;
blk_queue_max_hw_sectors(xlo->xlo_queue, BLK_DEF_MAX_SECTORS);
/*
* By default, we do buffer IO, so it doesn't make sense to enable
* merge because the I/O submitted to backing file is handled page by
* page. For directio mode, merge does help to dispatch bigger request
* to underlayer disk. We will enable merge once directio is enabled.
*/
blk_queue_flag_set(QUEUE_FLAG_NOMERGES, xlo->xlo_queue);
err = -ENOMEM;
xlo->xlo_fmt = xloop_file_fmt_alloc();
if (!xlo->xlo_fmt)
goto out_free_queue;
xloop_file_fmt_set_xlo(xlo->xlo_fmt, xlo);
err = -ENOMEM;
disk = xlo->xlo_disk = alloc_disk(1 << part_shift);
if (!disk)
goto out_free_file_fmt;
/*
* Disable partition scanning by default. The in-kernel partition
* scanning can be requested individually per-device during its
* setup. Userspace can always add and remove partitions from all
* devices. The needed partition minors are allocated from the
* extended minor space, the main xloop device numbers will continue
* to match the xloop minors, regardless of the number of partitions
* used.
*
* If max_part is given, partition scanning is globally enabled for
* all xloop devices. The minors for the main xloop devices will be
* multiples of max_part.
*
* Note: Global-for-all-devices, set-only-at-init, read-only module
* parameteters like 'max_xloop' and 'max_part' make things needlessly
* complicated, are too static, inflexible and may surprise
* userspace tools. Parameters like this in general should be avoided.
*/
if (!part_shift)
disk->flags |= GENHD_FL_NO_PART_SCAN;
disk->flags |= GENHD_FL_EXT_DEVT;
atomic_set(&xlo->xlo_refcnt, 0);
xlo->xlo_number = i;
spin_lock_init(&xlo->xlo_lock);
disk->major = XLOOP_MAJOR;
disk->first_minor = i << part_shift;
disk->fops = &xlo_fops;
disk->private_data = xlo;
disk->queue = xlo->xlo_queue;
sprintf(disk->disk_name, "xloop%d", i);
add_disk(disk);
*l = xlo;
/* initialize debugfs entries */
/* create for each loop device a debugfs directory under 'loop' if
* the 'block' directory exists, otherwise create the loop directory in
* the root directory */
#ifdef CONFIG_DEBUG_FS
xlo->xlo_dbgfs_dir = debugfs_create_dir(disk->disk_name, xloop_dbgfs_dir);
if (IS_ERR_OR_NULL(xlo->xlo_dbgfs_dir)) {
err = -ENODEV;
xlo->xlo_dbgfs_dir = NULL;
goto out_free_file_fmt;
}
#endif
return xlo->xlo_number;
out_free_file_fmt:
xloop_file_fmt_free(xlo->xlo_fmt);
out_free_queue:
blk_cleanup_queue(xlo->xlo_queue);
out_cleanup_tags:
blk_mq_free_tag_set(&xlo->tag_set);
out_free_idr:
idr_remove(&xloop_index_idr, i);
out_free_dev:
kfree(xlo);
out:
return err;
}
static void xloop_remove(struct xloop_device *xlo)
{
xloop_file_fmt_free(xlo->xlo_fmt);
debugfs_remove(xlo->xlo_dbgfs_dir);
del_gendisk(xlo->xlo_disk);
blk_cleanup_queue(xlo->xlo_queue);
blk_mq_free_tag_set(&xlo->tag_set);
put_disk(xlo->xlo_disk);
kfree(xlo);
}
static int find_free_cb(int id, void *ptr, void *data)
{
struct xloop_device *xlo = ptr;
struct xloop_device **l = data;
if (xlo->xlo_state == Xlo_unbound) {
*l = xlo;
return 1;
}
return 0;
}
static int xloop_lookup(struct xloop_device **l, int i)
{
struct xloop_device *xlo;
int ret = -ENODEV;
if (i < 0) {
int err;
err = idr_for_each(&xloop_index_idr, &find_free_cb, &xlo);
if (err == 1) {
*l = xlo;
ret = xlo->xlo_number;
}
goto out;
}
/* lookup and return a specific i */
xlo = idr_find(&xloop_index_idr, i);
if (xlo) {
*l = xlo;
ret = xlo->xlo_number;
}
out:
return ret;
}
static struct kobject *xloop_probe(dev_t dev, int *part, void *data)
{
struct xloop_device *xlo;
struct kobject *kobj;
int err;
mutex_lock(&xloop_ctl_mutex);
err = xloop_lookup(&xlo, MINOR(dev) >> part_shift);
if (err < 0)
err = xloop_add(&xlo, MINOR(dev) >> part_shift);
if (err < 0)
kobj = NULL;
else
kobj = get_disk_and_module(xlo->xlo_disk);
mutex_unlock(&xloop_ctl_mutex);
*part = 0;
return kobj;
}
static long xloop_control_ioctl(struct file *file, unsigned int cmd,
unsigned long parm)
{
struct xloop_device *xlo;
int ret;
ret = mutex_lock_killable(&xloop_ctl_mutex);
if (ret)
return ret;
ret = -ENOSYS;
switch (cmd) {
case XLOOP_CTL_ADD:
ret = xloop_lookup(&xlo, parm);
if (ret >= 0) {
ret = -EEXIST;
break;
}
ret = xloop_add(&xlo, parm);
break;
case XLOOP_CTL_REMOVE:
ret = xloop_lookup(&xlo, parm);
if (ret < 0)
break;
if (xlo->xlo_state != Xlo_unbound) {
ret = -EBUSY;
break;
}
if (atomic_read(&xlo->xlo_refcnt) > 0) {
ret = -EBUSY;
break;
}
xlo->xlo_disk->private_data = NULL;
idr_remove(&xloop_index_idr, xlo->xlo_number);
xloop_remove(xlo);
break;
case XLOOP_CTL_GET_FREE:
ret = xloop_lookup(&xlo, -1);
if (ret >= 0)
break;
ret = xloop_add(&xlo, -1);
}
mutex_unlock(&xloop_ctl_mutex);
return ret;
}
static const struct file_operations xloop_ctl_fops = {
.open = nonseekable_open,
.unlocked_ioctl = xloop_control_ioctl,
.compat_ioctl = xloop_control_ioctl,
.owner = THIS_MODULE,
.llseek = noop_llseek,
};
static struct miscdevice xloop_misc = {
.minor = XLOOP_CTRL_MINOR,
.name = "xloop-control",
.fops = &xloop_ctl_fops,
};
MODULE_ALIAS_MISCDEV(XLOOP_CTRL_MINOR);
MODULE_ALIAS("devname:xloop-control");
static int __init xloop_init(void)
{
int i, nr;
unsigned long range;
struct xloop_device *xlo;
int err;
part_shift = 0;
if (max_part > 0) {
part_shift = fls(max_part);
/*
* Adjust max_part according to part_shift as it is exported
* to user space so that user can decide correct minor number
* if [s]he want to create more devices.
*
* Note that -1 is required because partition 0 is reserved
* for the whole disk.
*/
max_part = (1UL << part_shift) - 1;
}
if ((1UL << part_shift) > DISK_MAX_PARTS) {
err = -EINVAL;
goto err_out;
}
if (max_xloop > 1UL << (MINORBITS - part_shift)) {
err = -EINVAL;
goto err_out;
}
/*
* If max_xloop is specified, create that many devices upfront.
* This also becomes a hard limit. If max_xloop is not specified,
* create CONFIG_BLK_DEV_XLOOP_MIN_COUNT xloop devices at module
* init time. xloop devices can be requested on-demand with the
* /dev/xloop-control interface, or be instantiated by accessing
* a 'dead' device node.
*/
if (max_xloop) {
nr = CONFIG_BLK_DEV_XLOOP_MIN_COUNT;
range = 1UL << MINORBITS;
}
err = misc_register(&xloop_misc);
if (err < 0)
goto err_out;
if (register_blkdev(XLOOP_MAJOR, "xloop")) {
err = -EIO;
goto misc_out;
}
#ifdef CONFIG_DEBUG_FS
xloop_dbgfs_dir = debugfs_create_dir("xloop", NULL);
if (IS_ERR_OR_NULL(xloop_dbgfs_dir)) {
err = -ENODEV;
goto misc_out;
}
#endif
blk_register_region(MKDEV(XLOOP_MAJOR, 0), range,
THIS_MODULE, xloop_probe, NULL, NULL);
/* pre-create number of devices given by config or max_xloop */
mutex_lock(&xloop_ctl_mutex);
for (i = 0; i < nr; i++)
xloop_add(&xlo, i);
mutex_unlock(&xloop_ctl_mutex);
pr_info("module loaded\n");
return 0;
misc_out:
misc_deregister(&xloop_misc);
err_out:
return err;
}
static int xloop_exit_cb(int id, void *ptr, void *data)
{
struct xloop_device *xlo = ptr;
xloop_remove(xlo);
return 0;
}
static void __exit xloop_exit(void)
{
unsigned long range;
range = max_xloop ? max_xloop << part_shift : 1UL << MINORBITS;
mutex_lock(&xloop_ctl_mutex);
idr_for_each(&xloop_index_idr, &xloop_exit_cb, NULL);
idr_destroy(&xloop_index_idr);
blk_unregister_region(MKDEV(XLOOP_MAJOR, 0), range);
unregister_blkdev(XLOOP_MAJOR, "xloop");
#ifdef CONFIG_DEBUG_FS
debugfs_remove(xloop_dbgfs_dir);
#endif
misc_deregister(&xloop_misc);
mutex_unlock(&xloop_ctl_mutex);
pr_info("exit module\n");
}
module_init(xloop_init);
module_exit(xloop_exit);
#ifndef MODULE
static int __init max_xloop_setup(char *str)
{
max_xloop = simple_strtol(str, NULL, 0);
return 1;
}
__setup("max_xloop=", max_xloop_setup);
#endif
|