grub-devel.gnu.org archive mirror
 help / color / mirror / Atom feed
* Re: New command to check NT's hibernation state
@ 2013-11-04  1:55 Peter Lustig
  0 siblings, 0 replies; 20+ messages in thread
From: Peter Lustig @ 2013-11-04  1:55 UTC (permalink / raw)
  To: grub-devel

[-- Attachment #1: Type: text/plain, Size: 9653 bytes --]

Thanks for the update.  I'm glad to hear it made the cut.


On Sun, Nov 3, 2013 at 7:49 PM, Vladimir 'φ-coder/phcoder' Serbinenko <
phcoder@gmail.com> wrote:

>
>
>
> -------- Original Message --------
> Subject: Re: New command to check NT's hibernation state
> Date: Mon, 04 Nov 2013 01:48:51 +0100
> From: Vladimir 'φ-coder/phcoder' Serbinenko <phcoder@gmail.com>
> To: grub-devel@gnu.org
>
> Going through e-mail archives found this one, looks like it got
> forgotten. Fixed problems with it and simplified greatly and committed.
> On 18.12.2011 04:16, Peter Lustig wrote:
> > On 17.12.2011 00:41, Vladimir 'phcoder' Serbinenko wrote:
> >
> >> /* nthibr.c - tests whether an MS Windows system partition is
> >> hibernated */
> >> /*
> >>    *  GRUB  --  GRand Unified Bootloader
> >>    *  Copyright (C) 2007,2008,2009,2011  Free Software Foundation, Inc.
> >>    *
> >>    *  GRUB is free software: you can redistribute it and/or modify
> >>    *  it under the terms of the GNU General Public License as
> >> published by
> >>    *  the Free Software Foundation, either version 3 of the License, or
> >>    *  (at your option) any later version.
> >>    *
> >>    *  GRUB 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 General Public License for more details.
> >>    *
> >>    *  You should have received a copy of the GNU General Public License
> >>    *  along with GRUB.  If not, see<http://www.gnu.org/licenses/>.
> >>    */
> >>
> >> #include<grub/types.h>
> >> #include<grub/mm.h>
> >> #include<grub/disk.h>
> >> #include<grub/file.h>
> >> #include<grub/misc.h>
> >> #include<grub/dl.h>
> >> #include<grub/extcmd.h>
> >> #include<grub/lib/arg.h>
> >> #include<grub/err.h>
> >> #include<grub/i18n.h>
> >>
> >> GRUB_MOD_LICENSE("GPLv3+");
> >>
> >> /* Define this 'empty' array to let the '-h' and '-u' switches be
> >> processed */
> >> static const struct grub_arg_option options[] = {
> >>     {0, 0, 0, 0, 0, 0}
> >> };
> >> Please remove this and use grub_command_t
> >> I understand now.  What threw me off was seeing the 'hello' module use
> >> 'extcmd.'
> >>>> static grub_err_t
> >>>> grub_cmd_nthibr (grub_extcmd_context_t ctxt __attribute__ ((unused)),
> >>>>                    int argc, char **args)
> >>>> {
> >>>>     char *partition_name = 0, *hibr_file_path = 0, hibr_file_magic[5];
> >>>>     grub_size_t name_length;
> >>>>     grub_ssize_t magic_size;
> >>>>     grub_disk_t partition;
> >>>>     grub_file_t hibr_file = 0;
> >>>>
> >>>>     /* Check argument count */
> >>>>     if (!argc)
> >>>>       return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("too few
> >>>> arguments"));
> >>>>     else if (argc>   1)
> >>>>       return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("too many
> >>>> arguments"));
> >>>>
> >>> Either ignore trailing argument or put both in one check != 1
> >>>>     /* Make copy of partition specifier, so it can be modified (if
> >>>> needed) */
> >>>>     name_length = grub_strlen (args[0]);
> >>>>     partition_name = grub_zalloc (name_length + 3);
> >>>>     if (!partition_name)
> >>>>       goto exit;
> >>>>     grub_strcpy (partition_name, args[0]);
> >>>>
> >>>>     /* Ensure partition specifier start with a '(' */
> >>>>     if (partition_name[0] != '(')
> >>>>       {
> >>>>         grub_memmove (partition_name + 1, partition_name,
> >>>> name_length++);
> >>>>         partition_name[0] = '(';
> >>>>       }
> >>>>
> >>>>     /* Ensure partition specifier ends with a ')' */
> >>>>     if (partition_name[name_length - 1] != ')')
> >>>>       partition_name[(++name_length) - 1] = ')';
> >>>>
> >>>>     /* Check if partition actually exists */
> >>>>     partition_name[name_length - 1] = '\0';
> >>>>     partition = grub_disk_open (partition_name + 1);
> >>>>     if (!partition)
> >>>>       goto exit;
> >>>>     grub_disk_close (partition);
> >>>>     partition_name[name_length - 1] = ')';
> >>>>
> >>>>     /* Build path to 'hiberfil.sys' */
> >>>>     hibr_file_path = grub_malloc ((grub_strlen (partition_name)
> >>>>                                    + grub_strlen ("/hiberfil.sys") +
> >>>> 1));
> >>>>     if (!hibr_file_path)
> >>>>       goto exit;
> >>>>     grub_strcpy (hibr_file_path, partition_name);
> >>>>     grub_strcat (hibr_file_path, "/hiberfil.sys");
> >>>>
> >>> It would be more efficient if you just try to open file and see what
> >>> error you get. Actually you don't even need to distinguish between
> >>> error cases here since you return the error you encountered. This will
> >>> also save one useless alloc.
> >>>>     /* Try to open 'hiberfil.sys' */
> >>>>     hibr_file = grub_file_open (hibr_file_path);
> >>>>     if (!hibr_file)
> >>>>       {
> >>>>         if (grub_errno == GRUB_ERR_FILE_NOT_FOUND)
> >>>>           grub_error (GRUB_ERR_FILE_NOT_FOUND, N_("'hiberfil.sys' not
> >>>> found"));
> >>> This overriding is unnecessary. FS code already provides this message
> >> This was intentional:  the default message ('file not found') is not
> >> particularly helpful in this case since the
> >> command's description nowhere mentions what file it's looking for (let
> >> alone that any file is needed for it to
> >> function).  I've updated this section to pop the first error off the
> >> stack to eliminate the duplication (and added
> >> a descriptive comment).
> >>>>         goto exit;
> >>>>       }
> >>>>
> >>>>     /* Try to read magic number of 'hiberfil.sys' */
> >>>>     magic_size = sizeof (hibr_file_magic) - 1;
> >>>>     grub_memset (hibr_file_magic, 0, sizeof (hibr_file_magic));
> >>>>     if (grub_file_read (hibr_file, hibr_file_magic, magic_size)<
> >>>> magic_size)
> >>>>       {
> >>>>         if (!grub_errno)
> >>>>           grub_error (GRUB_ERR_BAD_FILE_TYPE, N_("'hiberfil.sys' too
> >>>> small"));
> >>>>         goto exit;
> >>>>       }
> >>>>
> >>>>     /* Return SUCCESS if magic indicates file is active; else return
> >>>> FAILURE */
> >>>>     if (!grub_strncasecmp ("hibr", hibr_file_magic, magic_size))
> >>>>       grub_error (GRUB_ERR_NONE, "true");
> >>>>     else
> >>>>       grub_error (GRUB_ERR_TEST_FAILURE, "false");
> >>>>
> >>>> exit:
> >>>>     /* Ensure unmanaged resources are cleaned up */
> >>>>     if (partition_name)
> >>>>       grub_free (partition_name);
> >>>>     if (hibr_file_path)
> >>>>       grub_free (hibr_file_path);
> >>> No need to check that argument to free is non-NULL.
> >>>>     if (hibr_file)
> >>>>       grub_file_close (hibr_file);
> >>>>
> >>>>     return grub_errno;
> >>>> }
> >>>>
> >>>> static grub_extcmd_t cmd;
> >>>>
> >>>> GRUB_MOD_INIT (nthibr)
> >>>> {
> >>>>     cmd = grub_register_extcmd ("nthibr", grub_cmd_nthibr, 0,
> >>>>                                 N_("DEVICE"),
> >>>>                                 N_("Test whether an NT system
> >>>> partition "
> >>>>                                    "is hibernated."),
> >>>>                                 options);
> >>>> }
> >>>>
> >>>> GRUB_MOD_FINI (nthibr)
> >>>> {
> >>>>     grub_unregister_extcmd (cmd);
> >>>> }
> >>>>
> >> ~Peter Lustig
> >> -------------- next part --------------
> >> An HTML attachment was scrubbed...
> >> URL:<
> http://lists.gnu.org/archive/html/grub-devel/attachments/20111217/71127c00/attachment.html
> >
> >>
> >> -------------- next part --------------
> >> An embedded and charset-unspecified text was scrubbed...
> >> Name: nthibr.c
> >> URL:<
> http://lists.gnu.org/archive/html/grub-devel/attachments/20111217/71127c00/attachment.c
> >
> >>
> >>
> >> ------------------------------
> >>
> >> Message: 2
> >> Date: Sat, 17 Dec 2011 12:39:41 +0100
> >> From: Vladimir '?-coder/phcoder' Serbinenko     <phcoder@gmail.com>
> >> To:grub-devel@gnu.org
> >> Subject: Re: New command to check NT's hibernation state
> >> Message-ID:<4EEC7F7D.2050900@gmail.com>
> >> Content-Type: text/plain; charset=UTF-8; format=flowed
> >>
> >>
> >>>>>     /* Try to open 'hiberfil.sys' */
> >>>>>     hibr_file = grub_file_open (hibr_file_path);
> >>>>>     if (!hibr_file)
> >>>>>       {
> >>>>>         if (grub_errno == GRUB_ERR_FILE_NOT_FOUND)
> >>>>>           grub_error (GRUB_ERR_FILE_NOT_FOUND, N_("'hiberfil.sys' not
> >>>>> found"));
> >>>> This overriding is unnecessary. FS code already provides this message
> >>> This was intentional:  the default message ('file not found') is not
> >>> particularly helpful in this case since the
> >>> command's description nowhere mentions what file it's looking for (let
> >>> alone that any file is needed for it to
> >>> function).  I've updated this section to pop the first error off the
> >>> stack to eliminate the duplication (and added
> >>> a descriptive comment).
> >> This means that your copy of GRUB is old. Newer ones do have the
> >> descriptive message. And even if it wasn't the case it's something to be
> >> fixed in FS code, not by replacing error message here.
> > I've been using the latest release (1.99), so this fix must still be on
> > the development branch.  But I do appreciate
> > the idea of fixing something once at the source instead of at multiple
> > points of consumption.
> >
> >
> > _______________________________________________
> > Grub-devel mailing list
> > Grub-devel@gnu.org
> > https://lists.gnu.org/mailman/listinfo/grub-devel
> >
>
>
>
>
>
>
>

[-- Attachment #2: Type: text/html, Size: 13993 bytes --]

^ permalink raw reply	[flat|nested] 20+ messages in thread
[parent not found: <mailman.235.1324573308.26580.grub-devel@gnu.org>]
[parent not found: <mailman.213.1324054906.20674.grub-devel@gnu.org>]
[parent not found: <mailman.207.1322931671.23776.grub-devel@gnu.org>]
* Re: New command to check NT's hibernation state
@ 2011-12-03  4:57 Peter Lustig
  2011-12-03 10:41 ` Vladimir 'φ-coder/phcoder' Serbinenko
  0 siblings, 1 reply; 20+ messages in thread
From: Peter Lustig @ 2011-12-03  4:57 UTC (permalink / raw)
  To: grub-devel

[-- Attachment #1: Type: text/plain, Size: 1798 bytes --]

On 02.12.2011 07:05, Vladimir Serbinenko wrote:

>> P.S.  Do you know if there are any plans in the future to implement
>> write operations for filesystems?  (I noticed raw disk writing is
>> currently supported.)  If not, is the reason due to the technical
>> challenges (e.g. NTFS only had read-only access in GNU/Linux for quite
>> a while) or just a general lack of interest?
> Neither. Reliability concerns. Writing to filesystem is potentially
> dangerous and needs to be throughly tested. Since writing is rare for
> bootloader we won't receive enough testing of these code pathes so every
> write will remain a risk. We can't have such risks
I see. Just curious.

>>> Thanks for this. However the coding style isn't according to our
>>> standards. Could you adjust to the standard? I recommend looking at
>>> other code and reading GNU Coding Standard. E.g. we don't use {0}
>>> initialiser, return value of commands, C++ comments or M$-$tyle
>>> variables.
>> Sorry about that.  I've reviewed the standard and perused the source
>> tree, as you suggested, to determine the best style.  Attached is my
>> updated file.
>>
> Much better. There are still few problems like the arbitrary limit (we
> avoid any arbitrary limits, you have one easy to avoid on filename
> length). Also we don't use such ABORT macros as they offer no
> readability advantage. Review in more details when time permits.
Argh. I remember reading about avoiding arbitrary limits too.

I would contend that in this case the macros do improve readability (each
reducing 4-5 lines of code down to 1-2 lines); yet, to be consistent with the
rest of the source base, I've removed them.

Here's the file again.  Maybe the third time's the charm?

Thanks for being a stickler for conformance ( I mean it :) ),
Peter Lustig


[-- Attachment #2: nthibr.c --]
[-- Type: text/plain, Size: 4609 bytes --]

/* nthibr.c - tests whether an MS Windows system partition is hibernated */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2007,2008,2009,2011  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <grub/types.h>
#include <grub/mm.h>
#include <grub/disk.h>
#include <grub/file.h>
#include <grub/misc.h>
#include <grub/dl.h>
#include <grub/extcmd.h>
#include <grub/lib/arg.h>
#include <grub/err.h>
#include <grub/i18n.h>

GRUB_MOD_LICENSE("GPLv3+");

/* Define this 'empty' array to let the '-h' and '-u' switches be processed */
static const struct grub_arg_option options[] = {
  {0, 0, 0, 0, 0, 0}
};

static grub_err_t 
grub_cmd_nthibr (grub_extcmd_context_t ctxt __attribute__ ((unused)),
                 int argc, char **args)
{
  grub_err_t status = GRUB_ERR_NONE;
  char *partition_name, *hibr_file_path = 0, hibr_file_magic[5];
  grub_size_t name_length;
  grub_ssize_t magic_size;
  grub_disk_t partition;
  grub_file_t hibr_file = 0;

  /* Check argument count */
  if (!argc)
    {
      status = grub_error (GRUB_ERR_BAD_ARGUMENT, 
                           N_("too few arguments specified"));
      goto exit;
    }
  else if (argc > 1)
    {
      status = grub_error (GRUB_ERR_BAD_ARGUMENT, 
                           N_("too many arguments specified"));
      goto exit;
    }

  partition_name = args[0];
  name_length = grub_strlen (partition_name);

  /* Check if partition specifier 'looks right' */
  if (partition_name[0] != '(' || partition_name[name_length - 1] != ')')
    {
      status = grub_error (GRUB_ERR_BAD_FILENAME, 
                           N_("invalid partition specifier"));
      goto exit;
    }

  /* Check if partition actually exists */
  partition_name[name_length - 1] = '\0';
  partition = grub_disk_open (partition_name + 1);
  if (!partition)
    {
      status = grub_error (GRUB_ERR_UNKNOWN_DEVICE, 
                           N_("partition not found"));
      goto exit;
    }
  else 
    {
      grub_disk_close (partition);
      partition_name[name_length - 1] = ')';
    }

  /* Build path to 'hiberfil.sys' */
  hibr_file_path = grub_malloc (grub_strlen (partition_name) 
                                + grub_strlen ("/hiberfil.sys") + 1);
  if (!hibr_file_path)
    {
      status = grub_error (GRUB_ERR_OUT_OF_MEMORY,
                           N_("out of memory"));
      goto exit;
    }
  else
    {
      grub_strcpy (hibr_file_path, partition_name);
      grub_strcat (hibr_file_path, "/hiberfil.sys");
    }

  /* Try to open 'hiberfil.sys' */
  hibr_file = grub_file_open (hibr_file_path);
  if (!hibr_file)
    {
      status = grub_error (GRUB_ERR_FILE_NOT_FOUND, 
                           N_("'hiberfil.sys' not found"));
      goto exit;
    }

  /* Try to read magic number of 'hiberfil.sys' */
  magic_size = sizeof (hibr_file_magic) - 1;
  grub_memset (hibr_file_magic, 0, sizeof (hibr_file_magic));
  if (grub_file_read (hibr_file, hibr_file_magic, magic_size) < magic_size)
    {
      status = grub_error (GRUB_ERR_BAD_FILE_TYPE, 
                           N_("'hiberfil.sys' too small"));
      goto exit;
    }

  /* Return SUCCESS if magic indicates file is active; else return FAILURE */
  if (!grub_strncasecmp ("hibr", hibr_file_magic, magic_size))
    grub_puts (N_("The system is hibernated."));
  else 
    {
      grub_puts (N_("The system is NOT hibernated."));
      status = GRUB_ERR_TEST_FAILURE;
    }

exit: 
  /* Ensure unmanaged resources are cleaned up */
  if (hibr_file_path)
    grub_free (hibr_file_path);
  if (hibr_file)
    grub_file_close (hibr_file);

  return status;
}
\f
static grub_extcmd_t cmd;

GRUB_MOD_INIT (nthibr) 
{
  cmd = grub_register_extcmd ("nthibr", grub_cmd_nthibr, 0,
                              N_("DEVICE"),
                              N_("Test whether an NT system partition "
                                 "is hibernated."), 
                              options);
}

GRUB_MOD_FINI (nthibr) 
{
  grub_unregister_extcmd (cmd);
}

^ permalink raw reply	[flat|nested] 20+ messages in thread
* Re: Re: New command to check NT's hibernation state
@ 2011-12-02  5:16 Peter Lustig
  2011-12-02  6:05 ` Vladimir 'φ-coder/phcoder' Serbinenko
  0 siblings, 1 reply; 20+ messages in thread
From: Peter Lustig @ 2011-12-02  5:16 UTC (permalink / raw)
  To: grub-devel

[-- Attachment #1: Type: text/plain, Size: 799 bytes --]

> Thanks for this. However the coding style isn't according to our 
> standards. Could you adjust to the standard? I recommend looking at 
> other code and reading GNU Coding Standard. E.g. we don't use {0} 
> initialiser, return value of commands, C++ comments or M$-$tyle 
> variables. 

Sorry about that.  I've reviewed the standard and perused the source 
tree, as you suggested, to determine the best style.  Attached is my 
updated file.

Glad to be of help,
Peter Lustig

P.S.  Do you know if there are any plans in the future to implement 
write operations for filesystems?  (I noticed raw disk writing is 
currently supported.)  If not, is the reason due to the technical 
challenges (e.g. NTFS only had read-only access in GNU/Linux for quite a 
while) or just a general lack of interest?

[-- Attachment #2: nthibr.c --]
[-- Type: text/plain, Size: 4206 bytes --]

/* nthibr.c - tests whether an MS Windows system partition is hibernated */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2007,2008,2009,2011  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <grub/types.h>
#include <grub/disk.h>
#include <grub/file.h>
#include <grub/misc.h>
#include <grub/dl.h>
#include <grub/extcmd.h>
#include <grub/lib/arg.h>
#include <grub/err.h>
#include <grub/i18n.h>

GRUB_MOD_LICENSE("GPLv3+");

/* Define this 'empty' array to let the '-h' and '-u' switches be processed */
static const struct grub_arg_option options[] = {
  {0, 0, 0, 0, 0, 0}
};

static grub_err_t 
grub_cmd_nthibr (grub_extcmd_context_t ctxt __attribute__ ((unused)),
                 int argc, char **args)
{
  grub_err_t status = GRUB_ERR_NONE;
  char *partition_name, hibr_file_path[32], hibr_file_magic[5];
  grub_ssize_t length;
  grub_disk_t partition;
  grub_file_t hibr_file = 0;

# define ABORT(_code, _message)                     \
    do                                              \
      {                                             \
        status = grub_error ((_code), (_message));  \
        goto exit;                                  \
      }                                             \
    while (0)

  /* Check argument count */
  if (!argc)
    ABORT( GRUB_ERR_BAD_ARGUMENT, N_("too few arguments specified") );
  else if (argc > 1)
    ABORT( GRUB_ERR_BAD_ARGUMENT, N_("too many arguments specified") );

  partition_name = args[0];
  length = (grub_ssize_t) grub_strlen (partition_name);

  /* Check if partition specifier 'looks right' */
  if (partition_name[0] != '(' || partition_name[length - 1] != ')')
    ABORT( GRUB_ERR_BAD_FILENAME, N_("invalid partition specifier") );

  /* Check if partition actually exists */
  partition_name[length - 1] = '\0';
  partition = grub_disk_open (partition_name + 1);
  if (!partition)
    ABORT( GRUB_ERR_UNKNOWN_DEVICE, N_("partition not found") );
  else 
    {
      grub_disk_close (partition);
      partition_name[length - 1] = ')';
    }

  /* Build path to 'hiberfil.sys' */
  grub_strncpy (hibr_file_path, partition_name, sizeof (hibr_file_path) - 1);
  grub_strncat (hibr_file_path, "/hiberfil.sys", 
                sizeof (hibr_file_path) - grub_strlen (hibr_file_path) - 1);

  /* Try to open 'hiberfil.sys' */
  hibr_file = grub_file_open (hibr_file_path);
  if (!hibr_file)
    ABORT( GRUB_ERR_FILE_NOT_FOUND, N_("'hiberfil.sys' not found") );

  /* Try to read magic number of 'hiberfil.sys' */
  length = (grub_ssize_t) (sizeof (hibr_file_magic) - 1);
  grub_memset (hibr_file_magic, 0, sizeof (hibr_file_magic));
  if (grub_file_read (hibr_file, hibr_file_magic, length) < length)
    ABORT( GRUB_ERR_BAD_FILE_TYPE, N_("'hiberfil.sys' too small") );

  /* Return SUCCESS if magic indicates file is active; else return FAILURE */
  if (!grub_strncasecmp ("hibr", hibr_file_magic, length))
    grub_puts (N_("The system is hibernated."));
  else 
    {
      grub_puts (N_("The system is NOT hibernated."));
      status = GRUB_ERR_TEST_FAILURE;
    }

exit: 
  /* Ensure 'hiberfil.sys' is closed */
  if (hibr_file)
    grub_file_close (hibr_file);

# undef ABORT
  return status;
}
\f
static grub_extcmd_t cmd;

GRUB_MOD_INIT (nthibr) 
{
  cmd = grub_register_extcmd ("nthibr", grub_cmd_nthibr, 0,
                              N_("DEVICE"),
                              N_("Test whether an NT system partition "
                                 "is hibernated."), 
                              options);
}

GRUB_MOD_FINI (nthibr) 
{
  grub_unregister_extcmd (cmd);
}

^ permalink raw reply	[flat|nested] 20+ messages in thread
* New command to check NT's hibernation state
@ 2011-11-27 23:49 Peter Lustig
  2011-11-28  1:03 ` Vladimir 'φ-coder/phcoder' Serbinenko
  0 siblings, 1 reply; 20+ messages in thread
From: Peter Lustig @ 2011-11-27 23:49 UTC (permalink / raw)
  To: grub-devel

[-- Attachment #1: Type: text/plain, Size: 638 bytes --]

Hello all,

   I would like to contribute a small module I wrote to read the header 
of MS Window's "hiberfil.sys" and determine whether it is in use (i.e. 
Windows has been suspended to disk).  What is the procedure for donating 
code?  Would I need commit rights to the repository, or would someone 
else do it for me?  The source for the module is attached.

Thanks,
Peter Lustig

P.S. I have tested the code and verified it works for Windows 7.  Also, 
from what I understand about "hiberfil.sys" from the SandMan project 
(cf. <http://www.msuiche.net/pres/PacSec07-slides-0.4.pdf>), it should 
work for Windows Vista and XP as well.

[-- Attachment #2: nthibr.c --]
[-- Type: text/plain, Size: 5809 bytes --]

/* nthibr.c - tests whether an MS Windows system partition is hibernated */
/*
 *  GRUB  --  GRand Unified Bootloader
 *  Copyright (C) 2007,2008,2009,2011  Free Software Foundation, Inc.
 *
 *  GRUB is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  GRUB 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
 */

//======== INCLUDES ==========================================================//

//Common Utilities
#include <grub/mm.h>       //NULL
#include <grub/types.h>    //grub_*size_t
#include <grub/disk.h>     //grub_disk_t, grub_disk_*()
#include <grub/file.h>     //grub_file_t, grub_file_*()
#include <grub/misc.h>     //grub_str*(), grub_*puts(), grub_*printf()

//Module Management
#include <grub/dl.h>       //GRUB_MOD_*()
#include <grub/extcmd.h>   //grub_extcmd_*t, grub_*register_extcmd()
#include <grub/lib/arg.h>  //grub_arg_*, ARG_TYPE_*
#include <grub/err.h>      //grub_err_t, GRUB_ERR_*, grub_error()

//Internationalization
#include <grub/i18n.h>     //N_()

//======== PRAGMAS ===========================================================//

//permit use of the zero-initializer '{0}' for structures
#pragma GCC diagnostic ignored "-Wmissing-field-initializers"

//======== TYPE DEFINITIONS ==================================================//

typedef struct grub_arg_option grub_arg_option;

//======== MODULE VARIABLES ==================================================//

GRUB_MOD_LICENSE("GPLv3+");

static grub_extcmd_t cmd;

static const grub_arg_option options[] = {
  {
    .longarg  = "exit-codes", 
    .shortarg = 'x',
    .flags    = 0x0, 
    .doc      = N_("Display return codes used by this command and exit."), 
    .arg      = NULL,
    .type     = ARG_TYPE_NONE
  },
  {0} //end of list
};

//======== FUNCTIONS =========================================================//

static grub_err_t grub_cmd_nthibr (
  grub_extcmd_context_t ctxt, int argc, char* args[]
){
  grub_err_t status = GRUB_ERR_NONE;

  char *szPartName, szFilePath[32], szFileMagic[5] = {'\0'};

  grub_ssize_t length;

  grub_disk_t hPart;
  grub_file_t hFile = NULL;


  #define ABORT(_code, _message) {             \
    status = grub_error((_code), (_message));  \
    goto exit;                                 \
  }


  //If requested, print return codes and exit; else, proceed
  if (ctxt->state[0].set) {
    grub_printf(
      N_(
        "CODE  MEANING\n"
        "----  -------\n"
        "  %2d  system hibernated\n"
        "  %2d  system not hibernated\n"
        "  %2d  hibernation file too small\n"
        "  %2d  hibernation file not found\n"
        "  %2d  partition not found\n"
        "  %2d  invalid partition specifier\n"
        "  %2d  too few/many arguments provided\n"
      ),
      GRUB_ERR_NONE, GRUB_ERR_TEST_FAILURE, GRUB_ERR_BAD_FILE_TYPE,
      GRUB_ERR_FILE_NOT_FOUND, GRUB_ERR_BAD_FILENAME, GRUB_ERR_UNKNOWN_DEVICE, 
      GRUB_ERR_BAD_ARGUMENT
    );
    goto exit;
  }

  //Check argument count
  if (!argc) {
    ABORT( GRUB_ERR_BAD_ARGUMENT, N_("too few arguments specified") );
  } else if (argc > 1) {
    ABORT( GRUB_ERR_BAD_ARGUMENT, N_("too many arguments specified") );
  }

  szPartName = args[0];
  length = (grub_ssize_t) grub_strlen(szPartName);

  //Check if partition specifier 'looks right'
  if (szPartName[0] != '(' || szPartName[length-1] != ')')
    ABORT( GRUB_ERR_BAD_FILENAME, N_("invalid partition specifier") );

  //Check if partition actually exists
  szPartName[length-1] = '\0';
  if (NULL == (hPart = grub_disk_open(szPartName+1))) {
    ABORT( GRUB_ERR_UNKNOWN_DEVICE, N_("partition not found") );
  } else {
    grub_disk_close(hPart);
    szPartName[length-1] = ')';
  }

  //Build path to 'hiberfil.sys'
  grub_strncpy(szFilePath, szPartName, sizeof(szFilePath) - 1);
  grub_strncat ( 
    szFilePath, 
    "/hiberfil.sys", 
    sizeof(szFilePath) - grub_strlen(szFilePath) - 1
  );

  //Try to open 'hiberfil.sys'
  if (NULL == (hFile = grub_file_open(szFilePath))) {
    ABORT( GRUB_ERR_FILE_NOT_FOUND, N_("'hiberfil.sys' not found") );
  }

  //Try to read magic number of 'hiberfil.sys'
  length = (grub_ssize_t) (sizeof(szFileMagic) - 1);
  if (grub_file_read(hFile, szFileMagic, length) < length)
    ABORT( GRUB_ERR_BAD_FILE_TYPE, N_("'hiberfil.sys' too small") );

  //Return SUCCESS if magic indicates file is active; else return FAILURE
  if (0 == grub_strncasecmp("hibr", szFileMagic, length)) {
    grub_puts(N_("The system is hibernated."));
  } else {
    grub_puts(N_("The system is NOT hibernated."));
    status = GRUB_ERR_TEST_FAILURE;
  }

exit: 
  //Ensure 'hiberfil.sys' is closed
  if (hFile)
    grub_file_close(hFile);

  #undef ABORT
  return status;
} //grub_cmd_nthibr()


GRUB_MOD_INIT(nthibr) {
  cmd = grub_register_extcmd (
    "nthibr",                                                  //name
    grub_cmd_nthibr,                                           //function
    0x0,                                                       //flags = NONE
    N_("DEVICE"),                                              //summary = NONE
    N_("Test whether an NT system partition is hibernated."),  //description
    options                                                    //switches
  );
} //GRUB_MOD_INIT()


GRUB_MOD_FINI(nthibr) {
  grub_unregister_extcmd(cmd);
} //GRUB_MOD_FINI()

^ permalink raw reply	[flat|nested] 20+ messages in thread

end of thread, other threads:[~2013-11-04 13:24 UTC | newest]

Thread overview: 20+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
     [not found] <mailman.171.1324141254.27913.grub-devel@gnu.org>
2011-12-18  3:16 ` New command to check NT's hibernation state Peter Lustig
2011-12-22 12:10   ` Vladimir 'φ-coder/phcoder' Serbinenko
2013-11-04  0:48   ` Vladimir 'φ-coder/phcoder' Serbinenko
2013-11-04 13:13     ` Andrey Borzenkov
2013-11-04 13:24       ` Vladimir 'φ-coder/phcoder' Serbinenko
2013-11-04  1:55 Peter Lustig
     [not found] <mailman.235.1324573308.26580.grub-devel@gnu.org>
2011-12-23  4:32 ` Peter Lustig
2012-08-12  4:23   ` Peter Lustig
2013-01-28 18:11   ` Vladimir 'φ-coder/phcoder' Serbinenko
     [not found] <mailman.213.1324054906.20674.grub-devel@gnu.org>
2011-12-17  5:41 ` Peter Lustig
2011-12-17 11:39   ` Vladimir 'φ-coder/phcoder' Serbinenko
     [not found] <mailman.207.1322931671.23776.grub-devel@gnu.org>
2011-12-10  6:03 ` Peter Lustig
2011-12-16 15:25   ` Vladimir 'φ-coder/phcoder' Serbinenko
2011-12-16 15:30   ` Vladimir 'φ-coder/phcoder' Serbinenko
  -- strict thread matches above, loose matches on Subject: below --
2011-12-03  4:57 Peter Lustig
2011-12-03 10:41 ` Vladimir 'φ-coder/phcoder' Serbinenko
2011-12-02  5:16 Peter Lustig
2011-12-02  6:05 ` Vladimir 'φ-coder/phcoder' Serbinenko
2011-11-27 23:49 Peter Lustig
2011-11-28  1:03 ` Vladimir 'φ-coder/phcoder' Serbinenko
2011-11-28 13:27   ` Vladimir 'φ-coder/phcoder' Serbinenko

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).