tape.c 15.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * TAPE support
 *
 * Copyright 2006 Hans Leidekker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 20 21 22 23 24 25 26 27 28 29 30 31 32
 */

#include "config.h"
#include "wine/port.h"

#include <stdarg.h>
#include <stdio.h>
#ifdef HAVE_SYS_IOCTL_H
#include <sys/ioctl.h>
#endif
#ifdef HAVE_SYS_MTIO_H
#include <sys/mtio.h>
#endif

33 34 35
#if !defined(MTCOMPRESSION) && defined(MTCOMP)
#define MTCOMPRESSION MTCOMP
#endif
36 37 38
#if !defined(MTSETBLK) && defined(MTSETBSIZ)
#define MTSETBLK MTSETBSIZ
#endif
39 40 41 42 43 44
#if !defined(MTSETBLK) && defined(MTSRSZ)
#define MTSETBLK MTSRSZ
#endif
#ifndef MT_ST_BLKSIZE_MASK
#define MT_ST_BLKSIZE_MASK 0xffffff
#endif
45

46 47 48 49 50
/* Darwin 7.9.0 has MTSETBSIZ instead of MTSETBLK */
#if !defined(MTSETBLK) && defined(MTSETBSIZ)
#define MTSETBLK MTSETBSIZ
#endif

51 52
#include "ntstatus.h"
#define WIN32_NO_STATUS
53
#define NONAMELESSUNION
54 55 56 57 58 59 60 61 62 63 64 65 66 67
#include "windef.h"
#include "winternl.h"
#include "winioctl.h"
#include "ddk/ntddtape.h"
#include "ntdll_misc.h"
#include "wine/server.h"
#include "wine/debug.h"

WINE_DEFAULT_DEBUG_CHANNEL(tape);

static const char *io2str( DWORD io )
{
    switch (io)
    {
68
#define X(x)    case (x): return #x
69 70 71 72 73 74 75 76 77 78 79 80 81 82
    X(IOCTL_TAPE_CHECK_VERIFY);
    X(IOCTL_TAPE_CREATE_PARTITION);
    X(IOCTL_TAPE_ERASE);
    X(IOCTL_TAPE_FIND_NEW_DEVICES);
    X(IOCTL_TAPE_GET_DRIVE_PARAMS);
    X(IOCTL_TAPE_GET_MEDIA_PARAMS);
    X(IOCTL_TAPE_GET_POSITION);
    X(IOCTL_TAPE_GET_STATUS);
    X(IOCTL_TAPE_PREPARE);
    X(IOCTL_TAPE_SET_DRIVE_PARAMS);
    X(IOCTL_TAPE_SET_MEDIA_PARAMS);
    X(IOCTL_TAPE_SET_POSITION);
    X(IOCTL_TAPE_WRITE_MARKS);
#undef X
83
    default: { static char tmp[32]; sprintf(tmp, "IOCTL_TAPE_%d\n", io); return tmp; }
84 85 86 87 88 89
    }
}

/******************************************************************
 *      TAPE_GetStatus
 */
90
#ifdef HAVE_SYS_MTIO_H
91
static inline NTSTATUS TAPE_GetStatus( int error )
92 93 94 95
{
    if (!error) return STATUS_SUCCESS;
    return FILE_GetNtStatus();
}
96
#endif
97 98 99 100

/******************************************************************
 *      TAPE_CreatePartition
 */
101
static NTSTATUS TAPE_CreatePartition( int fd, const TAPE_CREATE_PARTITION *data )
102 103 104 105
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

106
    TRACE( "fd: %d method: 0x%08x count: 0x%08x size: 0x%08x\n",
107 108 109 110 111 112 113 114 115 116
           fd, data->Method, data->Count, data->Size );

    if (data->Count > 1)
    {
        WARN( "Creating more than 1 partition is not supported\n" );
        return STATUS_INVALID_PARAMETER;
    }

    switch (data->Method)
    {
117
#ifdef MTMKPART
118 119 120 121 122 123 124 125 126
    case TAPE_FIXED_PARTITIONS:
    case TAPE_SELECT_PARTITIONS:
        cmd.mt_op = MTMKPART;
        cmd.mt_count = 0;
        break;
    case TAPE_INITIATOR_PARTITIONS:
        cmd.mt_op = MTMKPART;
        cmd.mt_count = data->Size;
        break;
127
#endif
128
    default:
129
        ERR( "Unhandled method: 0x%08x\n", data->Method );
130 131 132 133 134 135 136 137 138 139 140 141 142
        return STATUS_INVALID_PARAMETER;
    }

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_Erase
 */
143
static NTSTATUS TAPE_Erase( int fd, const TAPE_ERASE *data )
144 145 146 147
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

148
    TRACE( "fd: %d type: 0x%08x immediate: 0x%02x\n",
149 150 151 152 153 154 155 156 157 158 159 160 161
           fd, data->Type, data->Immediate );

    switch (data->Type)
    {
    case TAPE_ERASE_LONG:
        cmd.mt_op = MTERASE;
        cmd.mt_count = 1;
        break;
    case TAPE_ERASE_SHORT:
        cmd.mt_op = MTERASE;
        cmd.mt_count = 0;
        break;
    default:
162
        ERR( "Unhandled type: 0x%08x\n", data->Type );
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
        return STATUS_INVALID_PARAMETER;
    }

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_GetDriveParams
 */
static NTSTATUS TAPE_GetDriveParams( int fd, TAPE_GET_DRIVE_PARAMETERS *data )
{
#ifdef HAVE_SYS_MTIO_H
    struct mtget get;
    NTSTATUS status;

    TRACE( "fd: %d\n", fd );

    memset( data, 0, sizeof(TAPE_GET_DRIVE_PARAMETERS) );

    status = TAPE_GetStatus( ioctl( fd, MTIOCGET, &get ) );
    if (status != STATUS_SUCCESS)
        return status;

    data->ECC = FALSE;
    data->Compression = FALSE;
    data->DataPadding = FALSE;
    data->ReportSetmarks = FALSE;
194 195 196
#ifdef HAVE_STRUCT_MTGET_MT_BLKSIZ
    data->DefaultBlockSize = get.mt_blksiz;
#else
197
    data->DefaultBlockSize = get.mt_dsreg & MT_ST_BLKSIZE_MASK;
198
#endif
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
    data->MaximumBlockSize = data->DefaultBlockSize;
    data->MinimumBlockSize = data->DefaultBlockSize;
    data->MaximumPartitionCount = 1;

    return status;
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_GetMediaParams
 */
static NTSTATUS TAPE_GetMediaParams( int fd, TAPE_GET_MEDIA_PARAMETERS *data )
{
#ifdef HAVE_SYS_MTIO_H
    struct mtget get;
    NTSTATUS status;

    TRACE( "fd: %d\n", fd );

    memset( data, 0, sizeof(TAPE_GET_MEDIA_PARAMETERS) );

    status = TAPE_GetStatus( ioctl( fd, MTIOCGET, &get ) );
    if (status != STATUS_SUCCESS)
        return status;

227 228
    data->Capacity.QuadPart = 1024 * 1024 * 1024;
    data->Remaining.QuadPart = 1024 * 1024 * 1024;
229 230 231
#ifdef HAVE_STRUCT_MTGET_MT_BLKSIZ
    data->BlockSize = get.mt_blksiz;
#else
232
    data->BlockSize = get.mt_dsreg & MT_ST_BLKSIZE_MASK;
233
#endif
234
    data->PartitionCount = 1;
235
#ifdef HAVE_STRUCT_MTGET_MT_GSTAT
236
    data->WriteProtected = (GMT_WR_PROT(get.mt_gstat) != 0);
237 238 239
#else
    data->WriteProtected = 0;
#endif
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254

    return status;
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_GetPosition
 */
static NTSTATUS TAPE_GetPosition( int fd, ULONG type, TAPE_GET_POSITION *data )
{
#ifdef HAVE_SYS_MTIO_H
    struct mtget get;
255
#ifndef HAVE_STRUCT_MTGET_MT_BLKNO
256
    struct mtpos pos;
257
#endif
258 259
    NTSTATUS status;

260
    TRACE( "fd: %d type: 0x%08x\n", fd, type );
261 262 263 264 265 266 267

    memset( data, 0, sizeof(TAPE_GET_POSITION) );

    status = TAPE_GetStatus( ioctl( fd, MTIOCGET, &get ) );
    if (status != STATUS_SUCCESS)
        return status;

268
#ifndef HAVE_STRUCT_MTGET_MT_BLKNO
269 270 271
    status = TAPE_GetStatus( ioctl( fd, MTIOCPOS, &pos ) );
    if (status != STATUS_SUCCESS)
        return status;
272
#endif
273 274 275 276 277 278

    switch (type)
    {
    case TAPE_ABSOLUTE_BLOCK:
        data->Type = type;
        data->Partition = get.mt_resid;
279 280 281
#ifdef HAVE_STRUCT_MTGET_MT_BLKNO
        data->OffsetLow = get.mt_blkno;
#else
282
        data->OffsetLow = pos.mt_blkno;
283
#endif
284
        break;
285 286 287 288 289
    case TAPE_LOGICAL_BLOCK:
    case TAPE_PSEUDO_LOGICAL_BLOCK:
        WARN( "Positioning type not supported\n" );
        break;
    default:
290
        ERR( "Unhandled type: 0x%08x\n", type );
291 292 293 294 295 296 297 298 299 300 301 302 303
        return STATUS_INVALID_PARAMETER;
    }

    return status;
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_Prepare
 */
304
static NTSTATUS TAPE_Prepare( int fd, const TAPE_PREPARE *data )
305 306 307 308
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

309
    TRACE( "fd: %d type: 0x%08x immediate: 0x%02x\n",
310 311 312 313
           fd, data->Operation, data->Immediate );

    switch (data->Operation)
    {
314
#ifdef MTLOAD
315 316 317
    case TAPE_LOAD:
        cmd.mt_op = MTLOAD;
        break;
318 319
#endif
#ifdef MTUNLOAD
320 321 322
    case TAPE_UNLOAD:
        cmd.mt_op = MTUNLOAD;
        break;
323 324
#endif
#ifdef MTRETEN
325 326 327
    case TAPE_TENSION:
        cmd.mt_op = MTRETEN;
        break;
328 329
#endif
#ifdef MTLOCK
330 331 332
    case TAPE_LOCK:
        cmd.mt_op = MTLOCK;
        break;
333 334
#endif
#ifdef MTUNLOCK
335 336 337
    case TAPE_UNLOCK:
        cmd.mt_op = MTUNLOCK;
        break;
338
#endif
339 340 341 342
    case TAPE_FORMAT:
        /* Native ignores this if the drive doesn't support it */
        return STATUS_SUCCESS;
    default:
343
        ERR( "Unhandled operation: 0x%08x\n", data->Operation );
344 345 346 347 348 349 350 351 352 353 354 355 356
        return STATUS_INVALID_PARAMETER;
    }

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_SetDriveParams
 */
357
static NTSTATUS TAPE_SetDriveParams( int fd, const TAPE_SET_DRIVE_PARAMETERS *data )
358
{
359
#if defined(HAVE_SYS_MTIO_H) && defined(MTCOMPRESSION)
360 361 362 363
    struct mtop cmd;

    TRACE( "fd: %d ECC: 0x%02x, compression: 0x%02x padding: 0x%02x\n",
            fd, data->ECC, data->Compression, data->DataPadding );
364
    TRACE( "setmarks: 0x%02x zonesize: 0x%08x\n",
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
           data->ReportSetmarks, data->EOTWarningZoneSize );

    if (data->ECC || data->DataPadding || data->ReportSetmarks ||
        data->EOTWarningZoneSize ) WARN( "Setting not supported\n" );

    cmd.mt_op = MTCOMPRESSION;
    cmd.mt_count = data->Compression;

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}
        
/******************************************************************
 *      TAPE_SetMediaParams
 */
383
static NTSTATUS TAPE_SetMediaParams( int fd, const TAPE_SET_MEDIA_PARAMETERS *data )
384 385 386 387
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

388
    TRACE( "fd: %d blocksize: 0x%08x\n", fd, data->BlockSize );
389 390 391 392 393 394 395 396 397 398 399 400 401 402
    
    cmd.mt_op = MTSETBLK;
    cmd.mt_count = data->BlockSize;

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}
        
/******************************************************************
 *      TAPE_SetPosition
 */
403
static NTSTATUS TAPE_SetPosition( int fd, const TAPE_SET_POSITION *data )
404 405 406 407
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

408 409 410
    TRACE( "fd: %d method: 0x%08x partition: 0x%08x offset: 0x%x%08x immediate: 0x%02x\n",
           fd, data->Method, data->Partition, (DWORD)(data->Offset.QuadPart >> 32),
           (DWORD)data->Offset.QuadPart, data->Immediate );
411

412 413 414 415
    if (sizeof(cmd.mt_count) < sizeof(data->Offset.QuadPart) &&
        (int)data->Offset.QuadPart != data->Offset.QuadPart)
    {
        ERR("Offset too large or too small\n");
416
        return STATUS_INVALID_PARAMETER;
417
    }
418 419 420 421 422 423

    switch (data->Method)
    {
    case TAPE_REWIND:
        cmd.mt_op = MTREW;
        break;
424
#ifdef MTSEEK
425 426
    case TAPE_ABSOLUTE_BLOCK:
        cmd.mt_op = MTSEEK;
427
        cmd.mt_count = data->Offset.QuadPart;
428
        break;
429 430
#endif
#ifdef MTEOM
431 432 433
    case TAPE_SPACE_END_OF_DATA:
        cmd.mt_op = MTEOM;
        break;
434
#endif
435
    case TAPE_SPACE_FILEMARKS:
436
        if (data->Offset.QuadPart >= 0) {
437
            cmd.mt_op = MTFSF;
438
            cmd.mt_count = data->Offset.QuadPart;
439 440 441
        }
        else {
            cmd.mt_op = MTBSF;
442
            cmd.mt_count = -data->Offset.QuadPart;
443
        }
444
        break;
445
#if defined(MTFSS) && defined(MTBSS)
446
    case TAPE_SPACE_SETMARKS:
447
        if (data->Offset.QuadPart >= 0) {
448
            cmd.mt_op = MTFSS;
449
            cmd.mt_count = data->Offset.QuadPart;
450 451 452
        }
        else {
            cmd.mt_op = MTBSS;
453
            cmd.mt_count = -data->Offset.QuadPart;
454
        }
455
        break;
456
#endif
457 458 459 460 461 462 463 464
    case TAPE_LOGICAL_BLOCK:
    case TAPE_PSEUDO_LOGICAL_BLOCK:
    case TAPE_SPACE_RELATIVE_BLOCKS:
    case TAPE_SPACE_SEQUENTIAL_FMKS:
    case TAPE_SPACE_SEQUENTIAL_SMKS:
        WARN( "Positioning method not supported\n" );
        return STATUS_INVALID_PARAMETER;
    default:
465
        ERR( "Unhandled method: 0x%08x\n", data->Method );
466 467 468 469 470 471 472 473 474 475 476 477 478
        return STATUS_INVALID_PARAMETER;
    }

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *      TAPE_WriteMarks
 */
479
static NTSTATUS TAPE_WriteMarks( int fd, const TAPE_WRITE_MARKS *data )
480 481 482 483
{
#ifdef HAVE_SYS_MTIO_H
    struct mtop cmd;

484
    TRACE( "fd: %d type: 0x%08x count: 0x%08x immediate: 0x%02x\n",
485 486 487 488
           fd, data->Type, data->Count, data->Immediate );

    switch (data->Type)
    {
489
#ifdef MTWSM
490 491 492 493
    case TAPE_SETMARKS:
        cmd.mt_op = MTWSM;
        cmd.mt_count = data->Count;
        break;
494
#endif
495 496 497 498 499 500 501
    case TAPE_FILEMARKS:
    case TAPE_SHORT_FILEMARKS:
    case TAPE_LONG_FILEMARKS:
        cmd.mt_op = MTWEOF;
        cmd.mt_count = data->Count;
        break;
    default:
502
        ERR( "Unhandled type: 0x%08x\n", data->Type );
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
        return STATUS_INVALID_PARAMETER;
    }

    return TAPE_GetStatus( ioctl( fd, MTIOCTOP, &cmd ) );
#else
    FIXME( "Not implemented.\n" );
    return STATUS_NOT_SUPPORTED;
#endif
}

/******************************************************************
 *		TAPE_DeviceIoControl
 *
 * SEE ALSO
 *   NtDeviceIoControl.
 */
NTSTATUS TAPE_DeviceIoControl( HANDLE device, HANDLE event,
    PIO_APC_ROUTINE apc, PVOID apc_user, PIO_STATUS_BLOCK io_status,
    ULONG io_control, LPVOID in_buffer, DWORD in_size,
    LPVOID out_buffer, DWORD out_size )
{
    DWORD sz = 0;
    NTSTATUS status = STATUS_INVALID_PARAMETER;
526
    int fd, needs_close;
527

528
    TRACE( "%p %s %p %d %p %d %p\n", device, io2str(io_control),
529 530 531 532
           in_buffer, in_size, out_buffer, out_size, io_status );

    io_status->Information = 0;

533
    if ((status = server_get_unix_fd( device, 0, &fd, &needs_close, NULL, NULL )))
534 535 536 537 538
        goto error;

    switch (io_control)
    {
    case IOCTL_TAPE_CREATE_PARTITION:
539
        status = TAPE_CreatePartition( fd, in_buffer );
540 541
        break;
    case IOCTL_TAPE_ERASE:
542
        status = TAPE_Erase( fd, in_buffer );
543 544
        break;
    case IOCTL_TAPE_GET_DRIVE_PARAMS:
545
        status = TAPE_GetDriveParams( fd, out_buffer );
546 547
        break;
    case IOCTL_TAPE_GET_MEDIA_PARAMS:
548
        status = TAPE_GetMediaParams( fd, out_buffer );
549
        break;
550
    case IOCTL_TAPE_GET_POSITION:
551
        status = TAPE_GetPosition( fd, ((TAPE_GET_POSITION *)in_buffer)->Type,
552
                                   out_buffer );
553 554 555 556 557
        break;
    case IOCTL_TAPE_GET_STATUS:
        status = FILE_GetNtStatus();
        break;
    case IOCTL_TAPE_PREPARE:
558
        status = TAPE_Prepare( fd, in_buffer );
559 560
        break;
    case IOCTL_TAPE_SET_DRIVE_PARAMS:
561
        status = TAPE_SetDriveParams( fd, in_buffer );
562 563
        break;
    case IOCTL_TAPE_SET_MEDIA_PARAMS:
564
        status = TAPE_SetMediaParams( fd, in_buffer );
565
        break;
566
    case IOCTL_TAPE_SET_POSITION:
567
        status = TAPE_SetPosition( fd, in_buffer );
568 569
        break;
    case IOCTL_TAPE_WRITE_MARKS:
570
        status = TAPE_WriteMarks( fd, in_buffer );
571 572 573 574 575 576
        break;

    case IOCTL_TAPE_CHECK_VERIFY:
    case IOCTL_TAPE_FIND_NEW_DEVICES:
        break;
    default:
577
        FIXME( "Unsupported IOCTL %x (type=%x access=%x func=%x meth=%x)\n",
578 579 580 581 582
               io_control, io_control >> 16, (io_control >> 14) & 3,
               (io_control >> 2) & 0xfff, io_control & 3 );
        break;
    }

583
    if (needs_close) close( fd );
584 585 586 587 588 589 590

error:
    io_status->u.Status = status;
    io_status->Information = sz;
    if (event) NtSetEvent( event, NULL );
    return status;
}