Skip to content

Commit

Permalink
Introduce Policy Service package for handling data producer/consumers…
Browse files Browse the repository at this point in the history 
… across phases

Creates a policy service for handling producing and creating policy accross phases.

Issue microsoft#867

cherry-pick from 238909f, c09449a, 13f011b, a8dee78, ab9d819, fbb9af5, 058d734
  • Loading branch information
@cfernald
cfernald committed Jun 20, 2024
1 parent e34854f commit f4250a4
Show file tree
Hide file tree
Showing 52 changed files with 6,447 additions and 0 deletions.
1 change: 1 addition & 0 deletions .pytool/CISettings.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ def GetPackagesSupported(self):
"MdeModulePkg",
"NetworkPkg",
"PcAtChipsetPkg",
"PolicyServicePkg",
"ShellPkg",
"StandaloneMmPkg",
"UefiCpuPkg",
Expand Down
234 changes: 234 additions & 0 deletions PolicyServicePkg/Include/Library/PolicyLib.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,234 @@
/** @file
Definitions for the policy libraries.
Copyright (c) Microsoft Corporation
SPDX-License-Identifier: BSD-2-Clause-Patent
**/

#ifndef _POLICY_LIB_H_
#define _POLICY_LIB_H_

#include <PolicyInterface.h>

#define VERIFIED_POLICY_LIB_VERSION 1

#pragma pack(1)

typedef struct _VERIFIED_POLICY_HEADER {
UINT64 Signature;
UINT16 MajorVersion;
UINT16 MinorVersion;
UINT32 Size;
} VERIFIED_POLICY_HEADER;

#pragma pack()

typedef VERIFIED_POLICY_HEADER VERIFIED_POLICY_DESCRIPTOR;

/**
Creates or updates a policy in the policy store. Will notify any applicable
callbacks.
@param[in] PolicyGuid The uniquely identifying GUID for the policy.
@param[in] Attributes Attributes of the policy to be set.
@param[in] Policy The policy data buffer. This buffer will be
copied into the data store.
@param[in] PolicySize The size of the provided policy data.
@retval EFI_SUCCESS Policy was created or updated.
@retval EFI_ACCESS_DENIED Policy was already finalized prior to this call.
@retval EFI_OUT_OF_RESOURCES Failed to allocate space for policy structures.
**/
EFI_STATUS
EFIAPI
SetPolicy (
IN CONST EFI_GUID *PolicyGuid,
IN UINT64 Attributes,
IN VOID *Policy,
IN UINT16 PolicySize
);

/**
Retrieves the policy descriptor, buffer, and size for a given policy GUID.
@param[in] PolicyGuid The GUID of the policy being retrieved.
@param[out] Attributes The attributes of the stored policy.
@param[out] Policy The buffer where the policy data is copied.
@param[in,out] PolicySize The size of the stored policy data buffer.
On output, contains the size of the stored policy.
@retval EFI_SUCCESS The policy was retrieved.
@retval EFI_BUFFER_TOO_SMALL The provided buffer size was too small.
@retval EFI_NOT_FOUND The policy does not exist.
**/
EFI_STATUS
EFIAPI
GetPolicy (
IN CONST EFI_GUID *PolicyGuid,
OUT UINT64 *Attributes OPTIONAL,
OUT VOID *Policy,
IN OUT UINT16 *PolicySize
);

/**
Removes a policy from the policy store. The policy will be removed from the store
and freed if possible.
@param[in] PolicyGuid The GUID of the policy being retrieved.
@retval EFI_SUCCESS The policy was removed.
@retval EFI_NOT_FOUND The policy does not exist.
**/
EFI_STATUS
EFIAPI
RemovePolicy (
IN CONST EFI_GUID *PolicyGuid
);

/**
Registers a callback for a policy event notification. The provided routine
will be invoked when one of multiple of the provided event types for the specified
guid occurs.
@param[in] PolicyGuid The GUID of the policy the being watched.
@param[in] EventTypes The events to notify the callback for.
@param[in] Priority The priority of the callback where the lower values
will be called first.
@param[in] CallbackRoutine The function pointer of the callback to be invoked.
@param[out] Handle Returns the handle to this callback entry.
@retval EFI_SUCCESS The callback notification as successfully registered.
@retval EFI_INVALID_PARAMETER EventTypes was 0 or Callback routine is invalid.
@retval Other The callback registration failed.
**/
EFI_STATUS
EFIAPI
RegisterPolicyNotify (
IN CONST EFI_GUID *PolicyGuid,
IN CONST UINT32 EventTypes,
IN CONST UINT32 Priority,
IN POLICY_HANDLER_CALLBACK CallbackRoutine,
OUT VOID **Handle
);

/**
Removes a registered notification callback.
@param[in] Handle The handle for the registered callback.
@retval EFI_SUCCESS The callback notification as successfully removed.
@retval EFI_INVALID_PARAMETER The provided handle is invalid.
@retval EFI_NOT_FOUND The provided handle could not be found.
**/
EFI_STATUS
EFIAPI
UnregisterPolicyNotify (
IN VOID *Handle
);

/**
Retrieves a verified policy of the given type from the policy store.
@param[in] PolicyGuid The GUID of policy in the policy store.
@param[in] Descriptor The descriptor for the verified policy data
structure.
@param[out] Attributes Returns the attributes of the policy in the
policy store.
@param[out] DataHandle Returns the handle to the verified policy.
@retval EFI_SUCCESS The policy was successfully retrieved.
@retval EFI_BAD_BUFFER_SIZE The policy was an unexpected size.
@retval EFI_INCOMPATIBLE_VERSION The verified policy major version did not
match.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
RETURN_STATUS
EFIAPI
GetVerifiedPolicy (
IN CONST EFI_GUID *PolicyGuid,
IN CONST VERIFIED_POLICY_DESCRIPTOR *Descriptor,
OUT UINT64 *Attributes OPTIONAL,
OUT EFI_HANDLE *DataHandle
);

/**
Creates a new verified policy data structure.
@param[in] Descriptor The descriptor of the verified policy data structure
to be created.
@param[out] DataHandle The handle to the newly created verified policy data
structure.
@retval EFI_SUCCESS The data structure was successfully created.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
**/
RETURN_STATUS
EFIAPI
CreateVerifiedPolicy (
IN CONST VERIFIED_POLICY_DESCRIPTOR *Descriptor,
OUT EFI_HANDLE *DataHandle
);

/**
Write a verified policy to the policy store.
@param[in] PolicyGuid The GUID of policy in the policy store.
@param[in] Attributes The attributes to set in the policy store.
@param[in] DataHandle The handle to the policy data.
@retval EFI_SUCCESS The policy was successfully retrieved.
@retval EFI_INVALID_PARAMETER DataHandle is NULL.
@retval EFI_BAD_BUFFER_SIZE The policy is too large.
**/
RETURN_STATUS
EFIAPI
SetVerifiedPolicy (
IN CONST EFI_GUID *PolicyGuid,
IN UINT64 Attributes,
IN EFI_HANDLE DataHandle
);

/**
Closes a policy data handle.
@param[in] DataHandle The policy handle to be closed.
@retval EFI_SUCCESS The policy handle was successfully
closed.
@retval EFI_INVALID_PARAMETER The data handle is NULL.
**/
RETURN_STATUS
EFIAPI
CloseVerifiedPolicy (
IN EFI_HANDLE DataHandle
);

/**
Records access to a policy data structure used by autogenerated code. This
function should not be manually called.
@param[in] DataHandle The policy handle where the access was made.
@param[in] CallerGuid The file guid of the caller for tracking access.
@param[in] Offset The offset into the policy data for the access.
@param[in] Size The size of the access.
@param[in] Write Indicates if the policy was written to.
**/
VOID
EFIAPI
ReportVerifiedPolicyAccess (
IN EFI_HANDLE DataHandle,
IN CONST EFI_GUID *CallerGuid,
IN UINT32 Offset,
IN UINT32 Size,
IN BOOLEAN Write
);

#endif
Loading

0 comments on commit f4250a4

Please sign in to comment.