Rev 3460 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
2288 | clevermous | 1 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
2 | ;; ;; |
||
2455 | mario79 | 3 | ;; Copyright (C) KolibriOS team 2011-2012. All rights reserved. ;; |
2288 | clevermous | 4 | ;; Distributed under terms of the GNU General Public License ;; |
5 | ;; ;; |
||
6 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
||
7 | |||
8 | $Revision: 3598 $ |
||
9 | |||
10 | ; ============================================================================= |
||
11 | ; ================================= Constants ================================= |
||
12 | ; ============================================================================= |
||
13 | ; Error codes for callback functions. |
||
14 | DISK_STATUS_OK = 0 ; success |
||
15 | DISK_STATUS_GENERAL_ERROR = -1; if no other code is suitable |
||
16 | DISK_STATUS_INVALID_CALL = 1 ; invalid input parameters |
||
17 | DISK_STATUS_NO_MEDIA = 2 ; no media present |
||
18 | DISK_STATUS_END_OF_MEDIA = 3 ; end of media while reading/writing data |
||
19 | ; Driver flags. Represent bits in DISK.DriverFlags. |
||
20 | DISK_NO_INSERT_NOTIFICATION = 1 |
||
21 | ; Media flags. Represent bits in DISKMEDIAINFO.Flags. |
||
22 | DISK_MEDIA_READONLY = 1 |
||
23 | |||
24 | ; If too many partitions are detected,there is probably an error on the disk. |
||
25 | ; 256 partitions should be enough for any reasonable use. |
||
26 | ; Also, the same number is limiting the number of MBRs to process; if |
||
27 | ; too many MBRs are visible,there probably is a loop in the MBR structure. |
||
28 | MAX_NUM_PARTITIONS = 256 |
||
29 | |||
30 | ; ============================================================================= |
||
31 | ; ================================ Structures ================================= |
||
32 | ; ============================================================================= |
||
33 | ; This structure defines all callback functions for working with the physical |
||
34 | ; device. They are implemented by a driver. Objects with this structure reside |
||
35 | ; in a driver. |
||
2381 | hidnplayr | 36 | struct DISKFUNC |
37 | strucsize dd ? |
||
2288 | clevermous | 38 | ; Size of the structure. This field is intended for possible extensions of |
39 | ; this structure. If a new function is added to this structure and a driver |
||
40 | ; implements an old version, the caller can detect this by checking .strucsize, |
||
41 | ; so the driver remains compatible. |
||
2381 | hidnplayr | 42 | close dd ? |
2288 | clevermous | 43 | ; The pointer to the function which frees all driver-specific resources for |
44 | ; the disk. |
||
45 | ; Optional, may be NULL. |
||
46 | ; void close(void* userdata); |
||
2381 | hidnplayr | 47 | closemedia dd ? |
2288 | clevermous | 48 | ; The pointer to the function which informs the driver that the kernel has |
49 | ; finished all processing with the current media. If media is removed, the |
||
50 | ; driver should decline all requests to that media with DISK_STATUS_NO_MEDIA, |
||
51 | ; even if new media is inserted, until this function is called. If media is |
||
52 | ; removed, a new call to 'disk_media_changed' is not allowed until this |
||
53 | ; function is called. |
||
54 | ; Optional, may be NULL (if media is not removable). |
||
55 | ; void closemedia(void* userdata); |
||
2381 | hidnplayr | 56 | querymedia dd ? |
2288 | clevermous | 57 | ; The pointer to the function which determines capabilities of the media. |
58 | ; int querymedia(void* userdata, DISKMEDIAINFO* info); |
||
59 | ; Return value: one of DISK_STATUS_* |
||
2381 | hidnplayr | 60 | read dd ? |
2288 | clevermous | 61 | ; The pointer to the function which reads data from the device. |
62 | ; int read(void* userdata, void* buffer, __int64 startsector, int* numsectors); |
||
63 | ; input: *numsectors = number of sectors to read |
||
64 | ; output: *numsectors = number of sectors which were successfully read |
||
65 | ; Return value: one of DISK_STATUS_* |
||
2381 | hidnplayr | 66 | write dd ? |
2288 | clevermous | 67 | ; The pointer to the function which writes data to the device. |
68 | ; Optional, may be NULL. |
||
69 | ; int write(void* userdata, void* buffer, __int64 startsector, int* numsectors); |
||
70 | ; input: *numsectors = number of sectors to write |
||
71 | ; output: *numsectors = number of sectors which were successfully written |
||
72 | ; Return value: one of DISK_STATUS_* |
||
2381 | hidnplayr | 73 | flush dd ? |
2288 | clevermous | 74 | ; The pointer to the function which flushes the internal device cache. |
75 | ; Optional, may be NULL. |
||
76 | ; int flush(void* userdata); |
||
77 | ; Return value: one of DISK_STATUS_* |
||
78 | ; Note that read/write are called by the cache manager, so a driver should not |
||
79 | ; create a software cache. This function is implemented for flushing a hardware |
||
80 | ; cache, if it exists. |
||
2381 | hidnplayr | 81 | adjust_cache_size dd ? |
2288 | clevermous | 82 | ; The pointer to the function which returns the cache size for this device. |
83 | ; Optional, may be NULL. |
||
84 | ; unsigned int adjust_cache_size(unsigned int suggested_size); |
||
85 | ; Return value: 0 = disable cache, otherwise = used cache size in bytes. |
||
86 | ends |
||
87 | |||
88 | ; This structure holds information on a medium. |
||
89 | ; Objects with this structure are allocated by the kernel as a part of the DISK |
||
90 | ; structure and are filled by a driver in the 'querymedia' callback. |
||
2381 | hidnplayr | 91 | struct DISKMEDIAINFO |
92 | Flags dd ? |
||
2288 | clevermous | 93 | ; Combination of DISK_MEDIA_* bits. |
2381 | hidnplayr | 94 | SectorSize dd ? |
2288 | clevermous | 95 | ; Size of the sector. |
2381 | hidnplayr | 96 | Capacity dq ? |
2288 | clevermous | 97 | ; Size of the media in sectors. |
98 | ends |
||
99 | |||
100 | ; This structure represents the disk cache. To follow the old implementation, |
||
101 | ; there are two distinct caches for a disk, one for "system" data,and the other |
||
102 | ; for "application" data. |
||
2381 | hidnplayr | 103 | struct DISKCACHE |
104 | mutex MUTEX |
||
2288 | clevermous | 105 | ; Lock to protect the cache. |
106 | ; The following fields are inherited from data32.inc:cache_ideX. |
||
2381 | hidnplayr | 107 | pointer dd ? |
108 | data_size dd ? ; unused |
||
109 | data dd ? |
||
110 | sad_size dd ? |
||
111 | search_start dd ? |
||
2288 | clevermous | 112 | ends |
113 | |||
114 | ; This structure represents a disk device and its media for the kernel. |
||
115 | ; This structure is allocated by the kernel in the 'disk_add' function, |
||
116 | ; freed in the 'disk_dereference' function. |
||
2381 | hidnplayr | 117 | struct DISK |
2288 | clevermous | 118 | ; Fields of disk object |
2381 | hidnplayr | 119 | Next dd ? |
120 | Prev dd ? |
||
2288 | clevermous | 121 | ; All disk devices are linked in one list with these two fields. |
122 | ; Head of the list is the 'disk_list' variable. |
||
2381 | hidnplayr | 123 | Functions dd ? |
2288 | clevermous | 124 | ; Pointer to the 'DISKFUNC' structure with driver functions. |
2381 | hidnplayr | 125 | Name dd ? |
2288 | clevermous | 126 | ; Pointer to the string used for accesses through the global filesystem. |
2381 | hidnplayr | 127 | UserData dd ? |
2288 | clevermous | 128 | ; This field is passed to all callback functions so a driver can decide which |
129 | ; physical device is addressed. |
||
2381 | hidnplayr | 130 | DriverFlags dd ? |
2288 | clevermous | 131 | ; Bitfield. Currently only DISK_NO_INSERT_NOTIFICATION bit is defined. |
132 | ; If it is set, the driver will never issue 'disk_media_changed' notification |
||
133 | ; with argument set to true, so the kernel must try to detect media during |
||
134 | ; requests from the file system. |
||
2381 | hidnplayr | 135 | RefCount dd ? |
2288 | clevermous | 136 | ; Count of active references to this structure. One reference is kept during |
137 | ; the lifetime of the structure between 'disk_add' and 'disk_del'. |
||
138 | ; Another reference is taken during any filesystem operation for this disk. |
||
139 | ; One reference is added if media is inserted. |
||
140 | ; The structure is destroyed when the reference count decrements to zero: |
||
141 | ; this usually occurs in 'disk_del', but can be delayed to the end of last |
||
142 | ; filesystem operation, if one is active. |
||
2381 | hidnplayr | 143 | MediaLock MUTEX |
2288 | clevermous | 144 | ; Lock to protect the MEDIA structure. See the description after |
145 | ; 'disk_list_mutex' for the locking strategy. |
||
146 | ; Fields of media object |
||
2381 | hidnplayr | 147 | MediaInserted db ? |
2288 | clevermous | 148 | ; 0 if media is not inserted, nonzero otherwise. |
2381 | hidnplayr | 149 | MediaUsed db ? |
2288 | clevermous | 150 | ; 0 if media fields are not used, nonzero otherwise. If .MediaRefCount is |
151 | ; nonzero, this field is nonzero too; however, when .MediaRefCount goes |
||
152 | ; to zero, there is some time interval during which media object is still used. |
||
3460 | clevermous | 153 | dw ? ; padding |
2288 | clevermous | 154 | ; The following fields are not valid unless either .MediaInserted is nonzero |
155 | ; or they are accessed from a code which has obtained the reference when |
||
156 | ; .MediaInserted was nonzero. |
||
2381 | hidnplayr | 157 | MediaRefCount dd ? |
2288 | clevermous | 158 | ; Count of active references to the media object. One reference is kept during |
159 | ; the lifetime of the media between two calls to 'disk_media_changed'. |
||
160 | ; Another reference is taken during any filesystem operation for this media. |
||
161 | ; The callback 'closemedia' is called when the reference count decrements to |
||
162 | ; zero: this usually occurs in 'disk_media_changed', but can be delayed to the |
||
163 | ; end of the last filesystem operation, if one is active. |
||
2381 | hidnplayr | 164 | MediaInfo DISKMEDIAINFO |
2288 | clevermous | 165 | ; This field keeps information on the current media. |
2381 | hidnplayr | 166 | NumPartitions dd ? |
2288 | clevermous | 167 | ; Number of partitions on this media. |
2381 | hidnplayr | 168 | Partitions dd ? |
2288 | clevermous | 169 | ; Pointer to array of .NumPartitions pointers to PARTITION structures. |
2381 | hidnplayr | 170 | cache_size dd ? |
2288 | clevermous | 171 | ; inherited from cache_ideX_size |
2381 | hidnplayr | 172 | SysCache DISKCACHE |
173 | AppCache DISKCACHE |
||
2288 | clevermous | 174 | ; Two caches for the disk. |
175 | ends |
||
176 | |||
177 | ; This structure represents one partition for the kernel. This is a base |
||
178 | ; template, the actual contents after common fields is determined by the |
||
179 | ; file system code for this partition. |
||
2381 | hidnplayr | 180 | struct PARTITION |
181 | FirstSector dq ? |
||
2288 | clevermous | 182 | ; First sector of the partition. |
2381 | hidnplayr | 183 | Length dq ? |
2288 | clevermous | 184 | ; Length of the partition in sectors. |
2381 | hidnplayr | 185 | Disk dd ? |
2288 | clevermous | 186 | ; Pointer to parent DISK structure. |
2381 | hidnplayr | 187 | FSUserFunctions dd ? |
2288 | clevermous | 188 | ; Handlers for the sysfunction 70h. This field is a pointer to the following |
189 | ; array. The first dword is a number of supported subfunctions, other dwords |
||
190 | ; point to handlers of corresponding subfunctions. |
||
191 | ; This field is 0 if file system is not recognized. |
||
192 | ; ...fs-specific data may follow... |
||
193 | ends |
||
194 | |||
195 | ; This is an external structure, it represents an entry in the partition table. |
||
2381 | hidnplayr | 196 | struct PARTITION_TABLE_ENTRY |
197 | Bootable db ? |
||
2288 | clevermous | 198 | ; 80h = bootable partition, 0 = non-bootable partition, other values = invalid |
2381 | hidnplayr | 199 | FirstHead db ? |
200 | FirstSector db ? |
||
201 | FirstTrack db ? |
||
2288 | clevermous | 202 | ; Coordinates of first sector in CHS. |
2381 | hidnplayr | 203 | Type db ? |
2288 | clevermous | 204 | ; Partition type, one of predefined constants. 0 = empty, several types denote |
205 | ; extended partition (see process_partition_table_entry), we are not interested |
||
206 | ; in other values. |
||
2381 | hidnplayr | 207 | LastHead db ? |
208 | LastSector db ? |
||
209 | LastTrack db ? |
||
2288 | clevermous | 210 | ; Coordinates of last sector in CHS. |
2381 | hidnplayr | 211 | FirstAbsSector dd ? |
2288 | clevermous | 212 | ; Coordinate of first sector in LBA. |
2381 | hidnplayr | 213 | Length dd ? |
2288 | clevermous | 214 | ; Length of the partition in sectors. |
215 | ends |
||
216 | |||
217 | ; ============================================================================= |
||
218 | ; ================================ Global data ================================ |
||
219 | ; ============================================================================= |
||
220 | iglobal |
||
221 | ; The pseudo-item for the list of all DISK structures. |
||
222 | ; Initialized to the empty list. |
||
223 | disk_list: |
||
224 | dd disk_list |
||
225 | dd disk_list |
||
226 | endg |
||
227 | uglobal |
||
228 | ; This mutex guards all operations with the global list of DISK structures. |
||
229 | disk_list_mutex MUTEX |
||
230 | ; * There are two dependent objects, a disk and a media. In the simplest case, |
||
231 | ; disk and media are both non-removable. However, in the general case both |
||
232 | ; can be removed at any time, simultaneously or only media,and this makes things |
||
233 | ; complicated. |
||
234 | ; * For efficiency, both disk and media objects are located in the one |
||
235 | ; structure named DISK. However, logically they are different. |
||
236 | ; * The following operations use data of disk object: adding (disk_add); |
||
237 | ; deleting (disk_del); filesystem (fs_lfn which eventually calls |
||
238 | ; dyndisk_handler or dyndisk_enum_root). |
||
239 | ; * The following operations use data of media object: adding/removing |
||
240 | ; (disk_media_changed); filesystem (fs_lfn which eventually calls |
||
241 | ; dyndisk_handler; dyndisk_enum_root doesn't work with media). |
||
242 | ; * Notifications disk_add, disk_media_changed, disk_del are synchronized |
||
243 | ; between themselves, this is a requirement for the driver. However, file |
||
244 | ; system operations are asynchronous, can be issued at any time by any |
||
245 | ; thread. |
||
246 | ; * We must prevent a situation when a filesystem operation thinks that the |
||
247 | ; object is still valid but in fact the notification has destroyed the |
||
248 | ; object. So we keep a reference counter for both disk and media and destroy |
||
249 | ; the object when this counter goes to zero. |
||
250 | ; * The driver must know when it is safe to free driver-allocated resources. |
||
251 | ; The object can be alive even after death notification has completed. |
||
252 | ; We use special callbacks to satisfy both assertions: 'close' for the disk |
||
253 | ; and 'closemedia' for the media. The destruction of the object includes |
||
254 | ; calling the corresponding callback. |
||
255 | ; * Each filesystem operation keeps one reference for the disk and one |
||
256 | ; reference for the media. Notification disk_del forces notification on the |
||
257 | ; media death, so the reference counter for the disk is always not less than |
||
258 | ; the reference counter for the media. |
||
259 | ; * Two operations "get the object" and "increment the reference counter" can |
||
260 | ; not be done simultaneously. We use a mutex to guard the consistency here. |
||
261 | ; It must be a part of the container for the object, so that this mutex can |
||
262 | ; be acquired as a part of getting the object from the container. The |
||
263 | ; container for disk object is the global list, and this list is guarded by |
||
264 | ; 'disk_list_mutex'. The container for media object is the disk object, and |
||
265 | ; the corresponding mutex is DISK.MediaLock. |
||
266 | ; * Notifications do not change the data of objects, they can only remove |
||
267 | ; objects. Thus we don't need another synchronization at this level. If two |
||
268 | ; filesystem operations are referencing the same filesystem data, this is |
||
269 | ; better resolved at the level of the filesystem. |
||
270 | endg |
||
271 | |||
272 | iglobal |
||
273 | ; The function 'disk_scan_partitions' needs three 512-byte buffers for |
||
274 | ; MBR, bootsector and fs-temporary sector data. It can not use the static |
||
275 | ; buffers always, since it can be called for two or more disks in parallel. |
||
276 | ; However, this case is not typical. We reserve three static 512-byte buffers |
||
277 | ; and a flag that these buffers are currently used. If 'disk_scan_partitions' |
||
278 | ; detects that the buffers are currently used, it allocates buffers from the |
||
279 | ; heap. |
||
280 | ; The flag is implemented as a global dword variable. When the static buffers |
||
281 | ; are not used, the value is -1. When the static buffers are used, the value |
||
282 | ; is normally 0 and temporarily can become greater. The function increments |
||
283 | ; this value. If the resulting value is zero, it uses the buffers and |
||
284 | ; decrements the value when the job is done. Otherwise, it immediately |
||
285 | ; decrements the value and uses buffers from the heap, allocated in the |
||
286 | ; beginning and freed in the end. |
||
287 | partition_buffer_users dd -1 |
||
288 | endg |
||
289 | uglobal |
||
290 | ; The static buffers for MBR, bootsector and fs-temporary sector data. |
||
291 | align 16 |
||
292 | mbr_buffer rb 512 |
||
293 | bootsect_buffer rb 512 |
||
294 | fs_tmp_buffer rb 512 |
||
295 | endg |
||
296 | |||
297 | iglobal |
||
298 | ; This is the array of default implementations of driver callbacks. |
||
299 | ; Same as DRIVERFUNC structure except for the first field; all functions must |
||
300 | ; have the default implementations. |
||
301 | align 4 |
||
302 | disk_default_callbacks: |
||
303 | dd disk_default_close |
||
304 | dd disk_default_closemedia |
||
305 | dd disk_default_querymedia |
||
306 | dd disk_default_read |
||
307 | dd disk_default_write |
||
308 | dd disk_default_flush |
||
309 | dd disk_default_adjust_cache_size |
||
310 | endg |
||
311 | |||
312 | ; ============================================================================= |
||
313 | ; ================================= Functions ================================= |
||
314 | ; ============================================================================= |
||
315 | |||
316 | ; This function registers a disk device. |
||
317 | ; This includes: |
||
318 | ; - allocating an internal structure describing this device; |
||
319 | ; - registering this structure in the global filesystem. |
||
320 | ; The function initializes the disk as if there is no media. If a media is |
||
321 | ; present, the function 'disk_media_changed' should be called after this |
||
322 | ; function succeeds. |
||
323 | ; Parameters: |
||
324 | ; [esp+4] = pointer to DISKFUNC structure with the callbacks |
||
325 | ; [esp+8] = pointer to name (ASCIIZ string) |
||
326 | ; [esp+12] = userdata to be passed to the callbacks as is. |
||
327 | ; [esp+16] = flags, bitfield. Currently only DISK_NO_INSERT_NOTIFICATION bit |
||
328 | ; is defined. |
||
329 | ; Return value: |
||
330 | ; NULL = operation has failed |
||
331 | ; non-NULL = handle of the disk. This handle can be used |
||
332 | ; in the operations with other Disk* functions. |
||
333 | ; The handle is the pointer to the internal structure DISK. |
||
334 | disk_add: |
||
335 | push ebx esi ; save used registers to be stdcall |
||
336 | ; 1. Allocate the DISK structure. |
||
337 | ; 1a. Call the heap manager. |
||
3598 | clevermous | 338 | movi eax, sizeof.DISK |
2288 | clevermous | 339 | call malloc |
340 | ; 1b. Check the result. If allocation failed, return (go to 9) with eax = 0. |
||
341 | test eax, eax |
||
342 | jz .nothing |
||
343 | ; 2. Copy the disk name to the DISK structure. |
||
344 | ; 2a. Get length of the name, including the terminating zero. |
||
345 | mov ebx, [esp+8+8] ; ebx = pointer to name |
||
346 | push eax ; save allocated pointer to DISK |
||
347 | xor eax, eax ; the argument of malloc() is in eax |
||
348 | @@: |
||
349 | inc eax |
||
350 | cmp byte [ebx+eax-1], 0 |
||
351 | jnz @b |
||
2643 | clevermous | 352 | ; 2b. Call the heap manager. Note that it can change ebx. |
353 | push ebx |
||
2288 | clevermous | 354 | call malloc |
2643 | clevermous | 355 | pop ebx |
2288 | clevermous | 356 | ; 2c. Check the result. If allocation failed, go to 7. |
357 | pop esi ; restore allocated pointer to DISK |
||
358 | test eax, eax |
||
359 | jz .free |
||
360 | ; 2d. Store the allocated pointer to the DISK structure. |
||
361 | mov [esi+DISK.Name], eax |
||
362 | ; 2e. Copy the name. |
||
363 | @@: |
||
364 | mov dl, [ebx] |
||
365 | mov [eax], dl |
||
366 | inc ebx |
||
367 | inc eax |
||
368 | test dl, dl |
||
369 | jnz @b |
||
370 | ; 3. Copy other arguments of the function to the DISK structure. |
||
371 | mov eax, [esp+4+8] |
||
372 | mov [esi+DISK.Functions], eax |
||
373 | mov eax, [esp+12+8] |
||
374 | mov [esi+DISK.UserData], eax |
||
375 | mov eax, [esp+16+8] |
||
376 | mov [esi+DISK.DriverFlags], eax |
||
377 | ; 4. Initialize other fields of the DISK structure. |
||
378 | ; Media is not inserted, reference counter is 1. |
||
379 | lea ecx, [esi+DISK.MediaLock] |
||
380 | call mutex_init |
||
381 | xor eax, eax |
||
382 | mov dword [esi+DISK.MediaInserted], eax |
||
3460 | clevermous | 383 | mov [esi+DISK.MediaRefCount], eax |
2288 | clevermous | 384 | inc eax |
385 | mov [esi+DISK.RefCount], eax |
||
386 | ; The DISK structure is initialized. |
||
387 | ; 5. Insert the new structure to the global list. |
||
388 | ; 5a. Acquire the mutex. |
||
389 | mov ecx, disk_list_mutex |
||
390 | call mutex_lock |
||
391 | ; 5b. Insert item to the tail of double-linked list. |
||
392 | mov edx, disk_list |
||
393 | list_add_tail esi, edx ;esi= new edx= list head |
||
394 | ; 5c. Release the mutex. |
||
395 | call mutex_unlock |
||
396 | ; 6. Return with eax = pointer to DISK. |
||
397 | xchg eax, esi |
||
398 | jmp .nothing |
||
399 | .free: |
||
400 | ; Memory allocation for DISK structure succeeded, but for disk name failed. |
||
401 | ; 7. Free the DISK structure. |
||
402 | xchg eax, esi |
||
403 | call free |
||
404 | ; 8. Return with eax = 0. |
||
405 | xor eax, eax |
||
406 | .nothing: |
||
407 | ; 9. Return. |
||
408 | pop esi ebx ; restore used registers to be stdcall |
||
409 | ret 16 ; purge 4 dword arguments to be stdcall |
||
410 | |||
411 | ; This function deletes a disk device from the global filesystem. |
||
412 | ; This includes: |
||
413 | ; - removing a media including all partitions; |
||
414 | ; - deleting this structure from the global filesystem; |
||
415 | ; - dereferencing the DISK structure and possibly destroying it. |
||
416 | ; Parameters: |
||
417 | ; [esp+4] = handle of the disk, i.e. the pointer to the DISK structure. |
||
418 | ; Return value: none. |
||
419 | disk_del: |
||
420 | push esi ; save used registers to be stdcall |
||
421 | ; 1. Force media to be removed. If the media is already removed, the |
||
422 | ; call does nothing. |
||
2643 | clevermous | 423 | mov esi, [esp+4+4] ; esi = handle of the disk |
2288 | clevermous | 424 | stdcall disk_media_changed, esi, 0 |
425 | ; 2. Delete the structure from the global list. |
||
426 | ; 2a. Acquire the mutex. |
||
427 | mov ecx, disk_list_mutex |
||
428 | call mutex_lock |
||
429 | ; 2b. Delete item from double-linked list. |
||
430 | mov eax, [esi+DISK.Next] |
||
431 | mov edx, [esi+DISK.Prev] |
||
432 | mov [eax+DISK.Prev], edx |
||
433 | mov [edx+DISK.Next], eax |
||
434 | ; 2c. Release the mutex. |
||
435 | call mutex_unlock |
||
436 | ; 3. The structure still has one reference created in disk_add. Remove this |
||
437 | ; reference. If there are no other references, disk_dereference will free the |
||
438 | ; structure. |
||
439 | call disk_dereference |
||
440 | ; 4. Return. |
||
441 | pop esi ; restore used registers to be stdcall |
||
442 | ret 4 ; purge 1 dword argument to be stdcall |
||
443 | |||
444 | ; This is an internal function which removes a previously obtained reference |
||
445 | ; to the disk. If this is the last reference, this function lets the driver |
||
446 | ; finalize all associated data, and afterwards frees the DISK structure. |
||
447 | ; esi = pointer to DISK structure |
||
448 | disk_dereference: |
||
449 | ; 1. Decrement reference counter. Use atomic operation to correctly handle |
||
450 | ; possible simultaneous calls. |
||
451 | lock dec [esi+DISK.RefCount] |
||
452 | ; 2. If the result is nonzero, there are other references, so nothing to do. |
||
453 | ; In this case, return (go to 4). |
||
454 | jnz .nothing |
||
455 | ; 3. If we are here, we just removed the last reference and must destroy the |
||
456 | ; disk object. |
||
457 | ; 3a. Call the driver. |
||
458 | mov al, DISKFUNC.close |
||
459 | stdcall disk_call_driver |
||
460 | ; 3b. Free the structure. |
||
461 | xchg eax, esi |
||
3202 | clevermous | 462 | push ebx |
2288 | clevermous | 463 | call free |
3202 | clevermous | 464 | pop ebx |
2288 | clevermous | 465 | ; 4. Return. |
466 | .nothing: |
||
467 | ret |
||
468 | |||
469 | ; This is an internal function which removes a previously obtained reference |
||
470 | ; to the media. If this is the last reference, this function calls 'closemedia' |
||
471 | ; callback to signal the driver that the processing has finished and it is safe |
||
472 | ; to inform about a new media. |
||
473 | ; esi = pointer to DISK structure |
||
474 | disk_media_dereference: |
||
475 | ; 1. Decrement reference counter. Use atomic operation to correctly handle |
||
476 | ; possible simultaneous calls. |
||
477 | lock dec [esi+DISK.MediaRefCount] |
||
478 | ; 2. If the result is nonzero, there are other references, so nothing to do. |
||
479 | ; In this case, return (go to 4). |
||
480 | jnz .nothing |
||
481 | ; 3. If we are here, we just removed the last reference and must destroy the |
||
482 | ; media object. |
||
483 | ; Note that the same place inside the DISK structure is reused for all media |
||
484 | ; objects, so we must guarantee that reusing does not happen while freeing. |
||
485 | ; Reusing is only possible when someone processes a new media. There are two |
||
486 | ; mutually exclusive variants: |
||
487 | ; * driver issues media insert notifications (DISK_NO_INSERT_NOTIFICATION bit |
||
488 | ; in DISK.DriverFlags is not set). In this case, we require from the driver |
||
489 | ; that such notification (except for the first one) can occur only after a |
||
490 | ; call to 'closemedia' callback. |
||
491 | ; * driver does not issue media insert notifications. In this case, the kernel |
||
492 | ; itself must sometimes check whether media is inserted. We have the flag |
||
493 | ; DISK.MediaUsed, visible to the kernel. This flag signals to the other parts |
||
494 | ; of kernel that the way is free. |
||
495 | ; In the first case other parts of the kernel do not use DISK.MediaUsed, so it |
||
496 | ; does not matter when this flag is cleared. In the second case this flag must |
||
497 | ; be cleared after all other actions, including call to 'closemedia'. |
||
498 | ; 3a. Free all partitions. |
||
499 | push esi edi |
||
500 | mov edi, [esi+DISK.NumPartitions] |
||
501 | mov esi, [esi+DISK.Partitions] |
||
502 | test edi, edi |
||
503 | jz .nofree |
||
504 | .freeloop: |
||
505 | lodsd |
||
506 | call free |
||
507 | dec edi |
||
508 | jnz .freeloop |
||
509 | .nofree: |
||
510 | pop edi esi |
||
511 | ; 3b. Free the cache. |
||
512 | call disk_free_cache |
||
513 | ; 3c. Call the driver. |
||
514 | mov al, DISKFUNC.closemedia |
||
515 | stdcall disk_call_driver |
||
516 | ; 3d. Clear the flag. |
||
517 | mov [esi+DISK.MediaUsed], 0 |
||
518 | .nothing: |
||
519 | ret |
||
520 | |||
521 | ; This function is called by the driver and informs the kernel that the media |
||
522 | ; has changed. If the media is non-removable, it is called exactly once |
||
523 | ; immediately after 'disk_add' and once from 'disk_del'. |
||
524 | ; Parameters: |
||
525 | ; [esp+4] = handle of the disk, i.e. the pointer to the DISK structure. |
||
526 | ; [esp+8] = new status of the media: zero = no media, nonzero = media inserted. |
||
527 | disk_media_changed: |
||
528 | push ebx esi edi ; save used registers to be stdcall |
||
529 | ; 1. Remove the existing media, if it is present. |
||
530 | mov esi, [esp+4+12] ; esi = pointer to DISK |
||
531 | ; 1a. Check whether it is present. Since DISK.MediaInserted is changed only |
||
532 | ; in this function and calls to this function are synchronized, no lock is |
||
533 | ; required for checking. |
||
534 | cmp [esi+DISK.MediaInserted], 0 |
||
535 | jz .noremove |
||
536 | ; We really need to remove the media. |
||
537 | ; 1b. Acquire mutex. |
||
538 | lea ecx, [esi+DISK.MediaLock] |
||
539 | call mutex_lock |
||
540 | ; 1c. Clear the flag. |
||
541 | mov [esi+DISK.MediaInserted], 0 |
||
542 | ; 1d. Release mutex. |
||
543 | call mutex_unlock |
||
544 | ; 1e. Remove the "lifetime" reference and possibly destroy the structure. |
||
545 | call disk_media_dereference |
||
546 | .noremove: |
||
547 | ; 2. Test whether there is new media. |
||
548 | cmp dword [esp+8+12], 0 |
||
549 | jz .noinsert |
||
550 | ; Yep, there is. |
||
551 | ; 3. Process the new media. We assume that all media fields are available to |
||
552 | ; use, see comments in 'disk_media_dereference' (this covers using by previous |
||
553 | ; media referencers) and note that calls to this function are synchronized |
||
554 | ; (this covers using by new media referencers). |
||
555 | ; 3a. Call the 'querymedia' callback. |
||
556 | ; .Flags are set to zero for possible future extensions. |
||
557 | lea edx, [esi+DISK.MediaInfo] |
||
558 | and [edx+DISKMEDIAINFO.Flags], 0 |
||
559 | mov al, DISKFUNC.querymedia |
||
560 | stdcall disk_call_driver, edx |
||
561 | ; 3b. Check the result of the callback. Abort if it failed. |
||
562 | test eax, eax |
||
563 | jnz .noinsert |
||
564 | ; 3c. Allocate the cache unless disabled by the driver. Abort if failed. |
||
565 | call disk_init_cache |
||
566 | test al, al |
||
567 | jz .noinsert |
||
568 | ; 3d. Acquire the lifetime reference for the media object. |
||
569 | inc [esi+DISK.MediaRefCount] |
||
570 | ; 3e. Scan for partitions. Ignore result; the list of partitions is valid even |
||
571 | ; on errors. |
||
572 | call disk_scan_partitions |
||
573 | ; 3f. Media is inserted and available for use. |
||
574 | inc [esi+DISK.MediaInserted] |
||
575 | .noinsert: |
||
576 | ; 4. Return. |
||
577 | pop edi esi ebx ; restore used registers to be stdcall |
||
578 | ret 8 ; purge 2 dword arguments to be stdcall |
||
579 | |||
580 | ; This function is a thunk for all functions of a disk driver. |
||
581 | ; It checks whether the referenced function is implemented in the driver. |
||
582 | ; If so, this function jumps to the function in the driver. |
||
583 | ; Otherwise, it jumps to the default implementation. |
||
584 | ; al = offset of function in the DISKFUNC structure; |
||
585 | ; esi = pointer to the DISK structure; |
||
586 | ; stack is the same as for the corresponding function except that the |
||
587 | ; first parameter (void* userdata) is prepended automatically. |
||
588 | disk_call_driver: |
||
589 | movzx eax, al ; eax = offset of function in the DISKFUNC structure |
||
590 | ; 1. Prepend the first argument to the stack. |
||
591 | pop ecx ; ecx = return address |
||
592 | push [esi+DISK.UserData] ; add argument |
||
593 | push ecx ; save return address |
||
594 | ; 2. Check that the required function is inside the table. If not, go to 5. |
||
595 | mov ecx, [esi+DISK.Functions] |
||
596 | cmp eax, [ecx+DISKFUNC.strucsize] |
||
597 | jae .default |
||
598 | ; 3. Check that the required function is implemented. If not, go to 5. |
||
599 | mov ecx, [ecx+eax] |
||
600 | test ecx, ecx |
||
601 | jz .default |
||
602 | ; 4. Jump to the required function. |
||
603 | jmp ecx |
||
604 | .default: |
||
605 | ; 5. Driver does not implement the required function; use default implementation. |
||
606 | jmp dword [disk_default_callbacks+eax-4] |
||
607 | |||
608 | ; The default implementation of DISKFUNC.querymedia. |
||
609 | disk_default_querymedia: |
||
3598 | clevermous | 610 | movi eax, DISK_STATUS_INVALID_CALL |
2288 | clevermous | 611 | ret 8 |
612 | |||
613 | ; The default implementation of DISKFUNC.read and DISKFUNC.write. |
||
614 | disk_default_read: |
||
615 | disk_default_write: |
||
3598 | clevermous | 616 | movi eax, DISK_STATUS_INVALID_CALL |
2288 | clevermous | 617 | ret 20 |
618 | |||
619 | ; The default implementation of DISKFUNC.close, DISKFUNC.closemedia and |
||
620 | ; DISKFUNC.flush. |
||
621 | disk_default_close: |
||
622 | disk_default_closemedia: |
||
623 | disk_default_flush: |
||
624 | xor eax, eax |
||
625 | ret 4 |
||
626 | |||
627 | ; The default implementation of DISKFUNC.adjust_cache_size. |
||
628 | disk_default_adjust_cache_size: |
||
3164 | clevermous | 629 | mov eax, [esp+8] |
630 | ret 8 |
||
2288 | clevermous | 631 | |
632 | ; This is an internal function called from 'disk_media_changed' when a new media |
||
633 | ; is detected. It creates the list of partitions for the media. |
||
634 | ; If media is not partitioned, then the list consists of one partition which |
||
635 | ; covers all the media. |
||
636 | ; esi = pointer to the DISK structure. |
||
637 | disk_scan_partitions: |
||
638 | ; 1. Initialize .NumPartitions and .Partitions fields as zeros: empty list. |
||
639 | and [esi+DISK.NumPartitions], 0 |
||
640 | and [esi+DISK.Partitions], 0 |
||
641 | ; 2. Currently we can work only with 512-bytes sectors. Check this restriction. |
||
642 | ; The only exception is 2048-bytes CD/DVD, but they are not supported yet by |
||
643 | ; this code. |
||
644 | cmp [esi+DISK.MediaInfo.SectorSize], 512 |
||
645 | jz .doscan |
||
646 | DEBUGF 1,'K : sector size is %d, only 512 is supported\n',[esi+DISK.MediaInfo.SectorSize] |
||
647 | ret |
||
648 | .doscan: |
||
649 | ; 3. Acquire the buffer for MBR and bootsector tests. See the comment before |
||
650 | ; the 'partition_buffer_users' variable. |
||
651 | mov ebx, mbr_buffer ; assume the global buffer is free |
||
652 | lock inc [partition_buffer_users] |
||
653 | jz .buffer_acquired ; yes, it is free |
||
654 | lock dec [partition_buffer_users] ; no, we must allocate |
||
655 | stdcall kernel_alloc, 512*3 |
||
656 | test eax, eax |
||
657 | jz .nothing |
||
658 | xchg eax, ebx |
||
659 | .buffer_acquired: |
||
660 | ; MBR/EBRs are organized in the chain. We use a loop over MBR/EBRs, but no |
||
661 | ; more than MAX_NUM_PARTITION times. |
||
662 | ; 4. Prepare things for the loop. |
||
663 | ; ebp will hold the sector number for current MBR/EBR. |
||
664 | ; [esp] will hold the sector number for current extended partition, if there |
||
665 | ; is one. |
||
666 | ; [esp+4] will hold the counter that prevents long loops. |
||
667 | push ebp ; save ebp |
||
668 | push MAX_NUM_PARTITIONS ; the counter of max MBRs to process |
||
669 | xor ebp, ebp ; start from sector zero |
||
670 | push ebp ; no extended partition yet |
||
671 | .new_mbr: |
||
672 | ; 5. Read the current sector. |
||
673 | ; Note that 'read' callback operates with 64-bit sector numbers, so we must |
||
674 | ; push additional zero as a high dword of sector number. |
||
675 | mov al, DISKFUNC.read |
||
676 | push 1 |
||
677 | stdcall disk_call_driver, ebx, ebp, 0, esp |
||
678 | pop ecx |
||
679 | ; 6. If the read has failed, abort the loop. |
||
680 | dec ecx |
||
681 | jnz .mbr_failed |
||
682 | ; 7. Check the MBR/EBR signature. If it is wrong, abort the loop. |
||
683 | ; Soon we will access the partition table which starts at ebx+0x1BE, |
||
684 | ; so we can fill its address right now. If we do it now, then the addressing |
||
685 | ; [ecx+0x40] is shorter than [ebx+0x1fe]: one-byte offset vs 4-bytes offset. |
||
686 | lea ecx, [ebx+0x1be] ; ecx -> partition table |
||
687 | cmp word [ecx+0x40], 0xaa55 |
||
688 | jnz .mbr_failed |
||
689 | ; 8. The MBR is treated differently from EBRs. For MBR we additionally need to |
||
690 | ; execute step 9 and possibly step 10. |
||
691 | test ebp, ebp |
||
692 | jnz .mbr |
||
693 | ; The partition table can be present or not present. In the first case, we just |
||
694 | ; read the MBR. In the second case, we just read the bootsector for a |
||
695 | ; filesystem. |
||
696 | ; The following algorithm is used to distinguish between these cases. |
||
697 | ; A. If at least one entry of the partition table is invalid, this is |
||
698 | ; a bootsector. See the description of 'is_partition_table_entry' for |
||
699 | ; definition of validity. |
||
700 | ; B. If all entries are empty (filesystem type field is zero) and the first |
||
701 | ; byte is jmp opcode (0EBh or 0E9h), this is a bootsector which happens to |
||
702 | ; have zeros in the place of partition table. |
||
703 | ; C. Otherwise, this is an MBR. |
||
704 | ; 9. Test for MBR vs bootsector. |
||
705 | ; 9a. Check entries. If any is invalid, go to 10 (rule A). |
||
706 | call is_partition_table_entry |
||
707 | jc .notmbr |
||
708 | add ecx, 10h |
||
709 | call is_partition_table_entry |
||
710 | jc .notmbr |
||
711 | add ecx, 10h |
||
712 | call is_partition_table_entry |
||
713 | jc .notmbr |
||
714 | add ecx, 10h |
||
715 | call is_partition_table_entry |
||
716 | jc .notmbr |
||
717 | ; 9b. Check types of the entries. If at least one is nonzero, go to 11 (rule C). |
||
718 | mov al, [ecx-30h+PARTITION_TABLE_ENTRY.Type] |
||
719 | or al, [ecx-20h+PARTITION_TABLE_ENTRY.Type] |
||
720 | or al, [ecx-10h+PARTITION_TABLE_ENTRY.Type] |
||
721 | or al, [ecx+PARTITION_TABLE_ENTRY.Type] |
||
722 | jnz .mbr |
||
723 | ; 9c. Empty partition table or bootsector with many zeroes? (rule B) |
||
724 | cmp byte [ebx], 0EBh |
||
725 | jz .notmbr |
||
726 | cmp byte [ebx], 0E9h |
||
727 | jnz .mbr |
||
728 | .notmbr: |
||
729 | ; 10. This is not an MBR. The media is not partitioned. Create one partition |
||
730 | ; which covers all the media and abort the loop. |
||
731 | stdcall disk_add_partition, 0, 0, \ |
||
732 | dword [esi+DISK.MediaInfo.Capacity], dword [esi+DISK.MediaInfo.Capacity+4] |
||
733 | jmp .done |
||
734 | .mbr: |
||
735 | ; 11. Process all entries of the new MBR/EBR |
||
736 | lea ecx, [ebx+0x1be] ; ecx -> partition table |
||
737 | push 0 ; assume no extended partition |
||
738 | call process_partition_table_entry |
||
739 | add ecx, 10h |
||
740 | call process_partition_table_entry |
||
741 | add ecx, 10h |
||
742 | call process_partition_table_entry |
||
743 | add ecx, 10h |
||
744 | call process_partition_table_entry |
||
745 | pop ebp |
||
746 | ; 12. Test whether we found a new EBR and should continue the loop. |
||
747 | ; 12a. If there was no next EBR, return. |
||
748 | test ebp, ebp |
||
749 | jz .done |
||
750 | ; Ok, we have EBR. |
||
751 | ; 12b. EBRs addresses are relative to the start of extended partition. |
||
752 | ; For simplicity, just abort if an 32-bit overflow occurs; large disks |
||
753 | ; are most likely partitioned with GPT, not MBR scheme, since the precise |
||
754 | ; calculation here would increase limit just twice at the price of big |
||
755 | ; compatibility problems. |
||
756 | pop eax ; load extended partition |
||
757 | add ebp, eax |
||
758 | jc .mbr_failed |
||
759 | ; 12c. If extended partition has not yet started, start it. |
||
760 | test eax, eax |
||
761 | jnz @f |
||
762 | mov eax, ebp |
||
763 | @@: |
||
764 | ; 12c. If the limit is not exceeded, continue the loop. |
||
765 | dec dword [esp] |
||
766 | push eax ; store extended partition |
||
767 | jnz .new_mbr |
||
768 | .mbr_failed: |
||
769 | .done: |
||
770 | ; 13. Cleanup after the loop. |
||
771 | pop eax ; not important anymore |
||
772 | pop eax ; not important anymore |
||
773 | pop ebp ; restore ebp |
||
774 | ; 14. Release the buffer. |
||
775 | ; 14a. Test whether it is the global buffer or we have allocated it. |
||
776 | cmp ebx, mbr_buffer |
||
777 | jz .release_partition_buffer |
||
778 | ; 14b. If we have allocated it, free it. |
||
779 | xchg eax, ebx |
||
780 | call free |
||
781 | jmp .nothing |
||
782 | ; 14c. Otherwise, release reference. |
||
783 | .release_partition_buffer: |
||
784 | lock dec [partition_buffer_users] |
||
785 | .nothing: |
||
786 | ; 15. Return. |
||
787 | ret |
||
788 | |||
789 | ; This is an internal function called from disk_scan_partitions. It checks |
||
790 | ; whether the entry pointed to by ecx is a valid entry of partition table. |
||
791 | ; The entry is valid if the first byte is 0 or 80h, the first sector plus the |
||
792 | ; length is less than twice the size of media. Multiplication by two is |
||
793 | ; required since the size mentioned in the partition table can be slightly |
||
794 | ; greater than the real size. |
||
795 | is_partition_table_entry: |
||
796 | ; 1. Check .Bootable field. |
||
797 | mov al, [ecx+PARTITION_TABLE_ENTRY.Bootable] |
||
798 | and al, 7Fh |
||
799 | jnz .invalid |
||
800 | ; 3. Calculate first sector + length. Note that .FirstAbsSector is relative |
||
801 | ; to the MBR/EBR, so the real sum is ebp + .FirstAbsSector + .Length. |
||
802 | mov eax, ebp |
||
803 | xor edx, edx |
||
804 | add eax, [ecx+PARTITION_TABLE_ENTRY.FirstAbsSector] |
||
805 | adc edx, 0 |
||
806 | add eax, [ecx+PARTITION_TABLE_ENTRY.Length] |
||
807 | adc edx, 0 |
||
808 | ; 4. Divide by two. |
||
809 | shr edx, 1 |
||
810 | rcr eax, 1 |
||
811 | ; 5. Compare with capacity. If the subtraction (edx:eax) - .Capacity does not |
||
812 | ; overflow, this is bad. |
||
813 | sub eax, dword [esi+DISK.MediaInfo.Capacity] |
||
814 | sbb edx, dword [esi+DISK.MediaInfo.Capacity+4] |
||
815 | jnc .invalid |
||
816 | .valid: |
||
817 | ; 5. Return success: CF is cleared. |
||
818 | clc |
||
819 | ret |
||
820 | .invalid: |
||
821 | ; 6. Return fail: CF is set. |
||
822 | stc |
||
823 | ret |
||
824 | |||
825 | ; This is an internal function called from disk_scan_partitions. It processes |
||
826 | ; the entry pointed to by ecx. |
||
827 | ; * If the entry is invalid, just ignore this entry. |
||
828 | ; * If the type is zero, just ignore this entry. |
||
829 | ; * If the type is one of types for extended partition, store the address |
||
830 | ; of this partition as the new MBR in [esp+4]. |
||
831 | ; * Otherwise, add the partition to the list of partitions for this disk. |
||
832 | ; We don't use the type from the entry to identify the file system; |
||
833 | ; fs-specific checks do this more reliably. |
||
834 | process_partition_table_entry: |
||
835 | ; 1. Check for valid entry. If invalid, return (go to 5). |
||
836 | call is_partition_table_entry |
||
837 | jc .nothing |
||
838 | ; 2. Check for empty entry. If invalid, return (go to 5). |
||
839 | mov al, [ecx+PARTITION_TABLE_ENTRY.Type] |
||
840 | test al, al |
||
841 | jz .nothing |
||
842 | ; 3. Check for extended partition. If extended, go to 6. |
||
843 | irp type,\ |
||
844 | 0x05,\ ; DOS: extended partition |
||
845 | 0x0f,\ ; WIN95: extended partition, LBA-mapped |
||
846 | 0xc5,\ ; DRDOS/secured: extended partition |
||
847 | 0xd5 ; Old Multiuser DOS secured: extended partition |
||
848 | { |
||
849 | cmp al, type |
||
850 | jz .extended |
||
851 | } |
||
852 | ; 4. If we are here, that is a normal partition. Add it to the list. |
||
853 | ; Note that the first sector is relative to MBR/EBR. |
||
854 | mov eax, ebp |
||
855 | xor edx, edx |
||
856 | add eax, [ecx+PARTITION_TABLE_ENTRY.FirstAbsSector] |
||
857 | adc edx, 0 |
||
858 | push ecx |
||
859 | stdcall disk_add_partition, eax, edx, \ |
||
860 | [ecx+PARTITION_TABLE_ENTRY.Length], 0 |
||
861 | pop ecx |
||
862 | .nothing: |
||
863 | ; 5. Return. |
||
864 | ret |
||
865 | .extended: |
||
866 | ; 6. If we are here, that is an extended partition. Store the address. |
||
867 | mov eax, [ecx+PARTITION_TABLE_ENTRY.FirstAbsSector] |
||
868 | mov [esp+4], eax |
||
869 | ret |
||
870 | |||
871 | ; This is an internal function called from disk_scan_partitions and |
||
872 | ; process_partition_table_entry. It adds one partition to the list of |
||
873 | ; partitions for the media. |
||
874 | proc disk_add_partition stdcall uses ebx edi, start:qword, length:qword |
||
875 | ; 1. Check that this partition will not exceed the limit on total number. |
||
876 | cmp [esi+DISK.NumPartitions], MAX_NUM_PARTITIONS |
||
877 | jae .nothing |
||
878 | ; 2. Check that this partition does not overlap with any already registered |
||
879 | ; partition. Since any file system assumes that the disk data will not change |
||
880 | ; outside of its control, such overlap could be destructive. |
||
881 | ; Since the number of partitions is usually very small and is guaranteed not |
||
882 | ; to be large, the simple linear search is sufficient. |
||
883 | ; 2a. Prepare the loop: edi will point to the current item of .Partitions |
||
884 | ; array, ecx will be the current item, ebx will hold number of items left. |
||
885 | mov edi, [esi+DISK.Partitions] |
||
886 | mov ebx, [esi+DISK.NumPartitions] |
||
887 | test ebx, ebx |
||
888 | jz .partitionok |
||
889 | .scan_existing: |
||
890 | ; 2b. Get the next partition. |
||
891 | mov ecx, [edi] |
||
892 | add edi, 4 |
||
893 | ; The range [.FirstSector, .FirstSector+.Length) must be either entirely to |
||
894 | ; the left of [start, start+length) or entirely to the right. |
||
895 | ; 2c. Subtract .FirstSector - start. The possible overflow distinguish between |
||
896 | ; cases "to the left" (2e) and "to the right" (2d). |
||
897 | mov eax, dword [ecx+PARTITION.FirstSector] |
||
898 | mov edx, dword [ecx+PARTITION.FirstSector+4] |
||
899 | sub eax, dword [start] |
||
900 | sbb edx, dword [start+4] |
||
901 | jb .less |
||
902 | ; 2d. .FirstSector is greater than or equal to start. Check that .FirstSector |
||
903 | ; is greater than or equal to start+length; the subtraction |
||
904 | ; (.FirstSector-start) - length must not cause overflow. Go to 2g if life is |
||
905 | ; good or to 2f in the other case. |
||
906 | sub eax, dword [length] |
||
907 | sbb edx, dword [length+4] |
||
908 | jb .overlap |
||
909 | jmp .next_existing |
||
910 | .less: |
||
911 | ; 2e. .FirstSector is less than start. Check that .FirstSector+.Length is less |
||
912 | ; than or equal to start. If the addition (.FirstSector-start) + .Length does |
||
913 | ; not cause overflow, then .FirstSector + .Length is strictly less than start; |
||
914 | ; since the equality is also valid, use decrement preliminarily. Go to 2g or |
||
915 | ; 2f depending on the overflow. |
||
916 | sub eax, 1 |
||
917 | sbb edx, 0 |
||
918 | add eax, dword [ecx+PARTITION.Length] |
||
919 | adc edx, dword [ecx+PARTITION.Length+4] |
||
920 | jnc .next_existing |
||
921 | .overlap: |
||
922 | ; 2f. The partition overlaps with previously registered partition. Say warning |
||
923 | ; and return with nothing done. |
||
924 | dbgstr 'two partitions overlap, ignoring the last one' |
||
925 | jmp .nothing |
||
926 | .next_existing: |
||
927 | ; 2g. The partition does not overlap with the current partition. Continue the |
||
928 | ; loop. |
||
929 | dec ebx |
||
930 | jnz .scan_existing |
||
931 | .partitionok: |
||
932 | ; 3. The partition has passed tests. Reallocate the partitions array for a new |
||
933 | ; entry. |
||
934 | ; 3a. Call the allocator. |
||
935 | mov eax, [esi+DISK.NumPartitions] |
||
936 | inc eax ; one more entry |
||
937 | shl eax, 2 ; each entry is dword |
||
938 | call malloc |
||
939 | ; 3b. Test the result. If failed, return with nothing done. |
||
940 | test eax, eax |
||
941 | jz .nothing |
||
942 | ; 3c. Copy the old array to the new array. |
||
943 | mov edi, eax |
||
944 | push esi |
||
945 | mov ecx, [esi+DISK.NumPartitions] |
||
946 | mov esi, [esi+DISK.Partitions] |
||
947 | rep movsd |
||
948 | pop esi |
||
949 | ; 3d. Set the field in the DISK structure to the new array. |
||
950 | xchg [esi+DISK.Partitions], eax |
||
951 | ; 3e. Free the old array. |
||
952 | call free |
||
953 | ; 4. Recognize the file system. |
||
954 | ; 4a. Call the filesystem recognizer. It will allocate the PARTITION structure |
||
955 | ; with possible filesystem-specific fields. |
||
956 | call disk_detect_partition |
||
957 | ; 4b. Check return value. If zero, return with list not changed; so far only |
||
958 | ; the array was reallocated, this is ok for other code. |
||
959 | test eax, eax |
||
960 | jz .nothing |
||
961 | ; 5. Insert the new partition to the list. |
||
962 | stosd |
||
963 | inc [esi+DISK.NumPartitions] |
||
964 | ; 6. Return. |
||
965 | .nothing: |
||
966 | ret |
||
967 | endp |
||
968 | |||
969 | ; This is an internal function called from disk_add_partition. |
||
970 | ; It tries to recognize the file system on the partition and allocates the |
||
971 | ; corresponding PARTITION structure with filesystem-specific fields. |
||
972 | disk_detect_partition: |
||
973 | ; This function inherits the stack frame from disk_add_partition. In stdcall |
||
974 | ; with ebp-based frame arguments start from ebp+8, since [ebp]=saved ebp |
||
975 | ; and [ebp+4]=return address. |
||
976 | virtual at ebp+8 |
||
977 | .start dq ? |
||
978 | .length dq ? |
||
979 | end virtual |
||
2643 | clevermous | 980 | ; When disk_add_partition is called, ebx contains a pointer to |
981 | ; a two-sectors-sized buffer. This function saves ebx in the stack |
||
982 | ; immediately before ebp. |
||
983 | virtual at ebp-4 |
||
984 | .buffer dd ? |
||
985 | end virtual |
||
986 | ; 1. Read the bootsector to the buffer. |
||
987 | mov al, DISKFUNC.read |
||
988 | mov ebx, [.buffer] |
||
989 | add ebx, 512 |
||
990 | push 1 |
||
991 | stdcall disk_call_driver, ebx, dword [.start], dword [.start+4], esp |
||
992 | ; 2. Run tests for all supported filesystems. If at least one test succeeded, |
||
993 | ; go to 4. |
||
994 | ; For tests: qword [ebp+8] = partition start, qword [ebp+10h] = partition |
||
995 | ; length, [esp] = 0 if reading bootsector failed or 1 if succeeded, |
||
996 | ; ebx points to the buffer for bootsector. |
||
997 | call fat_create_partition |
||
998 | test eax, eax |
||
999 | jnz .success |
||
1000 | ; 3. No file system has recognized the volume, so just allocate the PARTITION |
||
2288 | clevermous | 1001 | ; structure without extra fields. |
3598 | clevermous | 1002 | movi eax, sizeof.PARTITION |
2288 | clevermous | 1003 | call malloc |
1004 | test eax, eax |
||
1005 | jz .nothing |
||
1006 | mov edx, dword [.start] |
||
1007 | mov dword [eax+PARTITION.FirstSector], edx |
||
1008 | mov edx, dword [.start+4] |
||
1009 | mov dword [eax+PARTITION.FirstSector+4], edx |
||
1010 | mov edx, dword [.length] |
||
1011 | mov dword [eax+PARTITION.Length], edx |
||
1012 | mov edx, dword [.length+4] |
||
1013 | mov dword [eax+PARTITION.Length+4], edx |
||
2643 | clevermous | 1014 | mov [eax+PARTITION.Disk], esi |
1015 | and [eax+PARTITION.FSUserFunctions], 0 |
||
1016 | .success: |
||
2288 | clevermous | 1017 | .nothing: |
2643 | clevermous | 1018 | ; 4. Return with eax = pointer to PARTITION or NULL. |
1019 | pop ecx |
||
2288 | clevermous | 1020 | ret |
1021 | |||
1022 | ; This function is called from file_system_lfn. |
||
1023 | ; This handler gets the control each time when fn 70 is called |
||
1024 | ; with unknown item of root subdirectory. |
||
1025 | ; in: esi -> name |
||
1026 | ; ebp = 0 or rest of name relative to esi |
||
1027 | ; out: if the handler processes path, it must not return in file_system_lfn, |
||
1028 | ; but instead pop return address and return directly to the caller |
||
1029 | ; otherwise simply return |
||
1030 | dyndisk_handler: |
||
1031 | push ebx edi ; save registers used in file_system_lfn |
||
1032 | ; 1. Acquire the mutex. |
||
1033 | mov ecx, disk_list_mutex |
||
1034 | call mutex_lock |
||
1035 | ; 2. Loop over the list of DISK structures. |
||
1036 | ; 2a. Initialize. |
||
1037 | mov ebx, disk_list |
||
1038 | .scan: |
||
1039 | ; 2b. Get the next item. |
||
1040 | mov ebx, [ebx+DISK.Next] |
||
1041 | ; 2c. Check whether the list is done. If so, go to 3. |
||
1042 | cmp ebx, disk_list |
||
1043 | jz .notfound |
||
1044 | ; 2d. Compare names. If names match, go to 5. |
||
1045 | mov edi, [ebx+DISK.Name] |
||
1046 | push esi |
||
1047 | @@: |
||
1048 | ; esi points to the name from fs operation; it is terminated by zero or slash. |
||
1049 | lodsb |
||
1050 | test al, al |
||
1051 | jz .eoin_dec |
||
1052 | cmp al, '/' |
||
1053 | jz .eoin |
||
1054 | ; edi points to the disk name. |
||
1055 | inc edi |
||
1056 | ; edi points to lowercase name, this is a requirement for the driver. |
||
1057 | ; Characters at esi can have any register. Lowercase the current character. |
||
1058 | ; This lowercasing works for latin letters and digits; since the disk name |
||
1059 | ; should not contain other symbols, this is ok. |
||
1060 | or al, 20h |
||
1061 | cmp al, [edi-1] |
||
1062 | jz @b |
||
1063 | .wrongname: |
||
1064 | ; 2f. Names don't match. Continue the loop. |
||
1065 | pop esi |
||
1066 | jmp .scan |
||
1067 | .notfound: |
||
1068 | ; The loop is done and no name matches. |
||
1069 | ; 3. Release the mutex. |
||
1070 | call mutex_unlock |
||
1071 | ; 4. Return normally. |
||
1072 | pop edi ebx ; restore registers used in file_system_lfn |
||
1073 | ret |
||
1074 | ; part of 2d: the name matches partially, but we must check that this is full |
||
1075 | ; equality. |
||
1076 | .eoin_dec: |
||
1077 | dec esi |
||
1078 | .eoin: |
||
1079 | cmp byte [edi], 0 |
||
1080 | jnz .wrongname |
||
1081 | ; We found the addressed DISK structure. |
||
1082 | ; 5. Reference the disk. |
||
1083 | lock inc [ebx+DISK.RefCount] |
||
1084 | ; 6. Now we are sure that the DISK structure is not going to die at least |
||
1085 | ; while we are working with it, so release the global mutex. |
||
1086 | call mutex_unlock |
||
2643 | clevermous | 1087 | pop ecx ; pop from the stack saved value of esi |
2288 | clevermous | 1088 | ; 7. Acquire the mutex for media object. |
1089 | pop edi ; restore edi |
||
1090 | lea ecx, [ebx+DISK.MediaLock] |
||
1091 | call mutex_lock |
||
1092 | ; 8. Get the media object. If it is not NULL, reference it. |
||
1093 | xor edx, edx |
||
1094 | cmp [ebx+DISK.MediaInserted], dl |
||
1095 | jz @f |
||
1096 | mov edx, ebx |
||
1097 | inc [ebx+DISK.MediaRefCount] |
||
1098 | @@: |
||
1099 | ; 9. Now we are sure that the media object, if it exists, is not going to die |
||
1100 | ; at least while we are working with it, so release the mutex for media object. |
||
1101 | call mutex_unlock |
||
1102 | mov ecx, ebx |
||
1103 | pop ebx eax ; restore ebx, pop return address |
||
1104 | ; 10. Check whether the fs operation wants to enumerate partitions (go to 11) |
||
1105 | ; or work with some concrete partition (go to 12). |
||
1106 | cmp byte [esi], 0 |
||
1107 | jnz .haspartition |
||
1108 | ; 11. The fs operation wants to enumerate partitions. |
||
1109 | ; 11a. Only "list directory" operation is applicable to / |
||
1110 | ; the operation code. If wrong, go to 13. |
||
1111 | cmp dword [ebx], 1 |
||
1112 | jnz .access_denied |
||
1113 | ; 11b. If the media is inserted, use 'fs_dyndisk_next' as an enumeration |
||
1114 | ; procedure. Otherwise, use 'fs_dyndisk_next_nomedia'. |
||
1115 | mov esi, fs_dyndisk_next_nomedia |
||
1116 | test edx, edx |
||
1117 | jz @f |
||
1118 | mov esi, fs_dyndisk_next |
||
1119 | @@: |
||
1120 | ; 11c. Let the procedure from fs_lfn.inc do the job. |
||
1121 | jmp file_system_lfn.maindir_noesi |
||
1122 | .haspartition: |
||
1123 | ; 12. The fs operation has specified some partition. |
||
1124 | ; 12a. Store parameters for callback functions. |
||
1125 | push edx |
||
1126 | push ecx |
||
1127 | ; 12b. Store callback functions. |
||
1128 | push dyndisk_cleanup |
||
1129 | push fs_dyndisk |
||
1130 | mov edi, esp |
||
1131 | ; 12c. Let the procedure from fs_lfn.inc do the job. |
||
1132 | jmp file_system_lfn.found2 |
||
1133 | .access_denied: |
||
1134 | ; 13. Fail the operation with the appropriate code. |
||
1135 | mov dword [esp+32], ERROR_ACCESS_DENIED |
||
1136 | .cleanup: |
||
1137 | ; 14. Cleanup. |
||
1138 | mov esi, ecx ; disk*dereference assume that esi points to DISK |
||
1139 | .cleanup_esi: |
||
1140 | test edx, edx ; if there are no media, we didn't reference it |
||
1141 | jz @f |
||
1142 | call disk_media_dereference |
||
1143 | @@: |
||
1144 | call disk_dereference |
||
1145 | ; 15. Return. |
||
1146 | ret |
||
1147 | |||
1148 | ; This is a callback for cleaning up things called from file_system_lfn.found2. |
||
1149 | dyndisk_cleanup: |
||
1150 | mov esi, [edi+8] |
||
1151 | mov edx, [edi+12] |
||
1152 | jmp dyndisk_handler.cleanup_esi |
||
1153 | |||
1154 | ; This is a callback for enumerating partitions called from |
||
1155 | ; file_system_lfn.maindir in the case of inserted media. |
||
1156 | ; It just increments eax until DISK.NumPartitions reached and then |
||
1157 | ; cleans up. |
||
1158 | fs_dyndisk_next: |
||
1159 | cmp eax, [ecx+DISK.NumPartitions] |
||
1160 | jae .nomore |
||
1161 | inc eax |
||
1162 | clc |
||
1163 | ret |
||
1164 | .nomore: |
||
1165 | pusha |
||
1166 | mov esi, ecx |
||
1167 | call disk_media_dereference |
||
1168 | call disk_dereference |
||
1169 | popa |
||
1170 | stc |
||
1171 | ret |
||
1172 | |||
1173 | ; This is a callback for enumerating partitions called from |
||
1174 | ; file_system_lfn.maindir in the case of missing media. |
||
1175 | ; In this case we create one pseudo-partition. |
||
1176 | fs_dyndisk_next_nomedia: |
||
1177 | cmp eax, 1 |
||
1178 | jae .nomore |
||
1179 | inc eax |
||
1180 | clc |
||
1181 | ret |
||
1182 | .nomore: |
||
1183 | pusha |
||
1184 | mov esi, ecx |
||
1185 | call disk_dereference |
||
1186 | popa |
||
1187 | stc |
||
1188 | ret |
||
1189 | |||
1190 | ; This is a callback for doing real work with selected partition. |
||
1191 | ; Currently this is just placeholder, since no file systems are supported. |
||
1192 | ; edi = esp -> {dd fs_dyndisk, dd dyndisk_cleanup, dd pointer to DISK, dd media object} |
||
1193 | ; ecx = partition number, esi+ebp = ASCIIZ name |
||
1194 | fs_dyndisk: |
||
1195 | dec ecx ; convert to zero-based partition index |
||
1196 | pop edx edx edx eax ; edx = pointer to DISK, eax = NULL or edx |
||
1197 | test eax, eax |
||
1198 | jz .nomedia |
||
1199 | .main: |
||
1200 | cmp ecx, [edx+DISK.NumPartitions] |
||
1201 | jae .notfound |
||
2643 | clevermous | 1202 | mov eax, [edx+DISK.Partitions] |
1203 | mov eax, [eax+ecx*4] |
||
1204 | mov edi, [eax+PARTITION.FSUserFunctions] |
||
1205 | test edi, edi |
||
1206 | jz .nofs |
||
1207 | mov ecx, [ebx] |
||
1208 | cmp [edi], ecx |
||
1209 | jbe .unsupported |
||
1210 | push edx |
||
1211 | push ebp |
||
1212 | mov ebp, eax |
||
1213 | call dword [edi+4+ecx*4] |
||
1214 | pop ebp |
||
1215 | pop edx |
||
1216 | mov dword [esp+32], eax |
||
1217 | mov dword [esp+20], ebx |
||
2288 | clevermous | 1218 | .cleanup: |
1219 | mov esi, edx |
||
1220 | call disk_media_dereference |
||
1221 | call disk_dereference |
||
1222 | ret |
||
2643 | clevermous | 1223 | .nofs: |
1224 | mov dword [esp+32], ERROR_UNKNOWN_FS |
||
1225 | jmp .cleanup |
||
2288 | clevermous | 1226 | .notfound: |
1227 | mov dword [esp+32], ERROR_FILE_NOT_FOUND |
||
1228 | jmp .cleanup |
||
2643 | clevermous | 1229 | .unsupported: |
1230 | mov dword [esp+32], ERROR_UNSUPPORTED_FS |
||
1231 | jmp .cleanup |
||
2288 | clevermous | 1232 | .nomedia: |
1233 | test ecx, ecx |
||
1234 | jnz .notfound |
||
1235 | test byte [edx+DISK.DriverFlags], DISK_NO_INSERT_NOTIFICATION |
||
1236 | jz .deverror |
||
1237 | ; if the driver does not support insert notifications and we are the only fs |
||
1238 | ; operation with this disk, issue the fake insert notification; if media is |
||
1239 | ; still not inserted, 'disk_media_changed' will detect this and do nothing |
||
1240 | lea ecx, [edx+DISK.MediaLock] |
||
1241 | call mutex_lock |
||
1242 | cmp [edx+DISK.MediaRefCount], 1 |
||
1243 | jnz .noluck |
||
1244 | call mutex_unlock |
||
1245 | push edx |
||
1246 | stdcall disk_media_changed, edx, 1 |
||
1247 | pop edx |
||
1248 | lea ecx, [edx+DISK.MediaLock] |
||
1249 | call mutex_lock |
||
1250 | cmp [edx+DISK.MediaInserted], 0 |
||
1251 | jz .noluck |
||
1252 | lock inc [edx+DISK.MediaRefCount] |
||
1253 | call mutex_unlock |
||
1254 | xor ecx, ecx |
||
1255 | jmp .main |
||
1256 | .noluck: |
||
1257 | call mutex_unlock |
||
1258 | .deverror: |
||
1259 | mov dword [esp+32], ERROR_DEVICE |
||
1260 | mov esi, edx |
||
1261 | call disk_dereference |
||
1262 | ret |
||
1263 | |||
1264 | ; This function is called from file_system_lfn. |
||
1265 | ; This handler is called when virtual root is enumerated |
||
1266 | ; and must return all items which can be handled by this. |
||
1267 | ; It is called several times, first time with eax=0 |
||
1268 | ; in: eax = 0 for first call, previously returned value for subsequent calls |
||
1269 | ; out: eax = 0 => no more items |
||
1270 | ; eax != 0 => buffer pointed to by edi contains name of item |
||
1271 | dyndisk_enum_root: |
||
1272 | push edx ; save register used in file_system_lfn |
||
1273 | mov ecx, disk_list_mutex ; it will be useful |
||
1274 | ; 1. If this is the first call, acquire the mutex and initialize. |
||
1275 | test eax, eax |
||
1276 | jnz .notfirst |
||
1277 | call mutex_lock |
||
1278 | mov eax, disk_list |
||
1279 | .notfirst: |
||
1280 | ; 2. Get next item. |
||
1281 | mov eax, [eax+DISK.Next] |
||
1282 | ; 3. If there are no more items, go to 6. |
||
1283 | cmp eax, disk_list |
||
1284 | jz .last |
||
1285 | ; 4. Copy name from the DISK structure to edi. |
||
1286 | push eax esi |
||
1287 | mov esi, [eax+DISK.Name] |
||
1288 | @@: |
||
1289 | lodsb |
||
1290 | stosb |
||
1291 | test al, al |
||
1292 | jnz @b |
||
1293 | pop esi eax |
||
1294 | ; 5. Return with eax = item. |
||
1295 | pop edx ; restore register used in file_system_lfn |
||
1296 | ret |
||
1297 | .last: |
||
1298 | ; 6. Release the mutex and return with eax = 0. |
||
1299 | call mutex_unlock |
||
1300 | xor eax, eax |
||
1301 | pop edx ; restore register used in file_system_lfn |
||
1302 | ret |