source/dscore/src/loadMgr.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2001 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _LOADMGR_H_
#define _LOADMGR_H_


/*--------------------------------  Includes  --------------------------------*/
#include "clDsmSystem.h"

#include "linkList.h"
#include "object.h"
#include "dsmObject.h"
#include "objectCarousel.h"
#ifdef __cplusplus
extern "C" {
#endif


/*-----------------------------  Exported Macros  ----------------------------*/

#define LOAD_REQUEST_MAGIC   0x4C525154 /*'LRQT'*/
#define CRSL_LOAD_TIMEOUT    50000

/*------------------------------  Exported Types  ----------------------------*/

typedef enum {
    LRS_INITIAL = 0,
    LRS_STALLED_DSI,
    LRS_STALLED_SRG_MODULE,
    LRS_STALLED_MODULE,
    LRS_ABORTED_TIMEOUT,
    LRS_ABORTED_PATH_ERROR,
    LRS_ABORTED_LOAD_ERROR,
    LRS_ABORTED_BY_REQUESTER,
    LRS_LOADED,
    LRS_LITE_OPTIONS_LOADED,
    LRS_LITE_OPTIONS_PENDING,
    LRS_ABORT_PENDING_RELOAD
} LRStatus_t;


typedef enum {
    TT_NONE = 0,
    TT_SRG,
    TT_GEN_OBJECT,
    TT_PREFETCH_DIR_OBJ,
    TT_PREFETCH_NON_DIR_OBJ,
    TT_MODULE
} TargetType_t;

typedef struct LoadRequest_tag LoadRequest_t, *pLoadRequest_t;

typedef void (*LoadFinaliseFunc_t) ( pclDsmInstData_t idp,
    /*I*/ pLoadRequest_t pLoadRequest );

struct LoadRequest_tag {
    S_LLObject          llData[NUM_LISTS_LOAD_REQUEST];
    U32BIT              magic;
    LRStatus_t          status;             /* -- Curent load state */
    TargetType_t        targetKind;         /* -- Kind of final load target */

    pObjectCarousel_t   pObjCarousel;       /* -- OC this load is requested on */

    MemHandle           hDataCarousel;      /* -- DC that load is currently progressed to */
    MemHandle           hModule;            /* -- Module that load is currently progressed to */

    DeliveryParaTap_t   tap;                /* -- Next tap that load needs */
    ObjectLocation_t    objectLocation;     /* -- Next object that load needs */

    clDsmCachingRules_t cachingRules;

    /* -- Reference/handle to target */
    union {
        pDsmObject_t    pDsmObject;
        MemHandle       hOC;
    } targetRef;

    LoadFinaliseFunc_t  loadFinaliseFunc;   /* -- Callback */

    U32BIT              targetObjectOffset; /* -- NB. From start of moduleData */
    ObjectDataInfo_t    targetObjectInfo;

    /* -- Requester userData */
    void*               loadUserData;

    U32BIT              userTimeout;        /* -- Original timeout set on load */
                                            /* TODO: May not need to store timeout in loadRequest */

    BOOLEAN             clientRequest;      /* -- True = this load was requested
                                               -- by an external client (ie. not
                                               -- an internal pre-fetch */

    U32BIT              remainingPathOffset;
    MemHandle           hRemainingPath;

    BOOLEAN             temporary;          /* -- True = this is a temporary
                                             * -- request, do not store it */

};


/*------------------------------  Exported Data  -----------------------------*/


/*---------------------------  Exported Prototypes  --------------------------*/
#ifdef DSM_NO_MEM_CONTEXT
#define lmSetModuleCachingRules( x, a, b )  lmSetModuleCachingRules( a, b )
#endif

clDsmErr_t lmCarouselLoadCreate( pclDsmInstData_t idp, pObjectCarousel_t pOC,
    U32BIT timeout, MemHandle *phLoadRequest );

clDsmErr_t lmUpdateCarouselBoot( pclDsmInstData_t idp, pObjectCarousel_t pOC,
    clDsmCarouselInfo_t *pCarouselInfo );


clDsmErr_t lmRequestObjectLoad( pclDsmInstData_t idp,
    pObjectCarousel_t pOC, U8BIT* path, U32BIT timeout,
    H_ObjUserData pUserData, U32BIT sizeOfUserData,
    pDsmObject_t pDsmObject,
    MemHandle *phLoadRequest );

clDsmErr_t lmPrefetchObjectLoad( pclDsmInstData_t idp,
    pObjectCarousel_t pOC, U8BIT* path, U32BIT timeout,
    MemHandle *phLoadRequest );

void lmLoadDestroy( pclDsmInstData_t idp,
    MemHandle *phLoadRequest );

clDsmErr_t lmGetObjectLoadState( pclDsmInstData_t idp,
    /*I*/ pObjectCarousel_t pOC, U8BIT* path,
    /*O*/ BOOLEAN *pLoaded, MemHandle *phModule );

clDsmErr_t lmUpdateCarouselSRGInfo( pclDsmInstData_t idp,
    pObjectCarousel_t pOC, pDeliveryParaTap_t pSrgTap,
    pObjectLocation_t pSrgLocn );

clDsmErr_t lmUpdateDataCarousel( pclDsmInstData_t idp,
    pObjectCarousel_t pObjectCarousel, MemHandle *phDataCarousel,
    U32BIT transactionId, U8BIT* pDiiMsg, U16BIT diiMsgDataLen );

clDsmErr_t lmUpdateModule( pclDsmInstData_t idp,
    pObjectCarousel_t pOC, MemHandle *phModule );

void lmUnloadModule( pclDsmInstData_t idp, MemHandle *phModule );

void lmUnloadDataCarousel( pclDsmInstData_t idp, MemHandle *phDC );

void lmUnloadCarousel( pclDsmInstData_t idp, pObjectCarousel_t *ppOC );

void lmStopModuleLoadRequest( pclDsmInstData_t idp, MemHandle *phLoadRequest );

void lmSetObjectModuleLoaded( pclDsmInstData_t idp, MemHandle hModule );

void lmSetObjectModuleUnloaded( pclDsmInstData_t idp, MemHandle *phModule );

void lmAbortCarouselLoadRequest( pclDsmInstData_t idp, pObjectCarousel_t pOC );

void lmAbortLoadRequestsOnModuleTimeout( pclDsmInstData_t idp, MemHandle *phModule);

  clDsmErr_t lmLiteOptionsObjectHandle(pclDsmInstData_t  idp,
                   U8BIT            *name,
                   pLoadRequest_t   pLoadRequest );

clDsmErr_t lmLiteOptionsObjectOnModuleUpdate(pclDsmInstData_t  idp,
                    U8BIT            *name,
                    pObjectCarousel_t pCurrOC ,
                    MemHandle        hLoadedModule,
                    pLoadRequest_t   pLoadRequest );

/*----------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif /* _LOADMGR_H_ */