BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / C / PyEfiCompressor / EfiCompressor.c

/** @file\r
Efi Compressor\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <Python.h>\r
#include <Decompress.h>\r
\r
/*\r
 UefiDecompress(data_buffer, size, original_size)\r
*/\r
STATIC\r
PyObject*\r
UefiDecompress(\r
  PyObject    *Self,\r
  PyObject    *Args\r
  )\r
{\r
  PyObject      *SrcData;\r
  UINT32        SrcDataSize;\r
  UINT32        DstDataSize;\r
  UINTN         Status;\r
  UINT8         *SrcBuf;\r
  UINT8         *DstBuf;\r
  UINT8         *TmpBuf;\r
  Py_ssize_t    SegNum;\r
  Py_ssize_t    Index;\r
\r
  Status = PyArg_ParseTuple(\r
            Args,\r
            "Oi",\r
            &SrcData,\r
            &SrcDataSize\r
            );\r
  if (Status == 0) {\r
    return NULL;\r
  }\r
\r
  if (SrcData->ob_type->tp_as_buffer == NULL\r
      || SrcData->ob_type->tp_as_buffer->bf_getreadbuffer == NULL\r
      || SrcData->ob_type->tp_as_buffer->bf_getsegcount == NULL) {\r
    PyErr_SetString(PyExc_Exception, "First argument is not a buffer\n");\r
    return NULL;\r
  }\r
\r
  // Because some Python objects which support "buffer" protocol have more than one\r
  // memory segment, we have to copy them into a contiguous memory.\r
  SrcBuf = PyMem_Malloc(SrcDataSize);\r
  if (SrcBuf == NULL) {\r
    PyErr_SetString(PyExc_Exception, "Not enough memory\n");\r
    goto ERROR;\r
  }\r
\r
  SegNum = SrcData->ob_type->tp_as_buffer->bf_getsegcount((PyObject *)SrcData, NULL);\r
  TmpBuf = SrcBuf;\r
  for (Index = 0; Index < SegNum; ++Index) {\r
    VOID *BufSeg;\r
    Py_ssize_t Len;\r
\r
    Len = SrcData->ob_type->tp_as_buffer->bf_getreadbuffer((PyObject *)SrcData, Index, &BufSeg);\r
    if (Len < 0) {\r
      PyErr_SetString(PyExc_Exception, "Buffer segment is not available\n");\r
      goto ERROR;\r
    }\r
    memcpy(TmpBuf, BufSeg, Len);\r
    TmpBuf += Len;\r
  }\r
\r
  Status = Extract((VOID *)SrcBuf, SrcDataSize, (VOID **)&DstBuf, &DstDataSize, 1);\r
  if (Status != EFI_SUCCESS) {\r
    PyErr_SetString(PyExc_Exception, "Failed to decompress\n");\r
    goto ERROR;\r
  }\r
\r
  return PyBuffer_FromMemory(DstBuf, (Py_ssize_t)DstDataSize);\r
\r
ERROR:\r
  if (SrcBuf != NULL) {\r
    free(SrcBuf);\r
  }\r
\r
  if (DstBuf != NULL) {\r
    free(DstBuf);\r
  }\r
  return NULL;\r
}\r
\r
\r
STATIC\r
PyObject*\r
FrameworkDecompress(\r
  PyObject    *Self,\r
  PyObject    *Args\r
  )\r
{\r
  PyObject      *SrcData;\r
  UINT32        SrcDataSize;\r
  UINT32        DstDataSize;\r
  UINTN         Status;\r
  UINT8         *SrcBuf;\r
  UINT8         *DstBuf;\r
  UINT8         *TmpBuf;\r
  Py_ssize_t    SegNum;\r
  Py_ssize_t    Index;\r
\r
  Status = PyArg_ParseTuple(\r
            Args,\r
            "Oi",\r
            &SrcData,\r
            &SrcDataSize\r
            );\r
  if (Status == 0) {\r
    return NULL;\r
  }\r
\r
  if (SrcData->ob_type->tp_as_buffer == NULL\r
      || SrcData->ob_type->tp_as_buffer->bf_getreadbuffer == NULL\r
      || SrcData->ob_type->tp_as_buffer->bf_getsegcount == NULL) {\r
    PyErr_SetString(PyExc_Exception, "First argument is not a buffer\n");\r
    return NULL;\r
  }\r
\r
  // Because some Python objects which support "buffer" protocol have more than one\r
  // memory segment, we have to copy them into a contiguous memory.\r
  SrcBuf = PyMem_Malloc(SrcDataSize);\r
  if (SrcBuf == NULL) {\r
    PyErr_SetString(PyExc_Exception, "Not enough memory\n");\r
    goto ERROR;\r
  }\r
\r
  SegNum = SrcData->ob_type->tp_as_buffer->bf_getsegcount((PyObject *)SrcData, NULL);\r
  TmpBuf = SrcBuf;\r
  for (Index = 0; Index < SegNum; ++Index) {\r
    VOID *BufSeg;\r
    Py_ssize_t Len;\r
\r
    Len = SrcData->ob_type->tp_as_buffer->bf_getreadbuffer((PyObject *)SrcData, Index, &BufSeg);\r
    if (Len < 0) {\r
      PyErr_SetString(PyExc_Exception, "Buffer segment is not available\n");\r
      goto ERROR;\r
    }\r
    memcpy(TmpBuf, BufSeg, Len);\r
    TmpBuf += Len;\r
  }\r
\r
  Status = Extract((VOID *)SrcBuf, SrcDataSize, (VOID **)&DstBuf, &DstDataSize, 2);\r
  if (Status != EFI_SUCCESS) {\r
    PyErr_SetString(PyExc_Exception, "Failed to decompress\n");\r
    goto ERROR;\r
  }\r
\r
  return PyString_FromStringAndSize((CONST INT8*)DstBuf, (Py_ssize_t)DstDataSize);\r
\r
ERROR:\r
  if (SrcBuf != NULL) {\r
    free(SrcBuf);\r
  }\r
\r
  if (DstBuf != NULL) {\r
    free(DstBuf);\r
  }\r
  return NULL;\r
}\r
\r
\r
STATIC\r
PyObject*\r
UefiCompress(\r
  PyObject    *Self,\r
  PyObject    *Args\r
  )\r
{\r
  return NULL;\r
}\r
\r
\r
STATIC\r
PyObject*\r
FrameworkCompress(\r
  PyObject    *Self,\r
  PyObject    *Args\r
  )\r
{\r
  return NULL;\r
}\r
\r
STATIC INT8 DecompressDocs[] = "Decompress(): Decompress data using UEFI standard algorithm\n";\r
STATIC INT8 CompressDocs[] = "Compress(): Compress data using UEFI standard algorithm\n";\r
\r
STATIC PyMethodDef EfiCompressor_Funcs[] = {\r
  {"UefiDecompress", (PyCFunction)UefiDecompress, METH_VARARGS, DecompressDocs},\r
  {"UefiCompress", (PyCFunction)UefiCompress, METH_VARARGS, DecompressDocs},\r
  {"FrameworkDecompress", (PyCFunction)FrameworkDecompress, METH_VARARGS, DecompressDocs},\r
  {"FrameworkCompress", (PyCFunction)FrameworkCompress, METH_VARARGS, DecompressDocs},\r
  {NULL, NULL, 0, NULL}\r
};\r
\r
PyMODINIT_FUNC\r
initEfiCompressor(VOID) {\r
  Py_InitModule3("EfiCompressor", EfiCompressor_Funcs, "EFI Compression Algorithm Extension Module");\r
}\r
\r
\r